adafruit-circuitpython-sht4x


Nameadafruit-circuitpython-sht4x JSON
Version 1.0.20 PyPI version JSON
download
home_pageNone
SummaryPython library for Sensirion SHT4x temperature and humidity sensors
upload_time2024-10-02 17:18:22
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython sht4x temperature humidity sensor sht40 sensirion
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-busdevice
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

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

Python library for Sensirion SHT4x temperature and humidity sensors


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

.. code-block:: shell

    pip3 install adafruit-circuitpython-sht4x

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-sht4x

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

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

.. code-block:: python3

    import time
    import board
    import adafruit_sht4x

    i2c = board.I2C()   # uses board.SCL and board.SDA
    sht = adafruit_sht4x.SHT4x(i2c)
    print("Found SHT4x with serial number", hex(sht.serial_number))

    sht.mode = adafruit_sht4x.Mode.NOHEAT_HIGHPRECISION
    # Can also set the mode to enable heater
    # sht.mode = adafruit_sht4x.Mode.LOWHEAT_100MS
    print("Current mode is: ", adafruit_sht4x.Mode.string[sht.mode])

    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/sht4x/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_SHT4x/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-sht4x",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, sht4x, temperature, humidity, sensor, sht40, sensirion",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/a8/9a/310301526d24d7c51a8c666cef418fcf0d2063d1bbc5ab84be647bd17835/adafruit_circuitpython_sht4x-1.0.20.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-sht4x/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/sht4x/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_SHT4x/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_SHT4x/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\nPython library for Sensirion SHT4x temperature and humidity sensors\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-sht4x/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-sht4x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-sht4x\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-sht4x\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    import time\n    import board\n    import adafruit_sht4x\n\n    i2c = board.I2C()   # uses board.SCL and board.SDA\n    sht = adafruit_sht4x.SHT4x(i2c)\n    print(\"Found SHT4x with serial number\", hex(sht.serial_number))\n\n    sht.mode = adafruit_sht4x.Mode.NOHEAT_HIGHPRECISION\n    # Can also set the mode to enable heater\n    # sht.mode = adafruit_sht4x.Mode.LOWHEAT_100MS\n    print(\"Current mode is: \", adafruit_sht4x.Mode.string[sht.mode])\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/sht4x/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_SHT4x/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python library for Sensirion SHT4x temperature and humidity sensors",
    "version": "1.0.20",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SHT4x"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " sht4x",
        " temperature",
        " humidity",
        " sensor",
        " sht40",
        " sensirion"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "315e399884783e29e6d7c01d8bbd0d028b055361e5b1dd6128901894cd63416e",
                "md5": "074bae8af764079281b246a8c7bc1fb0",
                "sha256": "a7ff0e5741d24784cbb8a6b81b6011e8ccb75aa8e8442c3f827ebe7bbd4146c6"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_sht4x-1.0.20-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "074bae8af764079281b246a8c7bc1fb0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6350,
            "upload_time": "2024-10-02T17:18:21",
            "upload_time_iso_8601": "2024-10-02T17:18:21.764221Z",
            "url": "https://files.pythonhosted.org/packages/31/5e/399884783e29e6d7c01d8bbd0d028b055361e5b1dd6128901894cd63416e/adafruit_circuitpython_sht4x-1.0.20-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a89a310301526d24d7c51a8c666cef418fcf0d2063d1bbc5ab84be647bd17835",
                "md5": "e3b1cc5bbdae69d8a7b6bfd6b50dd18c",
                "sha256": "6e8249d083afd8ef2869d9d5ad5d3c7d0a80fbbbcb11cacf2cfc1762d201390c"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_sht4x-1.0.20.tar.gz",
            "has_sig": false,
            "md5_digest": "e3b1cc5bbdae69d8a7b6bfd6b50dd18c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27940,
            "upload_time": "2024-10-02T17:18:22",
            "upload_time_iso_8601": "2024-10-02T17:18:22.765447Z",
            "url": "https://files.pythonhosted.org/packages/a8/9a/310301526d24d7c51a8c666cef418fcf0d2063d1bbc5ab84be647bd17835/adafruit_circuitpython_sht4x-1.0.20.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-02 17:18:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_SHT4x",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-sht4x"
}
        
Elapsed time: 0.43334s