]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/guess_bitrate/pd.py
license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / guess_bitrate / pd.py
index 9acce50ae5cc1b1e93716d249ef7eb84ceaac534..45d68b055c0c39a5ac18e18731fba1b81bd571f0 100644 (file)
@@ -1,7 +1,7 @@
 ##
 ## This file is part of the libsigrokdecode project.
 ##
-## Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2013-2016 Uwe Hermann <uwe@hermann-uwe.de>
 ##
 ## 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
 ## 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, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+## along with this program; if not, see <http://www.gnu.org/licenses/>.
 ##
 
-# Bitrate / baudrate guessing protocol decoder
-
 import sigrokdecode as srd
 
+class SamplerateError(Exception):
+    pass
+
 class Decoder(srd.Decoder):
-    api_version = 1
+    api_version = 3
     id = 'guess_bitrate'
     name = 'Guess bitrate'
     longname = 'Guess bitrate/baudrate'
@@ -31,58 +31,47 @@ class Decoder(srd.Decoder):
     license = 'gplv2+'
     inputs = ['logic']
     outputs = ['guess_bitrate']
-    probes = [
+    channels = (
         {'id': 'data', 'name': 'Data', 'desc': 'Data line'},
-    ]
-    optional_probes = []
-    options = {}
-    annotations = [
-        ['bitrate', 'Bitrate / baudrate'],
-    ]
+    )
+    annotations = (
+        ('bitrate', 'Bitrate / baudrate'),
+    )
 
     def putx(self, data):
         self.put(self.ss_edge, self.samplenum, self.out_ann, data)
 
-    def __init__(self, **kwargs):
-        self.olddata = None
+    def __init__(self):
         self.ss_edge = None
         self.first_transition = True
         self.bitwidth = None
 
-    def start(self, metadata):
-        self.samplerate = metadata['samplerate']
-        # self.out_proto = self.register(srd.OUTPUT_PYTHON)
+    def start(self):
         self.out_ann = self.register(srd.OUTPUT_ANN)
 
-    def report(self):
-        pass
-
-    def decode(self, ss, es, data):
-        for (self.samplenum, pins) in data:
+        self.initial_pins = [1] # TODO: Not generally correct.
 
-            data = pins[0]
+    def metadata(self, key, value):
+        if key == srd.SRD_CONF_SAMPLERATE:
+            self.samplerate = value
 
-            # Wait for any transition on the data line.
-            if data == self.olddata:
-                continue
+    def decode(self):
+        if not self.samplerate:
+            raise SamplerateError('Cannot decode without samplerate.')
 
-            # Initialize first self.olddata with the first sample value.
-            if self.olddata == None:
-                self.olddata = data
-                continue
+        while True:
+            # Wait for any transition/edge on the data line.
+            self.wait({0: 'e'})
 
             # Get the smallest distance between two transitions
             # and use that to calculate the bitrate/baudrate.
-            if self.first_transition == True:
+            if self.first_transition:
                 self.ss_edge = self.samplenum
                 self.first_transition = False
             else:
                 b = self.samplenum - self.ss_edge
-                if self.bitwidth == None or b < self.bitwidth:
+                if self.bitwidth is None or b < self.bitwidth:
                     self.bitwidth = b
                     bitrate = int(float(self.samplerate) / float(b))
                     self.putx([0, ['%d' % bitrate]])
                 self.ss_edge = self.samplenum
-
-            self.olddata = data
-