Go to file
tar b2e665fcbd Set required python version as 3.10 2023-06-16 07:45:51 +02:00
src Add initial implementation 2023-06-14 21:21:37 +02:00
.gitignore Initial commit 2023-06-14 19:14:09 +00:00
LICENSE Add initial implementation 2023-06-14 21:21:37 +02:00
README.rst Set required python version as 3.10 2023-06-16 07:45:51 +02:00
pyproject.toml Set required python version as 3.10 2023-06-16 07:45:51 +02:00

README.rst

Purpose
=======
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.

This tool simulates interaction with the light controllers via MODBUS protocol over TCP/IP and additionally provides a simple UI for configuration and monitoring.
UI is built using **Flask**, simulator - using the **pyModbusTCP** package

Requires **python3.10** and above

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