##
## 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
probes = [
{'id': 'data', 'name': 'DATA', 'desc': 'DATA line'},
]
- optional_probes = [
- {'id': 'pon', 'name': 'PON', 'desc': 'Power on'},
- ]
+ optional_probes = []
options = {}
annotations = [
- ['Text', 'Human-readable text'],
- ['Warnings', 'Human-readable warnings'],
+ ['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):
+ self.samplerate = None
self.state = 'WAIT FOR RISING EDGE'
self.oldpins = None
self.oldval = None
- self.oldpon = None
self.samplenum = 0
- self.bit_start = 0
- self.bit_start_old = 0
- self.bit_end = 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
- 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):
- self.put(self.bit_start, self.bit_end, self.out_ann, data)
+ # Annotation for a single DCF77 bit.
+ self.put(self.ss_bit, self.es_bit, self.out_ann, data)
+
+ def putb(self, data):
+ # Annotation for a multi-bit DCF77 field.
+ self.put(self.ss_block, self.samplenum, self.out_ann, data)
# TODO: Which range to use? Only the 100ms/200ms or full second?
def handle_dcf77_bit(self, bit):
# 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([0, ['%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
+ # 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:
- self.putx([0, ['Start of minute (always 0)']])
+ self.putx([0, ['Start of minute (always 0)',
+ 'Start of minute', 'SoM']])
else:
- self.putx([0, ['ERROR: 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:
self.tmp = bit
+ self.ss_block = self.ss_bit
else:
self.tmp |= (bit << (c - 1))
if c == 14:
- self.putx([0, ['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 '
- self.putx([0, ['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 '
- self.putx([0, ['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 '
- self.putx([0, ['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 '
- self.putx([0, ['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 '
- self.putx([0, ['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:
- self.putx([0, ['Start of encoded time (always 1)']])
+ self.putx([7, ['Start of encoded time (always 1)',
+ 'Start of encoded time', 'SoeT']])
else:
- self.putx([0, ['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:
self.tmp = bit
+ self.ss_block = self.ss_bit
else:
self.tmp |= (bit << (c - 21))
if c == 27:
- self.putx([0, ['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!'
- self.putx([0, ['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:
self.tmp = bit
+ self.ss_block = self.ss_bit
else:
self.tmp |= (bit << (c - 29))
if c == 34:
- self.putx([0, ['Hours: %d' % bcd2int(self.tmp)]])
+ self.putb([10, ['Hours: %d' % bcd2int(self.tmp)]])
elif c == 35:
# Even parity over hour bits (29-35): DCF77 bit 35.
self.tmp |= (bit << (c - 29))
parity = bin(self.tmp).count('1')
s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
- self.putx([0, ['Hour parity: %s' % s]])
+ self.putx([11, ['Hour parity: %s' % s]])
elif c in range(36, 41 + 1):
# Day of month (1-31): DCF77 bits 36-41 (BCD format).
if c == 36:
self.tmp = bit
+ self.ss_block = self.ss_bit
else:
self.tmp |= (bit << (c - 36))
if c == 41:
- self.putx([0, ['Day: %d' % bcd2int(self.tmp)]])
+ self.putb([12, ['Day: %d' % bcd2int(self.tmp)]])
elif c in range(42, 44 + 1):
# Day of week (1-7): DCF77 bits 42-44 (BCD format).
# A value of 1 means Monday, 7 means Sunday.
if c == 42:
self.tmp = bit
+ self.ss_block = self.ss_bit
else:
self.tmp |= (bit << (c - 42))
if c == 44:
d = bcd2int(self.tmp)
dn = calendar.day_name[d - 1] # day_name[0] == Monday
- self.putx([0, ['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:
self.tmp = bit
+ self.ss_block = self.ss_bit
else:
self.tmp |= (bit << (c - 45))
if c == 49:
m = bcd2int(self.tmp)
mn = calendar.month_name[m] # month_name[1] == January
- self.putx([0, ['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:
self.tmp = bit
+ self.ss_block = self.ss_bit
else:
self.tmp |= (bit << (c - 50))
if c == 57:
- self.putx([0, ['Year: %d' % bcd2int(self.tmp)]])
+ 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!'
- self.putx([0, ['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):
+ 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).
if self.oldpins == pins:
continue
- self.oldpins, (val, pon) = pins, pins
-
- # Always remember the old PON state.
- if self.oldpon != pon:
- self.oldpon = pon
-
- # Warn if PON goes low.
- if self.oldpon == 1 and pon == 0:
- self.pon_ss = self.samplenum
- self.put(self.samplenum, self.samplenum, self.out_ann,
- [1, ['Warning: PON goes low, DCF77 reception '
- 'no longer possible']])
- elif self.oldpon == 0 and pon == 1:
- self.put(self.samplenum, self.samplenum, self.out_ann,
- [0, ['PON goes high, DCF77 reception now possible']])
- self.put(self.pon_ss, self.samplenum, self.out_ann,
- [1, ['Warning: PON low, DCF77 reception disabled']])
-
- # Ignore samples where PON == 0, they can't contain DCF77 signals.
- if pon == 0:
- continue
+ self.oldpins, (val,) = pins, pins
if self.state == 'WAIT FOR RISING EDGE':
# Wait until the next rising edge occurs.
continue
# Save the sample number where the DCF77 bit begins.
- self.bit_start = self.samplenum
+ self.ss_bit = self.samplenum
# Calculate the length (in ms) between two rising edges.
- len_edges = self.bit_start - self.bit_start_old
+ len_edges = self.ss_bit - self.ss_bit_old
len_edges_ms = int((len_edges / self.samplerate) * 1000)
# The time between two rising edges is usually around 1000ms.
# beginning of a new minute (and DCF77 bit 0 of that minute).
if len_edges_ms in range(1600, 2400 + 1):
self.bitcount = 0
- self.bit_start_old = self.bit_start
+ self.ss_bit_old = self.ss_bit
self.dcf77_bitnumber_is_known = 1
- self.bit_start_old = self.bit_start
+ self.ss_bit_old = self.ss_bit
self.state = 'GET BIT'
elif self.state == 'GET BIT':
continue
# Save the sample number where the DCF77 bit ends.
- self.bit_end = self.samplenum
+ self.es_bit = self.samplenum
# Calculate the length (in ms) of the current high period.
- len_high = self.samplenum - self.bit_start
+ len_high = self.samplenum - self.ss_bit
len_high_ms = int((len_high / self.samplerate) * 1000)
# If the high signal was 100ms long, that encodes a 0 bit.
projects / libsigrokdecode.git / blobdiff