summaryrefslogtreecommitdiff
path: root/docs/pyboard
diff options
context:
space:
mode:
authorDavid P <dpoirier@y7mail.com>2021-06-12 14:51:05 +1000
committerDamien George <damien@micropython.org>2021-07-18 11:19:44 +1000
commitfdd5b18133e9d9f5a4e76be22ece6632d11d7fee (patch)
tree07f4e1b5eb2688306ec840a0d099b4408f7b46f2 /docs/pyboard
parentcbc8d5b61f0742e810ad45bd27d8daa11f3dbbf8 (diff)
docs: Replace master/slave with controller/peripheral in I2C and SPI.
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
Diffstat (limited to 'docs/pyboard')
-rw-r--r--docs/pyboard/quickref.rst12
-rw-r--r--docs/pyboard/tutorial/amp_skin.rst2
-rw-r--r--docs/pyboard/tutorial/lcd_skin.rst6
3 files changed, 10 insertions, 10 deletions
diff --git a/docs/pyboard/quickref.rst b/docs/pyboard/quickref.rst
index 3ea319099..49b67eee4 100644
--- a/docs/pyboard/quickref.rst
+++ b/docs/pyboard/quickref.rst
@@ -191,7 +191,7 @@ See :ref:`pyb.SPI <pyb.SPI>`. ::
from pyb import SPI
- spi = SPI(1, SPI.MASTER, baudrate=200000, polarity=1, phase=0)
+ spi = SPI(1, SPI.CONTROLLER, baudrate=200000, polarity=1, phase=0)
spi.send('hello')
spi.recv(5) # receive 5 bytes on the bus
spi.send_recv('hello') # send and receive 5 bytes
@@ -210,12 +210,12 @@ eg ``I2C(1)``. Software I2C is also available by explicitly specifying the
i2c = I2C('X', freq=400000) # create hardware I2c object
i2c = I2C(scl='X1', sda='X2', freq=100000) # create software I2C object
- i2c.scan() # returns list of slave addresses
- i2c.writeto(0x42, 'hello') # write 5 bytes to slave with address 0x42
- i2c.readfrom(0x42, 5) # read 5 bytes from slave
+ i2c.scan() # returns list of peripheral addresses
+ i2c.writeto(0x42, 'hello') # write 5 bytes to peripheral with address 0x42
+ i2c.readfrom(0x42, 5) # read 5 bytes from peripheral
- i2c.readfrom_mem(0x42, 0x10, 2) # read 2 bytes from slave 0x42, slave memory 0x10
- i2c.writeto_mem(0x42, 0x10, 'xy') # write 2 bytes to slave 0x42, slave memory 0x10
+ i2c.readfrom_mem(0x42, 0x10, 2) # read 2 bytes from peripheral 0x42, peripheral memory 0x10
+ i2c.writeto_mem(0x42, 0x10, 'xy') # write 2 bytes to peripheral 0x42, peripheral memory 0x10
Note: for legacy I2C support see :ref:`pyb.I2C <pyb.I2C>`.
diff --git a/docs/pyboard/tutorial/amp_skin.rst b/docs/pyboard/tutorial/amp_skin.rst
index bcb583261..b6558959e 100644
--- a/docs/pyboard/tutorial/amp_skin.rst
+++ b/docs/pyboard/tutorial/amp_skin.rst
@@ -30,7 +30,7 @@ To set the volume, define the following function::
import pyb
def volume(val):
- pyb.I2C(1, pyb.I2C.MASTER).mem_write(val, 46, 0)
+ pyb.I2C(1, pyb.I2C.CONTROLLER).mem_write(val, 46, 0)
Then you can do::
diff --git a/docs/pyboard/tutorial/lcd_skin.rst b/docs/pyboard/tutorial/lcd_skin.rst
index 288ac1bf0..4df004160 100644
--- a/docs/pyboard/tutorial/lcd_skin.rst
+++ b/docs/pyboard/tutorial/lcd_skin.rst
@@ -51,7 +51,7 @@ MPR121 capacitive touch sensor has address 90.
To get started, try::
>>> import pyb
- >>> i2c = pyb.I2C(1, pyb.I2C.MASTER)
+ >>> i2c = pyb.I2C(1, pyb.I2C.CONTROLLER)
>>> i2c.mem_write(4, 90, 0x5e)
>>> touch = i2c.mem_read(1, 90, 0)[0]
@@ -68,7 +68,7 @@ directory or ``lib/`` directory) and then try::
>>> import pyb
>>> import mpr121
- >>> m = mpr121.MPR121(pyb.I2C(1, pyb.I2C.MASTER))
+ >>> m = mpr121.MPR121(pyb.I2C(1, pyb.I2C.CONTROLLER))
>>> for i in range(100):
... print(m.touch_status())
... pyb.delay(100)
@@ -80,7 +80,7 @@ Try touching each one in turn.
Note that if you put the LCD skin in the Y-position, then you need to
initialise the I2C bus using::
- >>> m = mpr121.MPR121(pyb.I2C(2, pyb.I2C.MASTER))
+ >>> m = mpr121.MPR121(pyb.I2C(2, pyb.I2C.CONTROLLER))
There is also a demo which uses the LCD and the touch sensors together,
and can be found `here <http://micropython.org/resources/examples/lcddemo.py>`__.