https://github.com/adafruit/adafruit_circuitpython_si7021

CircuitPython driver for the Si7021 temperature and humidity sensor
https://github.com/adafruit/adafruit_circuitpython_si7021

circuitpython hacktoberfest

Last synced: 3 months ago
JSON representation

CircuitPython driver for the Si7021 temperature and humidity sensor

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_si7021
• Owner: adafruit
• License: mit
• Created: 2017-02-03T17:17:22.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T17:33:51.000Z (about 1 year ago)
• Last Synced: 2024-10-07T11:10:13.836Z (3 months ago)
• Topics: circuitpython, hacktoberfest
• Language: Python
• Size: 118 KB
• Stars: 10
• Watchers: 23
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-si7021/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/si7021/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SI7021/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_SI7021/actions/

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

CircuitPython module for use with the SI7021 Temperature and Humidity Sensor.

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

* `Bus Device `_

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:

.. code-block:: shell

    pip3 install adafruit-circuitpython-si7021

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-si7021

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .venv/bin/activate

    pip3 install adafruit-circuitpython-si7021

Usage Notes

===========

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

.. code:: python

    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:

.. code:: python

    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:

.. code:: python

    sensor = adafruit_si7021.SI7021(i2c)

And then you can start measuring the temperature and humidity:

.. code:: python

    print(sensor.temperature)

    print(sensor.relative_humidity)

Documentation

=============

API documentation for this library can be found on `Read the Docs `_.

For information on building library documentation, please check out `this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.