https://github.com/bringauto/mission-module-display-tool
Simple http server for displaying state of vehicles from mission module. Connects to fleet http api
https://github.com/bringauto/mission-module-display-tool
Last synced: 4 months ago
JSON representation
Simple http server for displaying state of vehicles from mission module. Connects to fleet http api
- Host: GitHub
- URL: https://github.com/bringauto/mission-module-display-tool
- Owner: bringauto
- License: gpl-3.0
- Created: 2024-06-21T12:21:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T13:33:32.000Z (about 1 year ago)
- Last Synced: 2025-03-21T14:40:01.973Z (about 1 year ago)
- Language: Python
- Size: 52.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mission module display tool
This tool is used to display the positions of the cars on the map using the [fleet protocol HTTP API](https://github.com/bringauto/fleet-protocol-http-api).
## Installation
```bash
git clone https://github.com/bringauto/mission-module-display-tool.git
cd mission-module-display-tool
mkdir logs
pip install -r requirements.txt
```
## Command line arguments
* `--config=` - path to the JSON configuration file. If not set, the default path `./config/config.json` is used.
## JSON configuration
* `api-url` - URL of the fleet protocol HTTP API.
* `api-key` - API key for the fleet protocol HTTP API.
* `port` - port on which the web server will run.
## Usage
Starting the tool with the default configuration:
```bash
python3 display-tool.py
```
Starting the tool with a custom configuration:
```bash
python3 display-tool.py --config=./config/config.json
```
It will start web server on `http://localhost:5000/` and display the map with the cars.
## Running in docker
```bash
docker build -t mission-module-display-tool .
```
Replace `` with the name of the container network where the HTTP API is running.
```bash
docker run -p 5000:5000 --network= mission-module-display-tool --config=config/config-docker.json
```
If option `--config` is not set, the default configuration file `config/config-docker.json` is used.
### Example for use with [bringauto/etna](https://github.com/bringauto/etna)
To use the mission-module-display-tool with the bringauto/etna project, you can run the following commands:
```bash
docker build -t mission-module-display-tool .
```
```bash
docker run -p 5000:5000 --network=bring-emulator mission-module-display-tool --config=config/config-docker.json
```
In this example, the network is set to `bring-emulator`, which is the network name used by the bringauto/etna project docker compose file.