adafruit-circuitpython-shtc3


Nameadafruit-circuitpython-shtc3 JSON
Version 1.1.14 PyPI version JSON
download
home_page
SummaryA helper library for using the Senserion SHTC3 Humidity and Temperature Sensor
upload_time2023-12-09 17:34:10
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython shtc3 humidity relative temperature
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-shtc3/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/shtc3/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_SHTC3/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_SHTC3/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

A helper library for using the Senserion SHTC3 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>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_

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-shtc3/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-shtc3

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-shtc3

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-shtc3

Usage Example
=============

.. code-block:: python3

    import time
    import board
    import adafruit_shtc3

    i2c = board.I2C()   # uses board.SCL and board.SDA
    sht = adafruit_shtc3.SHTC3(i2c)

    while True:
        temperature, relative_humidity = sht.measurements
        print("Temperature: %0.1f C" % temperature)
        print("Humidity: %0.1f %%" % relative_humidity)
        print("")
        time.sleep(1)


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/shtc3/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_SHTC3/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-shtc3",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,shtc3,humidity,relative,temperature",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/61/56/bbe72ec64cc8dcbd9bb4f4160d49515844545163cafce22bb0e5dd24f418/adafruit-circuitpython-shtc3-1.1.14.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-shtc3/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/shtc3/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_SHTC3/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_SHTC3/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\nA helper library for using the Senserion SHTC3 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* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\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-shtc3/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-shtc3\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-shtc3\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-shtc3\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    import time\n    import board\n    import adafruit_shtc3\n\n    i2c = board.I2C()   # uses board.SCL and board.SDA\n    sht = adafruit_shtc3.SHTC3(i2c)\n\n    while True:\n        temperature, relative_humidity = sht.measurements\n        print(\"Temperature: %0.1f C\" % temperature)\n        print(\"Humidity: %0.1f %%\" % relative_humidity)\n        print(\"\")\n        time.sleep(1)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/shtc3/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_SHTC3/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A helper library for using the Senserion SHTC3 Humidity and Temperature Sensor",
    "version": "1.1.14",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SHTC3"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "shtc3",
        "humidity",
        "relative",
        "temperature"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e29606d9945daabd23466a64d6446fc467a94fb13680995e1b2a759633ce73d8",
                "md5": "b04acf9f5646f9284a7e5beb6508f7ea",
                "sha256": "607ce9ab90a002d4b6baecd3fc65cecab5edd73b7af057e756862dc091290720"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_shtc3-1.1.14-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b04acf9f5646f9284a7e5beb6508f7ea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6277,
            "upload_time": "2023-12-09T17:34:08",
            "upload_time_iso_8601": "2023-12-09T17:34:08.951446Z",
            "url": "https://files.pythonhosted.org/packages/e2/96/06d9945daabd23466a64d6446fc467a94fb13680995e1b2a759633ce73d8/adafruit_circuitpython_shtc3-1.1.14-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6156bbe72ec64cc8dcbd9bb4f4160d49515844545163cafce22bb0e5dd24f418",
                "md5": "8f7e50923179473c3ec3dc261a1677c1",
                "sha256": "c78df55e613b881d168d4ee0d3efd4bcf71bfa58855f0cff75f5519e10d680f9"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-shtc3-1.1.14.tar.gz",
            "has_sig": false,
            "md5_digest": "8f7e50923179473c3ec3dc261a1677c1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27249,
            "upload_time": "2023-12-09T17:34:10",
            "upload_time_iso_8601": "2023-12-09T17:34:10.651631Z",
            "url": "https://files.pythonhosted.org/packages/61/56/bbe72ec64cc8dcbd9bb4f4160d49515844545163cafce22bb0e5dd24f418/adafruit-circuitpython-shtc3-1.1.14.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:34:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_SHTC3",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-shtc3"
}
        
Elapsed time: 0.21763s