{"id":15018606,"url":"https://github.com/adafruit/adafruit_circuitpython_busdevice","last_synced_at":"2025-05-15T01:09:25.437Z","repository":{"id":13921446,"uuid":"75349305","full_name":"adafruit/Adafruit_CircuitPython_BusDevice","owner":"adafruit","description":"Two helper classes that handle transaction related state for I2C and SPI including locks.","archived":false,"fork":false,"pushed_at":"2025-01-16T19:31:16.000Z","size":188,"stargazers_count":114,"open_issues_count":1,"forks_count":77,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-05-08T02:55:38.973Z","etag":null,"topics":["circuitpython","hacktoberfest"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adafruit.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-02T01:41:12.000Z","updated_at":"2025-03-11T01:13:33.000Z","dependencies_parsed_at":"2024-04-09T17:51:34.453Z","dependency_job_id":"7bb6134e-c6af-4372-bdfa-1c4a1465cc2a","html_url":"https://github.com/adafruit/Adafruit_CircuitPython_BusDevice","commit_stats":{"total_commits":161,"total_committers":32,"mean_commits":5.03125,"dds":0.8881987577639752,"last_synced_commit":"88250a1e29a806dfc2a9dd9045bb0591a1178cca"},"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_BusDevice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_BusDevice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_BusDevice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_BusDevice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adafruit","download_url":"https://codeload.github.com/adafruit/Adafruit_CircuitPython_BusDevice/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254254043,"owners_count":22039792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circuitpython","hacktoberfest"],"created_at":"2024-09-24T19:52:10.693Z","updated_at":"2025-05-15T01:09:20.376Z","avatar_url":"https://github.com/adafruit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Adafruit CircuitPython BusDevice\n================================\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-busdevice/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/busdevice/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_BusDevice/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/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\nThe ``I2CDevice`` and ``SPIDevice`` helper classes make managing transaction state\non a bus easy. For example, they manage locking the bus to prevent other\nconcurrent access. For SPI devices, it manages the chip select and protocol\nchanges such as mode. For I2C, it manages the device address.\n\n.. _bus_device_installation:\n\n.. note:: On microcontroller boards using CircuitPython v6.3.0 or newer, the firmware\n    may already have the ``adafruit_bus_device`` package builtin, thus there may be no\n    need to add this package to your CIRCUITPY drive's \"lib\" directory. If both the\n    builtin and add-on ``adafruit_bus_device`` packages are present, then some\n    libraries that require this package *might* have problems importing it.\n\n    Please check the `CircuitPython documentation's \"module support matrix\"\n    \u003chttps://docs.circuitpython.org/en/latest/shared-bindings/support_matrix.html\u003e`_\n    to make sure that your board's firmware does include the builtin ``adafruit_bus_device``\n    package.\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI \u003chttps://pypi.org/project/adafruit-circuitpython-busdevice/\u003e`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-busdevice\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-busdevice\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name \u0026\u0026 cd project-name\n    python3 -m venv .venv\n    source .venv/bin/activate\n    pip3 install adafruit-circuitpython-busdevice\n\nUsage Example\n=============\n\nSee examples/read_register_i2c.py and examples/read_register_spi.py for examples of the module's usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs \u003chttps://docs.circuitpython.org/projects/busdevice/en/latest/\u003e`_.\n\nFor information on building library documentation, please check out `this guide \u003chttps://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1\u003e`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n\u003chttps://github.com/adafruit/Adafruit_CircuitPython_BusDevice/blob/main/CODE_OF_CONDUCT.md\u003e`_\nbefore contributing to help this project stay welcoming.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_busdevice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_busdevice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_busdevice/lists"}