Skip to content
CircuitPython driver for the Si7021 temperature and humidity sensor
Python
Branch: master
Clone or download
ladyada Merge pull request #13 from tannewt/remove_stop
Remove stop kwarg and use write_then_readinto.
Latest commit c739251 Aug 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs PyPi setup. Aug 7, 2018
examples renamed example; no learn guides need update Mar 4, 2018
.gitignore PyPi setup. Aug 7, 2018
.pylintrc ignore the board module imports in .pylintrc Aug 25, 2018
.readthedocs.yml updated .travis & .readthedocs yml Mar 4, 2018
.travis.yml PyPi setup. Aug 7, 2018
CODE_OF_CONDUCT.md updated CoC Aug 1, 2018
LICENSE Initial commit Feb 13, 2017
README.rst
adafruit_si7021.py Merge pull request #13 from tannewt/remove_stop Aug 21, 2019
requirements.txt PyPi setup. Aug 7, 2018
setup.py PyPi setup. Aug 7, 2018

README.rst

Introduction

Documentation Status Discord Build Status

CircuitPython module for use with the SI7021 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.

Usage Notes

Of course, you must import the library to use it:

import adafruit_si7021

This 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. 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_si7021.SI7021(i2c)

And then you can start measuring the temperature and humidity:

print(sensor.temperature)
print(sensor.relative_humidity)

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

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:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-si7021 --library_location .

Sphinx documentation

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.

You can’t perform that action at this time.