Python库 | wirepas_backend_client-1.3.6rc1.tar.gz

# Backend-client [](https://gitpod.io/#https://github.com/wirepas/backend-client) [](https://www.codacy.com/manual/wirepas/backend-client?utm_source=github.com&utm_medium=referral&utm_content=wirepas/backend-client&utm_campaign=Badge_Grade) [](https://travis-ci.com/wirepas/backend-client) [](https://backend-client.readthedocs.io/en/latest/?badge=latest) [](https://pypi.org/project/wirepas-backend-client/) <!-- MarkdownTOC levels="1,2,3" autolink="true" style="ordered" --> 1. [Introduction](#introduction) 1. [Installation](#installation) 1. [Host dependencies](#host-dependencies) 1. [Setting up a Python virtual environment](#setting-up-a-python-virtual-environment) 1. [Installing from PyPi](#installing-from-pypi) 1. [Installing from Github](#installing-from-github) 1. [Entrypoints](#entrypoints) 1. [Gateway command line interface](#gateway-command-line-interface) 1. [WPE Viewer](#wpe-viewer) 1. [WNT Viewer](#wnt-viewer) 1. [Provisioning server](#provisioning-server) 1. [Framework](#framework) 1. [Structure](#structure) 1. [Examples](#examples) 1. [Logging to fluentd](#logging-to-fluentd) 1. [Building and running over Docker](#building-and-running-over-docker) 1. [Dockerhub](#dockerhub) 1. [Running with docker](#running-with-docker) 1. [Running with compose](#running-with-compose) 1. [Building the image locally](#building-the-image-locally) 1. [Source documentation](#source-documentation) 1. [Contributing](#contributing) 1. [License](#license) <!-- /MarkdownTOC --> ## Introduction The Backend Client is a tool to serve as a decoder and a test framework where you can extend the existing interfaces to develop your own test cases. Interactions with a [gateway][wirepas_gateway] must be compliant with the Wirepas Backend to Gateway API. In addition to the interaction with the Backend to Gateway Public API, the Backend Client has also support for Wirepas Positioning Engine and Wirepas Network Tool. Support for these tools is still work in progress (see [milestones][backend_client_gh_milestones] and [projects][backend_client_gh_projects]). However, you can already benefit from existing entrypoints to help you capture data and debug your integration (see [entrypoints](#entrypoints)). Figure 1 illustrates the horizon where Backend Client is located. ![Architecture overview][here_img_overview] **Figure 1** - Backend Client role in the Wirepas ecosystem. ## Installation The Backend Client is written in python and it requires a valid MQTT broker target to connect to, WNT or WPE credentials. If you need help installing a MQTT broker or auxiliary software please refer to our tutorials repository. ### Host dependencies The main requirements of Backend Client are: - Python 3.7 - Pip (we recommend the latest available) - Linux system Certain Backend Client's dependencies must be compiled locally upon installation, thus require the installation of specific development headers. Under Debian, the extra requirements are met with: ```bash sudo apt-get install default-libmysqlclient-dev gcc python3.7-dev ``` Please be advised that the name of such packages might change depending on your Linux system. Please refer to the Dockerfiles under the [container folder][here_container] for more detailed information. Windows native environments are not supported. For help running the tool in Windows, please use the Linux subsystem, Docker or a virtual machine. ### Setting up a Python virtual environment As a recommendation, it is good practice to install and run the application on a virtual python environment. Such approach avoids possible issues with conflicting package versions. We recommend you use [pipenv][pipenv]: ```shell pip3 install pipenv ``` If you choose to install and run the Backend Client inside a virtual environment, please activate the environment before moving with the next steps. For pipenv, a virtual environment is created and activated by: ```shell pipenv --three pipenv shell ``` Once you activate your environment your can safely install the python package under it. For more information please refer to the tool's webpage. ### Installing from PyPi The Backend Client is available from [PyPi][backend_client_pypi] and you can install the latest stable version with: ```shell pip install wirepas-backend-client ``` If you wish to install a particular version please see the release history from PyPi. ### Installing from Github First of all, make sure to clone the repository using the https address. Checkout the [git tag that corresponds to the release version][backend_client_gh_releases] you want to install and install the package with: ```shell pip3 install . ``` If you leave your branch checked out to the top of master, it is likely that you might run into a few issues. If you find them, please be so kind to raise them to us through an [issue or bug report][backend_client_gh_issues]. If you want to develop or patch a bug under your local environment, you can install the package in development mode through: ```shell pip3 install -e . ``` When installed in development mode, changes to the source files will be immediately visible. ## Entrypoints After installation, the Backend Client exposes several [shell entrypoints][here_setup_entrypoints] that can be run from any location in your system. This section describes their usage in more detail. ### Gateway command line interface The Backend Client exposes an interactive gateway command line which is meant to interact with a gateway and sink pair connected to a given MQTT broker. To start an interactive command line to interact with a broker located in your _localhost_ environment type: ```shell wm-gw-cli ``` Connecting to a remote server requires you to specify the values as an argument or by reading from a yaml settings file. To view all the arguments, please issue the command: ```shell wm-gw-cli --help ``` #### Connecting to the MQTT broker For the gateway client to function properly, it needs to establish a connection to the same MQTT broker where one or multiple gateways are connected to. To do so, let's assume the following MQTT credentials are saved in ./examples/settings.yml: ```yaml # examples/settings.yml # Example on how to set the MQTT credentials towards a local broker # with basic authentication mqtt_hostname: 127.0.0.1 mqtt_password: password mqtt_username: username mqtt_port: 1883 # defaults to 8883 (secure port) mqtt_force_unsecure: True # defaults to False (secure) ``` To start the gateway against the MQTT broker specified in ./examples/settings.yml, issue the following command: ```shell wm-gw-cli cli --settings ./examples/settings.yml ``` Once the client launches, you will be greeted with: ```shell Welcome to the Wirepas Gateway Client cli! Connecting to mosquittouser@127.0.0.1:1883 (unsecure: True) Type help or ? to list commands Type ! to escape shell commands Use Arrow Up/Down to navigate your command history Use CTRL-D or bye to exit 09:50.17 | wm-gw-cli > ``` #### Commands The gateway client has a set of commands which you can view by typing ? in the client's shell: ```shell wm-gw-cli > ? Documented commands (type help <topic>): ======================================== EOF playback set_loop_iterations bye q set_loop_timeout clear_offline_gateways record set_reply_greeting eof scratchpad_s