Skip to content

Commit 63681a7

Browse files
committed
Link to the Bus Device docs.
1 parent 00a507c commit 63681a7

File tree

4 files changed

+20
-1
lines changed

4 files changed

+20
-1
lines changed

conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,4 +319,6 @@
319319

320320

321321
# Example configuration for intersphinx: refer to the Python standard library.
322-
intersphinx_mapping = {'http://docs.python.org/': None}
322+
intersphinx_mapping = {'http://docs.python.org/': None,
323+
'https://circuitpython.readthedocs.io/projects/bus_device/en/latest/': None,
324+
'https://circuitpython.readthedocs.io/projects/register/en/latest/': None}

docs/drivers.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ with CircuitPython and may or may not work with `MicroPython <https://micropytho
77
.. toctree::
88

99
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
10+
BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
1011
RGB Displays <http://micropython-rgb.readthedocs.io/>
1112
Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/>
1213
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>

shared-bindings/nativeio/I2C.c

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@
4242
//| physical level it consists of 2 wires: SCL and SDA, the clock and data
4343
//| lines respectively.
4444
//|
45+
//| .. seealso:: Using this class directly requires careful lock management.
46+
//| Instead, use :class:`~adafruit_bus_device.i2c_device.I2CDevice` to
47+
//| manage locks.
48+
//|
49+
//| .. seealso:: Using this class to directly read registers requires manual
50+
//| bit unpacking. Instead, use an existing driver or make one with
51+
//| :ref:`Register <register-module-reference>` data descriptors.
52+
//|
4553
//| :param ~microcontroller.Pin scl: The clock pin
4654
//| :param ~microcontroller.Pin sda: The data pin
4755
//| :param int frequency: The clock frequency

shared-bindings/nativeio/SPI.c

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@
5252
//|
5353
//| Construct an SPI object on the given pins.
5454
//|
55+
//| .. seealso:: Using this class directly requires careful lock management.
56+
//| Instead, use :class:`~adafruit_bus_device.spi_device.SPIDevice` to
57+
//| manage locks.
58+
//|
59+
//| .. seealso:: Using this class to directly read registers requires manual
60+
//| bit unpacking. Instead, use an existing driver or make one with
61+
//| :ref:`Register <register-module-reference>` data descriptors.
62+
//|
5563
//| :param ~microcontroller.Pin clock: the pin to use for the clock.
5664
//| :param ~microcontroller.Pin MOSI: the Master Out Slave In pin.
5765
//| :param ~microcontroller.Pin MISO: the Master In Slave Out pin.

0 commit comments

Comments
 (0)