dcf77: Fix incorrect startsample for "month" field.

[libsigrokdecode.git] / decoders / dcf77 / pd.py

diff --git a/decoders/dcf77/pd.py b/decoders/dcf77/pd.py
index 396945c93b6096554f505c28ccb6d12e7b9dac19..21da4f63ccef4569ff8e6465152e292a6b97b44e 100644 (file)
--- a/decoders/dcf77/pd.py
+++ b/decoders/dcf77/pd.py
@@ -1,7 +1,7 @@
 ##
 ## This file is part of the libsigrokdecode project.
 ##
 ##
 ## This file is part of the libsigrokdecode project.
 ##

-## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
+## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>

 ##
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by
 ##
 ## This program is free software; you can redistribute it and/or modify
 ## it under the terms of the GNU General Public License as published by


@@ -18,8 +18,6 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 

-# DCF77 protocol decoder
-

 import sigrokdecode as srd
 import calendar
 
 import sigrokdecode as srd
 import calendar
 


@@ -42,44 +40,51 @@ class Decoder(srd.Decoder):
     optional_probes = []
     options = {}
     annotations = [
     optional_probes = []
     options = {}
     annotations = [

-        ['start_of_minute', 'Start of minute'],
-        ['special_bits', 'Special bits (civil warnings, weather forecast)'],
-        ['call_bit', 'Call bit'],
-        ['summer_time', 'Summer time announcement'],
+        ['start-of-minute', 'Start of minute'],
+        ['special-bits', 'Special bits (civil warnings, weather forecast)'],
+        ['call-bit', 'Call bit'],
+        ['summer-time', 'Summer time announcement'],

         ['cest', 'CEST bit'],
         ['cet', 'CET bit'],
         ['cest', 'CEST bit'],
         ['cet', 'CET bit'],

-        ['leap_second', 'Leap second bit'],
-        ['start_of_time', 'Start of encoded time'],
+        ['leap-second', 'Leap second bit'],
+        ['start-of-time', 'Start of encoded time'],

         ['minute', 'Minute'],
         ['minute', 'Minute'],

-        ['minute_parity', 'Minute parity bit'],
+        ['minute-parity', 'Minute parity bit'],

         ['hour', 'Hour'],
         ['hour', 'Hour'],

-        ['hour_parity', 'Hour parity bit'],
+        ['hour-parity', 'Hour parity bit'],

         ['day', 'Day of month'],
         ['day', 'Day of month'],

-        ['day_of_week', 'Day of week'],
+        ['day-of-week', 'Day of week'],

         ['month', 'Month'],
         ['year', 'Year'],
         ['month', 'Month'],
         ['year', 'Year'],

-        ['date_parity', 'Date parity bit'],
-        ['raw_bits', 'Raw bits'],
-        ['unknown_bits', 'Unknown bits'],
+        ['date-parity', 'Date parity bit'],
+        ['raw-bits', 'Raw bits'],
+        ['unknown-bits', 'Unknown bits'],

         ['warnings', 'Human-readable warnings'],
     ]
         ['warnings', 'Human-readable warnings'],
     ]

+    annotation_rows = (
+        ('bits', 'Bits', (17, 18)),
+        ('fields', 'Fields', tuple(range(0, 16 + 1))),
+        ('warnings', 'Warnings', (19,)),
+    )

 
     def __init__(self, **kwargs):
 
     def __init__(self, **kwargs):

+        self.samplerate = None

         self.state = 'WAIT FOR RISING EDGE'
         self.oldpins = None
         self.oldval = None
         self.samplenum = 0
         self.ss_bit = self.ss_bit_old = self.es_bit = self.ss_block = 0
         self.state = 'WAIT FOR RISING EDGE'
         self.oldpins = None
         self.oldval = None
         self.samplenum = 0
         self.ss_bit = self.ss_bit_old = self.es_bit = self.ss_block = 0

+        self.datebits = []

         self.bitcount = 0 # Counter for the DCF77 bits (0..58)
         self.dcf77_bitnumber_is_known = 0
 
         self.bitcount = 0 # Counter for the DCF77 bits (0..58)
         self.dcf77_bitnumber_is_known = 0
 

-    def start(self, metadata):
-        self.samplerate = metadata['samplerate']
-        # self.out_proto = self.add(srd.OUTPUT_PROTO, 'dcf77')
-        self.out_ann = self.add(srd.OUTPUT_ANN, 'dcf77')
+    def start(self):
+        # self.out_python = self.register(srd.OUTPUT_PYTHON)
+        self.out_ann = self.register(srd.OUTPUT_ANN)

 
 

-    def report(self):
-        pass
+    def metadata(self, key, value):
+        if key == srd.SRD_CONF_SAMPLERATE:
+            self.samplerate = value

 
     def putx(self, data):
         # Annotation for a single DCF77 bit.
 
     def putx(self, data):
         # Annotation for a single DCF77 bit.


@@ -97,21 +102,27 @@ class Decoder(srd.Decoder):
         # Use 'Unknown DCF77 bit x: val' if we're not sure yet which of the
         # 0..58 bits it is (because we haven't seen a 'new minute' marker yet).
         # Otherwise, use 'DCF77 bit x: val'.
         # Use 'Unknown DCF77 bit x: val' if we're not sure yet which of the
         # 0..58 bits it is (because we haven't seen a 'new minute' marker yet).
         # Otherwise, use 'DCF77 bit x: val'.

-        s = '' if self.dcf77_bitnumber_is_known else 'Unknown '
-        self.putx([18, ['%sDCF77 bit %d: %d' % (s, c, bit)]])
+        s = 'B' if self.dcf77_bitnumber_is_known else 'Unknown b'
+        ann = 17 if self.dcf77_bitnumber_is_known else 18
+        self.putx([ann, ['%sit %d: %d' % (s, c, bit), '%d' % bit]])

 
         # If we're not sure yet which of the 0..58 DCF77 bits we have, return.
         # We don't want to decode bogus data.
         if not self.dcf77_bitnumber_is_known:
             return
 
 
         # If we're not sure yet which of the 0..58 DCF77 bits we have, return.
         # We don't want to decode bogus data.
         if not self.dcf77_bitnumber_is_known:
             return
 

+        # Collect bits 36-58, we'll need them for a parity check later.
+        if c in range(36, 58 + 1):
+            self.datebits.append(bit)
+

         # Output specific "decoded" annotations for the respective DCF77 bits.
         if c == 0:
             # Start of minute: DCF bit 0.
             if bit == 0:
         # Output specific "decoded" annotations for the respective DCF77 bits.
         if c == 0:
             # Start of minute: DCF bit 0.
             if bit == 0:

-                self.putx([0, ['Start of minute (always 0)']])
+                self.putx([0, ['Start of minute (always 0)',
+                               'Start of minute', 'SoM']])

             else:
             else:

-                self.putx([19, ['Start of minute != 0']])
+                self.putx([19, ['Start of minute != 0', 'SoM != 0']])

         elif c in range(1, 14 + 1):
             # Special bits (civil warnings, weather forecast): DCF77 bits 1-14.
             if c == 1:
         elif c in range(1, 14 + 1):
             # Special bits (civil warnings, weather forecast): DCF77 bits 1-14.
             if c == 1:


@@ -120,29 +131,39 @@ class Decoder(srd.Decoder):
             else:
                 self.tmp |= (bit << (c - 1))
             if c == 14:
             else:
                 self.tmp |= (bit << (c - 1))
             if c == 14:

-                self.putb([1, ['Special bits: %s' % bin(self.tmp)]])
+                s = bin(self.tmp)[2:].zfill(14)
+                self.putb([1, ['Special bits: %s' % s, 'SB: %s' % s]])

         elif c == 15:
             s = '' if (bit == 1) else 'not '
         elif c == 15:
             s = '' if (bit == 1) else 'not '

-            self.putx([2, ['Call bit is %sset' % s]])
+            self.putx([2, ['Call bit: %sset' % s, 'CB: %sset' % s]])

             # TODO: Previously this bit indicated use of the backup antenna.
         elif c == 16:
             s = '' if (bit == 1) else 'not '
             # TODO: Previously this bit indicated use of the backup antenna.
         elif c == 16:
             s = '' if (bit == 1) else 'not '

-            self.putx([3, ['Summer time announcement %sactive' % s]])
+            x = 'yes' if (bit == 1) else 'no'
+            self.putx([3, ['Summer time announcement: %sactive' % s,
+                           'Summer time: %sactive' % s,
+                           'Summer time: %s' % x, 'ST: %s' % x]])

         elif c == 17:
             s = '' if (bit == 1) else 'not '
         elif c == 17:
             s = '' if (bit == 1) else 'not '

-            self.putx([4, ['CEST is %sin effect' % s]])
+            x = 'yes' if (bit == 1) else 'no'
+            self.putx([4, ['CEST: %sin effect' % s, 'CEST: %s' % x]])

         elif c == 18:
             s = '' if (bit == 1) else 'not '
         elif c == 18:
             s = '' if (bit == 1) else 'not '

-            self.putx([5, ['CET is %sin effect' % s]])
+            x = 'yes' if (bit == 1) else 'no'
+            self.putx([5, ['CET: %sin effect' % s, 'CET: %s' % x]])

         elif c == 19:
             s = '' if (bit == 1) else 'not '
         elif c == 19:
             s = '' if (bit == 1) else 'not '

-            self.putx([6, ['Leap second announcement %sactive' % s]])
+            x = 'yes' if (bit == 1) else 'no'
+            self.putx([6, ['Leap second announcement: %sactive' % s,
+                           'Leap second: %sactive' % s,
+                           'Leap second: %s' % x, 'LS: %s' % x]])

         elif c == 20:
             # Start of encoded time: DCF bit 20.
             if bit == 1:
         elif c == 20:
             # Start of encoded time: DCF bit 20.
             if bit == 1:

-                self.putx([7, ['Start of encoded time (always 1)']])
+                self.putx([7, ['Start of encoded time (always 1)',
+                               'Start of encoded time', 'SoeT']])

             else:
             else:

-                self.putx([19, ['ERROR: Start of encoded time != 1']])
+                self.putx([19, ['Start of encoded time != 1', 'SoeT != 1']])

         elif c in range(21, 27 + 1):
             # Minutes (0-59): DCF77 bits 21-27 (BCD format).
             if c == 21:
         elif c in range(21, 27 + 1):
             # Minutes (0-59): DCF77 bits 21-27 (BCD format).
             if c == 21:


@@ -151,13 +172,14 @@ class Decoder(srd.Decoder):
             else:
                 self.tmp |= (bit << (c - 21))
             if c == 27:
             else:
                 self.tmp |= (bit << (c - 21))
             if c == 27:

-                self.putb([8, ['Minutes: %d' % bcd2int(self.tmp)]])
+                m = bcd2int(self.tmp)
+                self.putb([8, ['Minutes: %d' % m, 'Min: %d' % m]])

         elif c == 28:
             # Even parity over minute bits (21-28): DCF77 bit 28.
             self.tmp |= (bit << (c - 21))
             parity = bin(self.tmp).count('1')
             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
         elif c == 28:
             # Even parity over minute bits (21-28): DCF77 bit 28.
             self.tmp |= (bit << (c - 21))
             parity = bin(self.tmp).count('1')
             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'

-            self.putx([9, ['Minute parity: %s' % s]])
+            self.putx([9, ['Minute parity: %s' % s, 'Min parity: %s' % s]])

         elif c in range(29, 34 + 1):
             # Hours (0-23): DCF77 bits 29-34 (BCD format).
             if c == 29:
         elif c in range(29, 34 + 1):
             # Hours (0-23): DCF77 bits 29-34 (BCD format).
             if c == 29:


@@ -193,7 +215,8 @@ class Decoder(srd.Decoder):
             if c == 44:
                 d = bcd2int(self.tmp)
                 dn = calendar.day_name[d - 1] # day_name[0] == Monday
             if c == 44:
                 d = bcd2int(self.tmp)
                 dn = calendar.day_name[d - 1] # day_name[0] == Monday

-                self.putb([13, ['Day of week: %d (%s)' % (d, dn)]])
+                self.putb([13, ['Day of week: %d (%s)' % (d, dn),
+                                'DoW: %d (%s)' % (d, dn)]])

         elif c in range(45, 49 + 1):
             # Month (1-12): DCF77 bits 45-49 (BCD format).
             if c == 45:
         elif c in range(45, 49 + 1):
             # Month (1-12): DCF77 bits 45-49 (BCD format).
             if c == 45:


@@ -204,7 +227,8 @@ class Decoder(srd.Decoder):
             if c == 49:
                 m = bcd2int(self.tmp)
                 mn = calendar.month_name[m] # month_name[1] == January
             if c == 49:
                 m = bcd2int(self.tmp)
                 mn = calendar.month_name[m] # month_name[1] == January

-                self.putx([14, ['Month: %d (%s)' % (m, mn)]])
+                self.putb([14, ['Month: %d (%s)' % (m, mn),
+                                'Mon: %d (%s)' % (m, mn)]])

         elif c in range(50, 57 + 1):
             # Year (0-99): DCF77 bits 50-57 (BCD format).
             if c == 50:
         elif c in range(50, 57 + 1):
             # Year (0-99): DCF77 bits 50-57 (BCD format).
             if c == 50:


@@ -216,14 +240,16 @@ class Decoder(srd.Decoder):
                 self.putb([15, ['Year: %d' % bcd2int(self.tmp)]])
         elif c == 58:
             # Even parity over date bits (36-58): DCF77 bit 58.
                 self.putb([15, ['Year: %d' % bcd2int(self.tmp)]])
         elif c == 58:
             # Even parity over date bits (36-58): DCF77 bit 58.

-            self.tmp |= (bit << (c - 50))
-            parity = bin(self.tmp).count('1')
+            parity = self.datebits.count(1)

             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
             s = 'OK' if ((parity % 2) == 0) else 'INVALID!'

-            self.putx([16, ['Date parity: %s' % s]])
+            self.putx([16, ['Date parity: %s' % s, 'DP: %s' %s]])
+            self.datebits = []

         else:
             raise Exception('Invalid DCF77 bit: %d' % c)
 
     def decode(self, ss, es, data):
         else:
             raise Exception('Invalid DCF77 bit: %d' % c)
 
     def decode(self, ss, es, data):

+        if self.samplerate is None:
+            raise Exception("Cannot decode without samplerate.")

         for (self.samplenum, pins) in data:
 
             # Ignore identical samples early on (for performance reasons).
         for (self.samplenum, pins) in data:
 
             # Ignore identical samples early on (for performance reasons).