rgb_led_ws281x: refactor bit/bits handling, use more common code

[libsigrokdecode.git] / decoders / rgb_led_ws281x / pd.py

diff --git a/decoders/rgb_led_ws281x/pd.py b/decoders/rgb_led_ws281x/pd.py
index b4f7c581d7e8f14b971fef5a912a56c9c42be64b..295740515d41ef6286c1937c102a47d7a4fe30ba 100644 (file)
--- a/decoders/rgb_led_ws281x/pd.py
+++ b/decoders/rgb_led_ws281x/pd.py
@@ -18,11 +18,13 @@
 ##
 
 import sigrokdecode as srd
-from functools import reduce
+from common.srdhelper import bitpack_msb
 
 class SamplerateError(Exception):
     pass
 
+( ANN_BIT, ANN_RESET, ANN_RGB, ) = range(3)
+
 class Decoder(srd.Decoder):
     api_version = 3
     id = 'rgb_led_ws281x'
@@ -31,7 +33,8 @@ class Decoder(srd.Decoder):
     desc = 'RGB LED string protocol (WS281x).'
     license = 'gplv3+'
     inputs = ['logic']
-    outputs = ['rgb_led_ws281x']
+    outputs = []
+    tags = ['Display', 'IC']
     channels = (
         {'id': 'din', 'name': 'DIN', 'desc': 'DIN data line'},
     )
@@ -41,8 +44,12 @@ class Decoder(srd.Decoder):
         ('rgb', 'RGB'),
     )
     annotation_rows = (
-        ('bit', 'Bits', (0, 1)),
-        ('rgb', 'RGB', (2,)),
+        ('bits', 'Bits', (ANN_BIT, ANN_RESET,)),
+        ('rgb-vals', 'RGB values', (ANN_RGB,)),
+    )
+    options = (
+        {'id': 'type', 'desc': 'RGB or RGBW', 'default': 'RGB',
+         'values': ('RGB', 'RGBW')},
     )
 
     def __init__(self):
@@ -51,7 +58,6 @@ class Decoder(srd.Decoder):
     def reset(self):
         self.samplerate = None
         self.oldpin = None
-        self.ss_packet = None
         self.ss = None
         self.es = None
         self.bits = []
@@ -64,18 +70,38 @@ class Decoder(srd.Decoder):
         if key == srd.SRD_CONF_SAMPLERATE:
             self.samplerate = value
 
-    def handle_bits(self, samplenum):
-        if len(self.bits) == 24:
-            grb = reduce(lambda a, b: (a << 1) | b, self.bits)
+    def putg(self, ss, es, cls, text):
+        self.put(ss, es, self.out_ann, [cls, text])
+
+    def handle_bits(self):
+        if len(self.bits) < self.need_bits:
+            return
+        grb = bitpack_msb(self.bits, 0)
+        if self.options['type'] == 'RGB':
             rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0x0000ff)
-            self.put(self.ss_packet, samplenum, self.out_ann,
-                     [2, ['#%06x' % rgb]])
-            self.bits = []
-            self.ss_packet = None
+            text = '#{:06x}'.format(rgb)
+        else:
+            rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0xff0000ff)
+            text = '#{:08x}'.format(rgb)
+        ss_packet, es_packet = self.bits[0][1], self.bits[-1][2]
+        self.putg(ss_packet, es_packet, ANN_RGB, [text])
+        self.bits.clear()
+
+    def handle_bit(self, ss, es, value, ann_late = False):
+        if not ann_late:
+            text = ['{:d}'.format(value)]
+            self.putg(ss, es, ANN_BIT, text)
+        item = (value, ss, es)
+        self.bits.append(item)
+        self.handle_bits()
+        if ann_late:
+            text = ['{:d}'.format(value)]
+            self.putg(ss, es, ANN_BIT, text)
 
     def decode(self):
         if not self.samplerate:
             raise SamplerateError('Cannot decode without samplerate.')
+        self.need_bits = len(self.options['type']) * 8
 
         while True:
             # TODO: Come up with more appropriate self.wait() conditions.
@@ -88,22 +114,20 @@ class Decoder(srd.Decoder):
             # Check RESET condition (manufacturer recommends 50 usec minimal,
             # but real minimum is ~10 usec).
             if not self.inreset and not pin and self.es is not None and \
+                    self.ss is not None and \
                     (self.samplenum - self.es) / self.samplerate > 50e-6:
 
                 # Decode last bit value.
                 tH = (self.es - self.ss) / self.samplerate
                 bit_ = True if tH >= 625e-9 else False
 
-                self.bits.append(bit_)
-                self.handle_bits(self.es)
+                self.handle_bit(self.ss, self.es, bit_, True)
 
-                self.put(self.ss, self.es, self.out_ann, [0, ['%d' % bit_]])
-                self.put(self.es, self.samplenum, self.out_ann,
-                         [1, ['RESET', 'RST', 'R']])
+                text = ['RESET', 'RST', 'R']
+                self.putg(self.es, self.samplenum, ANN_RESET, text)
 
                 self.inreset = True
-                self.bits = []
-                self.ss_packet = None
+                self.bits.clear()
                 self.ss = None
 
             if not self.oldpin and pin:
@@ -113,16 +137,7 @@ class Decoder(srd.Decoder):
                     duty = self.es - self.ss
                     # Ideal duty for T0H: 33%, T1H: 66%.
                     bit_ = (duty / period) > 0.5
-
-                    self.put(self.ss, self.samplenum, self.out_ann,
-                             [0, ['%d' % bit_]])
-
-                    self.bits.append(bit_)
-                    self.handle_bits(self.samplenum)
-
-                if self.ss_packet is None:
-                    self.ss_packet = self.samplenum
-
+                    self.handle_bit(self.ss, self.samplenum, bit_)
                 self.ss = self.samplenum
 
             elif self.oldpin and not pin: