Skip to content

Commit

Permalink
Documentation: Fix indentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@amotl
amotl committed May 30, 2023
1 parent 6aab175 commit ff10bd7
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 60 deletions.
74 changes: 37 additions & 37 deletions CHANGES.rst
View file
Expand Up @@ -45,17 +45,17 @@ in-progress
- Try to fix :ref:`scale-adjust-firmware` regarding ESP8266 compatibility again
- `node-wifi-mqtt.ino`_ firmware:

- Fix ``DEEPSLEEP_TIME`` order of magnitude: ``MEASUREMENT_INTERVAL`` is in ms already. Thanks, Matthias!
- Fix IP address output. Thanks, Matthias!
- When ``SENSOR_DUMMY`` is enabled, don't use any real sensors. Thanks, Giuseppe!
- Add comment about connecting ``GPIO#16`` to ``RST`` for waking up after deep sleep. Thanks, Giuseppe and Matthias!
- Add sensor ADS1231. Thanks, Clemens!
- Fix ``DEEPSLEEP_TIME`` order of magnitude: ``MEASUREMENT_INTERVAL`` is in ms already. Thanks, Matthias!
- Fix IP address output. Thanks, Matthias!
- When ``SENSOR_DUMMY`` is enabled, don't use any real sensors. Thanks, Giuseppe!
- Add comment about connecting ``GPIO#16`` to ``RST`` for waking up after deep sleep. Thanks, Giuseppe and Matthias!
- Add sensor ADS1231. Thanks, Clemens!

- Improve :ref:`firmware-builder`

- Add support for architecture "ESP"
- Add variables ``TARGET_BOARD_TAG`` and ``TARGET_BOARD_SUB`` to firmware builder helper output
- Add firmware builder helper to Makefile for node-wifi-mqtt-homie
- Add support for architecture "ESP"
- Add variables ``TARGET_BOARD_TAG`` and ``TARGET_BOARD_SUB`` to firmware builder helper output
- Add firmware builder helper to Makefile for node-wifi-mqtt-homie

- Properly define and use ``HE_CONTAINERS`` in :ref:`generic-firmware`

Expand All @@ -66,29 +66,29 @@ in-progress
=================
- :ref:`scale-adjust-firmware` (`scale-adjust-hx711.ino`_ and `scale-adjust-ads1231.ino`_)

- Make it compile against Espressif/ESP8266
- Make it work on the ESP8266 at runtime by satisfying the watchdog. Thanks, Martin!
- Properly read numeric value from serial port. Thanks, Matthias!
- Fix computing the ``loadCellKgDivider``. Thanks, Clemens!
- Fix compilation on Arduino version <= 1.0.6
- Make it compile against Espressif/ESP8266
- Make it work on the ESP8266 at runtime by satisfying the watchdog. Thanks, Martin!
- Properly read numeric value from serial port. Thanks, Matthias!
- Fix computing the ``loadCellKgDivider``. Thanks, Clemens!
- Fix compilation on Arduino version <= 1.0.6

- :ref:`generic-firmware`: Reduce loop interval when being in bootstrap phase
- :ref:`node-gsm-http`: Fix Makefile for ESP8266. Thanks, Matthias!
- :ref:`node-yun-http`: Add firmware `node-yun-http.ino`_ for Mois Box. Thanks, Markus!
- Improve the `node-wifi-mqtt.ino`_ firmware for the :ref:`node-wifi-mqtt`:

- Fix Makefile for ESP8266 reported not to work on Ubuntu 16.10. Thanks, Matthias!
- Completely overhaul the basic ESP8266/MQTT firmware making it more efficient and flexible,
see also `Improve the basic “node-wifi-mqtt” firmware <https://community.hiveeyes.org/t/improve-the-basic-node-wifi-mqtt-firmware/235>`_.
Thanks, Giuseppe and Matthias!
- Start with single device counts of DHTxx and DS18B20 sensors to make firmware even more basic out of the box.
Thanks again, Matthias!
- Modularize and streamline code to better serve educational purposes
- Enable connecting to multiple WiFi access points with multiple attempts. Thanks, Matthias and Clemens!
- Read and transmit battery level. Thanks, Matthias!
- Read and transmit free heap memory
- Improve overall configurability and wifi_connect/mqtt_connect re. retrying
- Add deep sleep mode
- Fix Makefile for ESP8266 reported not to work on Ubuntu 16.10. Thanks, Matthias!
- Completely overhaul the basic ESP8266/MQTT firmware making it more efficient and flexible,
see also `Improve the basic “node-wifi-mqtt” firmware <https://community.hiveeyes.org/t/improve-the-basic-node-wifi-mqtt-firmware/235>`_.
Thanks, Giuseppe and Matthias!
- Start with single device counts of DHTxx and DS18B20 sensors to make firmware even more basic out of the box.
Thanks again, Matthias!
- Modularize and streamline code to better serve educational purposes
- Enable connecting to multiple WiFi access points with multiple attempts. Thanks, Matthias and Clemens!
- Read and transmit battery level. Thanks, Matthias!
- Read and transmit free heap memory
- Improve overall configurability and wifi_connect/mqtt_connect re. retrying
- Add deep sleep mode


2017-03-31 0.14.0
Expand All @@ -101,8 +101,8 @@ in-progress
- Improve firmwares :ref:`node-wifi-mqtt-homie` and :ref:`node-wifi-mqtt-homie-battery`
- :ref:`node-wifi-mqtt`:

- Fix JSON serialization: Transmit sensor readings as float values and improve robustness. Thanks, Matthias and Giuseppe!
- Improve configuration and documentation, last but not least regarding MQTT authentication.
- Fix JSON serialization: Transmit sensor readings as float values and improve robustness. Thanks, Matthias and Giuseppe!
- Improve configuration and documentation, last but not least regarding MQTT authentication.


2017-03-17 0.13.0
Expand All @@ -122,15 +122,15 @@ in-progress
- Add ArduinoSTL, a STL and iostream implementation for Arduino based on uClibc++
- Update firmware for :ref:`node-wifi-mqtt` (`node-wifi-mqtt.ino`_). Thanks Clemens and Karsten!

- Make things actually work
- Add dependency "Adafruit_MQTT_Library"
- Add more sensors
- Add Makefile and documentation
- Make things actually work
- Add dependency "Adafruit_MQTT_Library"
- Add more sensors
- Add Makefile and documentation

- Improve Homie Firmware for :ref:`node-wifi-mqtt-homie`

- Add dependencies as git submodules
- Add Makefile
- Add dependencies as git submodules
- Add Makefile

- Add :ref:`lib-terkin-data` library: Flexible data collection for decoupling sensor reading and telemetry domains

Expand All @@ -141,8 +141,8 @@ in-progress
Contributed as `PR #1`_ by Alexander Wilms of `Imkerverein Nettetal e.V.`_. Thanks a bunch!
- Update firmware for :ref:`open-hive-firmware-gprs`: (`openhive-gsm-wifi.ino`_). Thanks, Clemens!

- Add support for HX711
- Add support for ESP8266
- Add support for HX711
- Add support for ESP8266

- Add "makeEspArduino", a makefile for ESP8266 Arduino projects by Peter Lerup
- Pull update to HX711 submodule
Expand All @@ -167,8 +167,8 @@ in-progress
- Update firmware for :ref:`open-hive-firmware-gprs` "`openhive-gsm-wifi.ino`_": Modularize sensors and debugging. Thanks, Clemens!
- Add firmwares for Open Hive RFM69 tandem with build infrastructure and documentation

- :ref:`open-hive-firmware-rfm69-node`: `rfm69-node.ino`_
- :ref:`open-hive-firmware-rfm69-gateway-sdcard`: `rfm69-gateway-sdcard.ino`_
- :ref:`open-hive-firmware-rfm69-node`: `rfm69-node.ino`_
- :ref:`open-hive-firmware-rfm69-gateway-sdcard`: `rfm69-gateway-sdcard.ino`_

- Improve documentation

Expand Down
47 changes: 24 additions & 23 deletions doc/source/project/backlog.rst
View file
Expand Up @@ -145,8 +145,8 @@ Misc

- check out workbench@elbanco:/opt/esp-open-sdk after resizing /opt

- https://github.com/pfalcon/esp-open-sdk
- http://domoticx.com/sdk-esp8266-xtensa-architecture-toolchain/
- https://github.com/pfalcon/esp-open-sdk
- http://domoticx.com/sdk-esp8266-xtensa-architecture-toolchain/


2017-04-09
Expand All @@ -158,17 +158,17 @@ Misc
----------
- Further improvements to :ref:`node-wifi-mqtt`

- [o] Publish discrete values to the MQTT bus, use MQTT_DISCRETE maybe.
- [o] Add debugging using http://playground.arduino.cc/Code/SerialDebugger
- [x] Comment: "Connect the D0 pin with RST pin to enable wakeup of the MCU." re. deep sleep mode
- On "Adafruit Feather HUZZAH", wire RST with GPIO16,
see also https://learn.adafruit.com/adafruit-feather-huzzah-esp8266/pinouts
- [x] @gtuveri: it makes no sense to add #if SENSOR* stuff if SENSOR_DUMMY is true?
- [o] @gtuveri: why to proceed within execution if no WiFi connection has been established?
- [x] @Thias: ``#define DEEPSLEEP_TIME MEASUREMENT_INTERVAL * 1000UL`` since measurement interval is in ms already
- [x] Improve inline comments again
- [o] Switch from Adafruit_MQTT to https://github.com/tuanpmt/esp_mqtt or https://github.com/marvinroger/async-mqtt-client?
- [x] Add sensor ADS1231
- [o] Publish discrete values to the MQTT bus, use MQTT_DISCRETE maybe.
- [o] Add debugging using http://playground.arduino.cc/Code/SerialDebugger
- [x] Comment: "Connect the D0 pin with RST pin to enable wakeup of the MCU." re. deep sleep mode
- On "Adafruit Feather HUZZAH", wire RST with GPIO16,
see also https://learn.adafruit.com/adafruit-feather-huzzah-esp8266/pinouts
- [x] @gtuveri: it makes no sense to add #if SENSOR* stuff if SENSOR_DUMMY is true?
- [o] @gtuveri: why to proceed within execution if no WiFi connection has been established?
- [x] @Thias: ``#define DEEPSLEEP_TIME MEASUREMENT_INTERVAL * 1000UL`` since measurement interval is in ms already
- [x] Improve inline comments again
- [o] Switch from Adafruit_MQTT to https://github.com/tuanpmt/esp_mqtt or https://github.com/marvinroger/async-mqtt-client?
- [x] Add sensor ADS1231


2017-04-05
Expand Down Expand Up @@ -221,9 +221,9 @@ Misc
- https://github.com/bogde/HX711/pull/59
- Alternative libraries for ADS1231:

- https://github.com/rfjakob/barwin-arduino
- | https://github.com/jensfranke/ads-1231-particle-library
| see also: https://community.particle.io/t/library-for-ads-1231-bee-hive-weigh-scale/21719
- https://github.com/rfjakob/barwin-arduino
- | https://github.com/jensfranke/ads-1231-particle-library
| see also: https://community.particle.io/t/library-for-ads-1231-bee-hive-weigh-scale/21719
- http://forum.sodaq.com/c/beekeeping
- Rename node-gprs-http to node-gsm-wifi-http
Expand Down Expand Up @@ -279,15 +279,16 @@ RaspIO setup
----------
- [o] Investigate alternative HX711 library

- http://www.arduinolibraries.info/libraries/queuetue-digital-balance-library
- http://www.arduinolibraries.info/libraries/queuetue-hx711-library
- https://github.com/queuetue/Q2-Balance-Arduino-Library
- https://github.com/queuetue/Q2-HX711-Arduino-Library
- http://www.arduinolibraries.info/libraries/queuetue-digital-balance-library
- http://www.arduinolibraries.info/libraries/queuetue-hx711-library
- https://github.com/queuetue/Q2-Balance-Arduino-Library
- https://github.com/queuetue/Q2-HX711-Arduino-Library

- [o] Migrate from StandardCplusplus to ArduinoSTL?
- https://github.com/mike-matera/ArduinoSTL
- http://platformio.org/lib/show/750/ArduinoSTL
- See also https://github.com/maniacbug/StandardCplusplus/pull/20

- https://github.com/mike-matera/ArduinoSTL
- http://platformio.org/lib/show/750/ArduinoSTL
- See also https://github.com/maniacbug/StandardCplusplus/pull/20


2016-11-01
Expand Down

0 comments on commit ff10bd7

Please sign in to comment.