]>
Commit | Line | Data |
---|---|---|
5e6fa9cc GY |
1 | ## |
2 | ## This file is part of the libsigrokdecode project. | |
3 | ## | |
4 | ## Copyright (C) 2014 Gump Yang <gump.yang@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 2 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 | |
4539e9ca | 17 | ## along with this program; if not, see <http://www.gnu.org/licenses/>. |
5e6fa9cc GY |
18 | ## |
19 | ||
20 | import sigrokdecode as srd | |
12fecc8f | 21 | from .lists import * |
5e6fa9cc | 22 | |
21cda951 UH |
23 | class SamplerateError(Exception): |
24 | pass | |
25 | ||
34ed4b3f GS |
26 | class Pin: |
27 | IR, = range(1) | |
28 | ||
29 | class Ann: | |
30 | BIT, AGC, LONG_PAUSE, SHORT_PAUSE, STOP_BIT, \ | |
31 | LEADER_CODE, ADDR, ADDR_INV, CMD, CMD_INV, REPEAT_CODE, \ | |
32 | REMOTE, WARN = range(13) | |
33 | ||
5e6fa9cc | 34 | class Decoder(srd.Decoder): |
5844bb0f | 35 | api_version = 3 |
00962e76 UH |
36 | id = 'ir_nec' |
37 | name = 'IR NEC' | |
38 | longname = 'IR NEC' | |
39 | desc = 'NEC infrared remote control protocol.' | |
5e6fa9cc GY |
40 | license = 'gplv2+' |
41 | inputs = ['logic'] | |
6cbba91f | 42 | outputs = [] |
d6d8a8a4 | 43 | tags = ['IR'] |
6a15597a | 44 | channels = ( |
5e6fa9cc | 45 | {'id': 'ir', 'name': 'IR', 'desc': 'Data line'}, |
bee57ee8 UH |
46 | ) |
47 | options = ( | |
48 | {'id': 'polarity', 'desc': 'Polarity', 'default': 'active-low', | |
49 | 'values': ('active-low', 'active-high')}, | |
fb1870b0 | 50 | {'id': 'cd_freq', 'desc': 'Carrier Frequency', 'default': 0}, |
bee57ee8 UH |
51 | ) |
52 | annotations = ( | |
53 | ('bit', 'Bit'), | |
54 | ('agc-pulse', 'AGC pulse'), | |
55 | ('longpause', 'Long pause'), | |
56 | ('shortpause', 'Short pause'), | |
57 | ('stop-bit', 'Stop bit'), | |
58 | ('leader-code', 'Leader code'), | |
59 | ('addr', 'Address'), | |
60 | ('addr-inv', 'Address#'), | |
61 | ('cmd', 'Command'), | |
62 | ('cmd-inv', 'Command#'), | |
63 | ('repeat-code', 'Repeat code'), | |
64 | ('remote', 'Remote'), | |
e144452b | 65 | ('warning', 'Warning'), |
bee57ee8 | 66 | ) |
5e6fa9cc | 67 | annotation_rows = ( |
34ed4b3f GS |
68 | ('bits', 'Bits', (Ann.BIT, Ann.AGC, Ann.LONG_PAUSE, Ann.SHORT_PAUSE, Ann.STOP_BIT)), |
69 | ('fields', 'Fields', (Ann.LEADER_CODE, Ann.ADDR, Ann.ADDR_INV, Ann.CMD, Ann.CMD_INV, Ann.REPEAT_CODE)), | |
70 | ('remote-vals', 'Remote', (Ann.REMOTE,)), | |
71 | ('warnings', 'Warnings', (Ann.WARN,)), | |
5e6fa9cc GY |
72 | ) |
73 | ||
5e6fa9cc GY |
74 | def putx(self, data): |
75 | self.put(self.ss_start, self.samplenum, self.out_ann, data) | |
76 | ||
77 | def putb(self, data): | |
78 | self.put(self.ss_bit, self.samplenum, self.out_ann, data) | |
79 | ||
70835fd4 UH |
80 | def putd(self, data): |
81 | name = self.state.title() | |
34ed4b3f GS |
82 | d = {'ADDRESS': Ann.ADDR, 'ADDRESS#': Ann.ADDR_INV, |
83 | 'COMMAND': Ann.CMD, 'COMMAND#': Ann.CMD_INV} | |
70835fd4 UH |
84 | s = {'ADDRESS': ['ADDR', 'A'], 'ADDRESS#': ['ADDR#', 'A#'], |
85 | 'COMMAND': ['CMD', 'C'], 'COMMAND#': ['CMD#', 'C#']} | |
34ed4b3f GS |
86 | self.putx([d[self.state], [ |
87 | '{}: 0x{:02X}'.format(name, data), | |
88 | '{}: 0x{:02X}'.format(s[self.state][0], data), | |
89 | '{}: 0x{:02X}'.format(s[self.state][1], data), | |
90 | s[self.state][1], | |
91 | ]]) | |
70835fd4 UH |
92 | |
93 | def putstop(self, ss): | |
94 | self.put(ss, ss + self.stop, self.out_ann, | |
34ed4b3f | 95 | [Ann.STOP_BIT, ['Stop bit', 'Stop', 'St', 'S']]) |
70835fd4 UH |
96 | |
97 | def putpause(self, p): | |
98 | self.put(self.ss_start, self.ss_other_edge, self.out_ann, | |
34ed4b3f GS |
99 | [Ann.AGC, ['AGC pulse', 'AGC', 'A']]) |
100 | idx = Ann.LONG_PAUSE if p == 'Long' else Ann.SHORT_PAUSE | |
101 | self.put(self.ss_other_edge, self.samplenum, self.out_ann, [idx, [ | |
102 | '{} pause'.format(p), | |
103 | '{}-pause'.format(p[0]), | |
104 | '{}P'.format(p[0]), | |
105 | 'P', | |
106 | ]]) | |
70835fd4 | 107 | |
12fecc8f UH |
108 | def putremote(self): |
109 | dev = address.get(self.addr, 'Unknown device') | |
110 | buttons = command.get(self.addr, None) | |
111 | if buttons is None: | |
112 | btn = ['Unknown', 'Unk'] | |
113 | else: | |
114 | btn = buttons.get(self.cmd, ['Unknown', 'Unk']) | |
34ed4b3f GS |
115 | self.put(self.ss_remote, self.ss_bit + self.stop, self.out_ann, [Ann.REMOTE, [ |
116 | '{}: {}'.format(dev, btn[0]), | |
117 | '{}: {}'.format(dev, btn[1]), | |
118 | '{}'.format(btn[1]), | |
119 | ]]) | |
12fecc8f | 120 | |
92b7b49f | 121 | def __init__(self): |
10aeb8ea GS |
122 | self.reset() |
123 | ||
124 | def reset(self): | |
5e6fa9cc | 125 | self.state = 'IDLE' |
12fecc8f | 126 | self.ss_bit = self.ss_start = self.ss_other_edge = self.ss_remote = 0 |
5844bb0f | 127 | self.data = self.count = self.active = None |
12fecc8f | 128 | self.addr = self.cmd = None |
5e6fa9cc GY |
129 | |
130 | def start(self): | |
5e6fa9cc | 131 | self.out_ann = self.register(srd.OUTPUT_ANN) |
5844bb0f | 132 | |
5e6fa9cc GY |
133 | def metadata(self, key, value): |
134 | if key == srd.SRD_CONF_SAMPLERATE: | |
135 | self.samplerate = value | |
82ea183f | 136 | self.tolerance = 0.05 # +/-5% |
73fc79e0 UH |
137 | self.lc = int(self.samplerate * 0.0135) - 1 # 13.5ms |
138 | self.rc = int(self.samplerate * 0.01125) - 1 # 11.25ms | |
139 | self.dazero = int(self.samplerate * 0.001125) - 1 # 1.125ms | |
140 | self.daone = int(self.samplerate * 0.00225) - 1 # 2.25ms | |
70835fd4 | 141 | self.stop = int(self.samplerate * 0.000652) - 1 # 0.652ms |
5e6fa9cc | 142 | |
82ea183f GM |
143 | def compare_with_tolerance(self, measured, base): |
144 | return (measured >= base * (1 - self.tolerance) | |
145 | and measured <= base * (1 + self.tolerance)) | |
146 | ||
70835fd4 | 147 | def handle_bit(self, tick): |
5bb61a25 | 148 | ret = None |
82ea183f | 149 | if self.compare_with_tolerance(tick, self.dazero): |
5e6fa9cc | 150 | ret = 0 |
82ea183f | 151 | elif self.compare_with_tolerance(tick, self.daone): |
5e6fa9cc | 152 | ret = 1 |
5bb61a25 | 153 | if ret in (0, 1): |
34ed4b3f | 154 | self.putb([Ann.BIT, ['{:d}'.format(ret)]]) |
5bb61a25 | 155 | self.data |= (ret << self.count) # LSB-first |
5e6fa9cc | 156 | self.count = self.count + 1 |
5e6fa9cc | 157 | self.ss_bit = self.samplenum |
5e6fa9cc | 158 | |
70835fd4 | 159 | def data_ok(self): |
73fc79e0 | 160 | ret, name = (self.data >> 8) & (self.data & 0xff), self.state.title() |
70835fd4 | 161 | if self.count == 8: |
12fecc8f UH |
162 | if self.state == 'ADDRESS': |
163 | self.addr = self.data | |
164 | if self.state == 'COMMAND': | |
165 | self.cmd = self.data | |
70835fd4 UH |
166 | self.putd(self.data) |
167 | self.ss_start = self.samplenum | |
168 | return True | |
5e6fa9cc | 169 | if ret == 0: |
5bb61a25 | 170 | self.putd(self.data >> 8) |
5e6fa9cc | 171 | else: |
34ed4b3f | 172 | self.putx([Ann.WARN, ['{} error: 0x{:04X}'.format(name, self.data)]]) |
5e6fa9cc GY |
173 | self.data = self.count = 0 |
174 | self.ss_bit = self.ss_start = self.samplenum | |
70835fd4 | 175 | return ret == 0 |
5e6fa9cc | 176 | |
5844bb0f | 177 | def decode(self): |
21cda951 UH |
178 | if not self.samplerate: |
179 | raise SamplerateError('Cannot decode without samplerate.') | |
fb1870b0 GS |
180 | |
181 | cd_count = None | |
182 | if self.options['cd_freq']: | |
183 | cd_count = int(self.samplerate / self.options['cd_freq']) + 1 | |
1865f48d PM |
184 | prev_ir = None |
185 | ||
186 | self.active = 0 if self.options['polarity'] == 'active-low' else 1 | |
fb1870b0 | 187 | |
5844bb0f | 188 | while True: |
fb1870b0 GS |
189 | # Detect changes in the presence of an active input signal. |
190 | # The decoder can either be fed an already filtered RX signal | |
191 | # or optionally can detect the presence of a carrier. Periods | |
192 | # of inactivity (signal changes slower than the carrier freq, | |
193 | # if specified) pass on the most recently sampled level. This | |
194 | # approach works for filtered and unfiltered input alike, and | |
195 | # only slightly extends the active phase of input signals with | |
196 | # carriers included by one period of the carrier frequency. | |
197 | # IR based communication protocols can cope with this slight | |
198 | # inaccuracy just fine by design. Enabling carrier detection | |
199 | # on already filtered signals will keep the length of their | |
200 | # active period, but will shift their signal changes by one | |
201 | # carrier period before they get passed to decoding logic. | |
202 | if cd_count: | |
34ed4b3f | 203 | (cur_ir,) = self.wait([{Pin.IR: 'e'}, {'skip': cd_count}]) |
fb1870b0 GS |
204 | if self.matched[0]: |
205 | cur_ir = self.active | |
206 | if cur_ir == prev_ir: | |
207 | continue | |
208 | prev_ir = cur_ir | |
209 | self.ir = cur_ir | |
210 | else: | |
34ed4b3f | 211 | (self.ir,) = self.wait({Pin.IR: 'e'}) |
00962e76 | 212 | |
70835fd4 | 213 | if self.ir != self.active: |
5844bb0f | 214 | # Save the non-active edge, then wait for the next edge. |
70835fd4 | 215 | self.ss_other_edge = self.samplenum |
5e6fa9cc GY |
216 | continue |
217 | ||
73fc79e0 UH |
218 | b = self.samplenum - self.ss_bit |
219 | ||
220 | # State machine. | |
221 | if self.state == 'IDLE': | |
82ea183f | 222 | if self.compare_with_tolerance(b, self.lc): |
70835fd4 | 223 | self.putpause('Long') |
34ed4b3f | 224 | self.putx([Ann.LEADER_CODE, ['Leader code', 'Leader', 'LC', 'L']]) |
12fecc8f | 225 | self.ss_remote = self.ss_start |
73fc79e0 UH |
226 | self.data = self.count = 0 |
227 | self.state = 'ADDRESS' | |
82ea183f | 228 | elif self.compare_with_tolerance(b, self.rc): |
70835fd4 UH |
229 | self.putpause('Short') |
230 | self.putstop(self.samplenum) | |
231 | self.samplenum += self.stop | |
34ed4b3f | 232 | self.putx([Ann.REPEAT_CODE, ['Repeat code', 'Repeat', 'RC', 'R']]) |
73fc79e0 UH |
233 | self.data = self.count = 0 |
234 | self.ss_bit = self.ss_start = self.samplenum | |
235 | elif self.state == 'ADDRESS': | |
70835fd4 UH |
236 | self.handle_bit(b) |
237 | if self.count == 8: | |
238 | self.state = 'ADDRESS#' if self.data_ok() else 'IDLE' | |
239 | elif self.state == 'ADDRESS#': | |
240 | self.handle_bit(b) | |
241 | if self.count == 16: | |
242 | self.state = 'COMMAND' if self.data_ok() else 'IDLE' | |
73fc79e0 | 243 | elif self.state == 'COMMAND': |
70835fd4 UH |
244 | self.handle_bit(b) |
245 | if self.count == 8: | |
246 | self.state = 'COMMAND#' if self.data_ok() else 'IDLE' | |
247 | elif self.state == 'COMMAND#': | |
248 | self.handle_bit(b) | |
249 | if self.count == 16: | |
250 | self.state = 'STOP' if self.data_ok() else 'IDLE' | |
251 | elif self.state == 'STOP': | |
252 | self.putstop(self.ss_bit) | |
12fecc8f | 253 | self.putremote() |
70835fd4 UH |
254 | self.ss_bit = self.ss_start = self.samplenum |
255 | self.state = 'IDLE' |