X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fi2cfilter%2F__init__.py;h=6cbab8a1fe3da1354e3b02bf47589e6bdc38f641;hp=6443f5b620d61093867dc80b631ca69775be51cc;hb=84c1c0b52820af2418186ac3ecf93a5c6373a22e;hpb=48eee789a15ebd4c26d469a29dd79e7971f031fe;ds=sidebyside diff --git a/decoders/i2cfilter/__init__.py b/decoders/i2cfilter/__init__.py index 6443f5b..6cbab8a 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,21 +18,21 @@ ## ''' -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 .i2cfilter import * +from .pd import *