]> sigrok.org Git - libsigrokdecode.git/blobdiff - decoders/ir_sirc/pd.py
ir_sirc: symbolic names for IR pulse widths, more line trimming
[libsigrokdecode.git] / decoders / ir_sirc / pd.py
index e33eb42c2b0ccaf2ca3f145e44f724fc7a9795e1..0afacb0fdc97c0c5fb4cb6691564ab1989ab5f20 100644 (file)
@@ -30,6 +30,14 @@ class SIRCError(Exception):
 class SIRCErrorSilent(SIRCError):
     pass
 
+class Ann:
+    BIT, AGC, PAUSE, START, CMD, ADDR, EXT, REMOTE, WARN = range(9)
+
+AGC_USEC = 2400
+ONE_USEC = 1200
+ZERO_USEC = 600
+PAUSE_USEC = 600
+
 class Decoder(srd.Decoder):
     api_version = 3
     id = 'ir_sirc'
@@ -59,10 +67,10 @@ class Decoder(srd.Decoder):
         ('warning', 'Warning'),
     )
     annotation_rows = (
-        ('bits', 'Bits', (0, 1, 2)),
-        ('fields', 'Fields', (3, 4, 5, 6)),
-        ('remotes', 'Remotes', (7,)),
-        ('warnings', 'Warnings', (8,)),
+        ('bits', 'Bits', (Ann.BIT, Ann.AGC, Ann.PAUSE)),
+        ('fields', 'Fields', (Ann.START, Ann.CMD, Ann.ADDR, Ann.EXT)),
+        ('remotes', 'Remotes', (Ann.REMOTE,)),
+        ('warnings', 'Warnings', (Ann.WARN,)),
     )
 
     def __init__(self):
@@ -78,69 +86,70 @@ class Decoder(srd.Decoder):
     def metadata(self, key, value):
         if key == srd.SRD_CONF_SAMPLERATE:
             self.samplerate = value
+            self.snum_per_us = self.samplerate / 1e6
 
     def putg(self, ss, es, cls, texts):
         self.put(ss, es, self.out_ann, [cls, texts])
 
-    def tolerance(self, start, end, expected):
-        microseconds = 1000000 * (end - start) / self.samplerate
+    def tolerance(self, ss, es, expected):
+        microseconds = (es - ss) / self.snum_per_us
         tolerance = expected * 0.30
         return (expected - tolerance) < microseconds < (expected + tolerance)
 
-    def wait(self, *conds, timeout=None):
+    def wait_wrap(self, conds, timeout=None):
         conds = list(conds)
         if timeout is not None:
-            to = int(self.samplerate * timeout / 1000000)
+            to = int(timeout * self.snum_per_us)
             conds.append({'skip': to})
-        start = self.samplenum
-        signals = super(Decoder, self).wait(conds)
-        end = self.samplenum
-        return signals, start, end, self.matched
+        ss = self.samplenum
+        pins = self.wait(conds)
+        es = self.samplenum
+        return pins, ss, es, self.matched
 
     def read_pulse(self, high, time):
         e = 'f' if high else 'r'
         max_time = int(time * 1.30)
-        signals, start, end, (edge, timeout) = self.wait({0: e}, timeout=max_time)
-        if timeout or not self.tolerance(start, end, time):
+        pins, ss, es, (edge, timeout) = self.wait_wrap([{0: e}], max_time)
+        if timeout or not self.tolerance(ss, es, time):
             raise SIRCError('Timeout')
-        return signals, start, end, (edge, timeout)
+        return pins, ss, es, (edge, timeout)
 
     def read_bit(self):
         e = 'f' if self.active else 'r'
-        signals, high_start, high_end, (edge, timeout) = self.wait({0: e}, timeout=2000)
+        _, high_ss, high_es, (edge, timeout) = self.wait_wrap([{0: e}], 2000)
         if timeout:
             raise SIRCError('Bit High Timeout')
-        if self.tolerance(high_start, high_end, 1200):
+        if self.tolerance(high_ss, high_es, ONE_USEC):
             bit = 1
-        elif self.tolerance(high_start, high_end, 600):
+        elif self.tolerance(high_ss, high_es, ZERO_USEC):
             bit = 0
         else:
             raise SIRCError('Bit Low Timeout')
         try:
-            signals, low_start, low_end, matched = self.read_pulse(not self.active, 600)
+            _, low_ss, low_es, _ = self.read_pulse(not self.active, PAUSE_USEC)
             good = True
         except SIRCError:
-            low_end = high_end + int(600 * self.samplerate / 1000000)
+            low_es = high_es + int(PAUSE_USEC * self.snum_per_us)
             good = False
-        self.putg(high_start, low_end, 0, ['{}'.format(bit)])
-        return bit, high_start, low_end, good
+        self.putg(high_ss, low_es, Ann.BIT, ['{}'.format(bit)])
+        return bit, high_ss, low_es, good
 
     def read_signal(self):
         # Start code
         try:
-            signals, agc_start, agc_end, matched = self.read_pulse(self.active, 2400)
-            signals, pause_start, pause_end, matched = self.read_pulse(not self.active, 600)
+            _, agc_ss, agc_es, _ = self.read_pulse(self.active, AGC_USEC)
+            _, pause_ss, pause_es, _ = self.read_pulse(not self.active, PAUSE_USEC)
         except SIRCError:
             raise SIRCErrorSilent('not an SIRC message')
-        self.putg(agc_start, agc_end, 1, ['AGC', 'A'])
-        self.putg(pause_start, pause_end, 2, ['Pause', 'P'])
-        self.putg(agc_start, pause_end, 3, ['Start', 'S'])
+        self.putg(agc_ss, agc_es, Ann.AGC, ['AGC', 'A'])
+        self.putg(pause_ss, pause_es, Ann.PAUSE, ['Pause', 'P'])
+        self.putg(agc_ss, pause_es, Ann.START, ['Start', 'S'])
 
         # Read bits
         bits = []
         while True:
-            bit, start, end, good = self.read_bit()
-            bits.append((bit, start, end))
+            bit, ss, es, good = self.read_bit()
+            bits.append((bit, ss, es))
             if len(bits) > 20:
                 raise SIRCError('too many bits')
             if not good:
@@ -157,18 +166,18 @@ class Decoder(srd.Decoder):
                     address = bits[7:12]
                     extended = bits[12:20]
                 else:
-                    raise SIRCError('incorrect number of bits: {}'.format(len(bits)))
+                    raise SIRCError('incorrect bits count {}'.format(len(bits)))
                 break
 
         command_num = bitpack([b[0] for b in command])
         address_num = bitpack([b[0] for b in address])
         command_str = '0x{:02X}'.format(command_num)
         address_str = '0x{:02X}'.format(address_num)
-        self.putg(command[0][1], command[-1][2], 4, [
+        self.putg(command[0][1], command[-1][2], Ann.CMD, [
             'Command: {}'.format(command_str),
             'C:{}'.format(command_str),
         ])
-        self.putg(address[0][1], address[-1][2], 5, [
+        self.putg(address[0][1], address[-1][2], Ann.ADDR, [
             'Address: {}'.format(address_str),
             'A:{}'.format(address_str),
         ])
@@ -176,7 +185,7 @@ class Decoder(srd.Decoder):
         if extended:
             extended_num = bitpack([b[0] for b in extended])
             extended_str = '0x{:02X}'.format(extended_num)
-            self.putg(extended[0][1], extended[-1][2], 6, [
+            self.putg(extended[0][1], extended[-1][2], Ann.EXT, [
                 'Extended: {}'.format(extended_str),
                 'E:{}'.format(extended_str),
             ])
@@ -186,18 +195,19 @@ class Decoder(srd.Decoder):
         if not self.samplerate:
             raise SamplerateError('Cannot decode without samplerate.')
 
+        unknown = (['Unknown Device: ', 'UNK: '], {})
         while True:
             e = 'h' if self.active else 'l'
-            signal, start, end, matched = self.wait({0: e})
+            _, ss, es, _ = self.wait_wrap([{0: e}], None)
             try:
-                address, command, extended, payload_start, payload_end = self.read_signal()
-                names, commands = ADDRESSES.get((address, extended), (['Unknown Device: ', 'UNK: '], {}))
-                text = commands.get(command, 'Unknown')
-                self.putg(end, payload_end, 7, [n + text for n in names])
+                addr, cmd, ext, payload_ss, payload_es = self.read_signal()
+                names, cmds = ADDRESSES.get((addr, ext), unknown)
+                text = cmds.get(cmd, 'Unknown')
+                self.putg(es, payload_es, Ann.REMOTE, [n + text for n in names])
             except SIRCErrorSilent as e:
                 continue
             except SIRCError as e:
-                self.putg(end, self.samplenum, 8, [
+                self.putg(es, self.samplenum, Ann.WARN, [
                     'Error: {}'.format(e),
                     'Error',
                     'E',