Skip to content
Permalink
Browse files

Update documentation

  • Loading branch information...
amotl committed Mar 14, 2019
1 parent 27f5986 commit 68628b8c314955f55e45e221a7a965b42e2f8a1c
Showing with 16 additions and 5 deletions.
  1. +10 −5 README.rst
  2. +6 −0 doc/setup.rst
@@ -2,6 +2,8 @@
Hiveeyes MPY data logger
########################

Data logging for humans.


************
Introduction
@@ -33,17 +35,20 @@ Overview
Architecture
============
- Datalogger and Device
Singletons representing the data logger application and your logging device.

Singleton objects representing the data logger application and your logging device.

- Sensor and HardwareDriver

Sensor components wrap hardware drivers to generalize sensor reading.

- Telemetry and TelemetryTransport

The telemetry subsystem uses different transport adapters for different
connectivity scenarios. MQTT and HTTP over TCP over WiFi is implemented
already and TTN is almost there (thanks, Jan!). We are still waiting for
confirmation of LTE `CAT-M1`_ or `NB-IoT`_ connectivity in Germany
(thanks, Ron and Jan!).
already and TTN over LoRaWAN is almost there (thanks, Jan and Richard!).
We are still waiting for confirmation of LTE `CAT-M1`_ or `NB-IoT`_
connectivity in Germany (thanks, Ron and Jan!).

.. _CAT-M1: https://docs.pycom.io/tutorials/lte/cat-m1.html
.. _NB-IoT: https://docs.pycom.io/tutorials/lte/nb-iot.html
@@ -108,7 +113,7 @@ and conceive it in one way or another. You know who you are.

Have fun!

.. _Hiveeyes MPY data logger setup: https://github.com/hiveeyes/hiveeyes-micropython-firmware/blob/master/setup.rst
.. _Hiveeyes MPY data logger setup: https://github.com/hiveeyes/hiveeyes-micropython-firmware/blob/master/doc/setup.rst
.. _contributors: https://github.com/hiveeyes/hiveeyes-micropython-firmware/blob/master/CONTRIBUTORS.rst
.. _upgrade the Pycom firmware: https://github.com/hiveeyes/hiveeyes-micropython-firmware/blob/master/doc/pycom-firmware-upgrade.rst
.. _General information about the WiPy: https://docs.micropython.org/en/latest/wipy/general.html
@@ -35,6 +35,12 @@ of these tools.

make setup

Independently from running this command once, you might want to install
or update the MicroPython module dependencies with::

make install-requirements


Pre-flight checks
=================
Check serial interface connectivity::

0 comments on commit 68628b8

Please sign in to comment.
You can’t perform that action at this time.