##
## 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
## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
##
-# DCF77 protocol decoder
-
import sigrokdecode as srd
import calendar
+from common.srdhelper import bcd2int
-# Return the specified BCD number (max. 8 bits) as integer.
-def bcd2int(b):
- return (b & 0x0f) + ((b >> 4) * 10)
+class SamplerateError(Exception):
+ pass
class Decoder(srd.Decoder):
- api_version = 1
+ api_version = 2
id = 'dcf77'
name = 'DCF77'
longname = 'DCF77 time protocol'
license = 'gplv2+'
inputs = ['logic']
outputs = ['dcf77']
- probes = [
+ channels = (
{'id': 'data', 'name': 'DATA', 'desc': 'DATA line'},
- ]
- 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'],
- ['cest', 'CEST bit'],
- ['cet', 'CET bit'],
- ['leap_second', 'Leap second bit'],
- ['start_of_time', 'Start of encoded time'],
- ['minute', 'Minute'],
- ['minute_parity', 'Minute parity bit'],
- ['hour', 'Hour'],
- ['hour_parity', 'Hour parity bit'],
- ['day', 'Day of month'],
- ['day_of_week', 'Day of week'],
- ['month', 'Month'],
- ['year', 'Year'],
- ['date_parity', 'Date parity bit'],
- ['raw_bits', 'Raw bits'],
- ['unknown_bits', 'Unknown bits'],
- ['warnings', 'Human-readable warnings'],
- ]
+ )
+ annotations = (
+ ('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'),
+ ('minute', 'Minute'),
+ ('minute-parity', 'Minute parity bit'),
+ ('hour', 'Hour'),
+ ('hour-parity', 'Hour parity bit'),
+ ('day', 'Day of month'),
+ ('day-of-week', 'Day of week'),
+ ('month', 'Month'),
+ ('year', 'Year'),
+ ('date-parity', 'Date parity bit'),
+ ('raw-bits', 'Raw bits'),
+ ('unknown-bits', 'Unknown bits'),
+ ('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):
self.samplerate = None
self.state = 'WAIT FOR RISING EDGE'
self.oldpins = None
self.dcf77_bitnumber_is_known = 0
def start(self):
- # self.out_proto = self.add(srd.OUTPUT_PROTO, 'dcf77')
- self.out_ann = self.add(srd.OUTPUT_ANN, 'dcf77')
+ self.out_ann = self.register(srd.OUTPUT_ANN)
def metadata(self, key, value):
if key == srd.SRD_CONF_SAMPLERATE:
self.samplerate = value
- def report(self):
- pass
-
def putx(self, data):
# Annotation for a single DCF77 bit.
self.put(self.ss_bit, self.es_bit, self.out_ann, data)
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).
# Even parity over date bits (36-58): DCF77 bit 58.
parity = self.datebits.count(1)
s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
- self.putx([16, ['Date parity: %s' % s, 'DP: %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):
- if self.samplerate is None:
- raise Exception("Cannot decode without samplerate.")
+ if not self.samplerate:
+ raise SamplerateError('Cannot decode without samplerate.')
for (self.samplenum, pins) in data:
# Ignore identical samples early on (for performance reasons).
self.state = 'WAIT FOR RISING EDGE'
- else:
- raise Exception('Invalid state: %s' % self.state)
-
self.oldval = val
-