2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2014 Gump Yang <gump.yang@gmail.com>
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.
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.
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/>.
20 import sigrokdecode as srd
23 class SamplerateError(Exception):
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)
34 class Decoder(srd.Decoder):
39 desc = 'NEC infrared remote control protocol.'
45 {'id': 'ir', 'name': 'IR', 'desc': 'Data line'},
48 {'id': 'polarity', 'desc': 'Polarity', 'default': 'active-low',
49 'values': ('active-low', 'active-high')},
50 {'id': 'cd_freq', 'desc': 'Carrier Frequency', 'default': 0},
54 ('agc-pulse', 'AGC pulse'),
55 ('longpause', 'Long pause'),
56 ('shortpause', 'Short pause'),
57 ('stop-bit', 'Stop bit'),
58 ('leader-code', 'Leader code'),
60 ('addr-inv', 'Address#'),
62 ('cmd-inv', 'Command#'),
63 ('repeat-code', 'Repeat code'),
65 ('warning', 'Warning'),
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,)),
75 self.put(self.ss_start, self.samplenum, self.out_ann, data)
78 self.put(self.ss_bit, self.samplenum, self.out_ann, data)
81 name = self.state.title()
82 d = {'ADDRESS': Ann.ADDR, 'ADDRESS#': Ann.ADDR_INV,
83 'COMMAND': Ann.CMD, 'COMMAND#': Ann.CMD_INV}
84 s = {'ADDRESS': ['ADDR', 'A'], 'ADDRESS#': ['ADDR#', 'A#'],
85 'COMMAND': ['CMD', 'C'], 'COMMAND#': ['CMD#', 'C#']}
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),
93 def putstop(self, ss):
94 self.put(ss, ss + self.stop, self.out_ann,
95 [Ann.STOP_BIT, ['Stop bit', 'Stop', 'St', 'S']])
97 def putpause(self, p):
98 self.put(self.ss_start, self.ss_other_edge, self.out_ann,
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]),
109 dev = address.get(self.addr, 'Unknown device')
110 buttons = command.get(self.addr, None)
112 btn = ['Unknown', 'Unk']
114 btn = buttons.get(self.cmd, ['Unknown', 'Unk'])
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]),
126 self.ss_bit = self.ss_start = self.ss_other_edge = self.ss_remote = 0
127 self.data = self.count = self.active = None
128 self.addr = self.cmd = None
131 self.out_ann = self.register(srd.OUTPUT_ANN)
133 def metadata(self, key, value):
134 if key == srd.SRD_CONF_SAMPLERATE:
135 self.samplerate = value
136 self.tolerance = 0.05 # +/-5%
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
141 self.stop = int(self.samplerate * 0.000652) - 1 # 0.652ms
143 def compare_with_tolerance(self, measured, base):
144 return (measured >= base * (1 - self.tolerance)
145 and measured <= base * (1 + self.tolerance))
147 def handle_bit(self, tick):
149 if self.compare_with_tolerance(tick, self.dazero):
151 elif self.compare_with_tolerance(tick, self.daone):
154 self.putb([Ann.BIT, ['{:d}'.format(ret)]])
155 self.data |= (ret << self.count) # LSB-first
156 self.count = self.count + 1
157 self.ss_bit = self.samplenum
160 ret, name = (self.data >> 8) & (self.data & 0xff), self.state.title()
162 if self.state == 'ADDRESS':
163 self.addr = self.data
164 if self.state == 'COMMAND':
167 self.ss_start = self.samplenum
170 self.putd(self.data >> 8)
172 self.putx([Ann.WARN, ['{} error: 0x{:04X}'.format(name, self.data)]])
173 self.data = self.count = 0
174 self.ss_bit = self.ss_start = self.samplenum
178 if not self.samplerate:
179 raise SamplerateError('Cannot decode without samplerate.')
182 if self.options['cd_freq']:
183 cd_count = int(self.samplerate / self.options['cd_freq']) + 1
186 self.active = 0 if self.options['polarity'] == 'active-low' else 1
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.
203 (cur_ir,) = self.wait([{Pin.IR: 'e'}, {'skip': cd_count}])
206 if cur_ir == prev_ir:
211 (self.ir,) = self.wait({Pin.IR: 'e'})
213 if self.ir != self.active:
214 # Save the non-active edge, then wait for the next edge.
215 self.ss_other_edge = self.samplenum
218 b = self.samplenum - self.ss_bit
221 if self.state == 'IDLE':
222 if self.compare_with_tolerance(b, self.lc):
223 self.putpause('Long')
224 self.putx([Ann.LEADER_CODE, ['Leader code', 'Leader', 'LC', 'L']])
225 self.ss_remote = self.ss_start
226 self.data = self.count = 0
227 self.state = 'ADDRESS'
228 elif self.compare_with_tolerance(b, self.rc):
229 self.putpause('Short')
230 self.putstop(self.samplenum)
231 self.samplenum += self.stop
232 self.putx([Ann.REPEAT_CODE, ['Repeat code', 'Repeat', 'RC', 'R']])
233 self.data = self.count = 0
234 self.ss_bit = self.ss_start = self.samplenum
235 elif self.state == 'ADDRESS':
238 self.state = 'ADDRESS#' if self.data_ok() else 'IDLE'
239 elif self.state == 'ADDRESS#':
242 self.state = 'COMMAND' if self.data_ok() else 'IDLE'
243 elif self.state == 'COMMAND':
246 self.state = 'COMMAND#' if self.data_ok() else 'IDLE'
247 elif self.state == 'COMMAND#':
250 self.state = 'STOP' if self.data_ok() else 'IDLE'
251 elif self.state == 'STOP':
252 self.putstop(self.ss_bit)
254 self.ss_bit = self.ss_start = self.samplenum