• file
• latest
• revisions
• annotate
• diff
• comparison
• raw

components/esp32-owb/README.md@88d965579617 (annotated)

components/esp32-owb/README.md

Tue, 08 Oct 2019 12:00:31 +0200

author

Michiel Broek <mbroek@mbse.eu>

date

Tue, 08 Oct 2019 12:00:31 +0200

changeset 0

88d965579617

child 72

acc1904cd70d

permissions

-rw-r--r--

Initial import of the CO2 meter application.

0 88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	1	# esp32-owb
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	2
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	3	This is a ESP32-compatible C component for the Maxim Integrated "1-Wire" protocol.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	4
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	5	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).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	6
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	7	Support for v2.1 is available on the [ESP-IDF_v2.1](https://github.com/DavidAntliff/esp32-owb/tree/ESP-IDF_v2.1) branch.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	8
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	9	## Features
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	10
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	11	This library includes:
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	12
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	13	* External power supply mode (parasitic mode not yet supported).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	14	* Static (stack-based) or dynamic (malloc-based) memory model.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	15	* No globals - support any number of 1-Wire buses simultaneously.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	16	* 1-Wire device detection and validation, including search for multiple devices on a single bus.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	17	* Addressing optimisation for a single (solo) device on a bus.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	18	* 1-Wire bus operations including multi-byte read and write operations.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	19	* CRC checks on ROM code.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	20
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	21	This component includes two methods of bus access - delay-driven GPIO and RMT-driven slots.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	22	The original implementation used CPU delays to construct the 1-Wire read/write timeslots
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	23	however this proved to be too unreliable. A second method, using the ESP32's RMT peripheral,
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	24	results in very accurate read/write timeslots and more reliable operation.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	25
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	26	Therefore I highly recommend that you use the RMT driver. The GPIO driver should be considered deprecated.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	27
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	28	## Documentation
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	29
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	30	Automatically generated API documentation (doxygen) is available [here](https://davidantliff.github.io/esp32-owb/index.html).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	31
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	32	## Source Code
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	33
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	34	The source is available from [GitHub](https://www.github.com/DavidAntliff/esp32-owb).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	35
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	36	## License
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	37
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	38	The code in this project is licensed under the MIT license - see LICENSE for details.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	39
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	40	## Links
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	41
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	42	* [esp32-ds18b20](https://github.com/DavidAntliff/esp32-ds18b20) - ESP32-compatible DS18B20 Digital Thermometer component for ESP32
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	43	* [1-Wire Communication Through Software](https://www.maximintegrated.com/en/app-notes/index.mvp/id/126)
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	44	* [1-Wire Search Algorithm](https://www.maximintegrated.com/en/app-notes/index.mvp/id/187)
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	45	* [Espressif IoT Development Framework for ESP32](https://github.com/espressif/esp-idf)
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	46
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	47	## Acknowledgements
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	48
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	49	Thank you to [Chris Morgan](https://github.com/chmorgan) for his contribution of adding RMT peripheral support for more reliable operation.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	50
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	51	Parts of this code are based on references provided to the public domain by Maxim Integrated.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	52
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	53	"1-Wire" is a registered trademark of Maxim Integrated.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	54