decoders/ir_nec/pd.py

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