X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fi2cfilter%2F__init__.py;h=6cbab8a1fe3da1354e3b02bf47589e6bdc38f641;hb=da9bcbd9f45b0153465c55ec726a0d76f6d7f01e;hp=97572bf48335e5888b758308876db56fe1562707;hpb=50bd5d259677faf87bb3408e111d0e833d7ba9b4;p=libsigrokdecode.git diff --git a/decoders/i2cfilter/__init__.py b/decoders/i2cfilter/__init__.py index 97572bf..6cbab8a 100644 --- a/decoders/i2cfilter/__init__.py +++ b/decoders/i2cfilter/__init__.py @@ -18,20 +18,20 @@ ## ''' -Generic I2C filtering protocol decoder. +This is a generic I²C filtering protocol decoder. -Takes input from the I2C protocol decoder and removes all traffic +It takes input from the I²C protocol decoder and removes all traffic except that from/to the specified slave address and/or direction. 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 slave address to filter out should be passed in as an option +The I²C 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. +of the I²C session will be output. ''' from .pd import *