]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/i2c.py
move sigrokdecode.Decoder type to its own source file
[libsigrokdecode.git] / decoders / i2c.py
index 0044190a9f9fde656a81890458c16cf8ba6dcbb6..f0a95b79fd334b1dc6d9e2ca875b0dee988694fe 100644 (file)
 # TODO: Handle multiple different I2C devices on same bus
 #       -> we need to decode multiple protocols at the same time.
 
-#
-Protocol output format:
-#
-I2C packet:
-[<i2c_command>, <data>, <ack_bit>]
-#
-<i2c_command> is one of:
-  - 'START' (START condition)
-  - 'START REPEAT' (Repeated START)
-#   - 'ADDRESS READ' (Slave address, read)
-#   - 'ADDRESS WRITE' (Slave address, write)
-  - 'DATA READ' (Data, read)
-  - 'DATA WRITE' (Data, write)
-  - 'STOP' (STOP condition)
-#
-<data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
-command. For 'START', 'START REPEAT' and 'STOP', this is None.
-#
-<ack_bit> is either 'ACK' or 'NACK', but may also be None.
-#
+'''
+Protocol output format:
+
+I2C packet:
+[<i2c_command>, <data>, <ack_bit>]
+
+<i2c_command> is one of:
+  - 'START' (START condition)
+  - 'START REPEAT' (Repeated START)
+  - 'ADDRESS READ' (Address, read)
+  - 'ADDRESS WRITE' (Address, write)
+  - 'DATA READ' (Data, read)
+  - 'DATA WRITE' (Data, write)
+  - 'STOP' (STOP condition)
+
+<data> is the data or address byte associated with the 'ADDRESS*' and 'DATA*'
+command. For 'START', 'START REPEAT' and 'STOP', this is None.
+
+<ack_bit> is either 'ACK' or 'NACK', but may also be None.
+'''
 
 import sigrokdecode as srd
 
@@ -121,8 +121,6 @@ class Decoder(srd.Decoder):
     longname = 'Inter-Integrated Circuit'
     desc = 'I2C is a two-wire, multi-master, serial bus.'
     longdesc = '...'
-    author = 'Uwe Hermann'
-    email = 'uwe@hermann-uwe.de'
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['i2c']