license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / 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 class Decoder(srd.Decoder):
27     api_version = 2
28     id = 'rgb_led_ws281x'
29     name = 'RGB LED (WS281x)'
30     longname = 'RGB LED string decoder (WS281x)'
31     desc = 'RGB LED string protocol (WS281x).'
32     license = 'gplv3+'
33     inputs = ['logic']
34     outputs = ['rgb_led_ws281x']
35     channels = (
36         {'id': 'din', 'name': 'DIN', 'desc': 'DIN data line'},
37     )
38     annotations = (
39         ('bit', 'Bit'),
40         ('reset', 'RESET'),
41         ('rgb', 'RGB'),
42     )
43     annotation_rows = (
44         ('bit', 'Bits', (0, 1)),
45         ('rgb', 'RGB', (2,)),
46     )
47
48     def __init__(self):
49         self.samplerate = None
50         self.oldpin = None
51         self.ss_packet = None
52         self.ss = None
53         self.es = None
54         self.bits = []
55         self.inreset = False
56
57     def start(self):
58         self.out_ann = self.register(srd.OUTPUT_ANN)
59
60     def metadata(self, key, value):
61         if key == srd.SRD_CONF_SAMPLERATE:
62             self.samplerate = value
63
64     def handle_bits(self, samplenum):
65         if len(self.bits) == 24:
66             grb = reduce(lambda a, b: (a << 1) | b, self.bits)
67             rgb = (grb & 0xff0000) >> 8 | (grb & 0x00ff00) << 8 | (grb & 0x0000ff)
68             self.put(self.ss_packet, samplenum, self.out_ann,
69                      [2, ['#%06x' % rgb]])
70             self.bits = []
71             self.ss_packet = None
72
73     def decode(self, ss, es, data):
74         if not self.samplerate:
75             raise SamplerateError('Cannot decode without samplerate.')
76
77         for (samplenum, (pin, )) in data:
78             if self.oldpin is None:
79                 self.oldpin = pin
80                 continue
81
82             # Check RESET condition (manufacturer recommends 50 usec minimal,
83             # but real minimum is ~10 usec).
84             if not self.inreset and not pin and self.es is not None and \
85                     (samplenum - self.es) / self.samplerate > 50e-6:
86
87                 # Decode last bit value.
88                 tH = (self.es - self.ss) / self.samplerate
89                 bit_ = True if tH >= 625e-9 else False
90
91                 self.bits.append(bit_)
92                 self.handle_bits(self.es)
93
94                 self.put(self.ss, self.es, self.out_ann, [0, ['%d' % bit_]])
95                 self.put(self.es, samplenum, self.out_ann,
96                          [1, ['RESET', 'RST', 'R']])
97
98                 self.inreset = True
99                 self.bits = []
100                 self.ss_packet = None
101                 self.ss = None
102
103             if not self.oldpin and pin:
104                 # Rising edge.
105                 if self.ss and self.es:
106                     period = samplenum - self.ss
107                     duty = self.es - self.ss
108                     # Ideal duty for T0H: 33%, T1H: 66%.
109                     bit_ = (duty / period) > 0.5
110
111                     self.put(self.ss, samplenum, self.out_ann,
112                              [0, ['%d' % bit_]])
113
114                     self.bits.append(bit_)
115                     self.handle_bits(samplenum)
116
117                 if self.ss_packet is None:
118                     self.ss_packet = samplenum
119
120                 self.ss = samplenum
121
122             elif self.oldpin and not pin:
123                 # Falling edge.
124                 self.inreset = False
125                 self.es = samplenum
126
127             self.oldpin = pin