Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

api/iodevices: update i2c doc and sample

Browse Source 
Reflect that we read one byte by default.

By popular request, also allow a second way to send one byte, by specifying a register with no data.
This commit is contained in:
Laurens Valk
2020-02-03 10:37:32 +01:00
parent ab6b15f047
commit 3e5f552591
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pybricks-projects
+1 -1
Submodule pybricks-projects updated: f7f1ce5768...8d9bb6e11a
pybricks/iodevices.py
+5 -5
View File
@@ -110,26 +110,26 @@ class I2CDevice():
"""
pass
def read(self, reg, length):
def read(self, reg, length=1):
"""Read bytes, starting at a given register.
Arguments:
reg (``int``): Register at which to begin
reading: 0--255 or 0x00--0xFF.
length (``int``): How many bytes to read.
length (``int``): How many bytes to read (*Default*: ``1``).
Returns:
``bytes``: Bytes returned from the device.
"""
pass
def write(self, reg, data):
def write(self, reg, data=None):
"""Write bytes, starting at a given register.
Arguments:
reg (``int``): Register at which to begin
writing: 0--255 or 0x00--0xFF.
data (``bytes``): Bytes to be written.
data (``bytes``): Bytes to be written (*Default*: ``None``).
"""
pass
@@ -157,7 +157,7 @@ class UARTDevice():
exception is raised.
Arguments:
length (``int``): How many bytes to read (*Default*: 1).
length (``int``): How many bytes to read (*Default*: ``1``).
Returns:
``bytes``: Bytes returned from the device.