diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 04cf808..91e09aa 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -2,9 +2,9 @@ name: Tests on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] # Also, run each Monday At 07:00. schedule: diff --git a/README.rst b/README.rst index 0a8f3e3..4a398e0 100644 --- a/README.rst +++ b/README.rst @@ -52,7 +52,7 @@ Terkin :target: https://pypi.org/project/terkin/ .. image:: https://img.shields.io/pypi/l/terkin.svg - :target: https://github.com/hiveeyes/terkin-datalogger/blob/master/LICENSE + :target: https://github.com/hiveeyes/terkin-datalogger/blob/main/LICENSE .. image:: https://img.shields.io/pypi/dm/terkin.svg :target: https://pypi.org/project/terkin/ @@ -179,7 +179,7 @@ and adjust each configuration setting appropriately. The documentation of all parameters is in the file itself and should be reasonably self-explanatory. For using Terkin with TTN/LoRaWAN find some more details -`here `_. +`here `_. Sandbox setup ============= diff --git a/client/TTN/README.rst b/client/TTN/README.rst index 2334ccc..f958712 100644 --- a/client/TTN/README.rst +++ b/client/TTN/README.rst @@ -39,7 +39,7 @@ has been extended to also encode ``load`` and ``voltage`` readings. In order to forward those variables into your TTN payload you would need to insert the given decoder.js code into your TTN App. In TTN console under Payload Formats switch to Custom and paste the Javascript from -`decoder.js `_. +`decoder.js `_. The decoder function is backwards compatible to the built-in CayenneLPP decoder. ********************* @@ -56,15 +56,15 @@ HTTP endpoint URLs for common use are already set up and can be requested from @thiasB or @ClemensGruber but you can of course set up your own endpoint and use the Javascript provided in -- `putsreq.hiveeyes.js `_ for the Hiveeyes.org target, or -- `putsreq.bee-observer.js `_ for the bee-observer.org target, or -- `putsreq.beep.js `_ for the beep.nl target +- `putsreq.hiveeyes.js `_ for the Hiveeyes.org target, or +- `putsreq.bee-observer.js `_ for the bee-observer.org target, or +- `putsreq.beep.js `_ for the beep.nl target ************ Telegram Bot ************ A Telegram bot for interacting with the device via LoRaWAN downlinks is -available from the `telegram_terkin_ttn_bot.py `_ file. +available from the `telegram_terkin_ttn_bot.py `_ file. Currently these two capabilities are implemented: diff --git a/doc/source/_resources.rst b/doc/source/_resources.rst index 667fcfa..5352418 100644 --- a/doc/source/_resources.rst +++ b/doc/source/_resources.rst @@ -24,4 +24,4 @@ .. Terkin .. _Install and configure the Terkin Datalogger development sandbox on Windows: https://community.hiveeyes.org/t/einrichten-der-micropython-firmware-unter-win10/2110 -.. _Getting started with Pycom MicroPython: https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/pycom-getting-started.rst +.. _Getting started with Pycom MicroPython: https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/pycom-getting-started.rst diff --git a/doc/source/attic/hardware.rst b/doc/source/attic/hardware.rst index 752f6ee..af0863f 100644 --- a/doc/source/attic/hardware.rst +++ b/doc/source/attic/hardware.rst @@ -29,11 +29,11 @@ configurations based on devices like these: - `Hiveeyes Buerger`_ -.. _Reference hardware: https://github.com/hiveeyes/terkin-datalogger/blob/master/README-HARDWARE.md +.. _Reference hardware: https://github.com/hiveeyes/terkin-datalogger/blob/main/README-HARDWARE.md -.. _EasyHive Pycom-Shield: https://github.com/hiveeyes/terkin-datalogger/blob/master/README-HARDWARE.md#easyhive-pycom-shield -.. _Hiverize Funktionsmuster: https://github.com/hiveeyes/terkin-datalogger/blob/master/README-HARDWARE.md#hiverize-funktionsmuster -.. _Hiveeyes Buerger: https://github.com/hiveeyes/terkin-datalogger/blob/master/README-HARDWARE.md#hiveeyes-buerger +.. _EasyHive Pycom-Shield: https://github.com/hiveeyes/terkin-datalogger/blob/main/README-HARDWARE.md#easyhive-pycom-shield +.. _Hiverize Funktionsmuster: https://github.com/hiveeyes/terkin-datalogger/blob/main/README-HARDWARE.md#hiverize-funktionsmuster +.. _Hiveeyes Buerger: https://github.com/hiveeyes/terkin-datalogger/blob/main/README-HARDWARE.md#hiveeyes-buerger .. _Pycom FiPy: https://pycom.io/product/fipy/ diff --git a/doc/source/development/backlog.rst b/doc/source/development/backlog.rst index 807f3b2..a8a0c13 100644 --- a/doc/source/development/backlog.rst +++ b/doc/source/development/backlog.rst @@ -41,7 +41,7 @@ S3 - Doku bei https://community.hiveeyes.org/t/uberarbeitung-des-terkin-readme-im-repository/3152/5 bzw. - https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/cpython.rst + https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/cpython.rst aktualisieren und veröffentlichen - Update credits @@ -370,7 +370,7 @@ Prio 1.3 - Add ``alive_timer`` based on ``Timer.Chrono()`` - Battery low warning & shutdown: if voltage < 4.0 / < 3.7 (normal: 4.3) - MOSFET gate -- [x] ESP32 Mock for testing: https://github.com/hiveeyes/terkin-datalogger/tree/master/test +- [x] ESP32 Mock for testing: https://github.com/hiveeyes/terkin-datalogger/tree/main/test - [o] Scan Bluetooth neighbourhood for proximity applications https://docs.pycom.io/firmwareapi/pycom/network/bluetooth/ - [o] Add Device ID as HTTP header diff --git a/doc/source/development/micropython/sandbox-operation.rst b/doc/source/development/micropython/sandbox-operation.rst index d398c99..436b2c4 100644 --- a/doc/source/development/micropython/sandbox-operation.rst +++ b/doc/source/development/micropython/sandbox-operation.rst @@ -177,7 +177,7 @@ you along, please have a look at `Terkin Datalogger troubleshooting`_. -.. _upgrade the Pycom firmware: https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/pycom-firmware-upgrade.rst +.. _upgrade the Pycom firmware: https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/pycom-firmware-upgrade.rst .. _Filesystem corruption on FiPy's FatFS in brownout conditions: https://community.hiveeyes.org/t/fipy-verliert-programm-nach-power-off-durch-leeren-lipo-vermutlich-brownout-filesystem-corruption/2057 -.. _Terkin Datalogger troubleshooting: https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/troubleshooting.rst +.. _Terkin Datalogger troubleshooting: https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/troubleshooting.rst .. _create an issue: https://github.com/hiveeyes/terkin-datalogger/issues/new diff --git a/doc/source/development/micropython/sandbox-setup.rst b/doc/source/development/micropython/sandbox-setup.rst index c6eb4f9..2db58bb 100644 --- a/doc/source/development/micropython/sandbox-setup.rst +++ b/doc/source/development/micropython/sandbox-setup.rst @@ -142,4 +142,4 @@ At this point, you should take a minute to have a look at you through essential commands and function keys you will definitively need after taking the red pill. -.. _getting started with Pycom MicroPython: https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/getting-started.rst +.. _getting started with Pycom MicroPython: https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/getting-started.rst diff --git a/doc/source/development/troubleshooting.rst b/doc/source/development/troubleshooting.rst index afed8c5..87d1e6d 100644 --- a/doc/source/development/troubleshooting.rst +++ b/doc/source/development/troubleshooting.rst @@ -4,7 +4,7 @@ Troubleshooting We've jumped through some tires that you don't have to. -.. _upgrade your firmware: https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/pycom-firmware-upgrade.rst +.. _upgrade your firmware: https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/pycom-firmware-upgrade.rst When experiencing problems, please also visit https://docs.pycom.io/gettingstarted/troubleshooting-guide.html. @@ -554,7 +554,7 @@ https://community.hiveeyes.org/t/fipy-verliert-programm-nach-power-off-durch-lee Solution -------- -Use LittleFS, see https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/getting-started.rst +Use LittleFS, see https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/getting-started.rst Network stack overload diff --git a/doc/source/project/license.rst b/doc/source/project/license.rst index b052f4a..56e4288 100644 --- a/doc/source/project/license.rst +++ b/doc/source/project/license.rst @@ -47,4 +47,4 @@ The documentation is licensed under the terms of the Creative Commons `CC-BY-SA .. _GNU Lesser General Public License: https://www.gnu.org/licenses/lgpl-3.0.en.html .. _European Union Public Licence: https://opensource.org/licenses/EUPL-1.2 .. _CC-BY-SA 4.0 license: https://creativecommons.org/licenses/by-sa/4.0/ -.. _notices about licenses of third-party components: https://github.com/hiveeyes/terkin/blob/master/THIRD-PARTY-NOTICES.rst +.. _notices about licenses of third-party components: https://github.com/hiveeyes/terkin-datalogger/blob/main/THIRD-PARTY-NOTICES.rst diff --git a/mpy_manifest.py b/mpy_manifest.py index 1aea914..6d82bc3 100644 --- a/mpy_manifest.py +++ b/mpy_manifest.py @@ -1,5 +1,5 @@ # FROZEN_MANIFEST file for building firmware images for Genuine MicroPython. -# https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/release.rst#build-firmware-images +# https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/release.rst#build-firmware-images include('$(PORT_DIR)/boards/manifest.py') freeze('dist-packages') freeze('src/lib') diff --git a/test/test_lorawan.py b/test/test_lorawan.py index 0438dbf..b9e61b5 100644 --- a/test/test_lorawan.py +++ b/test/test_lorawan.py @@ -12,7 +12,7 @@ Setup ===== -- https://github.com/hiveeyes/terkin-datalogger/blob/master/doc/tests.rst +- https://github.com/hiveeyes/terkin-datalogger/blob/main/doc/tests.rst Synopsis ========