Skip to content

Commit

Permalink
Documentation: Various updates
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed May 31, 2023
1 parent 3679b50 commit d30aa00
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 11 deletions.
41 changes: 33 additions & 8 deletions doc/source/firmware/overview.md
Expand Up @@ -64,6 +64,31 @@ Running the [Mois Box], transmitting sensor data over HTTP, using the
::::
:::::

::::::

### Open Hive

All systems conceived by Open Hive. Clemens Gruber reports about the development progress
on his personal site at http://open-hive.org/. He pioneered low-cost scale platform
designs based on aluminium bars.

:::{seealso}
Clemens shared many resources about the [development of a low-cost, aluminium scale platform],
see [Bee Scale Prototype 2], [Open Hive Single Scale Bar], and [Two-bars aluminium scale platform].
:::

[Bee Scale Prototype 2]: https://www.facebook.com/media/set/?set=a.10204255675971783.1073741828.1224510416&type=1&l=41802f0fee
[development of a low-cost, aluminium scale platform]: https://community.hiveeyes.org/t/low-cost-half-only-scale-platform-aluminium/250
[Open Hive Single Scale Bar]: https://community.hiveeyes.org/t/open-hive-scale-bar-for-single-side-weighting/595
[Two-bars aluminium scale platform]: https://community.hiveeyes.org/t/waage-konstruktion-mit-2-wagebalken-und-130-x-30-x-22-mm-wagezellen/3033


#### GSM, Wi-Fi

::::::{grid} 1
:margin: 0
:padding: 0

:::::{grid-item-card}
::::{grid} 2
:margin: 0
Expand All @@ -73,10 +98,10 @@ Running the [Mois Box], transmitting sensor data over HTTP, using the
:columns: 8
[Open Hive GSM / Wi-Fi sensor node](#openhive-gsm-wifi)

The firmware source code powering the [Open Hive Box] and [Open Hive WiFi Solar],
using the [GPRSbee] GSM modem.
Firmware powering the [Open Hive Bee Scale GSM], using a [GPRSbee] GSM
modem, and the [Open Hive WiFi Solar], based on an [ESP8266].

**Date:** 2015
**Date:** 2014
**Source:** [openhive-gsm-wifi.ino]
:::
:::{grid-item}
Expand Down Expand Up @@ -479,17 +504,17 @@ caption: Firmwares
maxdepth: 1
hidden:
---
backdoor/multihop/README
backdoor/node-pipa/README
backdoor/node-wifi-mqtt/README
homie/node-homie-basic/README
homie/node-homie-lowpower/README
moislabs/beescale-yun/README
openhive/openhive-gsm-wifi/README
openhive/rfm69-gateway-sdcard/README
openhive/rfm69-gateway-uart/README
openhive/rfm69-node/README
openhive/scale-adjust/README
backdoor/multihop/README
backdoor/node-pipa/README
backdoor/node-wifi-mqtt/README
homie/node-homie-basic/README
homie/node-homie-lowpower/README
ringlabs/bienenwaage-2.0/README
ringlabs/bienenwaage-5.0/README
```
2 changes: 2 additions & 0 deletions doc/source/index.rst
Expand Up @@ -209,6 +209,8 @@ An example scenario how a telemetry data network can look like in a multi-sensor
environment. In order to learn more about the Kotori message router and data historian,
visit its documentation at :ref:`kotori`.

.. Mermaid Flowcharts documentation: https://mermaid.js.org/syntax/flowchart.html
.. mermaid::

%%{init: {"flowchart": {"htmlLabels": false}} }%%
Expand Down
7 changes: 4 additions & 3 deletions doc/source/project/backlog.rst
Expand Up @@ -44,10 +44,10 @@ Iteration 2

Layout
------
- [o] @mois-update
- [o] Updates for @mois' system

- New group ``Moislabs``
- https://github.com/bee-mois/beescale
- New group ``Mois' Lab``
- Link to https://github.com/bee-mois/beescale
- Update README
- first: https://www.euse.de/wp/blog/2011/11/bienen-ueberwachen/ (8. November 2011)
- recent: https://www.euse.de/wp/blog/2023/05/wettermessung-direkt-am-stand/ (22. Mai 2023)
Expand All @@ -60,6 +60,7 @@ Documentation
- [o] At least, on all firmwares, you will need to configure the ``HX711_OFFSET`` and ``HX711_KNOWN_WEIGHT`` values ...
- [o] Rename ``./openhive/rfm69-node/synopsis.dot``
- [o] Add a flowchart to each program? Use Mermaid instead of Graphviz?
- [o] Add Grafana embed to each program?
- [o] Improve leftnav, with sections
- [o] Improve section about Kotori
- [o] Add more footer links like Discourse
Expand Down

0 comments on commit d30aa00

Please sign in to comment.