X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fir_nec%2Fpd.py;h=3ee3716b14bc3e572c521c02c0eb78916d5dc02f;hp=8a41a875ed714115f5056df9b32b09ae128bde33;hb=e144452bcdd5f2abbe6b6f3da41ad64f67e39def;hpb=70835fd4d2dcf2c67e2448b73f0b7008ddf9fe29 diff --git a/decoders/ir_nec/pd.py b/decoders/ir_nec/pd.py index 8a41a87..3ee3716 100644 --- a/decoders/ir_nec/pd.py +++ b/decoders/ir_nec/pd.py @@ -14,46 +14,53 @@ ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with this program; if not, write to the Free Software -## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +## along with this program; if not, see . ## import sigrokdecode as srd +from .lists import * + +class SamplerateError(Exception): + pass class Decoder(srd.Decoder): - api_version = 1 + api_version = 3 id = 'ir_nec' name = 'IR NEC' longname = 'IR NEC' desc = 'NEC infrared remote control protocol.' license = 'gplv2+' inputs = ['logic'] - outputs = ['ir_nec'] - probes = [ + outputs = [] + tags = ['IR'] + channels = ( {'id': 'ir', 'name': 'IR', 'desc': 'Data line'}, - ] - optional_probes = [] - options = { - 'polarity': ['Polarity', 'active-low'], - } - annotations = [ - ['bit', 'Bit'], - ['agc-pulse', 'AGC pulse'], - ['longpause', 'Long pause'], - ['shortpause', 'Short pause'], - ['stop-bit', 'Stop bit'], - ['leader-code', 'Leader code'], - ['addr', 'Address'], - ['addr-inv', 'Address#'], - ['cmd', 'Command'], - ['cmd-inv', 'Command#'], - ['repeat-code', 'Repeat code'], - ['warnings', 'Warnings'], - ] + ) + options = ( + {'id': 'polarity', 'desc': 'Polarity', 'default': 'active-low', + 'values': ('active-low', 'active-high')}, + {'id': 'cd_freq', 'desc': 'Carrier Frequency', 'default': 0}, + ) + annotations = ( + ('bit', 'Bit'), + ('agc-pulse', 'AGC pulse'), + ('longpause', 'Long pause'), + ('shortpause', 'Short pause'), + ('stop-bit', 'Stop bit'), + ('leader-code', 'Leader code'), + ('addr', 'Address'), + ('addr-inv', 'Address#'), + ('cmd', 'Command'), + ('cmd-inv', 'Command#'), + ('repeat-code', 'Repeat code'), + ('remote', 'Remote'), + ('warning', 'Warning'), + ) annotation_rows = ( ('bits', 'Bits', (0, 1, 2, 3, 4)), ('fields', 'Fields', (5, 6, 7, 8, 9, 10)), - ('warnings', 'Warnings', (11,)), + ('remote-vals', 'Remote', (11,)), + ('warnings', 'Warnings', (12,)), ) def putx(self, data): @@ -82,77 +89,125 @@ class Decoder(srd.Decoder): self.put(self.ss_other_edge, self.samplenum, self.out_ann, [idx, [p + ' pause', '%s-pause' % p[0], '%sP' % p[0], 'P']]) - def __init__(self, **kwargs): + def putremote(self): + dev = address.get(self.addr, 'Unknown device') + buttons = command.get(self.addr, None) + if buttons is None: + btn = ['Unknown', 'Unk'] + else: + btn = buttons.get(self.cmd, ['Unknown', 'Unk']) + self.put(self.ss_remote, self.ss_bit + self.stop, self.out_ann, + [11, ['%s: %s' % (dev, btn[0]), '%s: %s' % (dev, btn[1]), + '%s' % btn[1]]]) + + def __init__(self): + self.reset() + + def reset(self): self.state = 'IDLE' - self.ss_bit = self.ss_start = self.ss_other_edge = 0 - self.data = self.count = self.active = self.old_ir = None + self.ss_bit = self.ss_start = self.ss_other_edge = self.ss_remote = 0 + self.data = self.count = self.active = None + self.addr = self.cmd = None def start(self): - # self.out_python = self.register(srd.OUTPUT_PYTHON) self.out_ann = self.register(srd.OUTPUT_ANN) - self.active = 0 if self.options['polarity'] == 'active-low' else 1 - self.old_ir = 1 if self.active == 0 else 0 def metadata(self, key, value): if key == srd.SRD_CONF_SAMPLERATE: self.samplerate = value - self.margin = int(self.samplerate * 0.0001) - 1 # 0.1ms + self.tolerance = 0.05 # +/-5% self.lc = int(self.samplerate * 0.0135) - 1 # 13.5ms self.rc = int(self.samplerate * 0.01125) - 1 # 11.25ms self.dazero = int(self.samplerate * 0.001125) - 1 # 1.125ms self.daone = int(self.samplerate * 0.00225) - 1 # 2.25ms self.stop = int(self.samplerate * 0.000652) - 1 # 0.652ms + def compare_with_tolerance(self, measured, base): + return (measured >= base * (1 - self.tolerance) + and measured <= base * (1 + self.tolerance)) + def handle_bit(self, tick): - ret = 0xff - if tick in range(self.dazero - self.margin, self.dazero + self.margin): + ret = None + if self.compare_with_tolerance(tick, self.dazero): ret = 0 - elif tick in range(self.daone - self.margin, self.daone + self.margin): + elif self.compare_with_tolerance(tick, self.daone): ret = 1 - if ret < 2: + if ret in (0, 1): self.putb([0, ['%d' % ret]]) - self.data = self.data * 2 + ret + self.data |= (ret << self.count) # LSB-first self.count = self.count + 1 self.ss_bit = self.samplenum def data_ok(self): ret, name = (self.data >> 8) & (self.data & 0xff), self.state.title() if self.count == 8: + if self.state == 'ADDRESS': + self.addr = self.data + if self.state == 'COMMAND': + self.cmd = self.data self.putd(self.data) self.ss_start = self.samplenum return True if ret == 0: - self.putd(self.data & 0xff) + self.putd(self.data >> 8) else: - self.putx([11, ['%s error: 0x%04X' % (name, self.data)]]) + self.putx([12, ['%s error: 0x%04X' % (name, self.data)]]) self.data = self.count = 0 self.ss_bit = self.ss_start = self.samplenum return ret == 0 - def decode(self, ss, es, data): - if self.samplerate is None: - raise Exception("Cannot decode without samplerate.") - for (self.samplenum, pins) in data: - self.ir = pins[0] + def decode(self): + if not self.samplerate: + raise SamplerateError('Cannot decode without samplerate.') + + cd_count = None + if self.options['cd_freq']: + cd_count = int(self.samplerate / self.options['cd_freq']) + 1 + prev_ir = None + + self.active = 0 if self.options['polarity'] == 'active-low' else 1 + + while True: + # Detect changes in the presence of an active input signal. + # The decoder can either be fed an already filtered RX signal + # or optionally can detect the presence of a carrier. Periods + # of inactivity (signal changes slower than the carrier freq, + # if specified) pass on the most recently sampled level. This + # approach works for filtered and unfiltered input alike, and + # only slightly extends the active phase of input signals with + # carriers included by one period of the carrier frequency. + # IR based communication protocols can cope with this slight + # inaccuracy just fine by design. Enabling carrier detection + # on already filtered signals will keep the length of their + # active period, but will shift their signal changes by one + # carrier period before they get passed to decoding logic. + if cd_count: + (cur_ir,) = self.wait([{0: 'e'}, {'skip': cd_count}]) + if self.matched[0]: + cur_ir = self.active + if cur_ir == prev_ir: + continue + prev_ir = cur_ir + self.ir = cur_ir + else: + (self.ir,) = self.wait({0: 'e'}) - # Wait for an "interesting" edge, but also record the other ones. - if self.old_ir == self.ir: - continue if self.ir != self.active: + # Save the non-active edge, then wait for the next edge. self.ss_other_edge = self.samplenum - self.old_ir = self.ir continue b = self.samplenum - self.ss_bit # State machine. if self.state == 'IDLE': - if b in range(self.lc - self.margin, self.lc + self.margin): + if self.compare_with_tolerance(b, self.lc): self.putpause('Long') self.putx([5, ['Leader code', 'Leader', 'LC', 'L']]) + self.ss_remote = self.ss_start self.data = self.count = 0 self.state = 'ADDRESS' - elif b in range(self.rc - self.margin, self.rc + self.margin): + elif self.compare_with_tolerance(b, self.rc): self.putpause('Short') self.putstop(self.samplenum) self.samplenum += self.stop @@ -177,10 +232,6 @@ class Decoder(srd.Decoder): self.state = 'STOP' if self.data_ok() else 'IDLE' elif self.state == 'STOP': self.putstop(self.ss_bit) + self.putremote() self.ss_bit = self.ss_start = self.samplenum self.state = 'IDLE' - else: - raise Exception('Invalid state: %s' % self.state) - - self.old_ir = self.ir -