Skip to content

add a note about possible builtin pkg #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 29, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ changes such as mode. For I2C, it manages the device address.

.. _bus_device_installation:

.. note:: On microcontroller boards using CircuitPython v6.3.0 or newer, the firmware
may already have the ``adafruit_bus_device`` package builtin, thus there may be no
need to add this package to your CIRCUITPY drive's "lib" directory. If both the
builtin and add-on ``adafruit_bus_device`` packages are present, then some
libraries that require this package *might* have problems importing it.

Please check the `CircuitPython documentation's "module support matrix"
<https://circuitpython.readthedocs.io/en/latest/shared-bindings/support_matrix.html>`_
to make sure that your board's firmware does include the builtin ``adafruit_bus_device``
package.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-busdevice/>`_. To install for current user:

Expand Down