abibas/README.rst

35 lines
1.1 KiB
ReStructuredText
Raw Normal View History

2023-06-14 19:21:37 +00:00
Purpose
=======
2023-06-16 05:45:51 +00:00
This is a simple helper tool designed specifically for one enterprise app,
which in turn controls flashing lights on the wind turbines for aviation safety.
2023-06-14 19:21:37 +00:00
2023-06-16 05:45:51 +00:00
This tool simulates interaction with the light controllers via MODBUS protocol over TCP/IP and additionally provides a simple UI for configuration and monitoring.
2023-06-14 19:21:37 +00:00
UI is built using **Flask**, simulator - using the **pyModbusTCP** package
2023-06-16 05:45:51 +00:00
Requires **python3.10** and above
2023-06-14 19:21:37 +00:00
Licensed under **GPLv3** license
Setup & debug
=============
+ clone the repo and cd to the cloned dir
+ ``python3.11 -m venv .venv``
+ ``source .venv/bin/activate``
+ ``pip install build``
+ ``python -m build``
+ ``pip install -e .``
+ ``pip list`` (pip show abibas, pip uninstall abibas, etc)
At this stage the package is installed in editable mode, to run it in debug mode:
+ ``abibas-debug``
or in normal mode:
+ ``abibas``
If in debug mode changes made to the Flask app will be applied automatically at runtime,
for the changes in simulator though the tool has to be restarted.
**main** module can be manipulated for debugging purposes as well