2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012-2016 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, see <http://www.gnu.org/licenses/>.
20 import sigrokdecode as srd
22 from common.srdhelper import bcd2int
24 class SamplerateError(Exception):
27 class Decoder(srd.Decoder):
31 longname = 'DCF77 time protocol'
32 desc = 'European longwave time signal (77.5kHz carrier signal).'
37 {'id': 'data', 'name': 'DATA', 'desc': 'DATA line'},
40 ('start-of-minute', 'Start of minute'),
41 ('special-bits', 'Special bits (civil warnings, weather forecast)'),
42 ('call-bit', 'Call bit'),
43 ('summer-time', 'Summer time announcement'),
46 ('leap-second', 'Leap second bit'),
47 ('start-of-time', 'Start of encoded time'),
49 ('minute-parity', 'Minute parity bit'),
51 ('hour-parity', 'Hour parity bit'),
52 ('day', 'Day of month'),
53 ('day-of-week', 'Day of week'),
56 ('date-parity', 'Date parity bit'),
57 ('raw-bits', 'Raw bits'),
58 ('unknown-bits', 'Unknown bits'),
59 ('warnings', 'Human-readable warnings'),
62 ('bits', 'Bits', (17, 18)),
63 ('fields', 'Fields', tuple(range(0, 16 + 1))),
64 ('warnings', 'Warnings', (19,)),
68 self.samplerate = None
69 self.state = 'WAIT FOR RISING EDGE'
70 self.ss_bit = self.ss_bit_old = self.es_bit = self.ss_block = 0
72 self.bitcount = 0 # Counter for the DCF77 bits (0..58)
73 self.dcf77_bitnumber_is_known = 0
76 self.out_ann = self.register(srd.OUTPUT_ANN)
78 def metadata(self, key, value):
79 if key == srd.SRD_CONF_SAMPLERATE:
80 self.samplerate = value
83 # Annotation for a single DCF77 bit.
84 self.put(self.ss_bit, self.es_bit, self.out_ann, data)
87 # Annotation for a multi-bit DCF77 field.
88 self.put(self.ss_block, self.samplenum, self.out_ann, data)
90 # TODO: Which range to use? Only the 100ms/200ms or full second?
91 def handle_dcf77_bit(self, bit):
94 # Create one annotation for each DCF77 bit (containing the 0/1 value).
95 # Use 'Unknown DCF77 bit x: val' if we're not sure yet which of the
96 # 0..58 bits it is (because we haven't seen a 'new minute' marker yet).
97 # Otherwise, use 'DCF77 bit x: val'.
98 s = 'B' if self.dcf77_bitnumber_is_known else 'Unknown b'
99 ann = 17 if self.dcf77_bitnumber_is_known else 18
100 self.putx([ann, ['%sit %d: %d' % (s, c, bit), '%d' % bit]])
102 # If we're not sure yet which of the 0..58 DCF77 bits we have, return.
103 # We don't want to decode bogus data.
104 if not self.dcf77_bitnumber_is_known:
107 # Collect bits 36-58, we'll need them for a parity check later.
108 if c in range(36, 58 + 1):
109 self.datebits.append(bit)
111 # Output specific "decoded" annotations for the respective DCF77 bits.
113 # Start of minute: DCF bit 0.
115 self.putx([0, ['Start of minute (always 0)',
116 'Start of minute', 'SoM']])
118 self.putx([19, ['Start of minute != 0', 'SoM != 0']])
119 elif c in range(1, 14 + 1):
120 # Special bits (civil warnings, weather forecast): DCF77 bits 1-14.
123 self.ss_block = self.ss_bit
125 self.tmp |= (bit << (c - 1))
127 s = bin(self.tmp)[2:].zfill(14)
128 self.putb([1, ['Special bits: %s' % s, 'SB: %s' % s]])
130 s = '' if (bit == 1) else 'not '
131 self.putx([2, ['Call bit: %sset' % s, 'CB: %sset' % s]])
132 # TODO: Previously this bit indicated use of the backup antenna.
134 s = '' if (bit == 1) else 'not '
135 x = 'yes' if (bit == 1) else 'no'
136 self.putx([3, ['Summer time announcement: %sactive' % s,
137 'Summer time: %sactive' % s,
138 'Summer time: %s' % x, 'ST: %s' % x]])
140 s = '' if (bit == 1) else 'not '
141 x = 'yes' if (bit == 1) else 'no'
142 self.putx([4, ['CEST: %sin effect' % s, 'CEST: %s' % x]])
144 s = '' if (bit == 1) else 'not '
145 x = 'yes' if (bit == 1) else 'no'
146 self.putx([5, ['CET: %sin effect' % s, 'CET: %s' % x]])
148 s = '' if (bit == 1) else 'not '
149 x = 'yes' if (bit == 1) else 'no'
150 self.putx([6, ['Leap second announcement: %sactive' % s,
151 'Leap second: %sactive' % s,
152 'Leap second: %s' % x, 'LS: %s' % x]])
154 # Start of encoded time: DCF bit 20.
156 self.putx([7, ['Start of encoded time (always 1)',
157 'Start of encoded time', 'SoeT']])
159 self.putx([19, ['Start of encoded time != 1', 'SoeT != 1']])
160 elif c in range(21, 27 + 1):
161 # Minutes (0-59): DCF77 bits 21-27 (BCD format).
164 self.ss_block = self.ss_bit
166 self.tmp |= (bit << (c - 21))
168 m = bcd2int(self.tmp)
169 self.putb([8, ['Minutes: %d' % m, 'Min: %d' % m]])
171 # Even parity over minute bits (21-28): DCF77 bit 28.
172 self.tmp |= (bit << (c - 21))
173 parity = bin(self.tmp).count('1')
174 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
175 self.putx([9, ['Minute parity: %s' % s, 'Min parity: %s' % s]])
176 elif c in range(29, 34 + 1):
177 # Hours (0-23): DCF77 bits 29-34 (BCD format).
180 self.ss_block = self.ss_bit
182 self.tmp |= (bit << (c - 29))
184 self.putb([10, ['Hours: %d' % bcd2int(self.tmp)]])
186 # Even parity over hour bits (29-35): DCF77 bit 35.
187 self.tmp |= (bit << (c - 29))
188 parity = bin(self.tmp).count('1')
189 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
190 self.putx([11, ['Hour parity: %s' % s]])
191 elif c in range(36, 41 + 1):
192 # Day of month (1-31): DCF77 bits 36-41 (BCD format).
195 self.ss_block = self.ss_bit
197 self.tmp |= (bit << (c - 36))
199 self.putb([12, ['Day: %d' % bcd2int(self.tmp)]])
200 elif c in range(42, 44 + 1):
201 # Day of week (1-7): DCF77 bits 42-44 (BCD format).
202 # A value of 1 means Monday, 7 means Sunday.
205 self.ss_block = self.ss_bit
207 self.tmp |= (bit << (c - 42))
209 d = bcd2int(self.tmp)
210 dn = calendar.day_name[d - 1] # day_name[0] == Monday
211 self.putb([13, ['Day of week: %d (%s)' % (d, dn),
212 'DoW: %d (%s)' % (d, dn)]])
213 elif c in range(45, 49 + 1):
214 # Month (1-12): DCF77 bits 45-49 (BCD format).
217 self.ss_block = self.ss_bit
219 self.tmp |= (bit << (c - 45))
221 m = bcd2int(self.tmp)
222 mn = calendar.month_name[m] # month_name[1] == January
223 self.putb([14, ['Month: %d (%s)' % (m, mn),
224 'Mon: %d (%s)' % (m, mn)]])
225 elif c in range(50, 57 + 1):
226 # Year (0-99): DCF77 bits 50-57 (BCD format).
229 self.ss_block = self.ss_bit
231 self.tmp |= (bit << (c - 50))
233 self.putb([15, ['Year: %d' % bcd2int(self.tmp)]])
235 # Even parity over date bits (36-58): DCF77 bit 58.
236 parity = self.datebits.count(1)
237 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
238 self.putx([16, ['Date parity: %s' % s, 'DP: %s' % s]])
241 raise Exception('Invalid DCF77 bit: %d' % c)
244 if not self.samplerate:
245 raise SamplerateError('Cannot decode without samplerate.')
247 if self.state == 'WAIT FOR RISING EDGE':
248 # Wait until the next rising edge occurs.
251 # Save the sample number where the DCF77 bit begins.
252 self.ss_bit = self.samplenum
254 # Calculate the length (in ms) between two rising edges.
255 len_edges = self.ss_bit - self.ss_bit_old
256 len_edges_ms = int((len_edges / self.samplerate) * 1000)
258 # The time between two rising edges is usually around 1000ms.
259 # For DCF77 bit 59, there is no rising edge at all, i.e. the
260 # time between DCF77 bit 59 and DCF77 bit 0 (of the next
261 # minute) is around 2000ms. Thus, if we see an edge with a
262 # 2000ms distance to the last one, this edge marks the
263 # beginning of a new minute (and DCF77 bit 0 of that minute).
264 if len_edges_ms in range(1600, 2400 + 1):
266 self.ss_bit_old = self.ss_bit
267 self.dcf77_bitnumber_is_known = 1
269 self.ss_bit_old = self.ss_bit
270 self.state = 'GET BIT'
272 elif self.state == 'GET BIT':
273 # Wait until the next falling edge occurs.
276 # Save the sample number where the DCF77 bit ends.
277 self.es_bit = self.samplenum
279 # Calculate the length (in ms) of the current high period.
280 len_high = self.samplenum - self.ss_bit
281 len_high_ms = int((len_high / self.samplerate) * 1000)
283 # If the high signal was 100ms long, that encodes a 0 bit.
284 # If it was 200ms long, that encodes a 1 bit.
285 if len_high_ms in range(40, 160 + 1):
287 elif len_high_ms in range(161, 260 + 1):
290 bit = -1 # TODO: Error?
292 # There's no bit 59, make sure none is decoded.
293 if bit in (0, 1) and self.bitcount in range(0, 58 + 1):
294 self.handle_dcf77_bit(bit)
297 self.state = 'WAIT FOR RISING EDGE'