Skip to content

Commit ff10bd7

Browse files
committed
Documentation: Fix indentation
1 parent 6aab175 commit ff10bd7

File tree

2 files changed

+61
-60
lines changed

2 files changed

+61
-60
lines changed

CHANGES.rst

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@ in-progress
4545
- Try to fix :ref:`scale-adjust-firmware` regarding ESP8266 compatibility again
4646
- `node-wifi-mqtt.ino`_ firmware:
4747

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

5454
- Improve :ref:`firmware-builder`
5555

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

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

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

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

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

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

9393

9494
2017-03-31 0.14.0
@@ -101,8 +101,8 @@ in-progress
101101
- Improve firmwares :ref:`node-wifi-mqtt-homie` and :ref:`node-wifi-mqtt-homie-battery`
102102
- :ref:`node-wifi-mqtt`:
103103

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

107107

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

125-
- Make things actually work
126-
- Add dependency "Adafruit_MQTT_Library"
127-
- Add more sensors
128-
- Add Makefile and documentation
125+
- Make things actually work
126+
- Add dependency "Adafruit_MQTT_Library"
127+
- Add more sensors
128+
- Add Makefile and documentation
129129

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

132-
- Add dependencies as git submodules
133-
- Add Makefile
132+
- Add dependencies as git submodules
133+
- Add Makefile
134134

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

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

144-
- Add support for HX711
145-
- Add support for ESP8266
144+
- Add support for HX711
145+
- Add support for ESP8266
146146

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

170-
- :ref:`open-hive-firmware-rfm69-node`: `rfm69-node.ino`_
171-
- :ref:`open-hive-firmware-rfm69-gateway-sdcard`: `rfm69-gateway-sdcard.ino`_
170+
- :ref:`open-hive-firmware-rfm69-node`: `rfm69-node.ino`_
171+
- :ref:`open-hive-firmware-rfm69-gateway-sdcard`: `rfm69-gateway-sdcard.ino`_
172172

173173
- Improve documentation
174174

doc/source/project/backlog.rst

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,8 @@ Misc
145145

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

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

151151

152152
2017-04-09
@@ -158,17 +158,17 @@ Misc
158158
----------
159159
- Further improvements to :ref:`node-wifi-mqtt`
160160

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

173173

174174
2017-04-05
@@ -221,9 +221,9 @@ Misc
221221
- https://github.com/bogde/HX711/pull/59
222222
- Alternative libraries for ADS1231:
223223

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

282-
- http://www.arduinolibraries.info/libraries/queuetue-digital-balance-library
283-
- http://www.arduinolibraries.info/libraries/queuetue-hx711-library
284-
- https://github.com/queuetue/Q2-Balance-Arduino-Library
285-
- https://github.com/queuetue/Q2-HX711-Arduino-Library
282+
- http://www.arduinolibraries.info/libraries/queuetue-digital-balance-library
283+
- http://www.arduinolibraries.info/libraries/queuetue-hx711-library
284+
- https://github.com/queuetue/Q2-Balance-Arduino-Library
285+
- https://github.com/queuetue/Q2-HX711-Arduino-Library
286286

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

292293

293294
2016-11-01

0 commit comments

Comments
 (0)