rgb_led_ws281x: use symbolic names for annotation classes

[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..0591e95ea9e1bf4a4d0da1c2bee7169f197f4c49 100644 (file)
--- a/decoders/rgb_led_ws281x/pd.py
+++ b/decoders/rgb_led_ws281x/pd.py
@@ -23,6 +23,8 @@ from functools import reduce
 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):
@@ -65,13 +72,22 @@ class Decoder(srd.Decoder):
             self.samplerate = value
 
     def handle_bits(self, samplenum):
-        if len(self.bits) == 24:
-            grb = reduce(lambda a, b: (a << 1) | b, self.bits)
-            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
+        if self.options['type'] == 'RGB':
+            if len(self.bits) == 24:
+                grb = reduce(lambda a, b: (a << 1) | b, self.bits)
+                rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0x0000ff)
+                self.put(self.ss_packet, samplenum, self.out_ann,
+                         [ANN_RGB, ['#%06x' % rgb]])
+                self.bits = []
+                self.ss_packet = None
+        else:
+            if len(self.bits) == 32:
+                grb = reduce(lambda a, b: (a << 1) | b, self.bits)
+                rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0xff0000ff)
+                self.put(self.ss_packet, samplenum, self.out_ann,
+                         [ANN_RGB, ['#%08x' % rgb]])
+                self.bits = []
+                self.ss_packet = None
 
     def decode(self):
         if not self.samplerate:
@@ -88,6 +104,7 @@ 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.
@@ -97,9 +114,9 @@ class Decoder(srd.Decoder):
                 self.bits.append(bit_)
                 self.handle_bits(self.es)
 
-                self.put(self.ss, self.es, self.out_ann, [0, ['%d' % bit_]])
+                self.put(self.ss, self.es, self.out_ann, [ANN_BIT, ['%d' % bit_]])
                 self.put(self.es, self.samplenum, self.out_ann,
-                         [1, ['RESET', 'RST', 'R']])
+                         [ANN_RESET, ['RESET', 'RST', 'R']])
 
                 self.inreset = True
                 self.bits = []
@@ -115,7 +132,7 @@ class Decoder(srd.Decoder):
                     bit_ = (duty / period) > 0.5
 
                     self.put(self.ss, self.samplenum, self.out_ann,
-                             [0, ['%d' % bit_]])
+                             [ANN_BIT, ['%d' % bit_]])
 
                     self.bits.append(bit_)
                     self.handle_bits(self.samplenum)