X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=decoders%2Fi2cfilter%2F__init__.py;h=31c3c6b73dc2732cb583de049335009a9db62137;hb=37e4c724efa64dd6061f7bb83f126b81da949771;hp=9a0b256756941c91d62427cfd8a27ffcbbf59505;hpb=24c74fd30fb161837c5f8b01baf3c0fe2dfa4ed5;p=libsigrokdecode.git diff --git a/decoders/i2cfilter/__init__.py b/decoders/i2cfilter/__init__.py index 9a0b256..31c3c6b 100644 --- a/decoders/i2cfilter/__init__.py +++ b/decoders/i2cfilter/__init__.py @@ -1,5 +1,5 @@ ## -## This file is part of the sigrok project. +## This file is part of the libsigrokdecode project. ## ## Copyright (C) 2012 Bert Vermeulen ## @@ -18,20 +18,20 @@ ## ''' -Generic I2C filtering protocol decoder. +Generic I²C filtering protocol decoder. -Takes input from the I2C protocol decoder and removes all traffic +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 *