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 handle_bits(self, samplenum):
  75         if self.options['type'] == 'RGB':
  76             if len(self.bits) == 24:
  77                 grb = reduce(lambda a, b: (a << 1) | b, self.bits)
  78                 rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0x0000ff)
  79                 self.put(self.ss_packet, samplenum, self.out_ann,
  80                          [ANN_RGB, ['#%06x' % rgb]])
  81                 self.bits = []
  82                 self.ss_packet = None
  83         else:
  84             if len(self.bits) == 32:
  85                 grb = reduce(lambda a, b: (a << 1) | b, self.bits)
  86                 rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0xff0000ff)
  87                 self.put(self.ss_packet, samplenum, self.out_ann,
  88                          [ANN_RGB, ['#%08x' % rgb]])
  89                 self.bits = []
  90                 self.ss_packet = None
  91
  92     def decode(self):
  93         if not self.samplerate:
  94             raise SamplerateError('Cannot decode without samplerate.')
  95
  96         while True:
  97             # TODO: Come up with more appropriate self.wait() conditions.
  98             (pin,) = self.wait()
  99
 100             if self.oldpin is None:
 101                 self.oldpin = pin
 102                 continue
 103
 104             # Check RESET condition (manufacturer recommends 50 usec minimal,
 105             # but real minimum is ~10 usec).
 106             if not self.inreset and not pin and self.es is not None and \
 107                     self.ss is not None and \
 108                     (self.samplenum - self.es) / self.samplerate > 50e-6:
 109
 110                 # Decode last bit value.
 111                 tH = (self.es - self.ss) / self.samplerate
 112                 bit_ = True if tH >= 625e-9 else False
 113
 114                 self.bits.append(bit_)
 115                 self.handle_bits(self.es)
 116
 117                 self.put(self.ss, self.es, self.out_ann, [ANN_BIT, ['%d' % bit_]])
 118                 self.put(self.es, self.samplenum, self.out_ann,
 119                          [ANN_RESET, ['RESET', 'RST', 'R']])
 120
 121                 self.inreset = True
 122                 self.bits = []
 123                 self.ss_packet = None
 124                 self.ss = None
 125
 126             if not self.oldpin and pin:
 127                 # Rising edge.
 128                 if self.ss and self.es:
 129                     period = self.samplenum - self.ss
 130                     duty = self.es - self.ss
 131                     # Ideal duty for T0H: 33%, T1H: 66%.
 132                     bit_ = (duty / period) > 0.5
 133
 134                     self.put(self.ss, self.samplenum, self.out_ann,
 135                              [ANN_BIT, ['%d' % bit_]])
 136
 137                     self.bits.append(bit_)
 138                     self.handle_bits(self.samplenum)
 139
 140                 if self.ss_packet is None:
 141                     self.ss_packet = self.samplenum
 142
 143                 self.ss = self.samplenum
 144
 145             elif self.oldpin and not pin:
 146                 # Falling edge.
 147                 self.inreset = False
 148                 self.es = self.samplenum
 149
 150             self.oldpin = pin