CircuitPython module for the SHT31-D temperature and humidity sensor.
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.
You must import the library to use it:
This driver takes an instantiated and active I2C object (from the
bitbangio library) as an argument to its constructor. The way to create
an I2C object depends on the board you are using. For boards with labeled SCL
and SDA pins, you can:
from busio import I2C from board import SCL, SDA i2c = I2C(SCL, SDA)
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:
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
To build this library locally you’ll need to install the circuitpython-build-tools package.
python3 -m venv .env source .env/bin/activate pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
Then run the build:
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-sht31d --library_location .
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .env source .env/bin/activate pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
cd docs sphinx-build -E -W -b html . _build/html
This will output the documentation to
docs/_build/html. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.