/esp32-ds18b20-example

ESP32-compatible example for Maxim Integrated DS18B20 Programmable Resolution 1-Wire Digital Thermometer.

Primary LanguageCMIT LicenseMIT

esp32-ds18b20-example

Build Status license

Introduction

This is an example application for the Maxim Integrated DS18B20 Programmable Resolution 1-Wire Digital Thermometer device.

It supports a single or multiple devices on the same 1-Wire bus.

It is written and tested for v3.0 of the ESP-IDF environment, using the xtensa-esp32-elf toolchain (gcc version 5.2.0, crosstool-ng-1.22.0-80-g6c4433a).

Support for ESP-IDF v2.1 is available on the ESP-IDF_v2.1 branch.

Ensure that submodules are cloned:

$ git clone --recursive https://github.com/DavidAntliff/esp32-ds18b20-example.git

Build the application with:

$ cd esp32-ds18b20-example.git
$ make menuconfig    # set your serial configuration and the 1-Wire GPIO - see below
$ make flash monitor

For version 3.2 or newer of ESP-IDF, you can build with the CMake build system:

$ $IDF_PATH/tools/idf.py menuconfig  # set your serial configuration and the 1-Wire GPIO - see below
$ $IDF_PATH/tools/idf.py build
$ $IDF_PATH/tools/idf.py flash monitor

The program should detect your connected devices and periodically obtain temperature readings from them, displaying them on the console.

Dependencies

This application makes use of the following components (included as submodules):

Hardware

To run this example, connect one or more DS18B20 devices to a single GPIO on the ESP32. Use the recommended pull-up resistor of 4.7 KOhms, connected to the 3.3V supply.

make menuconfig can be used to set the 1-Wire GPIO.

If you have several devices and see occasional CRC errors, consider using a 2.2 kOhm pull-up resistor instead. Also consider adding decoupling capacitors between the sensor supply voltage and ground, as close to each sensor as possible.

Features

This example provides:

  • External power supply mode.
  • Static (stack-based) or dynamic (malloc-based) memory model examples.
  • No global variables.
  • Device search.
  • Addressing optimisation for a single (solo) device on a bus.
  • CRC checks on ROM code and temperature data.
  • Programmable temperature measurement resolution (9, 10, 11 or 12-bit resolution).
  • Temperature conversion and retrieval.
  • Simultaneous conversion across multiple devices.

Source Code

The source is available from GitHub.

License

The code in this project is licensed under the MIT license - see LICENSE for details.

Links

Acknowledgements

"1-Wire" is a registered trademark of Maxim Integrated.