Skip to content

Commit b8133c4

Browse files
peterhinchdpgeorge
authored andcommitted
docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.
1 parent 4a6cac4 commit b8133c4

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

docs/library/pyb.I2C.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,24 @@ Constructors
6363

6464
.. class:: pyb.I2C(bus, ...)
6565

66-
Construct an I2C object on the given bus. ``bus`` can be 1 or 2.
67-
With no additional parameters, the I2C object is created but not
66+
Construct an I2C object on the given bus. ``bus`` can be 1 or 2, 'X' or
67+
'Y'. With no additional parameters, the I2C object is created but not
6868
initialised (it has the settings from the last initialisation of
6969
the bus, if any). If extra arguments are given, the bus is initialised.
7070
See ``init`` for parameters of initialisation.
7171

72-
The physical pins of the I2C busses are:
72+
The physical pins of the I2C busses on Pyboards V1.0 and V1.1 are:
7373

7474
- ``I2C(1)`` is on the X position: ``(SCL, SDA) = (X9, X10) = (PB6, PB7)``
7575
- ``I2C(2)`` is on the Y position: ``(SCL, SDA) = (Y9, Y10) = (PB10, PB11)``
76+
77+
On the Pyboard Lite:
78+
79+
- ``I2C(1)`` is on the X position: ``(SCL, SDA) = (X9, X10) = (PB6, PB7)``
80+
- ``I2C(3)`` is on the Y position: ``(SCL, SDA) = (Y9, Y10) = (PA8, PB8)``
81+
82+
Calling the constructor with 'X' or 'Y' enables portability between Pyboard
83+
types.
7684

7785
Methods
7886
-------

0 commit comments

Comments
 (0)