adafruit-circuitpython-ds18x20


Nameadafruit-circuitpython-ds18x20 JSON
Version 1.4.0 PyPI version JSON
download
home_page
SummaryCircuitPython driver for Dallas 1-Wire temperature sensor.
upload_time2024-02-05 19:50:56
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit 1-wire temperature sensor ds18x20 hardware breakout micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-onewire typing-extensions
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds18x20/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/ds18x20/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_DS18X20/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_DS18X20/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 Dallas 1-Wire temperature sensor.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit OneWire <https://github.com/adafruit/Adafruit_CircuitPython_OneWire>`_

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>`_.

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

.. code-block:: python

    import board
    from adafruit_onewire.bus import OneWireBus
    from adafruit_ds18x20 import DS18X20

    ow_bus = OneWireBus(board.D2)
    ds18 = DS18X20(ow_bus, ow_bus.scan()[0])
    ds18.temperature


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

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-ds18x20",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,1-wire,temperature,sensor,ds18x20,hardware,breakout,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/97/ab/bfa47e8f8fca75b9ec1446ff67135340ae6afcecd13c302ee9b2f8a95e94/adafruit-circuitpython-ds18x20-1.4.0.tar.gz",
    "platform": null,
    "description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ds18x20/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/ds18x20/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_DS18X20/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_DS18X20/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 Dallas 1-Wire temperature sensor.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit OneWire <https://github.com/adafruit/Adafruit_CircuitPython_OneWire>`_\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\nUsage Example\n=============\n\n.. code-block:: python\n\n    import board\n    from adafruit_onewire.bus import OneWireBus\n    from adafruit_ds18x20 import DS18X20\n\n    ow_bus = OneWireBus(board.D2)\n    ds18 = DS18X20(ow_bus, ow_bus.scan()[0])\n    ds18.temperature\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ds18x20/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_DS18X20/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython driver for Dallas 1-Wire temperature sensor.",
    "version": "1.4.0",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DS18X20"
    },
    "split_keywords": [
        "adafruit",
        "1-wire",
        "temperature",
        "sensor",
        "ds18x20",
        "hardware",
        "breakout",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cecb2892eba4f22186428fcbea16dfe10b023aa9071ff0147c3d35f4f0040465",
                "md5": "55ba78fca1f11a6224748b3f7a2dcba0",
                "sha256": "bb49ddff5d8a262b53e8cc8f122d37fe12df35898ca846a02c581f19b7094ddc"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ds18x20-1.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "55ba78fca1f11a6224748b3f7a2dcba0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5284,
            "upload_time": "2024-02-05T19:50:55",
            "upload_time_iso_8601": "2024-02-05T19:50:55.801236Z",
            "url": "https://files.pythonhosted.org/packages/ce/cb/2892eba4f22186428fcbea16dfe10b023aa9071ff0147c3d35f4f0040465/adafruit_circuitpython_ds18x20-1.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "97abbfa47e8f8fca75b9ec1446ff67135340ae6afcecd13c302ee9b2f8a95e94",
                "md5": "458e937bf852d789521ba06933ae1e0a",
                "sha256": "59515bfa7ce284a010cdf0d8c970f662970d175498586833da1d698d11703a66"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-ds18x20-1.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "458e937bf852d789521ba06933ae1e0a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27021,
            "upload_time": "2024-02-05T19:50:56",
            "upload_time_iso_8601": "2024-02-05T19:50:56.961724Z",
            "url": "https://files.pythonhosted.org/packages/97/ab/bfa47e8f8fca75b9ec1446ff67135340ae6afcecd13c302ee9b2f8a95e94/adafruit-circuitpython-ds18x20-1.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-05 19:50:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_DS18X20",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-onewire",
            "specs": []
        },
        {
            "name": "typing-extensions",
            "specs": [
                [
                    "~=",
                    "4.0"
                ]
            ]
        }
    ],
    "lcname": "adafruit-circuitpython-ds18x20"
}
        
Elapsed time: 0.18709s