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

components/esp32-ds18b20/README.md@15dc572a7fcb (annotated)

components/esp32-ds18b20/README.md

Tue, 03 Oct 2023 17:24:06 +0200

author

Michiel Broek <mbroek@mbse.eu>

date

Tue, 03 Oct 2023 17:24:06 +0200

changeset 77

15dc572a7fcb

parent 0

88d965579617

permissions

-rw-r--r--

Version 0.3.0. Backported network code from experimental roaming project. Will now connect after reset to the strongest AP. Id the signal level drops below -67, extra scans are done to see for a better AP. Nothing is done yet. Removed config.conf file, all info is taken from the project menu and live tests. Better log the board type and send it via json mqtt. Send bssid and current channel too.

0 88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	1	# esp32-ds18b20
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	## Introduction
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	This is a ESP32-compatible C component for the Maxim Integrated DS18B20 Programmable Resolution 1-Wire Digital Thermometer device.
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	It supports multiple devices on the same 1-Wire bus.
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	It is written and tested for v2.1 and v3.0 of the [ESP-IDF](https://github.com/espressif/esp-idf) environment, using the xtensa-esp32-elf toolchain (gcc version 5.2.0).
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	## Dependencies
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	Requires [esp32-owb](https://github.com/DavidAntliff/esp32-owb).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	14
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	15	## Example
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	16
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	17	See [esp32-ds18b20-example](https://github.com/DavidAntliff/esp32-ds18b20-example) for an example that supports single and multiple devices on a single bus.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	18
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	19	## Features
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	In cooperation with the underlying esp32-owb component, this component includes:
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	22
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	23	* 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	24	* 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	25	* No globals - support any number of DS18B20 devices on any number of 1-Wire buses simultaneously.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	26	* 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	27	* 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	28	* CRC checks on temperature data.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	29	* Programmable temperature measurement resolution (9, 10, 11 or 12-bit resolution).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	30	* Temperature conversion and retrieval.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	31	* Separation of conversion and temperature retrieval to allow for simultaneous conversion across multiple devices.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	32
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	33	## Documentation
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	34
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	35	Automatically generated API documentation (doxygen) is available [here](https://davidantliff.github.io/esp32-ds18b20/index.html).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	36
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	37	## Source Code
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	38
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	39	The source is available from [GitHub](https://www.github.com/DavidAntliff/esp32-ds18b20).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	40
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	41	## License
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	42
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	43	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	44
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	45	## Links
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	* [DS18B20 Datasheet](http://datasheets.maximintegrated.com/en/ds/DS18B20.pdf)
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	48	* [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	49	* [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	50	* [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	51
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	52	## Acknowledgements
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	53
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	54	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	55
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	56	"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	57
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	58	## Roadmap
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	59
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	60	The following features are anticipated but not yet implemented:
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	61
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	62	* Concurrency support (multiple tasks accessing devices on the same bus).
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	63	* Alarm support.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	64	* EEPROM support.
88d965579617 Initial import of the CO2 meter application. Michiel Broek <mbroek@mbse.eu> parents: diff changeset	65	* Parasitic power support.