decoders/dcf77/pd.py

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