2 ## This file is part of the sigrok project.
4 ## Copyright (C) 2012 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
22 # DCF77 protocol decoder
25 # http://en.wikipedia.org/wiki/DCF77
29 # Protocol output format:
33 import sigrokdecode as srd
37 WAIT_FOR_RISING_EDGE = 0
40 # Annotation feed formats
43 # Return the specified BCD number (max. 8 bits) as integer.
45 return (b & 0x0f) + ((b >> 4) * 10)
47 class Decoder(srd.Decoder):
50 longname = 'DCF77 time protocol'
53 author = 'Uwe Hermann'
54 email = 'uwe@hermann-uwe.de'
59 {'id': 'data', 'name': 'DATA', 'desc': 'DATA line'},
64 ['ASCII', 'TODO: description'],
67 def __init__(self, **kwargs):
68 self.state = WAIT_FOR_RISING_EDGE
72 self.bit_start_old = 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')
84 # TODO: Which range to use? Only the 100ms/200ms or full second?
85 def handle_dcf77_bit(self, bit):
90 # Create one annotation for each DCF77 bit (containing the 0/1 value).
91 # Use 'Unknown DCF77 bit x: val' if we're not sure yet which of the
92 # 0..58 bits it is (because we haven't seen a 'new minute' marker yet).
93 # Otherwise, use 'DCF77 bit x: val'.
94 s = '' if self.dcf77_bitnumber_is_known else 'Unknown '
95 self.put(ss, es, a, [0, ['%sDCF77 bit %d: %d' % (s, c, bit)]])
97 # If we're not sure yet which of the 0..58 DCF77 bits we have, return.
98 # We don't want to decode bogus data.
99 if not self.dcf77_bitnumber_is_known:
102 # Output specific "decoded" annotations for the respective DCF77 bits.
104 # Start of minute: DCF bit 0.
106 self.put(ss, es, a, [0, ['Start of minute (always 0)']])
108 self.put(ss, es, a, [0, ['ERROR: Start of minute != 0']])
109 elif c in range(1, 14 + 1):
110 # Special bits (civil warnings, weather forecast): DCF77 bits 1-14.
114 self.tmp |= (bit << (c - 1))
116 self.put(ss, es, a, [0, ['Special bits: %s' % bin(self.tmp)]])
118 s = '' if (bit == 1) else 'not '
119 self.put(ss, es, a, [0, ['Call bit is %sset' % s]])
120 # TODO: Previously this bit indicated use of the backup antenna.
122 s = '' if (bit == 1) else 'not '
123 self.put(ss, es, a, [0, ['Summer time announcement %sactive' % s]])
125 s = '' if (bit == 1) else 'not '
126 self.put(ss, es, a, [0, ['CEST is %sin effect' % s]])
128 s = '' if (bit == 1) else 'not '
129 self.put(ss, es, a, [0, ['CET is %sin effect' % s]])
131 s = '' if (bit == 1) else 'not '
132 self.put(ss, es, a, [0, ['Leap second announcement %sactive' % s]])
134 # Start of encoded time: DCF bit 20.
136 self.put(ss, es, a, [0, ['Start of encoded time (always 1)']])
139 [0, ['ERROR: Start of encoded time != 1']])
140 elif c in range(21, 27 + 1):
141 # Minutes (0-59): DCF77 bits 21-27 (BCD format).
145 self.tmp |= (bit << (c - 21))
147 self.put(ss, es, a, [0, ['Minutes: %d' % bcd2int(self.tmp)]])
149 # Even parity over minute bits (21-28): DCF77 bit 28.
150 self.tmp |= (bit << (c - 21))
151 parity = bin(self.tmp).count('1')
152 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
153 self.put(ss, es, a, [0, ['Minute parity: %s' % s]])
154 elif c in range(29, 34 + 1):
155 # Hours (0-23): DCF77 bits 29-34 (BCD format).
159 self.tmp |= (bit << (c - 29))
161 self.put(ss, es, a, [0, ['Hours: %d' % bcd2int(self.tmp)]])
163 # Even parity over hour bits (29-35): DCF77 bit 35.
164 self.tmp |= (bit << (c - 29))
165 parity = bin(self.tmp).count('1')
166 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
167 self.put(ss, es, a, [0, ['Hour parity: %s' % s]])
168 elif c in range(36, 41 + 1):
169 # Day of month (1-31): DCF77 bits 36-41 (BCD format).
173 self.tmp |= (bit << (c - 36))
175 self.put(ss, es, a, [0, ['Day: %d' % bcd2int(self.tmp)]])
176 elif c in range(42, 44 + 1):
177 # Day of week (1-7): DCF77 bits 42-44 (BCD format).
178 # A value of 1 means Monday, 7 means Sunday.
182 self.tmp |= (bit << (c - 42))
184 d = bcd2int(self.tmp)
185 dn = calendar.day_name[d - 1] # day_name[0] == Monday
186 self.put(ss, es, a, [0, ['Day of week: %d (%s)' % (d, dn)]])
187 elif c in range(45, 49 + 1):
188 # Month (1-12): DCF77 bits 45-49 (BCD format).
192 self.tmp |= (bit << (c - 45))
194 m = bcd2int(self.tmp)
195 mn = calendar.month_name[m] # month_name[1] == January
196 self.put(ss, es, a, [0, ['Month: %d (%s)' % (m, mn)]])
197 elif c in range(50, 57 + 1):
198 # Year (0-99): DCF77 bits 50-57 (BCD format).
202 self.tmp |= (bit << (c - 50))
204 self.put(ss, es, a, [0, ['Year: %d' % bcd2int(self.tmp)]])
206 # Even parity over date bits (36-58): DCF77 bit 58.
207 self.tmp |= (bit << (c - 50))
208 parity = bin(self.tmp).count('1')
209 s = 'OK' if ((parity % 2) == 0) else 'INVALID!'
210 self.put(ss, es, a, [0, ['Date parity: %s' % s]])
212 raise Exception('Invalid DCF77 bit: %d' % c)
214 def decode(self, ss, es, data):
215 for samplenum, (pon, val) in data: # FIXME
217 self.samplenum += 1 # FIXME. Use samplenum. Off-by-one?
219 if self.state == WAIT_FOR_RISING_EDGE:
220 # Wait until the next rising edge occurs.
221 if not (self.oldval == 0 and val == 1):
225 # Save the sample number where the DCF77 bit begins.
226 self.bit_start = self.samplenum
228 # Calculate the length (in ms) between two rising edges.
229 len_edges = self.bit_start - self.bit_start_old
230 len_edges_ms = int((len_edges / self.samplerate) * 1000)
232 # The time between two rising edges is usually around 1000ms.
233 # For DCF77 bit 59, there is no rising edge at all, i.e. the
234 # time between DCF77 bit 59 and DCF77 bit 0 (of the next
235 # minute) is around 2000ms. Thus, if we see an edge with a
236 # 2000ms distance to the last one, this edge marks the
237 # beginning of a new minute (and DCF77 bit 0 of that minute).
238 if len_edges_ms in range(1600, 2400 + 1):
239 self.put(ss, es, self.out_ann, [0, ['New minute starts']])
241 self.bit_start_old = self.bit_start
242 self.dcf77_bitnumber_is_known = 1
243 # Don't switch to GET_BIT state this time.
246 self.bit_start_old = self.bit_start
249 elif self.state == GET_BIT:
250 # Wait until the next falling edge occurs.
251 if not (self.oldval == 1 and val == 0):
255 # Calculate the length (in ms) of the current high period.
256 len_high = self.samplenum - self.bit_start
257 len_high_ms = int((len_high / self.samplerate) * 1000)
259 # If the high signal was 100ms long, that encodes a 0 bit.
260 # If it was 200ms long, that encodes a 1 bit.
261 if len_high_ms in range(40, 160 + 1):
263 elif len_high_ms in range(161, 260 + 1):
266 bit = -1 # TODO: Error?
268 # TODO: There's no bit 59, make sure none is decoded.
269 if bit in (0, 1) and self.bitcount in range(0, 58 + 1):
270 self.handle_dcf77_bit(bit)
273 self.state = WAIT_FOR_RISING_EDGE
276 raise Exception('Invalid state: %s' % self.state)