2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012-2014 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, write to the Free Software
18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 import sigrokdecode as srd
23 from srdhelper import bcd2int
25 class SamplerateError(Exception):
28 class Decoder(srd.Decoder):
32 longname = 'DCF77 time protocol'
33 desc = 'European longwave time signal (77.5kHz carrier signal).'
38 {'id': 'data', 'name': 'DATA', 'desc': 'DATA line'},
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'),
47 ('leap-second', 'Leap second bit'),
48 ('start-of-time', 'Start of encoded time'),
50 ('minute-parity', 'Minute parity bit'),
52 ('hour-parity', 'Hour parity bit'),
53 ('day', 'Day of month'),
54 ('day-of-week', 'Day of week'),
57 ('date-parity', 'Date parity bit'),
58 ('raw-bits', 'Raw bits'),
59 ('unknown-bits', 'Unknown bits'),
60 ('warnings', 'Human-readable warnings'),
63 ('bits', 'Bits', (17, 18)),
64 ('fields', 'Fields', tuple(range(0, 16 + 1))),
65 ('warnings', 'Warnings', (19,)),
68 def __init__(self, **kwargs):
69 self.samplerate = None
70 self.state = 'WAIT FOR RISING EDGE'
74 self.ss_bit = self.ss_bit_old = self.es_bit = self.ss_block = 0
76 self.bitcount = 0 # Counter for the DCF77 bits (0..58)
77 self.dcf77_bitnumber_is_known = 0
80 self.out_ann = self.register(srd.OUTPUT_ANN)
82 def metadata(self, key, value):
83 if key == srd.SRD_CONF_SAMPLERATE:
84 self.samplerate = value
87 # Annotation for a single DCF77 bit.
88 self.put(self.ss_bit, self.es_bit, self.out_ann, data)
91 # Annotation for a multi-bit DCF77 field.
92 self.put(self.ss_block, self.samplenum, self.out_ann, data)
94 # TODO: Which range to use? Only the 100ms/200ms or full second?
95 def handle_dcf77_bit(self, bit):
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]])
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:
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)
115 # Output specific "decoded" annotations for the respective DCF77 bits.
117 # Start of minute: DCF bit 0.
119 self.putx([0, ['Start of minute (always 0)',
120 'Start of minute', 'SoM']])
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.
127 self.ss_block = self.ss_bit
129 self.tmp |= (bit << (c - 1))
131 s = bin(self.tmp)[2:].zfill(14)
132 self.putb([1, ['Special bits: %s' % s, 'SB: %s' % s]])
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.
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]])
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]])
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]])
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]])
158 # Start of encoded time: DCF bit 20.
160 self.putx([7, ['Start of encoded time (always 1)',
161 'Start of encoded time', 'SoeT']])
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).
168 self.ss_block = self.ss_bit
170 self.tmp |= (bit << (c - 21))
172 m = bcd2int(self.tmp)
173 self.putb([8, ['Minutes: %d' % m, 'Min: %d' % m]])
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).
184 self.ss_block = self.ss_bit
186 self.tmp |= (bit << (c - 29))
188 self.putb([10, ['Hours: %d' % bcd2int(self.tmp)]])
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).
199 self.ss_block = self.ss_bit
201 self.tmp |= (bit << (c - 36))
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.
209 self.ss_block = self.ss_bit
211 self.tmp |= (bit << (c - 42))
213 d = bcd2int(self.tmp)
214 dn = calendar.day_name[d - 1] # day_name[0] == Monday
215 self.putb([13, ['Day of week: %d (%s)' % (d, dn),
216 'DoW: %d (%s)' % (d, dn)]])
217 elif c in range(45, 49 + 1):
218 # Month (1-12): DCF77 bits 45-49 (BCD format).
221 self.ss_block = self.ss_bit
223 self.tmp |= (bit << (c - 45))
225 m = bcd2int(self.tmp)
226 mn = calendar.month_name[m] # month_name[1] == January
227 self.putb([14, ['Month: %d (%s)' % (m, mn),
228 'Mon: %d (%s)' % (m, mn)]])
229 elif c in range(50, 57 + 1):
230 # Year (0-99): DCF77 bits 50-57 (BCD format).
233 self.ss_block = self.ss_bit
235 self.tmp |= (bit << (c - 50))
237 self.putb([15, ['Year: %d' % bcd2int(self.tmp)]])
239 # Even parity over date bits (36-58): DCF77 bit 58.
240 parity = self.datebits.count(1)
241 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
242 self.putx([16, ['Date parity: %s' % s, 'DP: %s' % s]])
245 raise Exception('Invalid DCF77 bit: %d' % c)
247 def decode(self, ss, es, data):
248 if not self.samplerate:
249 raise SamplerateError('Cannot decode without samplerate.')
250 for (self.samplenum, pins) in data:
252 # Ignore identical samples early on (for performance reasons).
253 if self.oldpins == pins:
255 self.oldpins, (val,) = pins, pins
257 if self.state == 'WAIT FOR RISING EDGE':
258 # Wait until the next rising edge occurs.
259 if not (self.oldval == 0 and val == 1):
263 # Save the sample number where the DCF77 bit begins.
264 self.ss_bit = self.samplenum
266 # Calculate the length (in ms) between two rising edges.
267 len_edges = self.ss_bit - self.ss_bit_old
268 len_edges_ms = int((len_edges / self.samplerate) * 1000)
270 # The time between two rising edges is usually around 1000ms.
271 # For DCF77 bit 59, there is no rising edge at all, i.e. the
272 # time between DCF77 bit 59 and DCF77 bit 0 (of the next
273 # minute) is around 2000ms. Thus, if we see an edge with a
274 # 2000ms distance to the last one, this edge marks the
275 # beginning of a new minute (and DCF77 bit 0 of that minute).
276 if len_edges_ms in range(1600, 2400 + 1):
278 self.ss_bit_old = self.ss_bit
279 self.dcf77_bitnumber_is_known = 1
281 self.ss_bit_old = self.ss_bit
282 self.state = 'GET BIT'
284 elif self.state == 'GET BIT':
285 # Wait until the next falling edge occurs.
286 if not (self.oldval == 1 and val == 0):
290 # Save the sample number where the DCF77 bit ends.
291 self.es_bit = self.samplenum
293 # Calculate the length (in ms) of the current high period.
294 len_high = self.samplenum - self.ss_bit
295 len_high_ms = int((len_high / self.samplerate) * 1000)
297 # If the high signal was 100ms long, that encodes a 0 bit.
298 # If it was 200ms long, that encodes a 1 bit.
299 if len_high_ms in range(40, 160 + 1):
301 elif len_high_ms in range(161, 260 + 1):
304 bit = -1 # TODO: Error?
306 # There's no bit 59, make sure none is decoded.
307 if bit in (0, 1) and self.bitcount in range(0, 58 + 1):
308 self.handle_dcf77_bit(bit)
311 self.state = 'WAIT FOR RISING EDGE'