Skip to content

Commit

Permalink
README file updated
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrominatel committed Sep 25, 2024
1 parent 82eadf5 commit 2ee178a
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions components/ds18b20/examples/ds18b20-read/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 2ee178a

Please sign in to comment.