adafruit-circuitpython-onewire


Nameadafruit-circuitpython-onewire JSON
Version 2.0.12 PyPI version JSON
download
home_pageNone
SummaryCircuitPython OneWire helper library for 1-wire bus devices.
upload_time2025-10-20 20:46:47
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit onewire dallas 1-wire breakout hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-typing
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-onewire/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/onewire/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_OneWire/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_OneWire/actions/
    :alt: Build Status

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

Classes for use in communicating with devices on a 1-Wire bus.

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

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

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

**Note:** This library does **not** work on the Raspberry Pi as there is no kernel interface for it

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

.. code-block:: python

    import board
    from adafruit_onewire.bus import OneWireBus
    ow_bus = OneWireBus(board.D2)
    devices = ow_bus.scan()
    for d in devices:
        print("ROM={}\tFamily=0x{:02x}".format(d.rom, d.family_code))


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

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-onewire",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, onewire, dallas, 1-wire, breakout, hardware, micropython, circuitpython",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/6c/32/0ab2ce3a221fceec46dde825a76cffe42691cd1111586b7a7bb24bc6971e/adafruit_circuitpython_onewire-2.0.12.tar.gz",
    "platform": null,
    "description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-onewire/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/onewire/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_OneWire/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_OneWire/actions/\n    :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Code Style: Ruff\n\nClasses for use in communicating with devices on a 1-Wire bus.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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\n**Note:** This library does **not** work on the Raspberry Pi as there is no kernel interface for it\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import board\n    from adafruit_onewire.bus import OneWireBus\n    ow_bus = OneWireBus(board.D2)\n    devices = ow_bus.scan()\n    for d in devices:\n        print(\"ROM={}\\tFamily=0x{:02x}\".format(d.rom, d.family_code))\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/onewire/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_OneWire/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython OneWire helper library for 1-wire bus devices.",
    "version": "2.0.12",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_OneWire"
    },
    "split_keywords": [
        "adafruit",
        " onewire",
        " dallas",
        " 1-wire",
        " breakout",
        " hardware",
        " micropython",
        " circuitpython"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2254270f50dce6206d9c626b52030b81f7abc95e8756d70385c5e02b564bd4dd",
                "md5": "9c34d3a149d6850111e63a08e76bd96c",
                "sha256": "d3a894a37b2c27ae54a0a2a5c2a716dc9aef0f6ea588d58878ddb2d30e9cc498"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_onewire-2.0.12-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c34d3a149d6850111e63a08e76bd96c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6817,
            "upload_time": "2025-10-20T20:46:45",
            "upload_time_iso_8601": "2025-10-20T20:46:45.939393Z",
            "url": "https://files.pythonhosted.org/packages/22/54/270f50dce6206d9c626b52030b81f7abc95e8756d70385c5e02b564bd4dd/adafruit_circuitpython_onewire-2.0.12-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6c320ab2ce3a221fceec46dde825a76cffe42691cd1111586b7a7bb24bc6971e",
                "md5": "27b883425ee4e27bf671ff15b01976a3",
                "sha256": "c16800a481181840fe123793b90780cbd81db478fa652ace61469c9839610208"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_onewire-2.0.12.tar.gz",
            "has_sig": false,
            "md5_digest": "27b883425ee4e27bf671ff15b01976a3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23852,
            "upload_time": "2025-10-20T20:46:47",
            "upload_time_iso_8601": "2025-10-20T20:46:47.105412Z",
            "url": "https://files.pythonhosted.org/packages/6c/32/0ab2ce3a221fceec46dde825a76cffe42691cd1111586b7a7bb24bc6971e/adafruit_circuitpython_onewire-2.0.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-20 20:46:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_OneWire",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-typing",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-onewire"
}
        
Elapsed time: 1.85817s