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 <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-si7021/>`_. 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 <https://docs.circuitpython.org/projects/si7021/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_SI7021/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-si7021",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,si7021,temperature,humidity,sensorbreakout,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/c3/9f/0bc4e994b7256845263bad2dee573e99da18a8529589cd0ed18f36b3d9e2/adafruit-circuitpython-si7021-4.1.11.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-si7021/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/si7021/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SI7021/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SI7021/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython module for use with the SI7021 Temperature and Humidity Sensor.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-si7021/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-si7021\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-si7021\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-si7021\n\nUsage Notes\n===========\n\nOf course, you must import the library to use it:\n\n.. code:: python\n\n import adafruit_si7021\n\nThis driver takes an instantiated and active I2C object (from the ``busio`` or\nthe ``bitbangio`` library) as an argument to its constructor. The way to create\nan I2C object depends on the board you are using. For boards with labeled SCL\nand SDA pins, you can:\n\n.. code:: python\n\n from busio import I2C\n from board import SCL, SDA\n\n i2c = I2C(SCL, SDA)\n\nOnce you have created the I2C interface object, you can use it to instantiate\nthe sensor object:\n\n.. code:: python\n\n sensor = adafruit_si7021.SI7021(i2c)\n\n\nAnd then you can start measuring the temperature and humidity:\n\n.. code:: python\n\n print(sensor.temperature)\n print(sensor.relative_humidity)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/si7021/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_SI7021/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for SI7021 Temperature and Humidity Sensor.",
"version": "4.1.11",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SI7021"
},
"split_keywords": [
"adafruit",
"si7021",
"temperature",
"humidity",
"sensorbreakout",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94e283e5ebfef5503330eedc0f3970d0257939b059718da9a676e265ee432c20",
"md5": "bf35bd62838365ca634170ff4b194b61",
"sha256": "60809ecb3fdac13acbb35e14788701902fb1a5fcc1e9785956a45ef64e40a727"
},
"downloads": -1,
"filename": "adafruit_circuitpython_si7021-4.1.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf35bd62838365ca634170ff4b194b61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8401,
"upload_time": "2023-12-09T17:34:22",
"upload_time_iso_8601": "2023-12-09T17:34:22.440886Z",
"url": "https://files.pythonhosted.org/packages/94/e2/83e5ebfef5503330eedc0f3970d0257939b059718da9a676e265ee432c20/adafruit_circuitpython_si7021-4.1.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c39f0bc4e994b7256845263bad2dee573e99da18a8529589cd0ed18f36b3d9e2",
"md5": "b5961bb28a60f5373a0cfc45d8942364",
"sha256": "f5a6f57650377ac01cb449548d7f35f52e94a01b0d53fc39912302e725dfe4bd"
},
"downloads": -1,
"filename": "adafruit-circuitpython-si7021-4.1.11.tar.gz",
"has_sig": false,
"md5_digest": "b5961bb28a60f5373a0cfc45d8942364",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28961,
"upload_time": "2023-12-09T17:34:23",
"upload_time_iso_8601": "2023-12-09T17:34:23.704745Z",
"url": "https://files.pythonhosted.org/packages/c3/9f/0bc4e994b7256845263bad2dee573e99da18a8529589cd0ed18f36b3d9e2/adafruit-circuitpython-si7021-4.1.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:34:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SI7021",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-si7021"
}
JSON
