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 6f659609614e9dbfc1c3ff9dfb6e33e5142b33f2..0591e95ea9e1bf4a4d0da1c2bee7169f197f4c49 100644 (file)
--- a/decoders/rgb_led_ws281x/pd.py
+++ b/decoders/rgb_led_ws281x/pd.py
@@ -14,8 +14,7 @@
 ## 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/>.
 ##
 
 import sigrokdecode as srd
@@ -24,15 +23,18 @@ from functools import reduce
 class SamplerateError(Exception):
     pass
 
+( ANN_BIT, ANN_RESET, ANN_RGB, ) = range(3)
+
 class Decoder(srd.Decoder):
-    api_version = 2
+    api_version = 3
     id = 'rgb_led_ws281x'
     name = 'RGB LED (WS281x)'
     longname = 'RGB LED string decoder (WS281x)'
     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'},
     )
@@ -42,11 +44,18 @@ 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):
+        self.reset()
+
+    def reset(self):
         self.samplerate = None
         self.oldpin = None
         self.ss_packet = None
@@ -63,19 +72,31 @@ 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
-
-    def decode(self, ss, es, data):
+        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:
             raise SamplerateError('Cannot decode without samplerate.')
 
-        for (samplenum, (pin, )) in data:
+        while True:
+            # TODO: Come up with more appropriate self.wait() conditions.
+            (pin,) = self.wait()
+
             if self.oldpin is None:
                 self.oldpin = pin
                 continue
@@ -83,7 +104,8 @@ 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 \
-                    (samplenum - self.es) / self.samplerate > 50e-6:
+                    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
@@ -92,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.es, samplenum, self.out_ann,
-                         [1, ['RESET', 'RST', 'R']])
+                self.put(self.ss, self.es, self.out_ann, [ANN_BIT, ['%d' % bit_]])
+                self.put(self.es, self.samplenum, self.out_ann,
+                         [ANN_RESET, ['RESET', 'RST', 'R']])
 
                 self.inreset = True
                 self.bits = []
@@ -104,25 +126,25 @@ class Decoder(srd.Decoder):
             if not self.oldpin and pin:
                 # Rising edge.
                 if self.ss and self.es:
-                    period = samplenum - self.ss
+                    period = self.samplenum - self.ss
                     duty = self.es - self.ss
                     # Ideal duty for T0H: 33%, T1H: 66%.
                     bit_ = (duty / period) > 0.5
 
-                    self.put(self.ss, samplenum, self.out_ann,
-                             [0, ['%d' % bit_]])
+                    self.put(self.ss, self.samplenum, self.out_ann,
+                             [ANN_BIT, ['%d' % bit_]])
 
                     self.bits.append(bit_)
-                    self.handle_bits(samplenum)
+                    self.handle_bits(self.samplenum)
 
                 if self.ss_packet is None:
-                    self.ss_packet = samplenum
+                    self.ss_packet = self.samplenum
 
-                self.ss = samplenum
+                self.ss = self.samplenum
 
             elif self.oldpin and not pin:
                 # Falling edge.
                 self.inreset = False
-                self.es = samplenum
+                self.es = self.samplenum
 
             self.oldpin = pin