diff --git a/CHANGES.rst b/CHANGES.rst index 667e88c..ad1c284 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -270,7 +270,7 @@ Terkin_, `Hiveeyes-Lib`_ and `OpenHive-Lib`_. simple HTTP+JSON communication over GPRSbee. - Update ``HE_API_URL`` to use different url for non-TLS - communication: http://swarm.hiveeyes.org/api-notls/. + communication: ``http://swarm.hiveeyes.org/api-notls/``. The default GPRSbee devices don't do SSL. - Connect to access point with authentication by default, diff --git a/Makefile b/Makefile index 7d40c5b..41b3be0 100644 --- a/Makefile +++ b/Makefile @@ -10,15 +10,21 @@ include util.mk # Miscellaneous tools: # Software tests, Documentation builder, Virtual environment builder +# Build documentation. docs-html: virtualenv @# TODO: Invoke from `conf.py`. $(MAKE) rst2md export SPHINXBUILD="$(PWD)/$(sphinx)"; cd doc; make html +# Continuously build documentation. docs-autobuild: virtualenv $(pip) --quiet install sphinx-autobuild $(sphinx-autobuild) --open-browser doc/source doc/build +# Run link checker on documentation. +docs-linkcheck: virtualenv + $(sphinx) -j auto -n -W --keep-going -b linkcheck doc/source doc/build + virtualenv: setup-virtualenv @echo Installing packages from requirements-docs.txt. $(pip) install --quiet --upgrade --requirement requirements-docs.txt diff --git a/backdoor/node-pipa/README.rst b/backdoor/node-pipa/README.rst index a524e1d..247767d 100644 --- a/backdoor/node-pipa/README.rst +++ b/backdoor/node-pipa/README.rst @@ -49,7 +49,7 @@ Details - The telemetry domain has been sketched out by @amotl. - - https://github.com/hiveeyes/arduino/tree/master/node-pipa/examples/legacy-gprsbee + - https://github.com/hiveeyes/arduino/tree/main/backdoor/node-pipa/examples/legacy-gprsbee - https://hiveeyes.org/docs/arduino/TerkinData/README.html - The sensor domain might be implemented on top of the EnviroDIY @@ -59,7 +59,7 @@ Details - https://community.hiveeyes.org/t/envirodiy-mayfly-data-logger/3035 - https://github.com/EnviroDIY/ModularSensors - - https://github.com/hiveeyes/arduino/tree/master/node-pipa/examples/pipa-envirodiy + - https://github.com/hiveeyes/arduino/tree/main/backdoor/node-pipa/examples/pipa-envirodiy ******* diff --git a/backdoor/node-pipa/examples/legacy-gprsbee/pipa-legacy-gprsbee.ino b/backdoor/node-pipa/examples/legacy-gprsbee/pipa-legacy-gprsbee.ino index be2f37e..6dcab28 100644 --- a/backdoor/node-pipa/examples/legacy-gprsbee/pipa-legacy-gprsbee.ino +++ b/backdoor/node-pipa/examples/legacy-gprsbee/pipa-legacy-gprsbee.ino @@ -118,9 +118,9 @@ #if USE_GPRSBEE #include // https://github.com/SodaqMoja/GPRSbee #endif -#include // https://github.com/hiveeyes/arduino/tree/master/libraries/Terkin -#include // https://github.com/hiveeyes/arduino/tree/master/libraries/Hiveeyes -#include // https://github.com/hiveeyes/arduino/tree/master/libraries/OpenHive +#include // https://github.com/hiveeyes/arduino/tree/main/libraries/Terkin +#include // https://github.com/hiveeyes/arduino/tree/main/libraries/Hiveeyes +#include // https://github.com/hiveeyes/arduino/tree/main/libraries/OpenHive #include // Arduino diff --git a/backdoor/node-pipa/examples/pipa-espressif/pipa-espressif.ino b/backdoor/node-pipa/examples/pipa-espressif/pipa-espressif.ino index e92b4b0..2e763f2 100644 --- a/backdoor/node-pipa/examples/pipa-espressif/pipa-espressif.ino +++ b/backdoor/node-pipa/examples/pipa-espressif/pipa-espressif.ino @@ -103,9 +103,9 @@ // Libraries // --------- #include // https://github.com/bblanchon/ArduinoJson -#include // https://github.com/hiveeyes/arduino/tree/master/libraries/Terkin -#include // https://github.com/hiveeyes/arduino/tree/master/libraries/Hiveeyes -#include // https://github.com/hiveeyes/arduino/tree/master/libraries/OpenHive +#include // https://github.com/hiveeyes/arduino/tree/main/libraries/Terkin +#include // https://github.com/hiveeyes/arduino/tree/main/libraries/Hiveeyes +#include // https://github.com/hiveeyes/arduino/tree/main/libraries/OpenHive #include // Arduino diff --git a/doc/source/conf.py b/doc/source/conf.py index 86ac1bb..da0a10c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -351,3 +351,11 @@ def setup(app): ogp_site_url = "https://hiveeyes.org/docs/arduino/" ogp_description_length = 300 ogp_enable_meta_description = True + +# -- Options for link checker ---------------------------------- + +# A list of regular expressions that match URIs that should not be checked when doing a linkcheck build. +linkcheck_ignore = [ + # Ignore GitHub anchors. + "https://github.com/plerup/makeEspArduino.*#", +] diff --git a/doc/source/coverage.md b/doc/source/coverage.md index 8ccef5e..89f55c2 100644 --- a/doc/source/coverage.md +++ b/doc/source/coverage.md @@ -4,7 +4,7 @@ # Sensors -- [HX711], [BME280], [DS18B20], [DHT22], [TSL2591] +- [HX711], [BME280], [DS18B20], [DHT22], [TSL25911] # Telemetry transports diff --git a/doc/source/firmware-builder.rst b/doc/source/firmware-builder.rst index c4d1af8..4756f24 100644 --- a/doc/source/firmware-builder.rst +++ b/doc/source/firmware-builder.rst @@ -36,7 +36,7 @@ for setting up a GPRS device for communication in form of the quadruple For getting an idea about the variable replacements we are aiming at with an example sketch suitable for automatic building using the variables described above, please have a look at -`node-gprs-any.ino, line 81 ff. `_ +`openhive-gsm-wifi.ino, line 81 ff. `_ .. attention:: @@ -45,7 +45,8 @@ suitable for automatic building using the variables described above, please have The blueprint is the fine Cloud Build Service of the NodeMCU community: - - https://nodemcu.readthedocs.io/en/master/en/build/ + - https://nodemcu.readthedocs.io/en/release/getting-started/#cloud-builder + - https://nodemcu.readthedocs.io/en/release/build/#cloud-build-service - https://nodemcu-build.com/ diff --git a/doc/source/firmware/overview.md b/doc/source/firmware/overview.md index 4503de7..3029132 100644 --- a/doc/source/firmware/overview.md +++ b/doc/source/firmware/overview.md @@ -146,6 +146,14 @@ A playground for building a generic C++ datalogger framework. ### Homie-based +:::{note} **References:** +The Homie-based firmwares have been conceived by Alexander Wilms. +- https://www.imker-nettetal.de/esp8266-beescale-erste-eindruecke/ +- https://community.hiveeyes.org/t/welcome-alex/189 +- https://community.hiveeyes.org/t/inbetriebnahme-von-node-wifi-mqtt-homie-mit-hiveeyes-anbindung/185 +- https://imker-nettetal.de/nsa-for-bees/ +::: + ::::::{grid} 1 :margin: 0 :padding: 0 @@ -217,8 +225,7 @@ Markus Euskirchen and Clemens Gruber reported about the development progress. - https://www.euse.de/wp/blog/series/bienenwaage2/ ::: - -#### Wi-Fi, GSM +#### GSM, Wi-Fi ::::::{grid} 1 :margin: 0 @@ -269,7 +276,7 @@ using the [GPRSbee] GSM modem. :columns: 4 {bdg-primary-line}`gsm` {bdg-primary-line}`wifi` {bdg-primary-line}`http` {bdg-primary-line}`csv` -{bdg-success-line}`hx711` {bdg-success-line}`ds18b20` {bdg-success-line}`dht22` +{bdg-success-line}`hx711` {bdg-success-line}`ads1231` {bdg-success-line}`ds18b20` {bdg-success-line}`dht22` {bdg-secondary-line}`ATmega328` {bdg-secondary-line}`esp8266` @@ -327,7 +334,7 @@ gateway. ::: :::{grid-item} :columns: 4 -{bdg-primary-line}`rfm69` {bdg-primary-line}`uart` {bdg-primary-line}`csv` +{bdg-primary-line}`rf69` {bdg-primary-line}`uart` {bdg-primary-line}`csv` {bdg-secondary-line}`ATmega328` ::: @@ -350,7 +357,7 @@ Receive sensor data over radio and store it onto an SD card on an Arduino Yún. ::: :::{grid-item} :columns: 4 -{bdg-primary-line}`rfm69` {bdg-primary-line}`sdcard` {bdg-primary-line}`csv` +{bdg-primary-line}`rf69` {bdg-primary-line}`sdcard` {bdg-primary-line}`csv` {bdg-secondary-line}`ATmega328` ::: @@ -373,7 +380,7 @@ Collect sensor data, encode it to [CSV], and send it using an [RFM69] radio modu ::: :::{grid-item} :columns: 4 -{bdg-primary-line}`rfm69` {bdg-primary-line}`csv` +{bdg-primary-line}`rf69` {bdg-primary-line}`csv` {bdg-success-line}`ads1231` {bdg-success-line}`ds18b20` {bdg-success-line}`dht22` diff --git a/doc/source/resources-md.md b/doc/source/resources-md.md index 84e38b1..4625d89 100644 --- a/doc/source/resources-md.md +++ b/doc/source/resources-md.md @@ -35,7 +35,7 @@ [Microchip]: https://en.wikipedia.org/wiki/Microchip_Technology [AVR microcontroller family]: https://en.wikipedia.org/wiki/MegaAVR [ATmega328]: https://en.wikipedia.org/wiki/ATmega328 -[Seeeduino Stalker v2.3]: http://wiki.seeedstudio.com/wiki/Seeeduino_Stalker_v2.3 +[Seeeduino Stalker v2.3]: https://web.archive.org/web/20180118214610/https://wiki.seeedstudio.com/wiki/Seeeduino_Stalker_v2.3 [ESP8266]: https://en.wikipedia.org/wiki/ESP8266 [ESP32]: https://en.wikipedia.org/wiki/ESP32 [Adafruit Feather HUZZAH]: https://www.adafruit.com/product/2821 @@ -57,8 +57,8 @@ [RHT03]: http://www.humiditycn.com/cp22.html [DHT33]: http://shop.boxtec.ch/digital-humiditytemperature-sensor-dht33-rht04-p-40541.html [RHT04]: http://www.humiditycn.com/cp21.html -[TSL25911]: http://ams.com/eng/Products/Light-Sensors/Ambient-Light-Sensors/TSL25911 -[TSL2591]: https://www.adafruit.com/product/1980 +[TSL25911]: https://ams.com/tsl25911 +[Adafruit TSL2591 STEMMA QT]: https://www.adafruit.com/product/1980 [LowPowerLab]: https://lowpowerlab.com/ [RFM69 based sensors and MQTT gateway]: https://github.com/computourist/RFM69-MQTT-client [Bencode]: https://en.wikipedia.org/wiki/Bencode @@ -96,7 +96,7 @@ [makeESPArduino]: https://github.com/plerup/makeEspArduino [Bare-Arduino-Project]: https://github.com/ladislas/Bare-Arduino-Project [HTTPie]: http://httpie.org -[HttpRequester]: https://addons.mozilla.org/en-us/firefox/addon/httprequester/ +[HttpRequester]: https://github.com/tommut/HttpRequester [PlatformIO]: https://platformio.org/ [PlatformIO IDE]: https://platformio.org/platformio-ide [NodeMCU]: https://en.wikipedia.org/wiki/NodeMCU diff --git a/doc/source/resources.rst b/doc/source/resources.rst index 68e9613..78b8389 100644 --- a/doc/source/resources.rst +++ b/doc/source/resources.rst @@ -85,7 +85,7 @@ .. _Microchip: https://en.wikipedia.org/wiki/Microchip_Technology .. _AVR microcontroller family: https://en.wikipedia.org/wiki/MegaAVR .. _ATmega328: https://en.wikipedia.org/wiki/ATmega328 -.. _Seeeduino Stalker v2.3: http://wiki.seeedstudio.com/wiki/Seeeduino_Stalker_v2.3 +.. _Seeeduino Stalker v2.3: https://web.archive.org/web/20180118214610/https://wiki.seeedstudio.com/wiki/Seeeduino_Stalker_v2.3 .. Espressif .. _ESP8266: https://en.wikipedia.org/wiki/ESP8266 @@ -117,8 +117,8 @@ .. _RHT03: http://www.humiditycn.com/cp22.html .. _DHT33: http://shop.boxtec.ch/digital-humiditytemperature-sensor-dht33-rht04-p-40541.html .. _RHT04: http://www.humiditycn.com/cp21.html -.. _TSL25911: http://ams.com/eng/Products/Light-Sensors/Ambient-Light-Sensors/TSL25911 -.. _TSL2591: https://www.adafruit.com/product/1980 +.. _TSL25911: https://ams.com/tsl25911 +.. _Adafruit TSL2591 STEMMA QT: https://www.adafruit.com/product/1980 .. LowPowerLab and computourist .. _LowPowerLab: https://lowpowerlab.com/ @@ -172,7 +172,7 @@ .. _makeESPArduino: https://github.com/plerup/makeEspArduino .. _Bare-Arduino-Project: https://github.com/ladislas/Bare-Arduino-Project .. _HTTPie: http://httpie.org -.. _HttpRequester: https://addons.mozilla.org/en-us/firefox/addon/httprequester/ +.. _HttpRequester: https://github.com/tommut/HttpRequester .. _PlatformIO: https://platformio.org/ diff --git a/homie/node-homie-basic/README.rst b/homie/node-homie-basic/README.rst index a73fa0c..98b2b51 100644 --- a/homie/node-homie-basic/README.rst +++ b/homie/node-homie-basic/README.rst @@ -144,7 +144,8 @@ When starting the ESP8266 device with Homie firmware, it will come up in ``confi and spawn a secure WiFi access point named ``Homie-xxxxxxxxxxxx``, like ``Homie-c631f278df44``. Connect to it. -Configure the device by uploading the `JSON configuration file `_ to the `HTTP JSON API `_ at http://192.168.1.1:: +Configure the device by uploading the `JSON configuration file `_ to +the `HTTP JSON API `_ at ``http://192.168.1.1``:: # 1. Clone real configuration from blueprint cp example.config.json config.json @@ -157,10 +158,7 @@ Configure the device by uploading the `JSON configuration file `_ - -.. _http-json-api: https://homie-esp8266.readme.io/docs/http-json-api -.. _json-configuration-file: https://homie-esp8266.readme.io/docs/json-configuration-file + `Connecting to the AP and configuring the device `_ SPIFFS @@ -223,4 +221,6 @@ Backlog .. _Homie custom settings: https://homie-esp8266.readme.io/docs/custom-settings +.. _http-json-api: https://homieiot.github.io/homie-esp8266/docs/2.0.0/configuration/http-json-api/ .. _UI bundle: https://homie-esp8266.readme.io/docs/ui-bundle +.. _json-configuration-file: https://homieiot.github.io/homie-esp8266/docs/2.0.0/configuration/json-configuration-file/ diff --git a/libraries/BERadio/doc/research.rst b/libraries/BERadio/doc/research.rst index c64ab30..7ddfeb1 100644 --- a/libraries/BERadio/doc/research.rst +++ b/libraries/BERadio/doc/research.rst @@ -115,10 +115,10 @@ Misc Simulation ========== -- http://www.nongnu.org/simulavr/ +- https://www.nongnu.org/simulavr/ - https://github.com/Traumflug/simulavr -- http://mirror.unicorncloud.org/savannah-nongnu/simulavr/manual-1.0.pdf -- http://download.savannah.gnu.org/releases/simulavr/ +- https://bigsearcher.com/mirrors/nongnu/simulavr/manual-1.0.pdf +- https://download.savannah.gnu.org/releases/simulavr/ Operating Systems diff --git a/libraries/TerkinData/README.rst b/libraries/TerkinData/README.rst index f1f8974..6c41275 100644 --- a/libraries/TerkinData/README.rst +++ b/libraries/TerkinData/README.rst @@ -274,11 +274,6 @@ JSON .. seealso:: Full source of ``_. -.. _csv_basic.cpp: https://github.com/hiveeyes/arduino/blob/main/libraries/TerkinData/examples/csv_basic.cpp -.. _urlencoded_basic.cpp: https://github.com/hiveeyes/arduino/blob/main/libraries/TerkinData/examples/urlencoded_basic.cpp -.. _json_basic.cpp: https://github.com/hiveeyes/arduino/blob/main/libraries/TerkinData/examples/json_basic.cpp - - ******** Download ******** @@ -319,3 +314,6 @@ Terkin .. _ArduinoJSON: https://github.com/bblanchon/ArduinoJson .. _ArduinoSTL: https://github.com/mike-matera/ArduinoSTL +.. _csv_basic.cpp: https://github.com/hiveeyes/arduino/blob/main/libraries/TerkinData/examples/csv/csv_basic.cpp +.. _json_basic.cpp: https://github.com/hiveeyes/arduino/blob/main/libraries/TerkinData/examples/json/json_basic.cpp +.. _urlencoded_basic.cpp: https://github.com/hiveeyes/arduino/blob/main/libraries/TerkinData/examples/urlencoded/urlencoded_basic.cpp diff --git a/openhive/openhive-yun/README.rst b/openhive/openhive-yun/README.rst index 8409da8..62cd352 100644 --- a/openhive/openhive-yun/README.rst +++ b/openhive/openhive-yun/README.rst @@ -59,8 +59,8 @@ Sensors - ADS1231_ ADC weigh scale breakout board - DS18B20_ digital thermometer - DHT22_ (RHT03_) digital humidity/temperature sensor -- TSL25911_ Ambient Light Sensor aka. - TSL2591_ High Dynamic Range Digital Light Sensor +- `TSL25911`_ Ambient Light Sensor aka. + `Adafruit TSL2591 STEMMA QT`_ High Dynamic Range Digital Light Sensor ***** diff --git a/openhive/scale-adjust/ADS1231/scale-adjust-ads1231.ino b/openhive/scale-adjust/ADS1231/scale-adjust-ads1231.ino index 1f9c3fc..3e36946 100644 --- a/openhive/scale-adjust/ADS1231/scale-adjust-ads1231.ino +++ b/openhive/scale-adjust/ADS1231/scale-adjust-ads1231.ino @@ -75,7 +75,7 @@ int weightSamplesNumber = 10; // take at least 10 readings for adjusting // libraries // load cell -#include // https://github.com/hiveeyes/arduino/tree/master/libraries/ADS1231 +#include // https://github.com/hiveeyes/aerowind-ads1231 ADS1231 loadCell; // Create ADS1231 object int adjustScale = true; // flag for adjust vs. operation mode long weightSensorValue; diff --git a/openhive/scale-adjust/README.rst b/openhive/scale-adjust/README.rst index a0abdcc..2c73d07 100644 --- a/openhive/scale-adjust/README.rst +++ b/openhive/scale-adjust/README.rst @@ -55,10 +55,9 @@ If you're still reading, you might want to have a look at these fine papers: - `Load cell troubleshooting from Interface`_ +.. _How to use load cells: http://www.aandd.jp/products/weighing/loadcell/introduction/pdf/6-1.pdf .. _Load cell Primer: http://www.phidgets.com/docs/Load_Cell_Primer .. _Load cell glossary: http://www.interfaceforce.com/index.php?mod=library&show=22 -.. _How to use load cells: http://www.aandd.jp/products/weighing/loadcell/introduction/pdf/6-1.pdf -.. _Load cell and weight module handbook: https://www.ricelake.com/docs/prodinfo/Manuals/load-cells/lch_22054.pdf +.. _Load cell and weight module handbook: https://www.ricelake.com/media/b5mlti1q/m_us_22054_lc-wm_handbook_revb.pdf .. _Load cell troubleshooting from VPG Sensors: http://www.vishaypg.com/docs/11867/vpg-08.pdf .. _Load cell troubleshooting from Interface: http://www.loadcelltheory.com/troubleshoot.html - diff --git a/trudering/bienenwaage-2.0/README.rst b/trudering/bienenwaage-2.0/README.rst index 698e7bd..f38fdf4 100644 --- a/trudering/bienenwaage-2.0/README.rst +++ b/trudering/bienenwaage-2.0/README.rst @@ -66,7 +66,7 @@ Weight scale Adjust ``SCALE_DOUT_PIN_{A,B}``, ``SCALE_SCK_PIN_{A,B}``, ``Taragewicht_{A,B}`` and ``Skalierung_{A,B}``. To find out about appropriate values for ``Taragewicht_X`` and ``Skalierung_X``, please use a weight scale adjustment sketch like -https://github.com/hiveeyes/arduino/tree/master/scale-adjust/HX711. +https://github.com/hiveeyes/arduino/tree/main/openhive/scale-adjust/HX711. :: diff --git a/trudering/bienenwaage-2.0/bienenwaage-esp8266.ino b/trudering/bienenwaage-2.0/bienenwaage-esp8266.ino index 0dfb425..9b732a1 100644 --- a/trudering/bienenwaage-2.0/bienenwaage-esp8266.ino +++ b/trudering/bienenwaage-2.0/bienenwaage-esp8266.ino @@ -1,3 +1,7 @@ +/** + * Bienenwaage 2.0 NodeMCU (ESP8266) + * https://github.com/hiveeyes/arduino/tree/main/trudering/bienenwaage-2.0 + */ //Version 1.01 Spannungs Messung und Deep Sleep //Version 1.02 MQTT Anbindung //Version 1.03 Temperatur Meßung diff --git a/trudering/bienenwaage-5.0/README.rst b/trudering/bienenwaage-5.0/README.rst index d88d7b7..b15266d 100644 --- a/trudering/bienenwaage-5.0/README.rst +++ b/trudering/bienenwaage-5.0/README.rst @@ -54,7 +54,7 @@ Weight scale Adjust ``SCALE_DOUT_PIN_X``, ``SCALE_SCK_PIN_X``, ``Taragewicht_X`` and ``Skalierung_X``. To find out about appropriate values for ``Taragewicht_X`` and ``Skalierung_X``, please use a weight scale adjustment sketch like -https://github.com/hiveeyes/arduino/tree/master/scale-adjust/HX711. +https://github.com/hiveeyes/arduino/tree/main/openhive/scale-adjust/HX711. Temperature sensors =================== @@ -125,8 +125,8 @@ Pictures .. figure:: https://community.hiveeyes.org/uploads/default/optimized/2X/d/d3994ea5a4556598ba5b1c0f0d9baab587444943_2_375x500.jpeg :target: https://community.hiveeyes.org/uploads/default/original/2X/d/d3994ea5a4556598ba5b1c0f0d9baab587444943.jpeg -.. figure:: https://raw.githubusercontent.com/hiveeyes/arduino/master/node-esp32-generic/Bienenwaage%205.0%20TTGO-T-CALL_Leiterplatte.png - :target: https://raw.githubusercontent.com/hiveeyes/arduino/master/node-esp32-generic/Bienenwaage%205.0%20TTGO-T-CALL_Leiterplatte.png +.. figure:: https://raw.githubusercontent.com/hiveeyes/arduino/main/trudering/bienenwaage-5.0/Bienenwaage%205.0%20TTGO-T-CALL_Leiterplatte.png + :target: https://raw.githubusercontent.com/hiveeyes/arduino/main/trudering/bienenwaage-5.0/Bienenwaage%205.0%20TTGO-T-CALL_Leiterplatte.png *********** diff --git a/trudering/bienenwaage-5.0/bienenwaage-esp32.cpp b/trudering/bienenwaage-5.0/bienenwaage-esp32.cpp index b04bae5..5f84ba0 100644 --- a/trudering/bienenwaage-5.0/bienenwaage-esp32.cpp +++ b/trudering/bienenwaage-5.0/bienenwaage-esp32.cpp @@ -1,8 +1,9 @@ -/* - -Bienenwaage 5.0 TTGO-T-CALL -https://github.com/hiveeyes/arduino/tree/master/node-esp32-generic +/** + * Bienenwaage 5.0 TTGO T-Call (ESP32) + * https://github.com/hiveeyes/arduino/tree/main/trudering/bienenwaage-5.0 + */ +/** Telemetry | GSM or WiFi -----------------------