Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-debug_i2c/badge/?version=latest
:target: https://docs.circuitpython.org/projects/debug_i2c/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_Debug_I2C/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Debug_I2C/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
Wrapper library for debugging I2C.
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>`_.
Usage Example
=============
This example uses the LIS3DH accelerometer. This lib can be used with any I2C device. Save
the code to your board.
.. code-block:: python
import adafruit_lis3dh
from adafruit_debug_i2c import DebugI2C
import busio
import board
import digitalio
i2c = DebugI2C(busio.I2C(board.SCL, board.SDA))
int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT)
accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1)
print(accelerometer.acceleration)
for i in range(2):
print(accelerometer.acceleration)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/debug_i2c/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_Debug_I2C/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Building locally
================
Zip release files
-----------------
To build this library locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
.. code-block:: shell
python3 -m venv .venv
source .venv/bin/activate
pip install circuitpython-build-tools
Once installed, make sure you are in the virtual environment:
.. code-block:: shell
source .venv/bin/activate
Then run the build:
.. code-block:: shell
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-debug_i2c --library_location .
Sphinx documentation
-----------------------
Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):
.. code-block:: shell
python3 -m venv .venv
source .venv/bin/activate
pip install Sphinx sphinx-rtd-theme
Now, once you have the virtual environment activated:
.. code-block:: shell
cd docs
sphinx-build -E -W -b html . _build/html
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-debug-i2c",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,debug_i2c,i2c,debug",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/2e/22/a76fef09c928df903e9e83a18218619534ada4e491dd727b0117c01cc81f/adafruit-circuitpython-debug-i2c-1.2.17.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-debug_i2c/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/debug_i2c/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_Debug_I2C/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Debug_I2C/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\nWrapper library for debugging I2C.\n\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\nUsage Example\n=============\n\nThis example uses the LIS3DH accelerometer. This lib can be used with any I2C device. Save\nthe code to your board.\n\n.. code-block:: python\n\n import adafruit_lis3dh\n from adafruit_debug_i2c import DebugI2C\n import busio\n import board\n import digitalio\n\n i2c = DebugI2C(busio.I2C(board.SCL, board.SDA))\n int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT)\n accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1)\n\n print(accelerometer.acceleration)\n\n for i in range(2):\n print(accelerometer.acceleration)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/debug_i2c/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_Debug_I2C/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n\nBuilding locally\n================\n\nZip release files\n-----------------\n\nTo build this library locally you'll need to install the\n`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.\n\n.. code-block:: shell\n\n python3 -m venv .venv\n source .venv/bin/activate\n pip install circuitpython-build-tools\n\nOnce installed, make sure you are in the virtual environment:\n\n.. code-block:: shell\n\n source .venv/bin/activate\n\nThen run the build:\n\n.. code-block:: shell\n\n circuitpython-build-bundles --filename_prefix adafruit-circuitpython-debug_i2c --library_location .\n\nSphinx documentation\n-----------------------\n\nSphinx is used to build the documentation based on rST files and comments in the code. First,\ninstall dependencies (feel free to reuse the virtual environment from above):\n\n.. code-block:: shell\n\n python3 -m venv .venv\n source .venv/bin/activate\n pip install Sphinx sphinx-rtd-theme\n\nNow, once you have the virtual environment activated:\n\n.. code-block:: shell\n\n cd docs\n sphinx-build -E -W -b html . _build/html\n\nThis will output the documentation to ``docs/_build/html``. Open the index.html in your browser to\nview them. It will also (due to -W) error out on any warning like Travis will. This is a good way to\nlocally verify it will pass.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Wrapper library for debugging I2C.",
"version": "1.2.17",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Debug_I2C"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"debug_i2c",
"i2c",
"debug"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "36bc75ef7734add094900a2031d6ac5a0425d54d9262b969f6a28412b55c2036",
"md5": "8c29639a071ea53d044e6427378272ea",
"sha256": "3257ebc98977172d5a09cf8bb0f1dd8bede73fa6fc09afe6e8bac22e95f7e878"
},
"downloads": -1,
"filename": "adafruit_circuitpython_debug_i2c-1.2.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8c29639a071ea53d044e6427378272ea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5866,
"upload_time": "2023-12-09T17:44:12",
"upload_time_iso_8601": "2023-12-09T17:44:12.468003Z",
"url": "https://files.pythonhosted.org/packages/36/bc/75ef7734add094900a2031d6ac5a0425d54d9262b969f6a28412b55c2036/adafruit_circuitpython_debug_i2c-1.2.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e22a76fef09c928df903e9e83a18218619534ada4e491dd727b0117c01cc81f",
"md5": "0f261676916f7c7c98e2b997323dd9be",
"sha256": "a8a2906786a8d307130ed872a673fc7254bc65032c04548400c3c57940e40fd5"
},
"downloads": -1,
"filename": "adafruit-circuitpython-debug-i2c-1.2.17.tar.gz",
"has_sig": false,
"md5_digest": "0f261676916f7c7c98e2b997323dd9be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26533,
"upload_time": "2023-12-09T17:44:13",
"upload_time_iso_8601": "2023-12-09T17:44:13.571879Z",
"url": "https://files.pythonhosted.org/packages/2e/22/a76fef09c928df903e9e83a18218619534ada4e491dd727b0117c01cc81f/adafruit-circuitpython-debug-i2c-1.2.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:44:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Debug_I2C",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-debug-i2c"
}
JSON
