Skip to content

Latest commit

 

History

History
125 lines (89 loc) · 5.12 KB

README.md

File metadata and controls

125 lines (89 loc) · 5.12 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

EdgeTech-dAISy

This repo builds upon the IQT Labs EdgeTech-Core functionality to instantiate an MQTT client that reads from an aliased serial port and publishes a bytestring delimited by newlines to an MQTT topic. All of this functionality is wrapped in a Docker container for cross-platform compatibility.

Make Contribution · Report Bug · Request Feature

Built With

Python Poetry Docker

Getting Started

To run this repo, simply run:

docker-compose up

The dAISy module is containerized and dependencies are managed using poetry.

Prerequisites

Running this repo requires that you have Docker installed.

Usage

Spinning up this system requires an MQTT server and this container to be included in your docker-compose.yml. You can find an example of this workflow in this repository's docker-compose.yml. Additionally, some editing of relevant environment variables will be required based upon your system's configuration of topics to subscribe to and MQTT configuration. Examples of these environment variables can be found in this repository's .env file.

As this system is meant to be spun up with MQTT topics you would like to write to files, copying the daisy docker-compose statements into a master docker-compose.yml and .env files with your entire system of containers is the preferred workflow. Find an application architecture diagram example of how the usage of this module was envisioned below.

flowchart TD
    daisy(dAISy) -- dAISy Topic --> mqtt{MQTT}
    mqtt{MQTT} -- Subscribed to dAISy Topic --> filesaver(Filesaver)
    mqtt{MQTT} -- Subscribed to dAISy Topic -->  couchdbsaver(CouchDB Saver)

style mqtt fill:#0072bc,color:#ffffff
style daisy fill:#80c342,color:#ffffff
style couchdbsaver fill:#F9D308,color:#ffffff
style filesaver fill:#F9D308,color:#ffffff
Loading

Roadmap

  • TBA

See the open issues for a full list of proposed features (and known issues).

Contributing

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b dev)
  3. Commit your Changes (git commit -m 'adding some feature')
  4. Run (and make sure they pass):
black --diff --check *.py

pylint --disable=all --enable=unused-import *.py

mypy --allow-untyped-decorators --ignore-missing-imports --no-warn-return-any --strict --allow-subclassing-any *.py

If you do not have them installed, you can install them with pip install "black<23" pylint==v3.0.0a3 mypy==v0.991.

  1. Push to the Branch (git push origin dev)
  2. Open a Pull Request

See CONTRIBUTING.md for more information.

License

Distributed under the Apache 2.0. See LICENSE.txt for more information.

Contact IQTLabs

See our other projects: https://github.com/IQTLabs/

(back to top)