decoders/dcf77/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
   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, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 import sigrokdecode as srd
  22 import calendar
  23
  24 # Return the specified BCD number (max. 8 bits) as integer.
  25 def bcd2int(b):
  26     return (b & 0x0f) + ((b >> 4) * 10)
  27
  28 class Decoder(srd.Decoder):
  29     api_version = 1
  30     id = 'dcf77'
  31     name = 'DCF77'
  32     longname = 'DCF77 time protocol'
  33     desc = 'European longwave time signal (77.5kHz carrier signal).'
  34     license = 'gplv2+'
  35     inputs = ['logic']
  36     outputs = ['dcf77']
  37     probes = (
  38         {'id': 'data', 'name': 'DATA', 'desc': 'DATA line'},
  39     )
  40     annotations = (
  41         ('start-of-minute', 'Start of minute'),
  42         ('special-bits', 'Special bits (civil warnings, weather forecast)'),
  43         ('call-bit', 'Call bit'),
  44         ('summer-time', 'Summer time announcement'),
  45         ('cest', 'CEST bit'),
  46         ('cet', 'CET bit'),
  47         ('leap-second', 'Leap second bit'),
  48         ('start-of-time', 'Start of encoded time'),
  49         ('minute', 'Minute'),
  50         ('minute-parity', 'Minute parity bit'),
  51         ('hour', 'Hour'),
  52         ('hour-parity', 'Hour parity bit'),
  53         ('day', 'Day of month'),
  54         ('day-of-week', 'Day of week'),
  55         ('month', 'Month'),
  56         ('year', 'Year'),
  57         ('date-parity', 'Date parity bit'),
  58         ('raw-bits', 'Raw bits'),
  59         ('unknown-bits', 'Unknown bits'),
  60         ('warnings', 'Human-readable warnings'),
  61     )
  62     annotation_rows = (
  63         ('bits', 'Bits', (17, 18)),
  64         ('fields', 'Fields', tuple(range(0, 16 + 1))),
  65         ('warnings', 'Warnings', (19,)),
  66     )
  67
  68     def __init__(self, **kwargs):
  69         self.samplerate = None
  70         self.state = 'WAIT FOR RISING EDGE'
  71         self.oldpins = None
  72         self.oldval = None
  73         self.samplenum = 0
  74         self.ss_bit = self.ss_bit_old = self.es_bit = self.ss_block = 0
  75         self.datebits = []
  76         self.bitcount = 0 # Counter for the DCF77 bits (0..58)
  77         self.dcf77_bitnumber_is_known = 0
  78
  79     def start(self):
  80         # self.out_python = self.register(srd.OUTPUT_PYTHON)
  81         self.out_ann = self.register(srd.OUTPUT_ANN)
  82
  83     def metadata(self, key, value):
  84         if key == srd.SRD_CONF_SAMPLERATE:
  85             self.samplerate = value
  86
  87     def putx(self, data):
  88         # Annotation for a single DCF77 bit.
  89         self.put(self.ss_bit, self.es_bit, self.out_ann, data)
  90
  91     def putb(self, data):
  92         # Annotation for a multi-bit DCF77 field.
  93         self.put(self.ss_block, self.samplenum, self.out_ann, data)
  94
  95     # TODO: Which range to use? Only the 100ms/200ms or full second?
  96     def handle_dcf77_bit(self, bit):
  97         c = self.bitcount
  98
  99         # Create one annotation for each DCF77 bit (containing the 0/1 value).
 100         # Use 'Unknown DCF77 bit x: val' if we're not sure yet which of the
 101         # 0..58 bits it is (because we haven't seen a 'new minute' marker yet).
 102         # Otherwise, use 'DCF77 bit x: val'.
 103         s = 'B' if self.dcf77_bitnumber_is_known else 'Unknown b'
 104         ann = 17 if self.dcf77_bitnumber_is_known else 18
 105         self.putx([ann, ['%sit %d: %d' % (s, c, bit), '%d' % bit]])
 106
 107         # If we're not sure yet which of the 0..58 DCF77 bits we have, return.
 108         # We don't want to decode bogus data.
 109         if not self.dcf77_bitnumber_is_known:
 110             return
 111
 112         # Collect bits 36-58, we'll need them for a parity check later.
 113         if c in range(36, 58 + 1):
 114             self.datebits.append(bit)
 115
 116         # Output specific "decoded" annotations for the respective DCF77 bits.
 117         if c == 0:
 118             # Start of minute: DCF bit 0.
 119             if bit == 0:
 120                 self.putx([0, ['Start of minute (always 0)',
 121                                'Start of minute', 'SoM']])
 122             else:
 123                 self.putx([19, ['Start of minute != 0', 'SoM != 0']])
 124         elif c in range(1, 14 + 1):
 125             # Special bits (civil warnings, weather forecast): DCF77 bits 1-14.
 126             if c == 1:
 127                 self.tmp = bit
 128                 self.ss_block = self.ss_bit
 129             else:
 130                 self.tmp |= (bit << (c - 1))
 131             if c == 14:
 132                 s = bin(self.tmp)[2:].zfill(14)
 133                 self.putb([1, ['Special bits: %s' % s, 'SB: %s' % s]])
 134         elif c == 15:
 135             s = '' if (bit == 1) else 'not '
 136             self.putx([2, ['Call bit: %sset' % s, 'CB: %sset' % s]])
 137             # TODO: Previously this bit indicated use of the backup antenna.
 138         elif c == 16:
 139             s = '' if (bit == 1) else 'not '
 140             x = 'yes' if (bit == 1) else 'no'
 141             self.putx([3, ['Summer time announcement: %sactive' % s,
 142                            'Summer time: %sactive' % s,
 143                            'Summer time: %s' % x, 'ST: %s' % x]])
 144         elif c == 17:
 145             s = '' if (bit == 1) else 'not '
 146             x = 'yes' if (bit == 1) else 'no'
 147             self.putx([4, ['CEST: %sin effect' % s, 'CEST: %s' % x]])
 148         elif c == 18:
 149             s = '' if (bit == 1) else 'not '
 150             x = 'yes' if (bit == 1) else 'no'
 151             self.putx([5, ['CET: %sin effect' % s, 'CET: %s' % x]])
 152         elif c == 19:
 153             s = '' if (bit == 1) else 'not '
 154             x = 'yes' if (bit == 1) else 'no'
 155             self.putx([6, ['Leap second announcement: %sactive' % s,
 156                            'Leap second: %sactive' % s,
 157                            'Leap second: %s' % x, 'LS: %s' % x]])
 158         elif c == 20:
 159             # Start of encoded time: DCF bit 20.
 160             if bit == 1:
 161                 self.putx([7, ['Start of encoded time (always 1)',
 162                                'Start of encoded time', 'SoeT']])
 163             else:
 164                 self.putx([19, ['Start of encoded time != 1', 'SoeT != 1']])
 165         elif c in range(21, 27 + 1):
 166             # Minutes (0-59): DCF77 bits 21-27 (BCD format).
 167             if c == 21:
 168                 self.tmp = bit
 169                 self.ss_block = self.ss_bit
 170             else:
 171                 self.tmp |= (bit << (c - 21))
 172             if c == 27:
 173                 m = bcd2int(self.tmp)
 174                 self.putb([8, ['Minutes: %d' % m, 'Min: %d' % m]])
 175         elif c == 28:
 176             # Even parity over minute bits (21-28): DCF77 bit 28.
 177             self.tmp |= (bit << (c - 21))
 178             parity = bin(self.tmp).count('1')
 179             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
 180             self.putx([9, ['Minute parity: %s' % s, 'Min parity: %s' % s]])
 181         elif c in range(29, 34 + 1):
 182             # Hours (0-23): DCF77 bits 29-34 (BCD format).
 183             if c == 29:
 184                 self.tmp = bit
 185                 self.ss_block = self.ss_bit
 186             else:
 187                 self.tmp |= (bit << (c - 29))
 188             if c == 34:
 189                 self.putb([10, ['Hours: %d' % bcd2int(self.tmp)]])
 190         elif c == 35:
 191             # Even parity over hour bits (29-35): DCF77 bit 35.
 192             self.tmp |= (bit << (c - 29))
 193             parity = bin(self.tmp).count('1')
 194             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
 195             self.putx([11, ['Hour parity: %s' % s]])
 196         elif c in range(36, 41 + 1):
 197             # Day of month (1-31): DCF77 bits 36-41 (BCD format).
 198             if c == 36:
 199                 self.tmp = bit
 200                 self.ss_block = self.ss_bit
 201             else:
 202                 self.tmp |= (bit << (c - 36))
 203             if c == 41:
 204                 self.putb([12, ['Day: %d' % bcd2int(self.tmp)]])
 205         elif c in range(42, 44 + 1):
 206             # Day of week (1-7): DCF77 bits 42-44 (BCD format).
 207             # A value of 1 means Monday, 7 means Sunday.
 208             if c == 42:
 209                 self.tmp = bit
 210                 self.ss_block = self.ss_bit
 211             else:
 212                 self.tmp |= (bit << (c - 42))
 213             if c == 44:
 214                 d = bcd2int(self.tmp)
 215                 dn = calendar.day_name[d - 1] # day_name[0] == Monday
 216                 self.putb([13, ['Day of week: %d (%s)' % (d, dn),
 217                                 'DoW: %d (%s)' % (d, dn)]])
 218         elif c in range(45, 49 + 1):
 219             # Month (1-12): DCF77 bits 45-49 (BCD format).
 220             if c == 45:
 221                 self.tmp = bit
 222                 self.ss_block = self.ss_bit
 223             else:
 224                 self.tmp |= (bit << (c - 45))
 225             if c == 49:
 226                 m = bcd2int(self.tmp)
 227                 mn = calendar.month_name[m] # month_name[1] == January
 228                 self.putb([14, ['Month: %d (%s)' % (m, mn),
 229                                 'Mon: %d (%s)' % (m, mn)]])
 230         elif c in range(50, 57 + 1):
 231             # Year (0-99): DCF77 bits 50-57 (BCD format).
 232             if c == 50:
 233                 self.tmp = bit
 234                 self.ss_block = self.ss_bit
 235             else:
 236                 self.tmp |= (bit << (c - 50))
 237             if c == 57:
 238                 self.putb([15, ['Year: %d' % bcd2int(self.tmp)]])
 239         elif c == 58:
 240             # Even parity over date bits (36-58): DCF77 bit 58.
 241             parity = self.datebits.count(1)
 242             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
 243             self.putx([16, ['Date parity: %s' % s, 'DP: %s' %s]])
 244             self.datebits = []
 245         else:
 246             raise Exception('Invalid DCF77 bit: %d' % c)
 247
 248     def decode(self, ss, es, data):
 249         if self.samplerate is None:
 250             raise Exception("Cannot decode without samplerate.")
 251         for (self.samplenum, pins) in data:
 252
 253             # Ignore identical samples early on (for performance reasons).
 254             if self.oldpins == pins:
 255                 continue
 256             self.oldpins, (val,) = pins, pins
 257
 258             if self.state == 'WAIT FOR RISING EDGE':
 259                 # Wait until the next rising edge occurs.
 260                 if not (self.oldval == 0 and val == 1):
 261                     self.oldval = val
 262                     continue
 263
 264                 # Save the sample number where the DCF77 bit begins.
 265                 self.ss_bit = self.samplenum
 266
 267                 # Calculate the length (in ms) between two rising edges.
 268                 len_edges = self.ss_bit - self.ss_bit_old
 269                 len_edges_ms = int((len_edges / self.samplerate) * 1000)
 270
 271                 # The time between two rising edges is usually around 1000ms.
 272                 # For DCF77 bit 59, there is no rising edge at all, i.e. the
 273                 # time between DCF77 bit 59 and DCF77 bit 0 (of the next
 274                 # minute) is around 2000ms. Thus, if we see an edge with a
 275                 # 2000ms distance to the last one, this edge marks the
 276                 # beginning of a new minute (and DCF77 bit 0 of that minute).
 277                 if len_edges_ms in range(1600, 2400 + 1):
 278                     self.bitcount = 0
 279                     self.ss_bit_old = self.ss_bit
 280                     self.dcf77_bitnumber_is_known = 1
 281
 282                 self.ss_bit_old = self.ss_bit
 283                 self.state = 'GET BIT'
 284
 285             elif self.state == 'GET BIT':
 286                 # Wait until the next falling edge occurs.
 287                 if not (self.oldval == 1 and val == 0):
 288                     self.oldval = val
 289                     continue
 290
 291                 # Save the sample number where the DCF77 bit ends.
 292                 self.es_bit = self.samplenum
 293
 294                 # Calculate the length (in ms) of the current high period.
 295                 len_high = self.samplenum - self.ss_bit
 296                 len_high_ms = int((len_high / self.samplerate) * 1000)
 297
 298                 # If the high signal was 100ms long, that encodes a 0 bit.
 299                 # If it was 200ms long, that encodes a 1 bit.
 300                 if len_high_ms in range(40, 160 + 1):
 301                     bit = 0
 302                 elif len_high_ms in range(161, 260 + 1):
 303                     bit = 1
 304                 else:
 305                     bit = -1 # TODO: Error?
 306
 307                 # There's no bit 59, make sure none is decoded.
 308                 if bit in (0, 1) and self.bitcount in range(0, 58 + 1):
 309                     self.handle_dcf77_bit(bit)
 310                     self.bitcount += 1
 311
 312                 self.state = 'WAIT FOR RISING EDGE'
 313
 314             else:
 315                 raise Exception('Invalid state: %s' % self.state)
 316
 317             self.oldval = val
 318