X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fi2c%2F__init__.py;h=5216e01602a4498c031532ef71ffa6438b6f3e24;hp=3c29aa1cddf723dbc4d7262e2f9379490298ec58;hb=f9d87f641e55cd643037d81d7221ddc169cdae6b;hpb=1541976fcac03a780b5d27046f5f8884973c08ae

diff --git a/decoders/i2c/__init__.py b/decoders/i2c/__init__.py
index 3c29aa1..5216e01 100644
--- a/decoders/i2c/__init__.py
+++ b/decoders/i2c/__init__.py
@@ -59,21 +59,24 @@ http://en.wikipedia.org/wiki/I2C
 Protocol output format:
 
 I2C packet:
-[<i2c_command>, <data>, <ack_bit>]
+[<cmd>, <data>]
 
-<i2c_command> is one of:
+<cmd> is one of:
   - 'START' (START condition)
-  - 'START REPEAT' (Repeated START)
-  - 'ADDRESS READ' (Address, read)
-  - 'ADDRESS WRITE' (Address, write)
+  - 'START REPEAT' (Repeated START condition)
+  - 'ADDRESS READ' (Slave address, read)
+  - 'ADDRESS WRITE' (Slave address, write)
   - 'DATA READ' (Data, read)
   - 'DATA WRITE' (Data, write)
   - 'STOP' (STOP condition)
+  - 'ACK' (ACK bit)
+  - 'NACK' (NACK bit)
 
 <data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
-command. For 'START', 'START REPEAT' and 'STOP', this is None.
+command. Slave addresses do not include bit 0 (the READ/WRITE indication bit).
+For example, a slave address field could be 0x51 (instead of 0xa2).
+For 'START', 'START REPEAT', 'STOP', 'ACK', and 'NACK' <data> is None.
 
-<ack_bit> is either 'ACK' or 'NACK', but may also be None.
 '''
 
 from .i2c import *