Update description and readme
This commit is contained in:
parent
b2e665fcbd
commit
d1fe4c2791
|
@ -0,0 +1,16 @@
|
|||
This is a testing tool for one proprietary enterprise app which in turn handles aviation lights on top of the wind turbines for aviation safety.
|
||||
While working on that app it is not always possible to use real devices (so called light controllers).
|
||||
|
||||
Thus the purpose of this tool to help with development via simulating those devices.
|
||||
Communication with controllers is built upon **MODBUS** protocol via TCP/IP.
|
||||
|
||||
The name ``abibas`` is more like a joke implying that it is not real devices but the simulated ones.
|
||||
The tool consists of two parts - simulator (implemented using **pyModbusTCP**) and UI interface to it for configuration and monitoring (implemented using **Flask**)
|
||||
|
||||
Type ``abibas`` in terminal to run the tool after installation
|
||||
Type Ctrl+C to cancel (or stop) the tool
|
||||
After stopping it a table will be printed out with some stats info
|
||||
|
||||
Requires **python3.10** and above
|
||||
|
||||
Licensed under **GPLv3** license
|
|
@ -0,0 +1,42 @@
|
|||
Purpose
|
||||
=======
|
||||
This is a testing tool for one proprietary enterprise app which in turn handles aviation lights on top of the wind turbines for aviation safety.
|
||||
While working on that app it is not always possible to use real devices (so called light controllers).
|
||||
|
||||
Thus the purpose of this tool to help with development via simulating those devices.
|
||||
Communication with controllers is built upon **MODBUS** protocol via TCP/IP.
|
||||
|
||||
The name ``abibas`` is more like a joke implying that it is not real devices but the simulated ones.
|
||||
The tool consists of two parts - simulator (implemented using **pyModbusTCP**) and UI interface to it for configuration and monitoring (implemented using **Flask**)
|
||||
|
||||
Type ``abibas`` in terminal to run the tool after installation
|
||||
Type Ctrl+C to cancel (or stop) the tool
|
||||
After stopping it a table will be printed out with some stats info
|
||||
|
||||
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
|
34
README.rst
34
README.rst
|
@ -1,34 +0,0 @@
|
|||
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
|
|
@ -8,13 +8,18 @@ authors = [
|
|||
{name = "Taryel Hlontsi", email = "xhaaix@gmail.com"},
|
||||
]
|
||||
description = "Aviation lights simulator for Environmental Control (EC)"
|
||||
readme = "README.rst"
|
||||
readme = "DESCRIPTION.rst"
|
||||
requires-python = ">=3.10"
|
||||
keywords = ["simulator", "MODBUS", "EC"]
|
||||
license = {file = "LICENSE"}
|
||||
classifiers = [
|
||||
"Development Status :: 3 - Alpha",
|
||||
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
|
||||
"Intended Audience :: Developers",
|
||||
"Framework :: Flusk",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
]
|
||||
dependencies = [
|
||||
"Flask",
|
||||
|
|
Loading…
Reference in New Issue