1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-01-18 $'.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
286
288 out.write("<h3>waterlevel<h3>\n")
289 out.write("<table border=\"1\">\n")
290 out.write("<tr bgcolor=\"orange\">\n")
291 out.write("<th align=\"left\">Field Name</th>\n")
292 out.write("<th align=\"left\">Type</th>\n")
293 out.write("<th align=\"left\">Value</th>\n")
294 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
295 out.write("<th align=\"left\">Units</th>\n")
296 out.write("\n")
297 out.write("<tr>\n")
298 out.write("<td>dac</td>\n")
299 out.write("<td>uint</td>\n")
300 if 'dac' in params:
301 out.write(" <td>"+str(params['dac'])+"</td>\n")
302 out.write(" <td>"+str(params['dac'])+"</td>\n")
303 out.write("</tr>\n")
304 out.write("\n")
305 out.write("<tr>\n")
306 out.write("<td>fid</td>\n")
307 out.write("<td>uint</td>\n")
308 if 'fid' in params:
309 out.write(" <td>"+str(params['fid'])+"</td>\n")
310 out.write(" <td>"+str(params['fid'])+"</td>\n")
311 out.write("</tr>\n")
312 out.write("\n")
313 out.write("<tr>\n")
314 out.write("<td>efid</td>\n")
315 out.write("<td>uint</td>\n")
316 if 'efid' in params:
317 out.write(" <td>"+str(params['efid'])+"</td>\n")
318 out.write(" <td>"+str(params['efid'])+"</td>\n")
319 out.write("</tr>\n")
320 out.write("\n")
321 out.write("<tr>\n")
322 out.write("<td>timetag_month</td>\n")
323 out.write("<td>uint</td>\n")
324 if 'timetag_month' in params:
325 out.write(" <td>"+str(params['timetag_month'])+"</td>\n")
326 out.write(" <td>"+str(params['timetag_month'])+"</td>\n")
327 out.write("</tr>\n")
328 out.write("\n")
329 out.write("<tr>\n")
330 out.write("<td>timetag_day</td>\n")
331 out.write("<td>uint</td>\n")
332 if 'timetag_day' in params:
333 out.write(" <td>"+str(params['timetag_day'])+"</td>\n")
334 out.write(" <td>"+str(params['timetag_day'])+"</td>\n")
335 out.write("</tr>\n")
336 out.write("\n")
337 out.write("<tr>\n")
338 out.write("<td>timetag_hour</td>\n")
339 out.write("<td>uint</td>\n")
340 if 'timetag_hour' in params:
341 out.write(" <td>"+str(params['timetag_hour'])+"</td>\n")
342 out.write(" <td>"+str(params['timetag_hour'])+"</td>\n")
343 out.write("</tr>\n")
344 out.write("\n")
345 out.write("<tr>\n")
346 out.write("<td>timetag_min</td>\n")
347 out.write("<td>uint</td>\n")
348 if 'timetag_min' in params:
349 out.write(" <td>"+str(params['timetag_min'])+"</td>\n")
350 out.write(" <td>"+str(params['timetag_min'])+"</td>\n")
351 out.write("</tr>\n")
352 out.write("\n")
353 out.write("<tr>\n")
354 out.write("<td>timetag_sec</td>\n")
355 out.write("<td>uint</td>\n")
356 if 'timetag_sec' in params:
357 out.write(" <td>"+str(params['timetag_sec'])+"</td>\n")
358 out.write(" <td>"+str(params['timetag_sec'])+"</td>\n")
359 out.write("</tr>\n")
360 out.write("\n")
361 out.write("<tr>\n")
362 out.write("<td>stationid</td>\n")
363 out.write("<td>aisstr6</td>\n")
364 if 'stationid' in params:
365 out.write(" <td>"+str(params['stationid'])+"</td>\n")
366 out.write(" <td>"+str(params['stationid'])+"</td>\n")
367 out.write("</tr>\n")
368 out.write("\n")
369 out.write("<tr>\n")
370 out.write("<td>stationloc_longitude</td>\n")
371 out.write("<td>decimal</td>\n")
372 if 'stationloc_longitude' in params:
373 out.write(" <td>"+str(params['stationloc_longitude'])+"</td>\n")
374 out.write(" <td>"+str(params['stationloc_longitude'])+"</td>\n")
375 out.write("<td>degrees</td>\n")
376 out.write("</tr>\n")
377 out.write("\n")
378 out.write("<tr>\n")
379 out.write("<td>stationloc_latitude</td>\n")
380 out.write("<td>decimal</td>\n")
381 if 'stationloc_latitude' in params:
382 out.write(" <td>"+str(params['stationloc_latitude'])+"</td>\n")
383 out.write(" <td>"+str(params['stationloc_latitude'])+"</td>\n")
384 out.write("<td>degrees</td>\n")
385 out.write("</tr>\n")
386 out.write("\n")
387 out.write("<tr>\n")
388 out.write("<td>waterlevel</td>\n")
389 out.write("<td>int</td>\n")
390 if 'waterlevel' in params:
391 out.write(" <td>"+str(params['waterlevel'])+"</td>\n")
392 out.write(" <td>"+str(params['waterlevel'])+"</td>\n")
393 out.write("<td>cm</td>\n")
394 out.write("</tr>\n")
395 out.write("\n")
396 out.write("<tr>\n")
397 out.write("<td>datum</td>\n")
398 out.write("<td>uint</td>\n")
399 if 'datum' in params:
400 out.write(" <td>"+str(params['datum'])+"</td>\n")
401 if str(params['datum']) in datumDecodeLut:
402 out.write("<td>"+datumDecodeLut[str(params['datum'])]+"</td>")
403 else:
404 out.write("<td><i>Missing LUT entry</i></td>")
405 out.write("</tr>\n")
406 out.write("\n")
407 out.write("<tr>\n")
408 out.write("<td>sigma</td>\n")
409 out.write("<td>float</td>\n")
410 if 'sigma' in params:
411 out.write(" <td>"+str(params['sigma'])+"</td>\n")
412 out.write(" <td>"+str(params['sigma'])+"</td>\n")
413 out.write("<td>m</td>\n")
414 out.write("</tr>\n")
415 out.write("\n")
416 out.write("<tr>\n")
417 out.write("<td>o</td>\n")
418 out.write("<td>uint</td>\n")
419 if 'o' in params:
420 out.write(" <td>"+str(params['o'])+"</td>\n")
421 out.write(" <td>"+str(params['o'])+"</td>\n")
422 out.write("</tr>\n")
423 out.write("\n")
424 out.write("<tr>\n")
425 out.write("<td>levelinferred</td>\n")
426 out.write("<td>bool</td>\n")
427 if 'levelinferred' in params:
428 out.write(" <td>"+str(params['levelinferred'])+"</td>\n")
429 out.write(" <td>"+str(params['levelinferred'])+"</td>\n")
430 out.write("</tr>\n")
431 out.write("\n")
432 out.write("<tr>\n")
433 out.write("<td>flat_tolerance_exceeded</td>\n")
434 out.write("<td>bool</td>\n")
435 if 'flat_tolerance_exceeded' in params:
436 out.write(" <td>"+str(params['flat_tolerance_exceeded'])+"</td>\n")
437 out.write(" <td>"+str(params['flat_tolerance_exceeded'])+"</td>\n")
438 out.write("</tr>\n")
439 out.write("\n")
440 out.write("<tr>\n")
441 out.write("<td>rate_tolerance_exceeded</td>\n")
442 out.write("<td>bool</td>\n")
443 if 'rate_tolerance_exceeded' in params:
444 out.write(" <td>"+str(params['rate_tolerance_exceeded'])+"</td>\n")
445 out.write(" <td>"+str(params['rate_tolerance_exceeded'])+"</td>\n")
446 out.write("</tr>\n")
447 out.write("\n")
448 out.write("<tr>\n")
449 out.write("<td>temp_tolerance_exceeded</td>\n")
450 out.write("<td>bool</td>\n")
451 if 'temp_tolerance_exceeded' in params:
452 out.write(" <td>"+str(params['temp_tolerance_exceeded'])+"</td>\n")
453 out.write(" <td>"+str(params['temp_tolerance_exceeded'])+"</td>\n")
454 out.write("</tr>\n")
455 out.write("\n")
456 out.write("<tr>\n")
457 out.write("<td>expected_height_exceeded</td>\n")
458 out.write("<td>bool</td>\n")
459 if 'expected_height_exceeded' in params:
460 out.write(" <td>"+str(params['expected_height_exceeded'])+"</td>\n")
461 out.write(" <td>"+str(params['expected_height_exceeded'])+"</td>\n")
462 out.write("</tr>\n")
463 out.write("\n")
464 out.write("<tr>\n")
465 out.write("<td>link_down</td>\n")
466 out.write("<td>bool</td>\n")
467 if 'link_down' in params:
468 out.write(" <td>"+str(params['link_down'])+"</td>\n")
469 out.write(" <td>"+str(params['link_down'])+"</td>\n")
470 out.write("</tr>\n")
471 out.write("\n")
472 out.write("<tr>\n")
473 out.write("<td>timeLastMeasured_month</td>\n")
474 out.write("<td>uint</td>\n")
475 if 'timeLastMeasured_month' in params:
476 out.write(" <td>"+str(params['timeLastMeasured_month'])+"</td>\n")
477 out.write(" <td>"+str(params['timeLastMeasured_month'])+"</td>\n")
478 out.write("</tr>\n")
479 out.write("\n")
480 out.write("<tr>\n")
481 out.write("<td>timeLastMeasured_day</td>\n")
482 out.write("<td>uint</td>\n")
483 if 'timeLastMeasured_day' in params:
484 out.write(" <td>"+str(params['timeLastMeasured_day'])+"</td>\n")
485 out.write(" <td>"+str(params['timeLastMeasured_day'])+"</td>\n")
486 out.write("</tr>\n")
487 out.write("\n")
488 out.write("<tr>\n")
489 out.write("<td>timeLastMeasured_hour</td>\n")
490 out.write("<td>uint</td>\n")
491 if 'timeLastMeasured_hour' in params:
492 out.write(" <td>"+str(params['timeLastMeasured_hour'])+"</td>\n")
493 out.write(" <td>"+str(params['timeLastMeasured_hour'])+"</td>\n")
494 out.write("</tr>\n")
495 out.write("\n")
496 out.write("<tr>\n")
497 out.write("<td>timeLastMeasured_min</td>\n")
498 out.write("<td>uint</td>\n")
499 if 'timeLastMeasured_min' in params:
500 out.write(" <td>"+str(params['timeLastMeasured_min'])+"</td>\n")
501 out.write(" <td>"+str(params['timeLastMeasured_min'])+"</td>\n")
502 out.write("</tr>\n")
503 out.write("\n")
504 out.write("<tr>\n")
505 out.write("<td>timeLastMeasured_sec</td>\n")
506 out.write("<td>uint</td>\n")
507 if 'timeLastMeasured_sec' in params:
508 out.write(" <td>"+str(params['timeLastMeasured_sec'])+"</td>\n")
509 out.write(" <td>"+str(params['timeLastMeasured_sec'])+"</td>\n")
510 out.write("</tr>\n")
511 out.write("</table>\n")
512
514 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer'''
515 out.write("\ <Placemark>\n")
516 out.write("\t <name>"+str(params['stationid'])+"</name>\n")
517 out.write("\t\t<description>\n")
518 import StringIO
519 buf = StringIO.StringIO()
520 printHtml(params,buf)
521 import cgi
522 out.write(cgi.escape(buf.getvalue()))
523 out.write("\t\t</description>\n")
524 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n")
525 out.write("\t\t<Point>\n")
526 out.write("\t\t\t<coordinates>")
527 out.write(str(params['stationloc_longitude']))
528 out.write(',')
529 out.write(str(params['stationloc_latitude']))
530 out.write(",0</coordinates>\n")
531 out.write("\t\t</Point>\n")
532 out.write("\t</Placemark>\n")
533
535 '''Print a timeLastMeasured_sec message to stdout.
536
537 Fields in params:
538 - dac(uint): Designated Area Code (field automatically set to "366")
539 - fid(uint): Functional Identifier (field automatically set to "1")
540 - efid(uint): extended functional identifier (field automatically set to "1")
541 - timetag_month(uint): Time the measurement represents month 1..12
542 - timetag_day(uint): Time the measurement represents day of the month 1..31
543 - timetag_hour(uint): Time the measurement represents UTC hours 0..23
544 - timetag_min(uint): Time the measurement represents minutes
545 - timetag_sec(uint): Time the measurement represents seconds
546 - stationid(aisstr6): Character identifier of the station. Usually a number.
547 - stationloc_longitude(decimal): Location of the sensor taking the water level measurement or position of prediction East West location
548 - stationloc_latitude(decimal): Location of the sensor taking the water level measurement or position of prediction North South location
549 - waterlevel(int): Water level in centimeters
550 - datum(uint): What reference datum applies to the value
551 - sigma(float): Standard deviation of 1 second samples used to compute the water level height
552 - o(uint): Count of number of samples that fall outside a 3-sigma band about the mean
553 - levelinferred(bool): indicates that the water level value has been inferred
554 - flat_tolerance_exceeded(bool): flat tolerance limit was exceeded. Need better descr
555 - rate_tolerance_exceeded(bool): rate of change tolerance limit was exceeded
556 - temp_tolerance_exceeded(bool): temperature difference tolerance limit was exceeded
557 - expected_height_exceeded(bool): either the maximum or minimum expected water level height limit was exceeded
558 - link_down(bool): Unable to communicate with the tide system. All data invalid
559 - timeLastMeasured_month(uint): Time since last measured value was available month 1..12
560 - timeLastMeasured_day(uint): Time since last measured value was available day of the month 1..31
561 - timeLastMeasured_hour(uint): Time since last measured value was available UTC hours 0..23
562 - timeLastMeasured_min(uint): Time since last measured value was available minutes
563 - timeLastMeasured_sec(uint): Time since last measured value was available seconds
564 @param params: Dictionary of field names/values.
565 @param out: File like object to write to
566 @rtype: stdout
567 @return: text to out
568 '''
569
570 if 'std'==format:
571 out.write("timeLastMeasured_sec:\n")
572 if 'dac' in params: out.write(" dac: "+str(params['dac'])+"\n")
573 if 'fid' in params: out.write(" fid: "+str(params['fid'])+"\n")
574 if 'efid' in params: out.write(" efid: "+str(params['efid'])+"\n")
575 if 'timetag_month' in params: out.write(" timetag_month: "+str(params['timetag_month'])+"\n")
576 if 'timetag_day' in params: out.write(" timetag_day: "+str(params['timetag_day'])+"\n")
577 if 'timetag_hour' in params: out.write(" timetag_hour: "+str(params['timetag_hour'])+"\n")
578 if 'timetag_min' in params: out.write(" timetag_min: "+str(params['timetag_min'])+"\n")
579 if 'timetag_sec' in params: out.write(" timetag_sec: "+str(params['timetag_sec'])+"\n")
580 if 'stationid' in params: out.write(" stationid: "+str(params['stationid'])+"\n")
581 if 'stationloc_longitude' in params: out.write(" stationloc_longitude: "+str(params['stationloc_longitude'])+"\n")
582 if 'stationloc_latitude' in params: out.write(" stationloc_latitude: "+str(params['stationloc_latitude'])+"\n")
583 if 'waterlevel' in params: out.write(" waterlevel: "+str(params['waterlevel'])+"\n")
584 if 'datum' in params: out.write(" datum: "+str(params['datum'])+"\n")
585 if 'sigma' in params: out.write(" sigma: "+str(params['sigma'])+"\n")
586 if 'o' in params: out.write(" o: "+str(params['o'])+"\n")
587 if 'levelinferred' in params: out.write(" levelinferred: "+str(params['levelinferred'])+"\n")
588 if 'flat_tolerance_exceeded' in params: out.write(" flat_tolerance_exceeded: "+str(params['flat_tolerance_exceeded'])+"\n")
589 if 'rate_tolerance_exceeded' in params: out.write(" rate_tolerance_exceeded: "+str(params['rate_tolerance_exceeded'])+"\n")
590 if 'temp_tolerance_exceeded' in params: out.write(" temp_tolerance_exceeded: "+str(params['temp_tolerance_exceeded'])+"\n")
591 if 'expected_height_exceeded' in params: out.write(" expected_height_exceeded: "+str(params['expected_height_exceeded'])+"\n")
592 if 'link_down' in params: out.write(" link_down: "+str(params['link_down'])+"\n")
593 if 'timeLastMeasured_month' in params: out.write(" timeLastMeasured_month: "+str(params['timeLastMeasured_month'])+"\n")
594 if 'timeLastMeasured_day' in params: out.write(" timeLastMeasured_day: "+str(params['timeLastMeasured_day'])+"\n")
595 if 'timeLastMeasured_hour' in params: out.write(" timeLastMeasured_hour: "+str(params['timeLastMeasured_hour'])+"\n")
596 if 'timeLastMeasured_min' in params: out.write(" timeLastMeasured_min: "+str(params['timeLastMeasured_min'])+"\n")
597 if 'timeLastMeasured_sec' in params: out.write(" timeLastMeasured_sec: "+str(params['timeLastMeasured_sec'])+"\n")
598 elif 'html'==format:
599 printHtml(params,out)
600 elif 'kml'==format:
601 printKml(params,out)
602 elif 'kml-full'==format:
603 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
604 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n")
605 out.write("<Document>\n")
606 out.write(" <name>Position</name>\n")
607 printKml(params,out)
608 out.write("</Document>\n")
609 out.write("</kml>\n")
610 else:
611 print "ERROR: unknown format:",format
612 assert False
613
614 return
615
616 datumEncodeLut = {
617 'MLLW':'0',
618 'IGLD-85':'1',
619 'WaterDepth':'2',
620 'STND':'3',
621 'MHW':'4',
622 'MLS':'5',
623 'NGVD':'6',
624 'NAVD':'7',
625 'WGS-84':'8',
626 'LAT':'9',
627 }
628
629 datumDecodeLut = {
630 '0':'MLLW',
631 '1':'IGLD-85',
632 '2':'WaterDepth',
633 '3':'STND',
634 '4':'MHW',
635 '5':'MLS',
636 '6':'NGVD',
637 '7':'NAVD',
638 '8':'WGS-84',
639 '9':'LAT',
640 }
641
642
643
644
645
646
647 import unittest
649 '''Return a params file base on the testvalue tags.
650 @rtype: dict
651 @return: params based on testvalue tags
652 '''
653 params = {}
654 params['dac'] = 366
655 params['fid'] = 1
656 params['efid'] = 1
657 params['timetag_month'] = 2
658 params['timetag_day'] = 28
659 params['timetag_hour'] = 23
660 params['timetag_min'] = 45
661 params['timetag_sec'] = 58
662 params['stationid'] = 'A234567'
663 params['stationloc_longitude'] = Decimal('-122.16328055555556')
664 params['stationloc_latitude'] = Decimal('37.424458333333334')
665 params['waterlevel'] = -97
666 params['datum'] = 0
667 params['sigma'] = -1.234
668 params['o'] = 240
669 params['levelinferred'] = False
670 params['flat_tolerance_exceeded'] = True
671 params['rate_tolerance_exceeded'] = False
672 params['temp_tolerance_exceeded'] = False
673 params['expected_height_exceeded'] = True
674 params['link_down'] = False
675 params['timeLastMeasured_month'] = 2
676 params['timeLastMeasured_day'] = 28
677 params['timeLastMeasured_hour'] = 23
678 params['timeLastMeasured_min'] = 45
679 params['timeLastMeasured_sec'] = 58
680
681 return params
682
684 '''Use testvalue tag text from each type to build test case the waterlevel message'''
686
687 params = testParams()
688 bits = encode(params)
689 r = decode(bits)
690
691
692 self.failUnlessEqual(r['dac'],params['dac'])
693 self.failUnlessEqual(r['fid'],params['fid'])
694 self.failUnlessEqual(r['efid'],params['efid'])
695 self.failUnlessEqual(r['timetag_month'],params['timetag_month'])
696 self.failUnlessEqual(r['timetag_day'],params['timetag_day'])
697 self.failUnlessEqual(r['timetag_hour'],params['timetag_hour'])
698 self.failUnlessEqual(r['timetag_min'],params['timetag_min'])
699 self.failUnlessEqual(r['timetag_sec'],params['timetag_sec'])
700 self.failUnlessEqual(r['stationid'],params['stationid'])
701 self.failUnlessAlmostEqual(r['stationloc_longitude'],params['stationloc_longitude'],5)
702 self.failUnlessAlmostEqual(r['stationloc_latitude'],params['stationloc_latitude'],5)
703 self.failUnlessEqual(r['waterlevel'],params['waterlevel'])
704 self.failUnlessEqual(r['datum'],params['datum'])
705 self.failUnlessAlmostEqual(r['sigma'],params['sigma'],3)
706 self.failUnlessEqual(r['o'],params['o'])
707 self.failUnlessEqual(r['levelinferred'],params['levelinferred'])
708 self.failUnlessEqual(r['flat_tolerance_exceeded'],params['flat_tolerance_exceeded'])
709 self.failUnlessEqual(r['rate_tolerance_exceeded'],params['rate_tolerance_exceeded'])
710 self.failUnlessEqual(r['temp_tolerance_exceeded'],params['temp_tolerance_exceeded'])
711 self.failUnlessEqual(r['expected_height_exceeded'],params['expected_height_exceeded'])
712 self.failUnlessEqual(r['link_down'],params['link_down'])
713 self.failUnlessEqual(r['timeLastMeasured_month'],params['timeLastMeasured_month'])
714 self.failUnlessEqual(r['timeLastMeasured_day'],params['timeLastMeasured_day'])
715 self.failUnlessEqual(r['timeLastMeasured_hour'],params['timeLastMeasured_hour'])
716 self.failUnlessEqual(r['timeLastMeasured_min'],params['timeLastMeasured_min'])
717 self.failUnlessEqual(r['timeLastMeasured_sec'],params['timeLastMeasured_sec'])
718
720 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
721 help='decode a "waterlevel" AIS message')
722 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
723 help='encode a "waterlevel" AIS message')
724 parser.add_option('--timetag_month-field', dest='timetag_monthField',metavar='uint',type='int'
725 ,help='Field parameter value [default: %default]')
726 parser.add_option('--timetag_day-field', dest='timetag_dayField',metavar='uint',type='int'
727 ,help='Field parameter value [default: %default]')
728 parser.add_option('--timetag_hour-field', dest='timetag_hourField',metavar='uint',type='int'
729 ,help='Field parameter value [default: %default]')
730 parser.add_option('--timetag_min-field', dest='timetag_minField',metavar='uint',type='int'
731 ,help='Field parameter value [default: %default]')
732 parser.add_option('--timetag_sec-field', dest='timetag_secField',metavar='uint',type='int'
733 ,help='Field parameter value [default: %default]')
734 parser.add_option('--stationid-field', dest='stationidField',default='@@@@@@@',metavar='aisstr6',type='string'
735 ,help='Field parameter value [default: %default]')
736 parser.add_option('--stationloc_longitude-field', dest='stationloc_longitudeField',default=Decimal('181'),metavar='decimal',type='string'
737 ,help='Field parameter value [default: %default]')
738 parser.add_option('--stationloc_latitude-field', dest='stationloc_latitudeField',default=Decimal('91'),metavar='decimal',type='string'
739 ,help='Field parameter value [default: %default]')
740 parser.add_option('--waterlevel-field', dest='waterlevelField',default=-32768,metavar='int',type='int'
741 ,help='Field parameter value [default: %default]')
742 parser.add_option('--datum-field', dest='datumField',default=31,metavar='uint',type='int'
743 ,help='Field parameter value [default: %default]')
744 parser.add_option('--sigma-field', dest='sigmaField',metavar='float',type='float'
745 ,help='Field parameter value [default: %default]')
746 parser.add_option('--o-field', dest='oField',default=255,metavar='uint',type='int'
747 ,help='Field parameter value [default: %default]')
748 parser.add_option('--levelinferred-field', dest='levelinferredField',metavar='bool',type='int'
749 ,help='Field parameter value [default: %default]')
750 parser.add_option('--flat_tolerance_exceeded-field', dest='flat_tolerance_exceededField',metavar='bool',type='int'
751 ,help='Field parameter value [default: %default]')
752 parser.add_option('--rate_tolerance_exceeded-field', dest='rate_tolerance_exceededField',metavar='bool',type='int'
753 ,help='Field parameter value [default: %default]')
754 parser.add_option('--temp_tolerance_exceeded-field', dest='temp_tolerance_exceededField',metavar='bool',type='int'
755 ,help='Field parameter value [default: %default]')
756 parser.add_option('--expected_height_exceeded-field', dest='expected_height_exceededField',metavar='bool',type='int'
757 ,help='Field parameter value [default: %default]')
758 parser.add_option('--link_down-field', dest='link_downField',metavar='bool',type='int'
759 ,help='Field parameter value [default: %default]')
760 parser.add_option('--timeLastMeasured_month-field', dest='timeLastMeasured_monthField',metavar='uint',type='int'
761 ,help='Field parameter value [default: %default]')
762 parser.add_option('--timeLastMeasured_day-field', dest='timeLastMeasured_dayField',metavar='uint',type='int'
763 ,help='Field parameter value [default: %default]')
764 parser.add_option('--timeLastMeasured_hour-field', dest='timeLastMeasured_hourField',metavar='uint',type='int'
765 ,help='Field parameter value [default: %default]')
766 parser.add_option('--timeLastMeasured_min-field', dest='timeLastMeasured_minField',metavar='uint',type='int'
767 ,help='Field parameter value [default: %default]')
768 parser.add_option('--timeLastMeasured_sec-field', dest='timeLastMeasured_secField',metavar='uint',type='int'
769 ,help='Field parameter value [default: %default]')
770
771
772 if __name__=='__main__':
773
774 from optparse import OptionParser
775 parser = OptionParser(usage="%prog [options]",
776 version="%prog "+__version__)
777
778 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
779 help='run the documentation tests')
780 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
781 help='run the unit tests')
782 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
783 help='Make the test output verbose')
784
785
786
787 typeChoices = ('binary','nmeapayload','nmea')
788 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
789 ,default='nmeapayload'
790 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]')
791
792
793 outputChoices = ('std','html','xml' , 'kml','kml-full')
794 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
795 ,default='std'
796 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
797
798 parser.add_option('-o','--output',dest='outputFileName',default=None,
799 help='Name of the python file to write [default: stdout]')
800
801 addMsgOptions(parser)
802
803 (options,args) = parser.parse_args()
804 success=True
805
806 if options.doctest:
807 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
808 sys.argv= [sys.argv[0]]
809 if options.verbose: sys.argv.append('-v')
810 import doctest
811 numfail,numtests=doctest.testmod()
812 if numfail==0: print 'ok'
813 else:
814 print 'FAILED'
815 success=False
816
817 if not success: sys.exit('Something Failed')
818 del success
819
820 if options.unittest:
821 sys.argv = [sys.argv[0]]
822 if options.verbose: sys.argv.append('-v')
823 unittest.main()
824
825 outfile = sys.stdout
826 if None!=options.outputFileName:
827 outfile = file(options.outputFileName,'w')
828
829
830 if options.doEncode:
831
832 if None==options.timetag_monthField: parser.error("missing value for timetag_monthField")
833 if None==options.timetag_dayField: parser.error("missing value for timetag_dayField")
834 if None==options.timetag_hourField: parser.error("missing value for timetag_hourField")
835 if None==options.timetag_minField: parser.error("missing value for timetag_minField")
836 if None==options.timetag_secField: parser.error("missing value for timetag_secField")
837 if None==options.stationidField: parser.error("missing value for stationidField")
838 if None==options.stationloc_longitudeField: parser.error("missing value for stationloc_longitudeField")
839 if None==options.stationloc_latitudeField: parser.error("missing value for stationloc_latitudeField")
840 if None==options.waterlevelField: parser.error("missing value for waterlevelField")
841 if None==options.datumField: parser.error("missing value for datumField")
842 if None==options.sigmaField: parser.error("missing value for sigmaField")
843 if None==options.oField: parser.error("missing value for oField")
844 if None==options.levelinferredField: parser.error("missing value for levelinferredField")
845 if None==options.flat_tolerance_exceededField: parser.error("missing value for flat_tolerance_exceededField")
846 if None==options.rate_tolerance_exceededField: parser.error("missing value for rate_tolerance_exceededField")
847 if None==options.temp_tolerance_exceededField: parser.error("missing value for temp_tolerance_exceededField")
848 if None==options.expected_height_exceededField: parser.error("missing value for expected_height_exceededField")
849 if None==options.link_downField: parser.error("missing value for link_downField")
850 if None==options.timeLastMeasured_monthField: parser.error("missing value for timeLastMeasured_monthField")
851 if None==options.timeLastMeasured_dayField: parser.error("missing value for timeLastMeasured_dayField")
852 if None==options.timeLastMeasured_hourField: parser.error("missing value for timeLastMeasured_hourField")
853 if None==options.timeLastMeasured_minField: parser.error("missing value for timeLastMeasured_minField")
854 if None==options.timeLastMeasured_secField: parser.error("missing value for timeLastMeasured_secField")
855 msgDict={
856 'dac': '366',
857 'fid': '1',
858 'efid': '1',
859 'timetag_month': options.timetag_monthField,
860 'timetag_day': options.timetag_dayField,
861 'timetag_hour': options.timetag_hourField,
862 'timetag_min': options.timetag_minField,
863 'timetag_sec': options.timetag_secField,
864 'stationid': options.stationidField,
865 'stationloc_longitude': options.stationloc_longitudeField,
866 'stationloc_latitude': options.stationloc_latitudeField,
867 'waterlevel': options.waterlevelField,
868 'datum': options.datumField,
869 'sigma': options.sigmaField,
870 'o': options.oField,
871 'levelinferred': options.levelinferredField,
872 'flat_tolerance_exceeded': options.flat_tolerance_exceededField,
873 'rate_tolerance_exceeded': options.rate_tolerance_exceededField,
874 'temp_tolerance_exceeded': options.temp_tolerance_exceededField,
875 'expected_height_exceeded': options.expected_height_exceededField,
876 'link_down': options.link_downField,
877 'timeLastMeasured_month': options.timeLastMeasured_monthField,
878 'timeLastMeasured_day': options.timeLastMeasured_dayField,
879 'timeLastMeasured_hour': options.timeLastMeasured_hourField,
880 'timeLastMeasured_min': options.timeLastMeasured_minField,
881 'timeLastMeasured_sec': options.timeLastMeasured_secField,
882 }
883
884 bits = encode(msgDict)
885 if 'binary'==options.ioType: print str(bits)
886 elif 'nmeapayload'==options.ioType:
887
888 print "bitLen",len(bits)
889 bitLen=len(bits)
890 if bitLen%6!=0:
891 bits = bits + BitVector(size=(6 - (bitLen%6)))
892 print "result:",binary.bitvectoais6(bits)[0]
893
894
895
896 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
897 else: sys.exit('ERROR: unknown ioType. Help!')
898
899 if options.doDecode:
900 for msg in args:
901 bv = None
902 if 'binary' == options.ioType: bv = BitVector(bitstring=msg)
903 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg)
904 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5])
905 else: sys.exit('ERROR: unknown ioType. Help!')
906
907 printFields(decode(bv),out=outfile,format=options.outputType)
908