decoders/rgb_led_ws281x/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2016 Vladimir Ermakov <vooon341@gmail.com>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 3 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21 from functools import reduce
  22
  23 class SamplerateError(Exception):
  24     pass
  25
  26 ( ANN_BIT, ANN_RESET, ANN_RGB, ) = range(3)
  27
  28 class Decoder(srd.Decoder):
  29     api_version = 3
  30     id = 'rgb_led_ws281x'
  31     name = 'RGB LED (WS281x)'
  32     longname = 'RGB LED string decoder (WS281x)'
  33     desc = 'RGB LED string protocol (WS281x).'
  34     license = 'gplv3+'
  35     inputs = ['logic']
  36     outputs = []
  37     tags = ['Display', 'IC']
  38     channels = (
  39         {'id': 'din', 'name': 'DIN', 'desc': 'DIN data line'},
  40     )
  41     annotations = (
  42         ('bit', 'Bit'),
  43         ('reset', 'RESET'),
  44         ('rgb', 'RGB'),
  45     )
  46     annotation_rows = (
  47         ('bits', 'Bits', (ANN_BIT, ANN_RESET,)),
  48         ('rgb-vals', 'RGB values', (ANN_RGB,)),
  49     )
  50     options = (
  51         {'id': 'type', 'desc': 'RGB or RGBW', 'default': 'RGB',
  52          'values': ('RGB', 'RGBW')},
  53     )
  54
  55     def __init__(self):
  56         self.reset()
  57
  58     def reset(self):
  59         self.samplerate = None
  60         self.oldpin = None
  61         self.ss_packet = None
  62         self.ss = None
  63         self.es = None
  64         self.bits = []
  65         self.inreset = False
  66
  67     def start(self):
  68         self.out_ann = self.register(srd.OUTPUT_ANN)
  69
  70     def metadata(self, key, value):
  71         if key == srd.SRD_CONF_SAMPLERATE:
  72             self.samplerate = value
  73
  74     def putg(self, ss, es, cls, text):
  75         self.put(ss, es, self.out_ann, [cls, text])
  76
  77     def handle_bits(self, samplenum):
  78         if self.options['type'] == 'RGB':
  79             if len(self.bits) == 24:
  80                 grb = reduce(lambda a, b: (a << 1) | b, self.bits)
  81                 rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0x0000ff)
  82                 text = ['#{:06x}'.format(rgb)]
  83                 self.putg(self.ss_packet, samplenum, ANN_RGB, text)
  84                 self.bits = []
  85                 self.ss_packet = None
  86         else:
  87             if len(self.bits) == 32:
  88                 grb = reduce(lambda a, b: (a << 1) | b, self.bits)
  89                 rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0xff0000ff)
  90                 text = ['#{:08x}'.format(rgb)]
  91                 self.putg(self.ss_packet, samplenum, ANN_RGB, text)
  92                 self.bits = []
  93                 self.ss_packet = None
  94
  95     def decode(self):
  96         if not self.samplerate:
  97             raise SamplerateError('Cannot decode without samplerate.')
  98
  99         while True:
 100             # TODO: Come up with more appropriate self.wait() conditions.
 101             (pin,) = self.wait()
 102
 103             if self.oldpin is None:
 104                 self.oldpin = pin
 105                 continue
 106
 107             # Check RESET condition (manufacturer recommends 50 usec minimal,
 108             # but real minimum is ~10 usec).
 109             if not self.inreset and not pin and self.es is not None and \
 110                     self.ss is not None and \
 111                     (self.samplenum - self.es) / self.samplerate > 50e-6:
 112
 113                 # Decode last bit value.
 114                 tH = (self.es - self.ss) / self.samplerate
 115                 bit_ = True if tH >= 625e-9 else False
 116
 117                 self.bits.append(bit_)
 118                 self.handle_bits(self.es)
 119
 120                 text = ['{:d}'.format(bit_)]
 121                 self.putg(self.ss, self.es, ANN_BIT, text)
 122                 text = ['RESET', 'RST', 'R']
 123                 self.putg(self.es, self.samplenum, ANN_RESET, text)
 124
 125                 self.inreset = True
 126                 self.bits = []
 127                 self.ss_packet = None
 128                 self.ss = None
 129
 130             if not self.oldpin and pin:
 131                 # Rising edge.
 132                 if self.ss and self.es:
 133                     period = self.samplenum - self.ss
 134                     duty = self.es - self.ss
 135                     # Ideal duty for T0H: 33%, T1H: 66%.
 136                     bit_ = (duty / period) > 0.5
 137
 138                     text = ['{:d}'.format(bit_)]
 139                     self.putg(self.ss, self.samplenum, ANN_BIT, text)
 140
 141                     self.bits.append(bit_)
 142                     self.handle_bits(self.samplenum)
 143
 144                 if self.ss_packet is None:
 145                     self.ss_packet = self.samplenum
 146
 147                 self.ss = self.samplenum
 148
 149             elif self.oldpin and not pin:
 150                 # Falling edge.
 151                 self.inreset = False
 152                 self.es = self.samplenum
 153
 154             self.oldpin = pin