diff options
| author | Peter Hinch <peter@hinch.me.uk> | 2016-03-17 13:10:04 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2016-03-17 20:18:36 +0000 |
| commit | b8133c4c0f70c5294c0423562e2541505b963c9b (patch) | |
| tree | 38d5a5d1fb4f4616d228e8a34bdc003a1fb4babe | |
| parent | 4a6cac464355fcbb3ada8f1c491ccfdd53f41b01 (diff) | |
| download | micropython-b8133c4c0f70c5294c0423562e2541505b963c9b.tar.gz micropython-b8133c4c0f70c5294c0423562e2541505b963c9b.zip | |
docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.
| -rw-r--r-- | docs/library/pyb.I2C.rst | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst index 0d00b1f753..9d17bb0559 100644 --- a/docs/library/pyb.I2C.rst +++ b/docs/library/pyb.I2C.rst @@ -63,16 +63,24 @@ Constructors .. class:: pyb.I2C(bus, ...) - Construct an I2C object on the given bus. ``bus`` can be 1 or 2. - With no additional parameters, the I2C object is created but not + Construct an I2C object on the given bus. ``bus`` can be 1 or 2, 'X' or + 'Y'. With no additional parameters, the I2C object is created but not initialised (it has the settings from the last initialisation of the bus, if any). If extra arguments are given, the bus is initialised. See ``init`` for parameters of initialisation. - The physical pins of the I2C busses are: + The physical pins of the I2C busses on Pyboards V1.0 and V1.1 are: - ``I2C(1)`` is on the X position: ``(SCL, SDA) = (X9, X10) = (PB6, PB7)`` - ``I2C(2)`` is on the Y position: ``(SCL, SDA) = (Y9, Y10) = (PB10, PB11)`` + + On the Pyboard Lite: + + - ``I2C(1)`` is on the X position: ``(SCL, SDA) = (X9, X10) = (PB6, PB7)`` + - ``I2C(3)`` is on the Y position: ``(SCL, SDA) = (Y9, Y10) = (PA8, PB8)`` + + Calling the constructor with 'X' or 'Y' enables portability between Pyboard + types. Methods ------- |