Skip to content

Commit 4991829

Browse files
tekktriktekktrik
authored
Update docs with links to tutorials for I2C, SPI, and UART
1 parent bf0e1fa commit 4991829

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

‎shared-bindings/busio/__init__.c‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@
7070
//| hardware. The last step is optional because CircuitPython automatically
7171
//| resets hardware after a program finishes."""
7272
//|
73+
//| Note that drivers will typically handle communication if provided the bus
74+
//| instance (such as `busio.I2C(board.SCL, board.SDA)`), and that many of
75+
//| the methods listed here are lower level functionalities that are needed
76+
//| for working with custom drivers.
77+
//|
78+
//| Tutorial for I2C and SPI:
79+
//| https://learn.adafruit.com/circuitpython-basics-i2c-and-spi
80+
//|
81+
//| Tutorial for UART:
82+
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-uart-serial
83+
//|
7384

7485
STATIC const mp_rom_map_elem_t busio_module_globals_table[] = {
7586
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_busio) },

0 commit comments

Comments
 (0)