Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 4.29 KB

README.md

File metadata and controls

87 lines (67 loc) · 4.29 KB

sht3x_example

Welcome to the sht3x_example AtomVM application.

This example application will drive a SHT3x temperature and humidity sensor attached to an ESP32 device using the 2-wire I2C interface and print readings to the console.

For this application, you will need:

  • An ESP32 device, flashed with the AtomVM image (including the VM and core libraries), and capable of connecting via UART to your development machine;
  • An SHT3x device, typically marketed as an integrated development board;
  • The esptool.py tool (for flashing);
  • The git version control tool;
  • Erlang/OTP 21 or higher, along with rebar3;
  • A serial monitor program of your choice (e.g, minicom)

While the IDF SDK and required tool chains are not required, they may make life a little easier.

Getting Started

Connection

Use of the SHT3x will typically require connecting some kind of development board, which includes the SHT3x integrated circuit integrated circuit, along with additional passive components, to you ESP32 device.

Connect the VCC and GND pins to a power source and ground (e.g., on your ESP32).

Connect the SDA and SCL pins on two selected GPIO pins on your ESP32 device (e.g., pin 21 and 22).

+-----------+                         +-------------+
|       VCC +-------------------------+ +3.3v       |
|       GND +-------------------------+ GND         |
|       SDA +-------------------------+ GPIO 21     |
|       SCL +-------------------------+ GPIO 22     |
+-----------+                         +-------------+
   SHT3X                                   ESP32

Note. The example program assumes the SDA pin is connected to the ESP32 GPIO pin 21 and the SCL pin is connected to the ESP32 GPIO pin 22. If you need to use different pins, make sure to change the example program to reflect your requirements.

Build Instructions

To build and flash this application to your ESP32 device, issue the esp32_flash target to the rebar3 command, and optionally specify the device port and baud rate, if they do not match the defaults.

Note. For information about the esp32_flash target, see the atomvm_rebar3_plugin instructions.

shell$ rebar3 esp32_flash -p /dev/ttyUSB0 -b 115200
===> Fetching atomvm_rebar3_plugin
===> Fetching packbeam (from {git,"https://github.com/atomvm/atomvm_packbeam.git",
                    {branch,"master"}})
===> Analyzing applications...
===> Compiling atomvm_rebar3_plugin
===> Compiling packbeam
===> Verifying dependencies...
===> App atomvm_lib is a checkout dependency and cannot be locked.
===> Analyzing applications...
===> Compiling atomvm_lib
===> Analyzing applications...
===> Compiling sht3x_example
===> AVM file written to : atomvm_lib.avm
===> AVM file written to : sht3x_example.avm
===> esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 115200 --before default_reset --after hard_reset write_flash -u --flash_mode dio --flash_freq 40m --flash_size detect 0x210000 .../atomvm_lib/examples/sht3x_example/_build/default/lib/sht3x_example.avm

esptool.py v2.1
Connecting........_____.
Chip is ESP32D0WDQ6 (revision (unknown 0xa))
Uploading stub...
Running stub...
Stub running...
Configuring flash size...
Auto-detected Flash size: 4MB
Wrote 16384 bytes at 0x00210000 in 1.4 seconds (91.4 kbit/s)...
Hash of data verified.

Leaving...
Hard resetting...

Connect to the device using the USB port (e.g., via minicom), and you should see something like:

Found AVM partition: size: 1048576, address: 0x210000
Booting file mapped at: 0x3f430000, size: 1048576
Found AVM partition: size: 1048576, address: 0x110000
Starting: sht3x_example.beam...
---
Temperature: {19,{79,1000}}, Humidity: {31,{91,100}}
Temperature: {19,{76,1000}}, Humidity: {31,{90,100}}
Temperature: {19,{79,1000}}, Humidity: {31,{91,100}}
Temperature: {19,{81,1000}}, Humidity: {31,{92,100}}
Temperature: {19,{89,1000}}, Humidity: {31,{90,100}}
...