adafruit-circuitpython-onewire


Nameadafruit-circuitpython-onewire JSON
Version 2.0.7 PyPI version JSON
download
home_page
SummaryCircuitPython OneWire helper library for 1-wire bus devices.
upload_time2023-12-09 17:46:15
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit onewire dallas 1-wire breakout hardware micropython circuitpython
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-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/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

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": "",
    "name": "adafruit-circuitpython-onewire",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,onewire,dallas,1-wire,breakout,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/1f/68/dbe2a0d07f92bb92bd3313ac28028aa80a391313c215e37625e8d7443627/adafruit-circuitpython-onewire-2.0.7.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/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\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.7",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_OneWire"
    },
    "split_keywords": [
        "adafruit",
        "onewire",
        "dallas",
        "1-wire",
        "breakout",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ade907668e8ffb62891ff9e90b96415e1f19ac53a902880d87f231c0c74d813",
                "md5": "83578879bb3d16241f7e561bd6a1a71d",
                "sha256": "f057df8877bba36a6d18149bc2349634a4102a99e70d1003ab95bc6d781e0f23"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_onewire-2.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "83578879bb3d16241f7e561bd6a1a71d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6793,
            "upload_time": "2023-12-09T17:46:13",
            "upload_time_iso_8601": "2023-12-09T17:46:13.387635Z",
            "url": "https://files.pythonhosted.org/packages/6a/de/907668e8ffb62891ff9e90b96415e1f19ac53a902880d87f231c0c74d813/adafruit_circuitpython_onewire-2.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1f68dbe2a0d07f92bb92bd3313ac28028aa80a391313c215e37625e8d7443627",
                "md5": "a65c76576b5d4f9d33c4bc1e3728e40a",
                "sha256": "584313ce30b753602387119b8a74e767c2e01e91549ee69ff8ce9fcd668a5072"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-onewire-2.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "a65c76576b5d4f9d33c4bc1e3728e40a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27069,
            "upload_time": "2023-12-09T17:46:15",
            "upload_time_iso_8601": "2023-12-09T17:46:15.103637Z",
            "url": "https://files.pythonhosted.org/packages/1f/68/dbe2a0d07f92bb92bd3313ac28028aa80a391313c215e37625e8d7443627/adafruit-circuitpython-onewire-2.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:46:15",
    "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": [],
    "lcname": "adafruit-circuitpython-onewire"
}
        
Elapsed time: 0.15005s