ents

Python package for the Environmental NeTworked Sensor (ENTS) project. It encodes and decodes the protobuf messages nodes upload, talks to the DirtViz backend, configures nodes over serial, and simulates a node when you do not have hardware to hand.

The firmware that runs on the nodes themselves is documented separately, with Doxygen, in embedded/doxygen.

Where to start

Split by what you are trying to do:

Using the package — you want to pull data out of DirtViz, decode a payload, check whether a node is alive, or configure one. Start here.

Developing the package — you want to change the package itself: environment setup, tests, linting, and regenerating the protobuf bindings after editing a .proto file.

API reference — generated from the docstrings.

Install

pip install ents

See Using the package for the rest.