All PDs: Consistent naming/case for annotation shortnames/IDs.

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

diff --git a/decoders/dcf77/pd.py b/decoders/dcf77/pd.py
index a31c313cb8f020a890d63c03911d682d009b810a..4c76eeb1444fab2502af5ab79acdb7491cd30857 100644 (file)
--- a/decoders/dcf77/pd.py
+++ b/decoders/dcf77/pd.py
@@ -18,8 +18,6 @@
 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 ##
 
-# DCF77 protocol decoder
-
 import sigrokdecode as srd
 import calendar
 
@@ -42,29 +40,30 @@ class Decoder(srd.Decoder):
     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'],
-        ['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_parity', 'Minute parity bit'],
+        ['minute-parity', 'Minute parity bit'],
         ['hour', 'Hour'],
-        ['hour_parity', 'Hour parity bit'],
+        ['hour-parity', 'Hour parity bit'],
         ['day', 'Day of month'],
-        ['day_of_week', 'Day of week'],
+        ['day-of-week', 'Day of week'],
         ['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'],
     ]
 
     def __init__(self, **kwargs):
+        self.samplerate = None
         self.state = 'WAIT FOR RISING EDGE'
         self.oldpins = None
         self.oldval = None
@@ -74,13 +73,13 @@ class Decoder(srd.Decoder):
         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_proto = 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.
@@ -244,6 +243,8 @@ class Decoder(srd.Decoder):
             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).