components/esp32-owb/README.md

changeset 72
acc1904cd70d
parent 0
88d965579617
--- a/components/esp32-owb/README.md	Tue Sep 26 14:56:04 2023 +0200
+++ b/components/esp32-owb/README.md	Tue Sep 26 14:57:18 2023 +0200
@@ -2,15 +2,20 @@
 
 This is a ESP32-compatible C component for the Maxim Integrated "1-Wire" protocol.
 
-It is written and tested for version 3.0 of the [ESP-IDF](https://github.com/espressif/esp-idf) environment, using the xtensa-esp32-elf toolchain (gcc version 5.2.0, crosstool-ng-1.22.0-80-g6c4433a).
+It is written for the `idf.py` target `esp32`, although it may work on other ESP-32 devices with minor modifications.
+
+It is tested for version 4.4.4 and 5.0.1 of the [ESP-IDF](https://github.com/espressif/esp-idf) environment.
 
-Support for v2.1 is available on the [ESP-IDF_v2.1](https://github.com/DavidAntliff/esp32-owb/tree/ESP-IDF_v2.1) branch.
+Legacy support for v2.1 is available on the [ESP-IDF_v2.1](https://github.com/DavidAntliff/esp32-owb/tree/ESP-IDF_v2.1) branch. This is no longer maintained.
+
+Legacy support for v3.0-v3.3 and v4.1-beta1 is available on the [ESP-IDF_v3.0-3.3_4.1-beta1](https://github.com/DavidAntliff/esp32-owb/tree/ESP-IDF_v3.0-3.3_4.1-beta1) branch. This is no longer maintained.
 
 ## Features
 
 This library includes:
 
- * External power supply mode (parasitic mode not yet supported).
+ * External power supply mode.
+ * Parasitic power mode.
  * Static (stack-based) or dynamic (malloc-based) memory model.
  * No globals - support any number of 1-Wire buses simultaneously.
  * 1-Wire device detection and validation, including search for multiple devices on a single bus.
@@ -23,7 +28,10 @@
 however this proved to be too unreliable. A second method, using the ESP32's RMT peripheral,
 results in very accurate read/write timeslots and more reliable operation.
 
-Therefore I highly recommend that you use the RMT driver. The GPIO driver should be considered deprecated.
+Therefore I highly recommend that you use the RMT driver. *The GPIO driver is deprecated and will be removed.*
+
+See documentation for [esp32-ds18b20](https://www.github.com/DavidAntliff/esp32-ds18b20#parasitic-power-mode) 
+for further information about parasitic power mode, including strong pull-up configuration.
 
 ## Documentation
 
@@ -39,16 +47,17 @@
 
 ## Links
 
- * [esp32-ds18b20](https://github.com/DavidAntliff/esp32-ds18b20) - ESP32-compatible DS18B20 Digital Thermometer component for ESP32
+ * [esp32-ds18b20](https://github.com/DavidAntliff/esp32-ds18b20) - ESP32-compatible DS18B20 Digital Thermometer 
+                                                                    component for ESP32
  * [1-Wire Communication Through Software](https://www.maximintegrated.com/en/app-notes/index.mvp/id/126)
  * [1-Wire Search Algorithm](https://www.maximintegrated.com/en/app-notes/index.mvp/id/187)
  * [Espressif IoT Development Framework for ESP32](https://github.com/espressif/esp-idf)
 
 ## Acknowledgements
 
-Thank you to [Chris Morgan](https://github.com/chmorgan) for his contribution of adding RMT peripheral support for more reliable operation.
+Thank you to [Chris Morgan](https://github.com/chmorgan) for his contribution of adding RMT peripheral support for more
+reliable operation.
 
 Parts of this code are based on references provided to the public domain by Maxim Integrated.
 
 "1-Wire" is a registered trademark of Maxim Integrated.
-

mercurial