decoders/dcf77/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012-2016 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, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21 import calendar
  22 from common.srdhelper import bcd2int
  23
  24 class SamplerateError(Exception):
  25     pass
  26
  27 class Decoder(srd.Decoder):
  28     api_version = 3
  29     id = 'dcf77'
  30     name = 'DCF77'
  31     longname = 'DCF77 time protocol'
  32     desc = 'European longwave time signal (77.5kHz carrier signal).'
  33     license = 'gplv2+'
  34     inputs = ['logic']
  35     outputs = []
  36     tags = ['Clock/timing']
  37     channels = (
  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):
  69         self.reset()
  70
  71     def reset(self):
  72         self.samplerate = None
  73         self.state = 'WAIT FOR RISING EDGE'
  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_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 = '{:014b}'.format(self.tmp)
 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                 try:
 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                 except IndexError:
 219                     self.putb([19, ['Day of week: %d (%s)' % (d, 'invalid'),
 220                                     'DoW: %d (%s)' % (d, 'inv')]])
 221         elif c in range(45, 49 + 1):
 222             # Month (1-12): DCF77 bits 45-49 (BCD format).
 223             if c == 45:
 224                 self.tmp = bit
 225                 self.ss_block = self.ss_bit
 226             else:
 227                 self.tmp |= (bit << (c - 45))
 228             if c == 49:
 229                 m = bcd2int(self.tmp)
 230                 try:
 231                     mn = calendar.month_name[m] # month_name[1] == January
 232                     self.putb([14, ['Month: %d (%s)' % (m, mn),
 233                                     'Mon: %d (%s)' % (m, mn)]])
 234                 except IndexError:
 235                     self.putb([19, ['Month: %d (%s)' % (m, 'invalid'),
 236                                     'Mon: %d (%s)' % (m, 'inv')]])
 237         elif c in range(50, 57 + 1):
 238             # Year (0-99): DCF77 bits 50-57 (BCD format).
 239             if c == 50:
 240                 self.tmp = bit
 241                 self.ss_block = self.ss_bit
 242             else:
 243                 self.tmp |= (bit << (c - 50))
 244             if c == 57:
 245                 self.putb([15, ['Year: %d' % bcd2int(self.tmp)]])
 246         elif c == 58:
 247             # Even parity over date bits (36-58): DCF77 bit 58.
 248             parity = self.datebits.count(1)
 249             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
 250             self.putx([16, ['Date parity: %s' % s, 'DP: %s' % s]])
 251             self.datebits = []
 252         else:
 253             self.putx([19, ['Invalid DCF77 bit: %d' % c,
 254                             'Invalid bit: %d' % c, 'Inv: %d' % c]])
 255
 256     def decode(self):
 257         if not self.samplerate:
 258             raise SamplerateError('Cannot decode without samplerate.')
 259         while True:
 260             if self.state == 'WAIT FOR RISING EDGE':
 261                 # Wait until the next rising edge occurs.
 262                 self.wait({0: 'r'})
 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                 self.wait({0: 'f'})
 288
 289                 # Save the sample number where the DCF77 bit ends.
 290                 self.es_bit = self.samplenum
 291
 292                 # Calculate the length (in ms) of the current high period.
 293                 len_high = self.samplenum - self.ss_bit
 294                 len_high_ms = int((len_high / self.samplerate) * 1000)
 295
 296                 # If the high signal was 100ms long, that encodes a 0 bit.
 297                 # If it was 200ms long, that encodes a 1 bit.
 298                 if len_high_ms in range(40, 160 + 1):
 299                     bit = 0
 300                 elif len_high_ms in range(161, 260 + 1):
 301                     bit = 1
 302                 else:
 303                     bit = -1
 304
 305                 if bit in (0, 1):
 306                     self.handle_dcf77_bit(bit)
 307                     self.bitcount += 1
 308                 else:
 309                     self.putx([19, ['Invalid bit timing', 'Inv timing', 'Inv']])
 310
 311                 self.state = 'WAIT FOR RISING EDGE'