srd: i2cfilter: Output actual I2C packets.

[libsigrokdecode.git] / decoders / i2cfilter / __init__.py

diff --git a/decoders/i2cfilter/__init__.py b/decoders/i2cfilter/__init__.py
index e9a9ab6028466134b1679751fe9e823c240df13d..6443f5b620d61093867dc80b631ca69775be51cc 100644 (file)
--- a/decoders/i2cfilter/__init__.py
+++ b/decoders/i2cfilter/__init__.py
@@ -20,15 +20,15 @@
 '''
 Generic I2C filtering protocol decoder.
 
-Takes input from the I2C protocol decoder and filters out traffic from/to
-a single address on the I2C bus.
+Takes input from the I2C protocol decoder and removes all traffic
+except that from/to the specified slave address and/or direction.
 
-It then outputs the filtered data one byte at a time as OUTPUT_PROTO up the
-protocol decoder stack. No annotations are output.
+It then outputs the filtered data again as OUTPUT_PROTO of type/format 'i2c'
+(up the protocol decoder stack). No annotations are output.
 
-The I2C address to filter out should be passed in as an option 'address', as
-an integer. A specific read or write operation can be selected with the
-'direction' option, which should be 'read' or 'write'.
+The I2C slave address to filter out should be passed in as an option
+'address', as an integer. A specific read or write operation can be selected
+with the 'direction' option, which should be 'read', 'write', or 'both'.
 
 Both of these are optional; if no options are specified the entire payload
 of the I2C session will be output.