srd: add generic I2C filter PD

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

diff --git a/decoders/i2cfilter/__init__.py b/decoders/i2cfilter/__init__.py
new file mode 100644 (file)
index 0000000..6c5f1ec
--- /dev/null
+++ b/decoders/i2cfilter/__init__.py
@@ -0,0 +1,36 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
+##
+
+'''
+Takes input from the I2C protocol decoder and filters out traffic from/to
+a single address on the I2C bus.
+
+It then outputs the filtered data one byte at a time as OUTPUT_PROTO 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'.
+
+Both of these are optional; if no options are specified the entire payload
+of the I2C session will be output.
+'''
+
+from .i2cfilter import *
+