diff options
| author | Peter Hinch <peter@hinch.me.uk> | 2018-08-02 17:34:34 +0100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2018-08-04 15:53:12 +1000 |
| commit | 163bacd1e80363117d24be05043ca595a3d4c9cf (patch) | |
| tree | f134d48d17d964ce6e4aad91241b93b51a8025cd /docs | |
| parent | 0d7a0880396734c9b56b3d62d52d12c226597811 (diff) | |
docs/library/machine.I2C.rst: Clarify availability of primitive I2C ops.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/machine.I2C.rst | 10 |
1 files changed, 2 insertions, 8 deletions
diff --git a/docs/library/machine.I2C.rst b/docs/library/machine.I2C.rst index a69c58999..71ca9b0d3 100644 --- a/docs/library/machine.I2C.rst +++ b/docs/library/machine.I2C.rst @@ -79,18 +79,16 @@ The following methods implement the primitive I2C master bus operations and can be combined to make any I2C transaction. They are provided if you need more control over the bus, otherwise the standard methods (see below) can be used. +These methods are available on software I2C only. + .. method:: I2C.start() Generate a START condition on the bus (SDA transitions to low while SCL is high). - Availability: ESP8266. - .. method:: I2C.stop() Generate a STOP condition on the bus (SDA transitions to high while SCL is high). - Availability: ESP8266. - .. method:: I2C.readinto(buf, nack=True) Reads bytes from the bus and stores them into *buf*. The number of bytes @@ -99,16 +97,12 @@ control over the bus, otherwise the standard methods (see below) can be used. is true then a NACK will be sent, otherwise an ACK will be sent (and in this case the slave assumes more bytes are going to be read in a later call). - Availability: ESP8266. - .. method:: I2C.write(buf) Write the bytes from *buf* to the bus. Checks that an ACK is received after each byte and stops transmitting the remaining bytes if a NACK is received. The function returns the number of ACKs that were received. - Availability: ESP8266. - Standard bus operations ----------------------- |