adafruit-circuitpython-si7021

Introduction

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.

Release files for adafruit-circuitpython-si7021 3.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-si7021 3.1.1
File	Size	Uploaded
adafruit-circuitpython-si7021-3.1.1.tar.gz	20.4 kB	Nov 12, 2018	Details

Release files / adafruit-circuitpython-si7021-3.1.1.tar.gz

Download URL	adafruit-circuitpython-si7021-3.1.1.tar.gz
Size	20.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`ce4c2c33b0daf6d0733e37b224dc7c60edea82dc93afe541fb4bfb925c1062c0`
BLAKE2b-256 checksum How to use checksums	`0a104b1a42b3dbc890e315aa3627fdd73b6642bc4a7e1f68692bb21eff888129`
Upload date	Nov 12, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3`