decoders/wiegand/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2016 Sean Burford <sburford@google.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 import sigrokdecode as srd
  21
  22 class Decoder(srd.Decoder):
  23     api_version = 3
  24     id = 'wiegand'
  25     name = 'Wiegand'
  26     longname = 'Wiegand interface'
  27     desc = 'Wiegand interface for electronic entry systems.'
  28     license = 'gplv2+'
  29     inputs = ['logic']
  30     outputs = ['wiegand']
  31     channels = (
  32         {'id': 'd0', 'name': 'D0', 'desc': 'Data 0 line'},
  33         {'id': 'd1', 'name': 'D1', 'desc': 'Data 1 line'},
  34     )
  35     options = (
  36         {'id': 'active', 'desc': 'Data lines active level',
  37          'default': 'low', 'values': ('low', 'high')},
  38         {'id': 'bitwidth_ms', 'desc': 'Single bit width in milliseconds',
  39          'default': 4, 'values': (1, 2, 4, 8, 16, 32)},
  40     )
  41     annotations = (
  42         ('bits', 'Bits'),
  43         ('state', 'State'),
  44     )
  45     annotation_rows = (
  46         ('bits', 'Binary value', (0,)),
  47         ('state', 'Stream state', (1,)),
  48     )
  49
  50     def __init__(self):
  51         self.reset()
  52
  53     def reset(self):
  54         self._samples_per_bit = 10
  55
  56         self._d0_prev = None
  57         self._d1_prev = None
  58
  59         self._state = None
  60         self.ss_state = None
  61
  62         self.ss_bit = None
  63         self.es_bit = None
  64         self._bit = None
  65         self._bits = []
  66
  67     def start(self):
  68         'Register output types and verify user supplied decoder values.'
  69         self.out_ann = self.register(srd.OUTPUT_ANN)
  70         self._active = 1 if self.options['active'] == 'high' else 0
  71         self._inactive = 1 - self._active
  72
  73     def metadata(self, key, value):
  74         'Receive decoder metadata about the data stream.'
  75         if key == srd.SRD_CONF_SAMPLERATE:
  76             ms_per_sample = 1000 * (1.0 / value)
  77             ms_per_bit = float(self.options['bitwidth_ms'])
  78             self._samples_per_bit = int(max(1, int(ms_per_bit / ms_per_sample)))
  79
  80     def _update_state(self, state, bit=None):
  81         'Update state and bit values when they change.'
  82         if self._bit is not None:
  83             self._bits.append(self._bit)
  84             self.put(self.ss_bit, self.samplenum, self.out_ann,
  85                      [0, [str(self._bit)]])
  86         self._bit = bit
  87         self.ss_bit = self.samplenum
  88         if bit is not None:
  89             # Set a timeout so that the final bit ends.
  90             self.es_bit = self.samplenum + self._samples_per_bit
  91         else:
  92             self.es_bit = None
  93
  94         if state != self._state:
  95             ann = None
  96             if self._state == 'data':
  97                 accum_bits = ''.join(str(x) for x in self._bits)
  98                 ann = [1, ['%d bits %s' % (len(self._bits), accum_bits),
  99                            '%d bits' % len(self._bits)]]
 100             elif self._state == 'invalid':
 101                 ann = [1, [self._state]]
 102             if ann:
 103                 self.put(self.ss_state, self.samplenum, self.out_ann, ann)
 104             self.ss_state = self.samplenum
 105             self._state = state
 106             self._bits = []
 107
 108     def decode(self):
 109         while True:
 110             # TODO: Come up with more appropriate self.wait() conditions.
 111             (d0, d1) = self.wait()
 112
 113             if d0 == self._d0_prev and d1 == self._d1_prev:
 114                 if self.es_bit and self.samplenum >= self.es_bit:
 115                     if (d0, d1) == (self._inactive, self._inactive):
 116                         self._update_state('idle')
 117                     else:
 118                         self._update_state('invalid')
 119                 continue
 120
 121             if self._state in (None, 'idle', 'data'):
 122                 if (d0, d1) == (self._active, self._inactive):
 123                     self._update_state('data', 0)
 124                 elif (d0, d1) == (self._inactive, self._active):
 125                     self._update_state('data', 1)
 126                 elif (d0, d1) == (self._active, self._active):
 127                     self._update_state('invalid')
 128             elif self._state == 'invalid':
 129                 # Wait until we see an idle state before leaving invalid.
 130                 # This prevents inverted lines from being misread.
 131                 if (d0, d1) == (self._inactive, self._inactive):
 132                     self._update_state('idle')
 133
 134             self._d0_prev, self._d1_prev = d0, d1
 135
 136     def report(self):
 137         return '%s: %s D0 %d D1 %d (active on %d), %d samples per bit' % (
 138             self.name, self._state, self._d0_prev, self._d1_prev,
 139             self._active, self._samples_per_bit)