Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ahtx0/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ahtx0/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_AHTx0/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_AHTx0/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 driver for the Adafruit AHT10 or AHT20 Humidity and Temperature 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://circuitpython.org/libraries>`_.
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-ahtx0/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ahtx0
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ahtx0
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-ahtx0
Usage Example
=============
.. code-block:: python3
import time
import board
import adafruit_ahtx0
# Create sensor object, communicating over the board's default I2C bus
i2c = board.I2C() # uses board.SCL and board.SDA
sensor = adafruit_ahtx0.AHTx0(i2c)
while True:
print("\nTemperature: %0.1f C" % sensor.temperature)
print("Humidity: %0.1f %%" % sensor.relative_humidity)
time.sleep(2)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ahtx0/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_AHTx0/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ahtx0",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ahtx0,aht10,humidity,temperature,sensor",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/91/e5/274df568c3d33000a3195fe6897c84fa87b40654d9c0d40490070bb7f11f/adafruit-circuitpython-ahtx0-1.0.21.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ahtx0/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ahtx0/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_AHTx0/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_AHTx0/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 driver for the Adafruit AHT10 or AHT20 Humidity and Temperature Sensor\n\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://circuitpython.org/libraries>`_.\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-ahtx0/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ahtx0\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ahtx0\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-ahtx0\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_ahtx0\n\n # Create sensor object, communicating over the board's default I2C bus\n i2c = board.I2C() # uses board.SCL and board.SDA\n sensor = adafruit_ahtx0.AHTx0(i2c)\n\n while True:\n print(\"\\nTemperature: %0.1f C\" % sensor.temperature)\n print(\"Humidity: %0.1f %%\" % sensor.relative_humidity)\n time.sleep(2)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ahtx0/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_AHTx0/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for the Adafruit AHT10 Humidity and Temperature Sensor",
"version": "1.0.21",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_AHTx0"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ahtx0",
"aht10",
"humidity",
"temperature",
"sensor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7157d2473c46004c0717064627e8e9051c41b8f9277b154955139316003d1502",
"md5": "8866509763c6b630dc8765f2e2bcc05a",
"sha256": "e3c15866025579ff2c381adae6d2c85f8b396d9fcd621994136939a723934310"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ahtx0-1.0.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8866509763c6b630dc8765f2e2bcc05a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5549,
"upload_time": "2023-12-18T16:52:38",
"upload_time_iso_8601": "2023-12-18T16:52:38.722338Z",
"url": "https://files.pythonhosted.org/packages/71/57/d2473c46004c0717064627e8e9051c41b8f9277b154955139316003d1502/adafruit_circuitpython_ahtx0-1.0.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91e5274df568c3d33000a3195fe6897c84fa87b40654d9c0d40490070bb7f11f",
"md5": "71a152c1a818b11625255696d4a6e7ca",
"sha256": "5f99605120b41466de69affd1b734f1ad3b97e92d1de5cefba3c7d3b1cc688d1"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ahtx0-1.0.21.tar.gz",
"has_sig": false,
"md5_digest": "71a152c1a818b11625255696d4a6e7ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26524,
"upload_time": "2023-12-18T16:52:40",
"upload_time_iso_8601": "2023-12-18T16:52:40.488726Z",
"url": "https://files.pythonhosted.org/packages/91/e5/274df568c3d33000a3195fe6897c84fa87b40654d9c0d40490070bb7f11f/adafruit-circuitpython-ahtx0-1.0.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-18 16:52:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_AHTx0",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ahtx0"
}
JSON
