j3d1/esp-open-rtos
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Completion of the document

Browse source
This commit is contained in:
Gunar Schorcht 2017-09-15 11:57:04 +02:00 committed by GitHub
parent ca482fa99a
commit 6ea41cfdc7
1 changed files with 26 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
examples/sht3x/README.md
View file

@ -1,7 +1,31 @@
# SHT3x Driver Examples
This example references two addtional drivers [i2c](https://github.com/kanflo/esp-open-rtos-driver-i2c) and [sht3x](https://github.com/gschorcht/esp-open-rtos/extras/sht3x), which are provided in the `../../extras` folder.
These examples references two addtional drivers [i2c](https://github.com/kanflo/esp-open-rtos-driver-i2c) and [sht3x](https://github.com/gschorcht/esp-open-rtos/extras/sht3x), which are provided in the `../../extras` folder.
If you plan to use one or both of this drivers in your own projects, please check the main development pages for updated versions or reported issues.
To run this example connect the SHT3x SCL to GPIO5 and SDA to GPIO4.
## Hardware setup
There are examples for only one sensor and examples for two sensors.
To run examples with **one sensor**, just use GPIO5 (SCL) and GPIO4 (SDA) to connect to the SHT3x sensor's I2C interface.
If you want to run examples with **two sensors**, you could do this with only one bus and different I2C addresses or with two buses and the same or different I2C addresses. In later case, use GPIO16 (SCL) and GPIO14 (SDA) for the second bus to connect to the second SHT3x sensor's I2C interface.
## Example description
__*shtx_callback_one_sensor*__
This example shows how to use a **callback function** to get the results of periodic measurements of only **one sensor** with a period of 1000 ms. It includes some simple error handling.
__*shtx_callback_two_sensors*__
This example shows how to use a **callback function** to get the results of periodic measurements of **two sensors** with **different measurement periods** of 1000 ms and 5000 ms, respectively. The sensors are connected to **two different buses**. There is no error handling in this example.
__*shtx_task_one_sensor*__
This example shows how to use a **task** in conjunction with function __*sht3x_get_values*__ to get the results of periodic measurements of only **one sensor** with a period of 1000 ms. The task uses function *vTaskDelay* to realize a periodic exudation of function *sht3x_get_values* with same rate as periodic measurements. There is no error handling in this example.
__*shtx_timer_one_sensor*__
This example shows how to use a **software timer** and **timer callback function** in conjunction with function __*sht3x_get_values*__ to get the results of periodic measurements of only **one sensor** with a period of 1000 ms. The timer callback function executes function *sht3x_get_values* to get the results of periodic measurements. The timer is started with same period as periodic measurements. Thus, the timer callback function is executed at same rate as periodic measurements. There is no error handling in this example.