1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-01-04 $'.split()[1]
5 __author__ = 'xmlbinmsg'
6
7 __doc__='''
8
9 Autogenerated python functions to serialize/deserialize binary messages.
10
11 Generated by: ./aisxmlbinmsg2py.py
12
13 Need to then wrap these functions with the outer AIS packet and then
14 convert the whole binary blob to a NMEA string. Those functions are
15 not currently provided in this file.
16
17 serialize: python to ais binary
18 deserialize: ais binary to python
19
20 The generated code uses translators.py, binary.py, and aisstring.py
21 which should be packaged with the resulting files.
22
23
24 @requires: U{epydoc<http://epydoc.sourceforge.net/>} > 3.0alpha3
25 @requires: U{BitVector<http://cheeseshop.python.org/pypi/BitVector>}
26
27 @author: '''+__author__+'''
28 @version: ''' + __version__ +'''
29 @var __date__: Date of last svn commit
30 @undocumented: __version__ __author__ __doc__ parser
31 @status: under development
32 @license: Generated code has no license
33 '''
34
35 import sys
36 from decimal import Decimal
37 from BitVector import BitVector
38
39 import binary, aisstring
40
41
42 TrueBV = BitVector(bitstring="1")
43 "Why always rebuild the True bit? This should speed things up a bunch"
44 FalseBV = BitVector(bitstring="0")
45 "Why always rebuild the False bit? This should speed things up a bunch"
46
47
48 -def encode(params, validate=False):
49 '''Create a waterlevel binary message payload to pack into an AIS Msg waterlevel.
50
51 Fields in params:
52 - dac(uint): Designated Area Code (field automatically set to "366")
53 - fid(uint): Functional Identifier (field automatically set to "1")
54 - efid(uint): extended functional identifier (field automatically set to "1")
55 - timetag_month(uint): Time the measurement represents month 1..12
56 - timetag_day(uint): Time the measurement represents day of the month 1..31
57 - timetag_hour(uint): Time the measurement represents UTC hours 0..23
58 - timetag_min(uint): Time the measurement represents minutes
59 - timetag_sec(uint): Time the measurement represents seconds
60 - stationid(aisstr6): Character identifier of the station. Usually a number.
61 - stationloc_longitude(decimal): Location of the sensor taking the water level measurement or position of prediction East West location
62 - stationloc_latitude(decimal): Location of the sensor taking the water level measurement or position of prediction North South location
63 - waterlevel(int): Water level in centimeters
64 - datum(uint): What reference datum applies to the value
65 - sigma(float): Standard deviation of 1 second samples used to compute the water level height
66 - o(uint): Count of number of samples that fall outside a 3-sigma band about the mean
67 - levelinferred(bool): indicates that the water level value has been inferred
68 - flat_tolerance_exceeded(bool): flat tolerance limit was exceeded. Need better descr
69 - rate_tolerance_exceeded(bool): rate of change tolerance limit was exceeded
70 - temp_tolerance_exceeded(bool): temperature difference tolerance limit was exceeded
71 - expected_height_exceeded(bool): either the maximum or minimum expected water level height limit was exceeded
72 - link_down(bool): Unable to communicate with the tide system. All data invalid
73 - timeLastMeasured_month(uint): Time since last measured value was available month 1..12
74 - timeLastMeasured_day(uint): Time since last measured value was available day of the month 1..31
75 - timeLastMeasured_hour(uint): Time since last measured value was available UTC hours 0..23
76 - timeLastMeasured_min(uint): Time since last measured value was available minutes
77 - timeLastMeasured_sec(uint): Time since last measured value was available seconds
78 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
79 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
80 @rtype: BitVector
81 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
82 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
83 '''
84
85 bvList = []
86 bvList.append(binary.setBitVectorSize(BitVector(intVal=366),16))
87 bvList.append(binary.setBitVectorSize(BitVector(intVal=1),4))
88 bvList.append(binary.setBitVectorSize(BitVector(intVal=1),12))
89 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timetag_month']),4))
90 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timetag_day']),5))
91 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timetag_hour']),5))
92 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timetag_min']),6))
93 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timetag_sec']),6))
94 if 'stationid' in params:
95 bvList.append(aisstring.encode(params['stationid'],42))
96 else:
97 bvList.append(aisstring.encode('@@@@@@@',42))
98 if 'stationloc_longitude' in params:
99 bvList.append(binary.bvFromSignedInt(int(Decimal(params['stationloc_longitude'])*Decimal('600000')),28))
100 else:
101 bvList.append(binary.bvFromSignedInt(108600000,28))
102 if 'stationloc_latitude' in params:
103 bvList.append(binary.bvFromSignedInt(int(Decimal(params['stationloc_latitude'])*Decimal('600000')),27))
104 else:
105 bvList.append(binary.bvFromSignedInt(54600000,27))
106 if 'waterlevel' in params:
107 bvList.append(binary.bvFromSignedInt(params['waterlevel'],16))
108 else:
109 bvList.append(binary.bvFromSignedInt(-32768,16))
110 if 'datum' in params:
111 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['datum']),5))
112 else:
113 bvList.append(binary.setBitVectorSize(BitVector(intVal=31),5))
114 bvList.append(binary.float2bitvec(params['sigma']))
115 if 'o' in params:
116 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['o']),8))
117 else:
118 bvList.append(binary.setBitVectorSize(BitVector(intVal=255),8))
119 if params["levelinferred"]: bvList.append(TrueBV)
120 else: bvList.append(FalseBV)
121 if params["flat_tolerance_exceeded"]: bvList.append(TrueBV)
122 else: bvList.append(FalseBV)
123 if params["rate_tolerance_exceeded"]: bvList.append(TrueBV)
124 else: bvList.append(FalseBV)
125 if params["temp_tolerance_exceeded"]: bvList.append(TrueBV)
126 else: bvList.append(FalseBV)
127 if params["expected_height_exceeded"]: bvList.append(TrueBV)
128 else: bvList.append(FalseBV)
129 if params["link_down"]: bvList.append(TrueBV)
130 else: bvList.append(FalseBV)
131 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeLastMeasured_month']),4))
132 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeLastMeasured_day']),5))
133 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeLastMeasured_hour']),5))
134 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeLastMeasured_min']),6))
135 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeLastMeasured_sec']),6))
136
137 return binary.joinBV(bvList)
138
139 -def decode(bv, validate=False):
140 '''Unpack a waterlevel message
141
142 Fields in params:
143 - dac(uint): Designated Area Code (field automatically set to "366")
144 - fid(uint): Functional Identifier (field automatically set to "1")
145 - efid(uint): extended functional identifier (field automatically set to "1")
146 - timetag_month(uint): Time the measurement represents month 1..12
147 - timetag_day(uint): Time the measurement represents day of the month 1..31
148 - timetag_hour(uint): Time the measurement represents UTC hours 0..23
149 - timetag_min(uint): Time the measurement represents minutes
150 - timetag_sec(uint): Time the measurement represents seconds
151 - stationid(aisstr6): Character identifier of the station. Usually a number.
152 - stationloc_longitude(decimal): Location of the sensor taking the water level measurement or position of prediction East West location
153 - stationloc_latitude(decimal): Location of the sensor taking the water level measurement or position of prediction North South location
154 - waterlevel(int): Water level in centimeters
155 - datum(uint): What reference datum applies to the value
156 - sigma(float): Standard deviation of 1 second samples used to compute the water level height
157 - o(uint): Count of number of samples that fall outside a 3-sigma band about the mean
158 - levelinferred(bool): indicates that the water level value has been inferred
159 - flat_tolerance_exceeded(bool): flat tolerance limit was exceeded. Need better descr
160 - rate_tolerance_exceeded(bool): rate of change tolerance limit was exceeded
161 - temp_tolerance_exceeded(bool): temperature difference tolerance limit was exceeded
162 - expected_height_exceeded(bool): either the maximum or minimum expected water level height limit was exceeded
163 - link_down(bool): Unable to communicate with the tide system. All data invalid
164 - timeLastMeasured_month(uint): Time since last measured value was available month 1..12
165 - timeLastMeasured_day(uint): Time since last measured value was available day of the month 1..31
166 - timeLastMeasured_hour(uint): Time since last measured value was available UTC hours 0..23
167 - timeLastMeasured_min(uint): Time since last measured value was available minutes
168 - timeLastMeasured_sec(uint): Time since last measured value was available seconds
169 @type bv: BitVector
170 @param bv: Bits defining a message
171 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
172 @rtype: dict
173 @return: params
174 '''
175
176
177
178
179 r = {}
180 r['dac']=366
181 r['fid']=1
182 r['efid']=1
183 r['timetag_month']=int(bv[32:36])
184 r['timetag_day']=int(bv[36:41])
185 r['timetag_hour']=int(bv[41:46])
186 r['timetag_min']=int(bv[46:52])
187 r['timetag_sec']=int(bv[52:58])
188 r['stationid']=aisstring.decode(bv[58:100])
189 r['stationloc_longitude']=Decimal(binary.signedIntFromBV(bv[100:128]))/Decimal('600000')
190 r['stationloc_latitude']=Decimal(binary.signedIntFromBV(bv[128:155]))/Decimal('600000')
191 r['waterlevel']=binary.signedIntFromBV(bv[155:171])
192 r['datum']=int(bv[171:176])
193 r['sigma']=binary.bitvec2float(bv[176:208])
194 r['o']=int(bv[208:216])
195 r['levelinferred']=bool(int(bv[216:217]))
196 r['flat_tolerance_exceeded']=bool(int(bv[217:218]))
197 r['rate_tolerance_exceeded']=bool(int(bv[218:219]))
198 r['temp_tolerance_exceeded']=bool(int(bv[219:220]))
199 r['expected_height_exceeded']=bool(int(bv[220:221]))
200 r['link_down']=bool(int(bv[221:222]))
201 r['timeLastMeasured_month']=int(bv[222:226])
202 r['timeLastMeasured_day']=int(bv[226:231])
203 r['timeLastMeasured_hour']=int(bv[231:236])
204 r['timeLastMeasured_min']=int(bv[236:242])
205 r['timeLastMeasured_sec']=int(bv[242:248])
206 return r
207
209 return 366
210
212 return 1
213
215 return 1
216
219
222
225
228
231
234
237
240
243
245 return int(bv[171:176])
246
249
251 return int(bv[208:216])
252
254 return bool(int(bv[216:217]))
255
257 return bool(int(bv[217:218]))
258
260 return bool(int(bv[218:219]))
261
263 return bool(int(bv[219:220]))
264
266 return bool(int(bv[220:221]))
267
269 return bool(int(bv[221:222]))
270
272 return int(bv[222:226])
273
275 return int(bv[226:231])
276
278 return int(bv[231:236])
279
281 return int(bv[236:242])
282
284 return int(bv[242:248])
285
287 '''Print a waterlevel message to stdout.
288
289 Fields in params:
290 - dac(uint): Designated Area Code (field automatically set to "366")
291 - fid(uint): Functional Identifier (field automatically set to "1")
292 - efid(uint): extended functional identifier (field automatically set to "1")
293 - timetag_month(uint): Time the measurement represents month 1..12
294 - timetag_day(uint): Time the measurement represents day of the month 1..31
295 - timetag_hour(uint): Time the measurement represents UTC hours 0..23
296 - timetag_min(uint): Time the measurement represents minutes
297 - timetag_sec(uint): Time the measurement represents seconds
298 - stationid(aisstr6): Character identifier of the station. Usually a number.
299 - stationloc_longitude(decimal): Location of the sensor taking the water level measurement or position of prediction East West location
300 - stationloc_latitude(decimal): Location of the sensor taking the water level measurement or position of prediction North South location
301 - waterlevel(int): Water level in centimeters
302 - datum(uint): What reference datum applies to the value
303 - sigma(float): Standard deviation of 1 second samples used to compute the water level height
304 - o(uint): Count of number of samples that fall outside a 3-sigma band about the mean
305 - levelinferred(bool): indicates that the water level value has been inferred
306 - flat_tolerance_exceeded(bool): flat tolerance limit was exceeded. Need better descr
307 - rate_tolerance_exceeded(bool): rate of change tolerance limit was exceeded
308 - temp_tolerance_exceeded(bool): temperature difference tolerance limit was exceeded
309 - expected_height_exceeded(bool): either the maximum or minimum expected water level height limit was exceeded
310 - link_down(bool): Unable to communicate with the tide system. All data invalid
311 - timeLastMeasured_month(uint): Time since last measured value was available month 1..12
312 - timeLastMeasured_day(uint): Time since last measured value was available day of the month 1..31
313 - timeLastMeasured_hour(uint): Time since last measured value was available UTC hours 0..23
314 - timeLastMeasured_min(uint): Time since last measured value was available minutes
315 - timeLastMeasured_sec(uint): Time since last measured value was available seconds
316 @param params: Dictionary of field names/values.
317 @param out: File like object to write to
318 @rtype: stdout
319 @return: text to out
320 '''
321
322 if 'std'==format:
323 out.write("waterlevel:\n")
324 if 'dac' in params: out.write(" dac: "+str(params['dac'])+"\n")
325 if 'fid' in params: out.write(" fid: "+str(params['fid'])+"\n")
326 if 'efid' in params: out.write(" efid: "+str(params['efid'])+"\n")
327 if 'timetag_month' in params: out.write(" timetag_month: "+str(params['timetag_month'])+"\n")
328 if 'timetag_day' in params: out.write(" timetag_day: "+str(params['timetag_day'])+"\n")
329 if 'timetag_hour' in params: out.write(" timetag_hour: "+str(params['timetag_hour'])+"\n")
330 if 'timetag_min' in params: out.write(" timetag_min: "+str(params['timetag_min'])+"\n")
331 if 'timetag_sec' in params: out.write(" timetag_sec: "+str(params['timetag_sec'])+"\n")
332 if 'stationid' in params: out.write(" stationid: "+str(params['stationid'])+"\n")
333 if 'stationloc_longitude' in params: out.write(" stationloc_longitude: "+str(params['stationloc_longitude'])+"\n")
334 if 'stationloc_latitude' in params: out.write(" stationloc_latitude: "+str(params['stationloc_latitude'])+"\n")
335 if 'waterlevel' in params: out.write(" waterlevel: "+str(params['waterlevel'])+"\n")
336 if 'datum' in params: out.write(" datum: "+str(params['datum'])+"\n")
337 if 'sigma' in params: out.write(" sigma: "+str(params['sigma'])+"\n")
338 if 'o' in params: out.write(" o: "+str(params['o'])+"\n")
339 if 'levelinferred' in params: out.write(" levelinferred: "+str(params['levelinferred'])+"\n")
340 if 'flat_tolerance_exceeded' in params: out.write(" flat_tolerance_exceeded: "+str(params['flat_tolerance_exceeded'])+"\n")
341 if 'rate_tolerance_exceeded' in params: out.write(" rate_tolerance_exceeded: "+str(params['rate_tolerance_exceeded'])+"\n")
342 if 'temp_tolerance_exceeded' in params: out.write(" temp_tolerance_exceeded: "+str(params['temp_tolerance_exceeded'])+"\n")
343 if 'expected_height_exceeded' in params: out.write(" expected_height_exceeded: "+str(params['expected_height_exceeded'])+"\n")
344 if 'link_down' in params: out.write(" link_down: "+str(params['link_down'])+"\n")
345 if 'timeLastMeasured_month' in params: out.write(" timeLastMeasured_month: "+str(params['timeLastMeasured_month'])+"\n")
346 if 'timeLastMeasured_day' in params: out.write(" timeLastMeasured_day: "+str(params['timeLastMeasured_day'])+"\n")
347 if 'timeLastMeasured_hour' in params: out.write(" timeLastMeasured_hour: "+str(params['timeLastMeasured_hour'])+"\n")
348 if 'timeLastMeasured_min' in params: out.write(" timeLastMeasured_min: "+str(params['timeLastMeasured_min'])+"\n")
349 if 'timeLastMeasured_sec' in params: out.write(" timeLastMeasured_sec: "+str(params['timeLastMeasured_sec'])+"\n")
350 elif 'html'==format:
351 out.write("<h3>waterlevel<h3>\n")
352 out.write("<table border=\"1\">\n")
353 out.write("<tr bgcolor=\"orange\">\n")
354 out.write("<th align=\"left\">Field Name</th>\n")
355 out.write("<th align=\"left\">Type</th>\n")
356 out.write("<th align=\"left\">Value</th>\n")
357 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
358 out.write("\n")
359 out.write("<tr>\n")
360 out.write("<td>dac</td>\n")
361 out.write("<td>uint</td>\n")
362 if 'dac' in params:
363 out.write(" <td>"+str(params['dac'])+"</td>\n")
364 out.write(" <td>"+str(params['dac'])+"</td>\n")
365 out.write("</tr>\n")
366 out.write("\n")
367 out.write("<tr>\n")
368 out.write("<td>fid</td>\n")
369 out.write("<td>uint</td>\n")
370 if 'fid' in params:
371 out.write(" <td>"+str(params['fid'])+"</td>\n")
372 out.write(" <td>"+str(params['fid'])+"</td>\n")
373 out.write("</tr>\n")
374 out.write("\n")
375 out.write("<tr>\n")
376 out.write("<td>efid</td>\n")
377 out.write("<td>uint</td>\n")
378 if 'efid' in params:
379 out.write(" <td>"+str(params['efid'])+"</td>\n")
380 out.write(" <td>"+str(params['efid'])+"</td>\n")
381 out.write("</tr>\n")
382 out.write("\n")
383 out.write("<tr>\n")
384 out.write("<td>timetag_month</td>\n")
385 out.write("<td>uint</td>\n")
386 if 'timetag_month' in params:
387 out.write(" <td>"+str(params['timetag_month'])+"</td>\n")
388 out.write(" <td>"+str(params['timetag_month'])+"</td>\n")
389 out.write("</tr>\n")
390 out.write("\n")
391 out.write("<tr>\n")
392 out.write("<td>timetag_day</td>\n")
393 out.write("<td>uint</td>\n")
394 if 'timetag_day' in params:
395 out.write(" <td>"+str(params['timetag_day'])+"</td>\n")
396 out.write(" <td>"+str(params['timetag_day'])+"</td>\n")
397 out.write("</tr>\n")
398 out.write("\n")
399 out.write("<tr>\n")
400 out.write("<td>timetag_hour</td>\n")
401 out.write("<td>uint</td>\n")
402 if 'timetag_hour' in params:
403 out.write(" <td>"+str(params['timetag_hour'])+"</td>\n")
404 out.write(" <td>"+str(params['timetag_hour'])+"</td>\n")
405 out.write("</tr>\n")
406 out.write("\n")
407 out.write("<tr>\n")
408 out.write("<td>timetag_min</td>\n")
409 out.write("<td>uint</td>\n")
410 if 'timetag_min' in params:
411 out.write(" <td>"+str(params['timetag_min'])+"</td>\n")
412 out.write(" <td>"+str(params['timetag_min'])+"</td>\n")
413 out.write("</tr>\n")
414 out.write("\n")
415 out.write("<tr>\n")
416 out.write("<td>timetag_sec</td>\n")
417 out.write("<td>uint</td>\n")
418 if 'timetag_sec' in params:
419 out.write(" <td>"+str(params['timetag_sec'])+"</td>\n")
420 out.write(" <td>"+str(params['timetag_sec'])+"</td>\n")
421 out.write("</tr>\n")
422 out.write("\n")
423 out.write("<tr>\n")
424 out.write("<td>stationid</td>\n")
425 out.write("<td>aisstr6</td>\n")
426 if 'stationid' in params:
427 out.write(" <td>"+str(params['stationid'])+"</td>\n")
428 out.write(" <td>"+str(params['stationid'])+"</td>\n")
429 out.write("</tr>\n")
430 out.write("\n")
431 out.write("<tr>\n")
432 out.write("<td>stationloc_longitude</td>\n")
433 out.write("<td>decimal</td>\n")
434 if 'stationloc_longitude' in params:
435 out.write(" <td>"+str(params['stationloc_longitude'])+"</td>\n")
436 out.write(" <td>"+str(params['stationloc_longitude'])+"</td>\n")
437 out.write("</tr>\n")
438 out.write("\n")
439 out.write("<tr>\n")
440 out.write("<td>stationloc_latitude</td>\n")
441 out.write("<td>decimal</td>\n")
442 if 'stationloc_latitude' in params:
443 out.write(" <td>"+str(params['stationloc_latitude'])+"</td>\n")
444 out.write(" <td>"+str(params['stationloc_latitude'])+"</td>\n")
445 out.write("</tr>\n")
446 out.write("\n")
447 out.write("<tr>\n")
448 out.write("<td>waterlevel</td>\n")
449 out.write("<td>int</td>\n")
450 if 'waterlevel' in params:
451 out.write(" <td>"+str(params['waterlevel'])+"</td>\n")
452 out.write(" <td>"+str(params['waterlevel'])+"</td>\n")
453 out.write("</tr>\n")
454 out.write("\n")
455 out.write("<tr>\n")
456 out.write("<td>datum</td>\n")
457 out.write("<td>uint</td>\n")
458 if 'datum' in params:
459 out.write(" <td>"+str(params['datum'])+"</td>\n")
460 if str(params['datum']) in datumDecodeLut:
461 out.write("<td>"+datumDecodeLut[str(params['datum'])]+"</td>")
462 else:
463 out.write("<td><i>Missing LUT entry</i></td>")
464 out.write("</tr>\n")
465 out.write("\n")
466 out.write("<tr>\n")
467 out.write("<td>sigma</td>\n")
468 out.write("<td>float</td>\n")
469 if 'sigma' in params:
470 out.write(" <td>"+str(params['sigma'])+"</td>\n")
471 out.write(" <td>"+str(params['sigma'])+"</td>\n")
472 out.write("</tr>\n")
473 out.write("\n")
474 out.write("<tr>\n")
475 out.write("<td>o</td>\n")
476 out.write("<td>uint</td>\n")
477 if 'o' in params:
478 out.write(" <td>"+str(params['o'])+"</td>\n")
479 out.write(" <td>"+str(params['o'])+"</td>\n")
480 out.write("</tr>\n")
481 out.write("\n")
482 out.write("<tr>\n")
483 out.write("<td>levelinferred</td>\n")
484 out.write("<td>bool</td>\n")
485 if 'levelinferred' in params:
486 out.write(" <td>"+str(params['levelinferred'])+"</td>\n")
487 out.write(" <td>"+str(params['levelinferred'])+"</td>\n")
488 out.write("</tr>\n")
489 out.write("\n")
490 out.write("<tr>\n")
491 out.write("<td>flat_tolerance_exceeded</td>\n")
492 out.write("<td>bool</td>\n")
493 if 'flat_tolerance_exceeded' in params:
494 out.write(" <td>"+str(params['flat_tolerance_exceeded'])+"</td>\n")
495 out.write(" <td>"+str(params['flat_tolerance_exceeded'])+"</td>\n")
496 out.write("</tr>\n")
497 out.write("\n")
498 out.write("<tr>\n")
499 out.write("<td>rate_tolerance_exceeded</td>\n")
500 out.write("<td>bool</td>\n")
501 if 'rate_tolerance_exceeded' in params:
502 out.write(" <td>"+str(params['rate_tolerance_exceeded'])+"</td>\n")
503 out.write(" <td>"+str(params['rate_tolerance_exceeded'])+"</td>\n")
504 out.write("</tr>\n")
505 out.write("\n")
506 out.write("<tr>\n")
507 out.write("<td>temp_tolerance_exceeded</td>\n")
508 out.write("<td>bool</td>\n")
509 if 'temp_tolerance_exceeded' in params:
510 out.write(" <td>"+str(params['temp_tolerance_exceeded'])+"</td>\n")
511 out.write(" <td>"+str(params['temp_tolerance_exceeded'])+"</td>\n")
512 out.write("</tr>\n")
513 out.write("\n")
514 out.write("<tr>\n")
515 out.write("<td>expected_height_exceeded</td>\n")
516 out.write("<td>bool</td>\n")
517 if 'expected_height_exceeded' in params:
518 out.write(" <td>"+str(params['expected_height_exceeded'])+"</td>\n")
519 out.write(" <td>"+str(params['expected_height_exceeded'])+"</td>\n")
520 out.write("</tr>\n")
521 out.write("\n")
522 out.write("<tr>\n")
523 out.write("<td>link_down</td>\n")
524 out.write("<td>bool</td>\n")
525 if 'link_down' in params:
526 out.write(" <td>"+str(params['link_down'])+"</td>\n")
527 out.write(" <td>"+str(params['link_down'])+"</td>\n")
528 out.write("</tr>\n")
529 out.write("\n")
530 out.write("<tr>\n")
531 out.write("<td>timeLastMeasured_month</td>\n")
532 out.write("<td>uint</td>\n")
533 if 'timeLastMeasured_month' in params:
534 out.write(" <td>"+str(params['timeLastMeasured_month'])+"</td>\n")
535 out.write(" <td>"+str(params['timeLastMeasured_month'])+"</td>\n")
536 out.write("</tr>\n")
537 out.write("\n")
538 out.write("<tr>\n")
539 out.write("<td>timeLastMeasured_day</td>\n")
540 out.write("<td>uint</td>\n")
541 if 'timeLastMeasured_day' in params:
542 out.write(" <td>"+str(params['timeLastMeasured_day'])+"</td>\n")
543 out.write(" <td>"+str(params['timeLastMeasured_day'])+"</td>\n")
544 out.write("</tr>\n")
545 out.write("\n")
546 out.write("<tr>\n")
547 out.write("<td>timeLastMeasured_hour</td>\n")
548 out.write("<td>uint</td>\n")
549 if 'timeLastMeasured_hour' in params:
550 out.write(" <td>"+str(params['timeLastMeasured_hour'])+"</td>\n")
551 out.write(" <td>"+str(params['timeLastMeasured_hour'])+"</td>\n")
552 out.write("</tr>\n")
553 out.write("\n")
554 out.write("<tr>\n")
555 out.write("<td>timeLastMeasured_min</td>\n")
556 out.write("<td>uint</td>\n")
557 if 'timeLastMeasured_min' in params:
558 out.write(" <td>"+str(params['timeLastMeasured_min'])+"</td>\n")
559 out.write(" <td>"+str(params['timeLastMeasured_min'])+"</td>\n")
560 out.write("</tr>\n")
561 out.write("\n")
562 out.write("<tr>\n")
563 out.write("<td>timeLastMeasured_sec</td>\n")
564 out.write("<td>uint</td>\n")
565 if 'timeLastMeasured_sec' in params:
566 out.write(" <td>"+str(params['timeLastMeasured_sec'])+"</td>\n")
567 out.write(" <td>"+str(params['timeLastMeasured_sec'])+"</td>\n")
568 out.write("</tr>\n")
569 out.write("</table>\n")
570 else:
571 print "ERROR: unknown format:",format
572 assert False
573
574 return
575
576 datumEncodeLut = {
577 'MLLW':'0',
578 'IGLD-85':'1',
579 'WaterDepth':'2',
580 'STND':'3',
581 'MHW':'4',
582 'MLS':'5',
583 'NGVD':'6',
584 'NAVD':'7',
585 }
586
587 datumDecodeLut = {
588 '0':'MLLW',
589 '1':'IGLD-85',
590 '2':'WaterDepth',
591 '3':'STND',
592 '4':'MHW',
593 '5':'MLS',
594 '6':'NGVD',
595 '7':'NAVD',
596 }
597
598
599
600
601
602
603 import unittest
605 '''Return a params file base on the testvalue tags.
606 @rtype: dict
607 @return: params based on testvalue tags
608 '''
609 params = {}
610 params['dac'] = 366
611 params['fid'] = 1
612 params['efid'] = 1
613 params['timetag_month'] = 2
614 params['timetag_day'] = 28
615 params['timetag_hour'] = 23
616 params['timetag_min'] = 45
617 params['timetag_sec'] = 58
618 params['stationid'] = 'A234567'
619 params['stationloc_longitude'] = Decimal('-122.16328055555556')
620 params['stationloc_latitude'] = Decimal('37.424458333333334')
621 params['waterlevel'] = -97
622 params['datum'] = 0
623 params['sigma'] = -1.234
624 params['o'] = 240
625 params['levelinferred'] = False
626 params['flat_tolerance_exceeded'] = True
627 params['rate_tolerance_exceeded'] = False
628 params['temp_tolerance_exceeded'] = False
629 params['expected_height_exceeded'] = True
630 params['link_down'] = False
631 params['timeLastMeasured_month'] = 2
632 params['timeLastMeasured_day'] = 28
633 params['timeLastMeasured_hour'] = 23
634 params['timeLastMeasured_min'] = 45
635 params['timeLastMeasured_sec'] = 58
636
637 return params
638
640 '''Use testvalue tag text from each type to build test case the waterlevel message'''
642
643 params = testParams()
644 bits = encode(params)
645 r = decode(bits)
646
647
648 self.failUnlessEqual(r['dac'],params['dac'])
649 self.failUnlessEqual(r['fid'],params['fid'])
650 self.failUnlessEqual(r['efid'],params['efid'])
651 self.failUnlessEqual(r['timetag_month'],params['timetag_month'])
652 self.failUnlessEqual(r['timetag_day'],params['timetag_day'])
653 self.failUnlessEqual(r['timetag_hour'],params['timetag_hour'])
654 self.failUnlessEqual(r['timetag_min'],params['timetag_min'])
655 self.failUnlessEqual(r['timetag_sec'],params['timetag_sec'])
656 self.failUnlessEqual(r['stationid'],params['stationid'])
657 self.failUnlessAlmostEqual(r['stationloc_longitude'],params['stationloc_longitude'],5)
658 self.failUnlessAlmostEqual(r['stationloc_latitude'],params['stationloc_latitude'],5)
659 self.failUnlessEqual(r['waterlevel'],params['waterlevel'])
660 self.failUnlessEqual(r['datum'],params['datum'])
661 self.failUnlessAlmostEqual(r['sigma'],params['sigma'],3)
662 self.failUnlessEqual(r['o'],params['o'])
663 self.failUnlessEqual(r['levelinferred'],params['levelinferred'])
664 self.failUnlessEqual(r['flat_tolerance_exceeded'],params['flat_tolerance_exceeded'])
665 self.failUnlessEqual(r['rate_tolerance_exceeded'],params['rate_tolerance_exceeded'])
666 self.failUnlessEqual(r['temp_tolerance_exceeded'],params['temp_tolerance_exceeded'])
667 self.failUnlessEqual(r['expected_height_exceeded'],params['expected_height_exceeded'])
668 self.failUnlessEqual(r['link_down'],params['link_down'])
669 self.failUnlessEqual(r['timeLastMeasured_month'],params['timeLastMeasured_month'])
670 self.failUnlessEqual(r['timeLastMeasured_day'],params['timeLastMeasured_day'])
671 self.failUnlessEqual(r['timeLastMeasured_hour'],params['timeLastMeasured_hour'])
672 self.failUnlessEqual(r['timeLastMeasured_min'],params['timeLastMeasured_min'])
673 self.failUnlessEqual(r['timeLastMeasured_sec'],params['timeLastMeasured_sec'])
674
676 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
677 help='decode a "waterlevel" AIS message')
678 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
679 help='encode a "waterlevel" AIS message')
680 parser.add_option('--timetag_month-field', dest='timetag_monthField',metavar='uint',type='int'
681 ,help='Field parameter value [default: %default]')
682 parser.add_option('--timetag_day-field', dest='timetag_dayField',metavar='uint',type='int'
683 ,help='Field parameter value [default: %default]')
684 parser.add_option('--timetag_hour-field', dest='timetag_hourField',metavar='uint',type='int'
685 ,help='Field parameter value [default: %default]')
686 parser.add_option('--timetag_min-field', dest='timetag_minField',metavar='uint',type='int'
687 ,help='Field parameter value [default: %default]')
688 parser.add_option('--timetag_sec-field', dest='timetag_secField',metavar='uint',type='int'
689 ,help='Field parameter value [default: %default]')
690 parser.add_option('--stationid-field', dest='stationidField',default='@@@@@@@',metavar='aisstr6',type='string'
691 ,help='Field parameter value [default: %default]')
692 parser.add_option('--stationloc_longitude-field', dest='stationloc_longitudeField',default=Decimal('181'),metavar='decimal',type='string'
693 ,help='Field parameter value [default: %default]')
694 parser.add_option('--stationloc_latitude-field', dest='stationloc_latitudeField',default=Decimal('91'),metavar='decimal',type='string'
695 ,help='Field parameter value [default: %default]')
696 parser.add_option('--waterlevel-field', dest='waterlevelField',default=-32768,metavar='int',type='int'
697 ,help='Field parameter value [default: %default]')
698 parser.add_option('--datum-field', dest='datumField',default=31,metavar='uint',type='int'
699 ,help='Field parameter value [default: %default]')
700 parser.add_option('--sigma-field', dest='sigmaField',metavar='float',type='float'
701 ,help='Field parameter value [default: %default]')
702 parser.add_option('--o-field', dest='oField',default=255,metavar='uint',type='int'
703 ,help='Field parameter value [default: %default]')
704 parser.add_option('--levelinferred-field', dest='levelinferredField',metavar='bool',type='int'
705 ,help='Field parameter value [default: %default]')
706 parser.add_option('--flat_tolerance_exceeded-field', dest='flat_tolerance_exceededField',metavar='bool',type='int'
707 ,help='Field parameter value [default: %default]')
708 parser.add_option('--rate_tolerance_exceeded-field', dest='rate_tolerance_exceededField',metavar='bool',type='int'
709 ,help='Field parameter value [default: %default]')
710 parser.add_option('--temp_tolerance_exceeded-field', dest='temp_tolerance_exceededField',metavar='bool',type='int'
711 ,help='Field parameter value [default: %default]')
712 parser.add_option('--expected_height_exceeded-field', dest='expected_height_exceededField',metavar='bool',type='int'
713 ,help='Field parameter value [default: %default]')
714 parser.add_option('--link_down-field', dest='link_downField',metavar='bool',type='int'
715 ,help='Field parameter value [default: %default]')
716 parser.add_option('--timeLastMeasured_month-field', dest='timeLastMeasured_monthField',metavar='uint',type='int'
717 ,help='Field parameter value [default: %default]')
718 parser.add_option('--timeLastMeasured_day-field', dest='timeLastMeasured_dayField',metavar='uint',type='int'
719 ,help='Field parameter value [default: %default]')
720 parser.add_option('--timeLastMeasured_hour-field', dest='timeLastMeasured_hourField',metavar='uint',type='int'
721 ,help='Field parameter value [default: %default]')
722 parser.add_option('--timeLastMeasured_min-field', dest='timeLastMeasured_minField',metavar='uint',type='int'
723 ,help='Field parameter value [default: %default]')
724 parser.add_option('--timeLastMeasured_sec-field', dest='timeLastMeasured_secField',metavar='uint',type='int'
725 ,help='Field parameter value [default: %default]')
726
727
728 if __name__=='__main__':
729
730 from optparse import OptionParser
731 parser = OptionParser(usage="%prog [options]",
732 version="%prog "+__version__)
733
734 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
735 help='run the documentation tests')
736 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
737 help='run the unit tests')
738 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
739 help='Make the test output verbose')
740
741
742
743 typeChoices = ('binary','nmeapayload','nmea')
744 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
745 ,default='nmeapayload'
746 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]')
747
748 outputChoices = ('std','html','xml')
749 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
750 ,default='std'
751 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
752
753 parser.add_option('-o','--output',dest='outputFileName',default=None,
754 help='Name of the python file to write [default: stdout]')
755
756 addMsgOptions(parser)
757
758 (options,args) = parser.parse_args()
759 success=True
760
761 if options.doctest:
762 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
763 sys.argv= [sys.argv[0]]
764 if options.verbose: sys.argv.append('-v')
765 import doctest
766 numfail,numtests=doctest.testmod()
767 if numfail==0: print 'ok'
768 else:
769 print 'FAILED'
770 success=False
771
772 if not success: sys.exit('Something Failed')
773 del success
774
775 if options.unittest:
776 sys.argv = [sys.argv[0]]
777 if options.verbose: sys.argv.append('-v')
778 unittest.main()
779
780 outfile = sys.stdout
781 if None!=options.outputFileName:
782 outfile = file(options.outputFileName,'w')
783
784
785 if options.doEncode:
786
787 if None==options.timetag_monthField: parser.error("missing value for timetag_monthField")
788 if None==options.timetag_dayField: parser.error("missing value for timetag_dayField")
789 if None==options.timetag_hourField: parser.error("missing value for timetag_hourField")
790 if None==options.timetag_minField: parser.error("missing value for timetag_minField")
791 if None==options.timetag_secField: parser.error("missing value for timetag_secField")
792 if None==options.stationidField: parser.error("missing value for stationidField")
793 if None==options.stationloc_longitudeField: parser.error("missing value for stationloc_longitudeField")
794 if None==options.stationloc_latitudeField: parser.error("missing value for stationloc_latitudeField")
795 if None==options.waterlevelField: parser.error("missing value for waterlevelField")
796 if None==options.datumField: parser.error("missing value for datumField")
797 if None==options.sigmaField: parser.error("missing value for sigmaField")
798 if None==options.oField: parser.error("missing value for oField")
799 if None==options.levelinferredField: parser.error("missing value for levelinferredField")
800 if None==options.flat_tolerance_exceededField: parser.error("missing value for flat_tolerance_exceededField")
801 if None==options.rate_tolerance_exceededField: parser.error("missing value for rate_tolerance_exceededField")
802 if None==options.temp_tolerance_exceededField: parser.error("missing value for temp_tolerance_exceededField")
803 if None==options.expected_height_exceededField: parser.error("missing value for expected_height_exceededField")
804 if None==options.link_downField: parser.error("missing value for link_downField")
805 if None==options.timeLastMeasured_monthField: parser.error("missing value for timeLastMeasured_monthField")
806 if None==options.timeLastMeasured_dayField: parser.error("missing value for timeLastMeasured_dayField")
807 if None==options.timeLastMeasured_hourField: parser.error("missing value for timeLastMeasured_hourField")
808 if None==options.timeLastMeasured_minField: parser.error("missing value for timeLastMeasured_minField")
809 if None==options.timeLastMeasured_secField: parser.error("missing value for timeLastMeasured_secField")
810 msgDict={
811 'dac': '366',
812 'fid': '1',
813 'efid': '1',
814 'timetag_month': options.timetag_monthField,
815 'timetag_day': options.timetag_dayField,
816 'timetag_hour': options.timetag_hourField,
817 'timetag_min': options.timetag_minField,
818 'timetag_sec': options.timetag_secField,
819 'stationid': options.stationidField,
820 'stationloc_longitude': options.stationloc_longitudeField,
821 'stationloc_latitude': options.stationloc_latitudeField,
822 'waterlevel': options.waterlevelField,
823 'datum': options.datumField,
824 'sigma': options.sigmaField,
825 'o': options.oField,
826 'levelinferred': options.levelinferredField,
827 'flat_tolerance_exceeded': options.flat_tolerance_exceededField,
828 'rate_tolerance_exceeded': options.rate_tolerance_exceededField,
829 'temp_tolerance_exceeded': options.temp_tolerance_exceededField,
830 'expected_height_exceeded': options.expected_height_exceededField,
831 'link_down': options.link_downField,
832 'timeLastMeasured_month': options.timeLastMeasured_monthField,
833 'timeLastMeasured_day': options.timeLastMeasured_dayField,
834 'timeLastMeasured_hour': options.timeLastMeasured_hourField,
835 'timeLastMeasured_min': options.timeLastMeasured_minField,
836 'timeLastMeasured_sec': options.timeLastMeasured_secField,
837 }
838
839 bits = encode(msgDict)
840 if 'binary'==options.ioType: print str(bits)
841 elif 'nmeapayload'==options.ioType:
842
843 print "bitLen",len(bits)
844 bitLen=len(bits)
845 if bitLen%6!=0:
846 bits = bits + BitVector(size=(6 - (bitLen%6)))
847 print "result:",binary.bitvectoais6(bits)[0]
848
849
850
851 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
852 else: sys.exit('ERROR: unknown ioType. Help!')
853
854 if options.doDecode:
855 for msg in args:
856 bv = None
857 if 'binary' == options.ioType: bv = BitVector(bitstring=msg)
858 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg)
859 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5])
860 else: sys.exit('ERROR: unknown ioType. Help!')
861
862 printFields(decode(bv),out=outfile,format=options.outputType)
863