diff --git a/API.md b/API.md index 3a7a24c78..e12eea92e 100644 --- a/API.md +++ b/API.md @@ -17,7 +17,7 @@ Callback Id | Bool | xdrv | xsns | xnrg | xlgt | Description ----------------------------|------|------|------|------|------|---------------------------------- FUNC_SETTINGS_OVERRIDE | | x | | | | Override start-up settings FUNC_PIN_STATE | x | 1 | 2 | | | At GPIO configuration -FUNC_I2C_INIT | | x | | | | Immediatly after I2C init +FUNC_I2C_INIT | | x | | | | Immediately after I2C init FUNC_MODULE_INIT | x | 3 | 1 | | 2 | Init module specific parameters FUNC_PRE_INIT | | 1 | 3 | 2 | | Once GPIO have been established FUNC_INIT | | 1 | 3 | 2 | | At end of initialisation diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b15232be..ddb0768a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,7 @@ To accept the CLA it is required to put a x between [ ] on `[ ] I accept the CLA **Why a CLA ?** -_"A Contributor Licence Agreement (CLA) is strongly recommended when accepting third party contributions to an open development project, such as an open source software project. In order to redistribute contributions, it is necessary to ensure that the project has the necessary rights to do so. A Contributor Licence Agreement is a lightweight agreement, signed by the copyright holder, that grants the necessary rights for the contribution to be redistributed as part of the project."_ [OSS Watch](http://oss-watch.ac.uk/resources/cla) +_"A Contributor License Agreement (CLA) is strongly recommended when accepting third party contributions to an open development project, such as an open source software project. In order to redistribute contributions, it is necessary to ensure that the project has the necessary rights to do so. A Contributor License Agreement is a lightweight agreement, signed by the copyright holder, that grants the necessary rights for the contribution to be redistributed as part of the project."_ [OSS Watch](http://oss-watch.ac.uk/resources/cla) A CLA is a legal document in which you state _you are entitled to contribute the code/documentation/translation to the project_ you’re contributing to and that _you are willing to have it used in distributions and derivative works_. This means that should there be any kind of legal issue in the future as to the origins and ownership of any particular piece of code, then that project has the necessary forms on file from the contributor(s) saying they were permitted to make this contribution. diff --git a/FIRMWARE.md b/FIRMWARE.md index f0e069a9a..43f76f8d2 100644 --- a/FIRMWARE.md +++ b/FIRMWARE.md @@ -27,7 +27,7 @@ See [CHANGELOG.md](https://github.com/arendst/Tasmota/blob/development/tasmota/C Unless your Tasmota powered device exhibits a problem or you need to make use of a feature that is not available in the Tasmota version currently installed on your device, leave your device alone - it works so don't make unnecessary changes! If the release version (i.e., the master branch) exhibits unexpected behaviour for your device and configuration, you should upgrade to the latest development version instead to see if your problem is resolved as some bugs in previous releases or development builds may already have been resolved. -If new commits have been merged and they compile successfuly, new binary files for every variant will be placed here https://github.com/arendst/Tasmota-firmware/tree/main/firmware (this URL address can NOT be used for OTA updates) It is important to note that these binaries are based on the current development codebase. These commits are tested as much as is possible and are typically quite stable. However, it is infeasible to test on the hundreds of different types of devices with all the available configuration options permitted. +If new commits have been merged and they compile successfully, new binary files for every variant will be placed here https://github.com/arendst/Tasmota-firmware/tree/main/firmware (this URL address can NOT be used for OTA updates) It is important to note that these binaries are based on the current development codebase. These commits are tested as much as is possible and are typically quite stable. However, it is infeasible to test on the hundreds of different types of devices with all the available configuration options permitted. Note that there is a chance, as with any upgrade, that the device may not function as expected. You must always account for the possibility that you may need to flash the device via the serial programming interface if the OTA upgrade fails. Even with the master release, you should always attempt to test the device or a similar prototype before upgrading a device which is in production or is hard to reach. And, as always, make a backup of the device configuration before beginning any firmware update. diff --git a/info/xdrv_57_tasmesh.md b/info/xdrv_57_tasmesh.md index 2da2fac19..ff7c3ee06 100644 --- a/info/xdrv_57_tasmesh.md +++ b/info/xdrv_57_tasmesh.md @@ -8,7 +8,7 @@ Automatic payload encryption is applied using the WiFi-password1 as the key. A m As ACK/NACK messages seem to be not reliable on both ESP-platforms, the method "send-and-pray" is used. -## Working priciple +## Working principle An ESP32 is needed as gateway/broker to connect the nodes (typically an ESP8266) to the WLAN. The ESP32 will receive the MQTT-topic of every node and subscribe to it as a proxy. If a MQTT-message in the form of 'cmnd/node_topic/...' is received, the broker will automatically send this to the referring node via ESP-NOW. diff --git a/pio-tools/espupload.py b/pio-tools/espupload.py index 8b0993a55..a25345e65 100755 --- a/pio-tools/espupload.py +++ b/pio-tools/espupload.py @@ -20,7 +20,7 @@ Provides: Uploads binary file to OTA server. - Usually initated from http-uploader.py + Usually initiated from http-uploader.py Requirements: - Python diff --git a/pio-tools/name-firmware.py b/pio-tools/name-firmware.py index 43e595117..6b32b771f 100644 --- a/pio-tools/name-firmware.py +++ b/pio-tools/name-firmware.py @@ -31,7 +31,7 @@ def bin_map_copy(source, target, env): # copy firmware.bin and map to final destination shutil.copy(firsttarget, bin_file) if env["PIOPLATFORM"] == "espressif32": - # the map file is needed later for fimrmware-metrics.py + # the map file is needed later for firmware-metrics.py shutil.copy(tasmotapiolib.get_source_map_path(env), map_file) if("safeboot" not in firmware_name): shutil.copy(factory, one_bin_file) diff --git a/tools/decode-status.py b/tools/decode-status.py index bc03d3604..980f09467 100755 --- a/tools/decode-status.py +++ b/tools/decode-status.py @@ -90,7 +90,7 @@ a_setoption = [[ "(Restart) Number of restarts to start detecting boot loop (default 1)", "(Light) RGB and White channel separation (default 0)", "(IR) Set the smallest sized UNKNOWN message packets we actually care about (default 6, max 255)", - "(CSE7766) Number of invalid power measurements before declaring it invalid allowing low load measurments (default 128)", + "(CSE7766) Number of invalid power measurements before declaring it invalid allowing low load measurements (default 128)", "(Button/Shutter) Ignore button change in seconds (default 0)", "(Wifi) Interval in seconds between gratuitous ARP requests (default 60)", "(Energy) Turn all power off at or above this temperature (default 90C)",