CircuitPython library for SHT31-D temperature and humidity sensor.
Project description
Introduction
CircuitPython module for the SHT31-D temperature and humidity sensor.
Dependencies
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
Installing from PyPI
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-sht31dTo install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-sht31dTo install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-sht31dUsage Example
You must import the library to use it:
import adafruit_sht31dThis driver takes an instantiated and active I2C object (from the busio or the bitbangio library) as an argument to its constructor. The way to create an I2C object depends on the board you are using.
from board
i2c = board.I2C()Once you have created the I2C interface object, you can use it to instantiate the sensor object:
sensor = adafruit_sht31d.SHT31D(i2c)And then you can start measuring the temperature and humidity:
print(sensor.temperature)
print(sensor.relative_humidity)You can instruct the sensor to periodically measure the temperature and humidity, storing the result in its internal cache:
sensor.mode = adafruit_sht31d.MODE_PERIODICYou can adjust the frequency at which the sensor periodically gathers data to: 0.5, 1, 2, 4 or 10 Hz. The following adjusts the frequency to 2 Hz:
sensor.frequency = adafruit_sht31d.FREQUENCY_2The sensor is capable of storing eight results. The sensor stores these results in an internal FILO cache. Retrieving these results is simlilar to taking a measurement. The sensor clears its cache once the stored data is read. The sensor always returns eight data points. The list of results is backfilled with the maximum output values of 130.0 ºC and 100.01831417975366 % RH:
print(sensor.temperature)
print(sensor.relative_humidity)The sensor will continue to collect data at the set interval until it is returned to single shot data acquisition mode:
sensor.mode = adafruit_sht31d.MODE_SINGLEDocumentation
API documentation for this library can be found on Read the Docs.
Contributing
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Documentation
For information on building library documentation, please check out this guide.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file adafruit-circuitpython-sht31d-2.3.7.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-sht31d-2.3.7.tar.gz
- Upload date:
- Size: 30.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4a82cc9ddb6bf0849471820df96af93201a9abf530181409573bd50acb5dd82a |
|
| MD5 | b55f2b76b8ee01dc829a1f3f485bf6e5 |
|
| BLAKE2b-256 | b6850b35ae601630a49cc8551c3f07a943912243ddeee0e3db18ea6a6147f16e |
