Skip to content

Commit 9c27f6d

Browse files
committed
Make a note on the classes that they aren't built in and provide a link to installation instructions.
1 parent 0403c01 commit 9c27f6d

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

README.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Adafruit CircuitPython BusDevice
2-
==============================
2+
================================
33

44
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-busdevice/badge/?version=latest
55
:target: https://circuitpython.readthedocs.io/projects/bus_device/en/latest/
@@ -10,6 +10,20 @@ on a bus easy. For example, they manage locking the bus to prevent other
1010
concurrent access. For SPI devices, it manages the chip select and protocol
1111
changes such as mode. For I2C, it manages the device address.
1212

13+
.. _bus_device_installation:
14+
15+
Installation
16+
-------------
17+
18+
This library is **NOT** built into CircuitPython to make it easy to update. To
19+
install it either follow the directions below or :ref:`install the library
20+
bundle <bundle_installation>`.
21+
22+
To install:
23+
24+
#. Download and unzip the `latest release zip <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice/releases>`_.
25+
#. Copy the unzipped `adafruit_bus_device` to the ``lib`` directory on the ``CIRCUITPY`` or ``MICROPYTHON`` drive.
26+
1327
API
1428
---
1529
.. toctree::

adafruit_bus_device/i2c_device.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ class I2CDevice:
2828
:param ~nativeio.I2C i2c: The I2C bus the device is on
2929
:param int device_address: The 7 bit device address
3030
31+
.. note:: This class is **NOT** built into CircuitPython. See
32+
:ref:`here for install instructions <bus_device_installation>`.
33+
3134
Example:
3235
3336
.. code-block:: python

adafruit_bus_device/spi_device.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ class SPIDevice:
2828
:param ~nativeio.SPI spi: The SPI bus the device is on
2929
:param ~microcontroller.Pin chip_select: The chip select pin
3030
31+
.. note:: This class is **NOT** built into CircuitPython. See
32+
:ref:`here for install instructions <bus_device_installation>`.
33+
3134
Example:
3235
3336
.. code-block:: python

0 commit comments

Comments
 (0)