Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-sht31d/badge/?version=latest
:target: https://docs.circuitpython.org/projects/sht31d/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_SHT31D/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SHT31D/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 the SHT31-D 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-sht31d/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-sht31d
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-sht31d
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-sht31d
Usage Example
=============
You must import the library to use it:
.. code:: python
import adafruit_sht31d
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.
.. code:: python
import board
i2c = board.I2C()
Once you have created the I2C interface object, you can use it to instantiate
the sensor object:
.. code:: python
sensor = adafruit_sht31d.SHT31D(i2c)
And then you can start measuring the temperature and humidity:
.. code:: python
print(sensor.temperature)
print(sensor.relative_humidity)
You can instruct the sensor to periodically measure the temperature and
humidity, storing the result in its internal cache:
.. code:: python
sensor.mode = adafruit_sht31d.MODE_PERIODIC
You can adjust the frequency at which the sensor periodically gathers data to:
0.5, 1, 2, 4 or 10 Hz. The following adjusts the frequency to 2 Hz:
.. code:: python
sensor.frequency = adafruit_sht31d.FREQUENCY_2
The sensor is capable of storing eight results. The sensor stores these
results in an internal FILO cache. Retrieving these results is simlilar to
taking a measurement. The sensor clears its cache once the stored data is read.
The sensor always returns eight data points. The list of results is backfilled
with the maximum output values of 130.0 ºC and 100.01831417975366 % RH:
.. code:: python
print(sensor.temperature)
print(sensor.relative_humidity)
The sensor will continue to collect data at the set interval until it is
returned to single shot data acquisition mode:
.. code:: python
sensor.mode = adafruit_sht31d.MODE_SINGLE
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/sht31d/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_SHT31D/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-sht31d",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,sht31d,sht31-d,temperature,humidity,sensor,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/c4/26/cc29b45b1080739258260b23cf3caa39049a629e0af44d9c5a777b06d1eb/adafruit-circuitpython-sht31d-2.3.24.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-sht31d/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/sht31d/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_SHT31D/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SHT31D/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 the SHT31-D 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\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-sht31d/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-sht31d\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-sht31d\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 .env\n source .env/bin/activate\n pip3 install adafruit-circuitpython-sht31d\n\nUsage Example\n=============\nYou must import the library to use it:\n\n.. code:: python\n\n import adafruit_sht31d\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.\n\n.. code:: python\n\n import board\n\n i2c = board.I2C()\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_sht31d.SHT31D(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\nYou can instruct the sensor to periodically measure the temperature and\nhumidity, storing the result in its internal cache:\n\n.. code:: python\n\n sensor.mode = adafruit_sht31d.MODE_PERIODIC\n\nYou can adjust the frequency at which the sensor periodically gathers data to:\n0.5, 1, 2, 4 or 10 Hz. The following adjusts the frequency to 2 Hz:\n\n.. code:: python\n\n sensor.frequency = adafruit_sht31d.FREQUENCY_2\n\nThe sensor is capable of storing eight results. The sensor stores these\nresults in an internal FILO cache. Retrieving these results is simlilar to\ntaking a measurement. The sensor clears its cache once the stored data is read.\nThe sensor always returns eight data points. The list of results is backfilled\nwith the maximum output values of 130.0 \u00baC and 100.01831417975366 % RH:\n\n.. code:: python\n\n print(sensor.temperature)\n print(sensor.relative_humidity)\n\nThe sensor will continue to collect data at the set interval until it is\nreturned to single shot data acquisition mode:\n\n.. code:: python\n\n sensor.mode = adafruit_sht31d.MODE_SINGLE\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/sht31d/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_SHT31D/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for SHT31-D temperature and humidity sensor.",
"version": "2.3.24",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SHT31D"
},
"split_keywords": [
"adafruit",
"sht31d",
"sht31-d",
"temperature",
"humidity",
"sensor",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3e9c94cbe03c5fd548ac75f24403ec931dac61b5042d8d59a095ded263a18f2",
"md5": "6695d9da0c111e30e7c1fb0d06971d62",
"sha256": "ec041ec19df8bd338a09cad48f716cbb26054ef533434b418e3ab31d87421bd7"
},
"downloads": -1,
"filename": "adafruit_circuitpython_sht31d-2.3.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6695d9da0c111e30e7c1fb0d06971d62",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7679,
"upload_time": "2023-12-09T17:34:03",
"upload_time_iso_8601": "2023-12-09T17:34:03.180459Z",
"url": "https://files.pythonhosted.org/packages/a3/e9/c94cbe03c5fd548ac75f24403ec931dac61b5042d8d59a095ded263a18f2/adafruit_circuitpython_sht31d-2.3.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c426cc29b45b1080739258260b23cf3caa39049a629e0af44d9c5a777b06d1eb",
"md5": "5c626daa4ef90240979d28ed0e02dbeb",
"sha256": "401be2e5f36236bce32e5d4be38c36261ffeafaeef7ad650bbc334a2d9f08a33"
},
"downloads": -1,
"filename": "adafruit-circuitpython-sht31d-2.3.24.tar.gz",
"has_sig": false,
"md5_digest": "5c626daa4ef90240979d28ed0e02dbeb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29184,
"upload_time": "2023-12-09T17:34:05",
"upload_time_iso_8601": "2023-12-09T17:34:05.309880Z",
"url": "https://files.pythonhosted.org/packages/c4/26/cc29b45b1080739258260b23cf3caa39049a629e0af44d9c5a777b06d1eb/adafruit-circuitpython-sht31d-2.3.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:34:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SHT31D",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-sht31d"
}
JSON
