2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2012-2013 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 # DCF77 protocol decoder
23 import sigrokdecode as srd
26 # Return the specified BCD number (max. 8 bits) as integer.
28 return (b & 0x0f) + ((b >> 4) * 10)
30 class Decoder(srd.Decoder):
34 longname = 'DCF77 time protocol'
35 desc = 'European longwave time signal (77.5kHz carrier signal).'
40 {'id': 'data', 'name': 'DATA', 'desc': 'DATA line'},
45 ['start_of_minute', 'Start of minute'],
46 ['special_bits', 'Special bits (civil warnings, weather forecast)'],
47 ['call_bit', 'Call bit'],
48 ['summer_time', 'Summer time announcement'],
51 ['leap_second', 'Leap second bit'],
52 ['start_of_time', 'Start of encoded time'],
54 ['minute_parity', 'Minute parity bit'],
56 ['hour_parity', 'Hour parity bit'],
57 ['day', 'Day of month'],
58 ['day_of_week', 'Day of week'],
61 ['date_parity', 'Date parity bit'],
62 ['raw_bits', 'Raw bits'],
63 ['unknown_bits', 'Unknown bits'],
64 ['warnings', 'Human-readable warnings'],
67 def __init__(self, **kwargs):
68 self.state = 'WAIT FOR RISING EDGE'
72 self.ss_bit = self.ss_bit_old = self.es_bit = self.ss_block = 0
73 self.bitcount = 0 # Counter for the DCF77 bits (0..58)
74 self.dcf77_bitnumber_is_known = 0
76 def start(self, metadata):
77 self.samplerate = metadata['samplerate']
78 # self.out_proto = self.add(srd.OUTPUT_PROTO, 'dcf77')
79 self.out_ann = self.add(srd.OUTPUT_ANN, 'dcf77')
85 # Annotation for a single DCF77 bit.
86 self.put(self.ss_bit, self.es_bit, self.out_ann, data)
89 # Annotation for a multi-bit DCF77 field.
90 self.put(self.ss_block, self.samplenum, self.out_ann, data)
92 # TODO: Which range to use? Only the 100ms/200ms or full second?
93 def handle_dcf77_bit(self, bit):
96 # Create one annotation for each DCF77 bit (containing the 0/1 value).
97 # Use 'Unknown DCF77 bit x: val' if we're not sure yet which of the
98 # 0..58 bits it is (because we haven't seen a 'new minute' marker yet).
99 # Otherwise, use 'DCF77 bit x: val'.
100 s = '' if self.dcf77_bitnumber_is_known else 'Unknown '
101 self.putx([18, ['%sDCF77 bit %d: %d' % (s, c, bit)]])
103 # If we're not sure yet which of the 0..58 DCF77 bits we have, return.
104 # We don't want to decode bogus data.
105 if not self.dcf77_bitnumber_is_known:
108 # Output specific "decoded" annotations for the respective DCF77 bits.
110 # Start of minute: DCF bit 0.
112 self.putx([0, ['Start of minute (always 0)']])
114 self.putx([19, ['Start of minute != 0']])
115 elif c in range(1, 14 + 1):
116 # Special bits (civil warnings, weather forecast): DCF77 bits 1-14.
119 self.ss_block = self.ss_bit
121 self.tmp |= (bit << (c - 1))
123 self.putb([1, ['Special bits: %s' % bin(self.tmp)]])
125 s = '' if (bit == 1) else 'not '
126 self.putx([2, ['Call bit is %sset' % s]])
127 # TODO: Previously this bit indicated use of the backup antenna.
129 s = '' if (bit == 1) else 'not '
130 self.putx([3, ['Summer time announcement %sactive' % s]])
132 s = '' if (bit == 1) else 'not '
133 self.putx([4, ['CEST is %sin effect' % s]])
135 s = '' if (bit == 1) else 'not '
136 self.putx([5, ['CET is %sin effect' % s]])
138 s = '' if (bit == 1) else 'not '
139 self.putx([6, ['Leap second announcement %sactive' % s]])
141 # Start of encoded time: DCF bit 20.
143 self.putx([7, ['Start of encoded time (always 1)']])
145 self.putx([19, ['ERROR: Start of encoded time != 1']])
146 elif c in range(21, 27 + 1):
147 # Minutes (0-59): DCF77 bits 21-27 (BCD format).
150 self.ss_block = self.ss_bit
152 self.tmp |= (bit << (c - 21))
154 self.putb([8, ['Minutes: %d' % bcd2int(self.tmp)]])
156 # Even parity over minute bits (21-28): DCF77 bit 28.
157 self.tmp |= (bit << (c - 21))
158 parity = bin(self.tmp).count('1')
159 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
160 self.putx([9, ['Minute parity: %s' % s]])
161 elif c in range(29, 34 + 1):
162 # Hours (0-23): DCF77 bits 29-34 (BCD format).
165 self.ss_block = self.ss_bit
167 self.tmp |= (bit << (c - 29))
169 self.putb([10, ['Hours: %d' % bcd2int(self.tmp)]])
171 # Even parity over hour bits (29-35): DCF77 bit 35.
172 self.tmp |= (bit << (c - 29))
173 parity = bin(self.tmp).count('1')
174 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
175 self.putx([11, ['Hour parity: %s' % s]])
176 elif c in range(36, 41 + 1):
177 # Day of month (1-31): DCF77 bits 36-41 (BCD format).
180 self.ss_block = self.ss_bit
182 self.tmp |= (bit << (c - 36))
184 self.putb([12, ['Day: %d' % bcd2int(self.tmp)]])
185 elif c in range(42, 44 + 1):
186 # Day of week (1-7): DCF77 bits 42-44 (BCD format).
187 # A value of 1 means Monday, 7 means Sunday.
190 self.ss_block = self.ss_bit
192 self.tmp |= (bit << (c - 42))
194 d = bcd2int(self.tmp)
195 dn = calendar.day_name[d - 1] # day_name[0] == Monday
196 self.putb([13, ['Day of week: %d (%s)' % (d, dn)]])
197 elif c in range(45, 49 + 1):
198 # Month (1-12): DCF77 bits 45-49 (BCD format).
201 self.ss_block = self.ss_bit
203 self.tmp |= (bit << (c - 45))
205 m = bcd2int(self.tmp)
206 mn = calendar.month_name[m] # month_name[1] == January
207 self.putx([14, ['Month: %d (%s)' % (m, mn)]])
208 elif c in range(50, 57 + 1):
209 # Year (0-99): DCF77 bits 50-57 (BCD format).
212 self.ss_block = self.ss_bit
214 self.tmp |= (bit << (c - 50))
216 self.putb([15, ['Year: %d' % bcd2int(self.tmp)]])
218 # Even parity over date bits (36-58): DCF77 bit 58.
219 self.tmp |= (bit << (c - 50))
220 parity = bin(self.tmp).count('1')
221 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
222 self.putx([16, ['Date parity: %s' % s]])
224 raise Exception('Invalid DCF77 bit: %d' % c)
226 def decode(self, ss, es, data):
227 for (self.samplenum, pins) in data:
229 # Ignore identical samples early on (for performance reasons).
230 if self.oldpins == pins:
232 self.oldpins, (val,) = pins, pins
234 if self.state == 'WAIT FOR RISING EDGE':
235 # Wait until the next rising edge occurs.
236 if not (self.oldval == 0 and val == 1):
240 # Save the sample number where the DCF77 bit begins.
241 self.ss_bit = self.samplenum
243 # Calculate the length (in ms) between two rising edges.
244 len_edges = self.ss_bit - self.ss_bit_old
245 len_edges_ms = int((len_edges / self.samplerate) * 1000)
247 # The time between two rising edges is usually around 1000ms.
248 # For DCF77 bit 59, there is no rising edge at all, i.e. the
249 # time between DCF77 bit 59 and DCF77 bit 0 (of the next
250 # minute) is around 2000ms. Thus, if we see an edge with a
251 # 2000ms distance to the last one, this edge marks the
252 # beginning of a new minute (and DCF77 bit 0 of that minute).
253 if len_edges_ms in range(1600, 2400 + 1):
255 self.ss_bit_old = self.ss_bit
256 self.dcf77_bitnumber_is_known = 1
258 self.ss_bit_old = self.ss_bit
259 self.state = 'GET BIT'
261 elif self.state == 'GET BIT':
262 # Wait until the next falling edge occurs.
263 if not (self.oldval == 1 and val == 0):
267 # Save the sample number where the DCF77 bit ends.
268 self.es_bit = self.samplenum
270 # Calculate the length (in ms) of the current high period.
271 len_high = self.samplenum - self.ss_bit
272 len_high_ms = int((len_high / self.samplerate) * 1000)
274 # If the high signal was 100ms long, that encodes a 0 bit.
275 # If it was 200ms long, that encodes a 1 bit.
276 if len_high_ms in range(40, 160 + 1):
278 elif len_high_ms in range(161, 260 + 1):
281 bit = -1 # TODO: Error?
283 # There's no bit 59, make sure none is decoded.
284 if bit in (0, 1) and self.bitcount in range(0, 58 + 1):
285 self.handle_dcf77_bit(bit)
288 self.state = 'WAIT FOR RISING EDGE'
291 raise Exception('Invalid state: %s' % self.state)