summaryrefslogtreecommitdiffstatshomepage
path: root/docs/wipy/general.rst
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2017-04-18 15:04:30 +1000
committerDamien George <damien.p.george@gmail.com>2017-04-18 15:04:30 +1000
commitc49b265389c487ebeb12290fcbf7c0af89cdb038 (patch)
tree7f5dbe4bc2868b69b02a5ce92aeb3fd97f935997 /docs/wipy/general.rst
parent27f0862550fe9008d3a3b784ac31c105134f1a69 (diff)
downloadmicropython-c49b265389c487ebeb12290fcbf7c0af89cdb038.tar.gz
micropython-c49b265389c487ebeb12290fcbf7c0af89cdb038.zip
docs/wipy/general: Add section about specifics of I2C implementation.
Diffstat (limited to 'docs/wipy/general.rst')
-rw-r--r--docs/wipy/general.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst
index b3d8e7892d..8b9b91c534 100644
--- a/docs/wipy/general.rst
+++ b/docs/wipy/general.rst
@@ -240,6 +240,23 @@ Additional Pin methods:
Returns a list of the alternate functions supported by the pin. List items are
a tuple of the form: ``('ALT_FUN_NAME', ALT_FUN_INDEX)``
+Additional details for machine.I2C
+----------------------------------
+
+On the WiPy there is a single hardware I2C peripheral, identified by "0". By
+default this is the peripheral that is used when constructing an I2C instance.
+The default pins are GP23 for SCL and GP13 for SDA, and one can create the
+default I2C peripheral simply by doing::
+
+ i2c = machine.I2C()
+
+The pins and frequency can be specified as::
+
+ i2c = machine.I2C(freq=400000, scl='GP23', sda='GP13')
+
+Only certain pins can be used as SCL/SDA. Please refer to the pinout for further
+information.
+
Known issues
------------