diff --git a/components/ds18b20/examples/ds18b20-read/README.md b/components/ds18b20/examples/ds18b20-read/README.md index bec1c171..ce82df6d 100644 --- a/components/ds18b20/examples/ds18b20-read/README.md +++ b/components/ds18b20/examples/ds18b20-read/README.md @@ -1,13 +1,25 @@ # DS18B20 sensor example -This example shows how to use the DS18B20 component. +This example shows how to use the 1-Wire temperature sensor [DS18B20](https://www.analog.com/media/en/technical-documentation/data-sheets/ds18b20.pdf) component. ## How to use the example +To add the component latest version to a project, you can use the following command: + +```bash +idf.py add-dependency "espressif/ds18b20" +``` + +To create a new project from this example, use: + +```bash +idf.py create-project-from-example "espressif/ds18b20:ds18b20-read" +``` + ### Hardware Required -* An ESP development board -* An DS18B20 sensor connected to GPIO 18. To use a different pin, modify `EXAMPLE_ONEWIRE_BUS_GPIO` in ds18b20-read.c. +* An ESP development board with RMT peripheral (e.g ESP32, ESP32-C3, ESP32-S3, etc) +* An DS18B20 sensor connected to GPIO 18. To use a different pin, modify `EXAMPLE_ONEWIRE_BUS_GPIO` in *ds18b20-read.c* file. * An USB cable for power supply and programming ### Example Output