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 fieldList = [
49 'time_month',
50 'time_day',
51 'time_hour',
52 'time_min',
53 'stationid',
54 'pos_longitude',
55 'pos_latitude',
56 'speed',
57 'gust',
58 'direction',
59 'reserved',
60 ]
61
62 -def encode(params, validate=False):
63 '''Create a sls_wind binary message payload to pack into an AIS Msg sls_wind.
64
65 Fields in params:
66 - time_month(uint): Time tag of measurement month 1..12
67 - time_day(uint): Time tag of measurement day of the month 1..31
68 - time_hour(uint): Time tag of measurement UTC hours 0..23
69 - time_min(uint): Time tag of measurement minutes
70 - stationid(aisstr6): Character identifier of the station
71 - pos_longitude(decimal): Location of measurement East West location
72 - pos_latitude(decimal): Location of measurement North South location
73 - speed(udecimal): Average wind speed
74 - gust(udecimal): Wind gust
75 - direction(uint): Wind direction
76 - reserved(uint): Reserved bits for future use (field automatically set to "0")
77 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
78 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
79 @rtype: BitVector
80 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
81 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
82 '''
83
84 bvList = []
85 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_month']),4))
86 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_day']),5))
87 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_hour']),5))
88 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_min']),6))
89 if 'stationid' in params:
90 bvList.append(aisstring.encode(params['stationid'],42))
91 else:
92 bvList.append(aisstring.encode('@@@@@@@',42))
93 if 'pos_longitude' in params:
94 bvList.append(binary.bvFromSignedInt(int(Decimal(params['pos_longitude'])*Decimal('60000')),25))
95 else:
96 bvList.append(binary.bvFromSignedInt(10860000,25))
97 if 'pos_latitude' in params:
98 bvList.append(binary.bvFromSignedInt(int(Decimal(params['pos_latitude'])*Decimal('60000')),24))
99 else:
100 bvList.append(binary.bvFromSignedInt(5460000,24))
101 if 'speed' in params:
102 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['speed'])*Decimal('10')))),10))
103 else:
104 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(1023)),10))
105 if 'gust' in params:
106 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['gust'])*Decimal('10')))),10))
107 else:
108 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(1023)),10))
109 if 'direction' in params:
110 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['direction']),9))
111 else:
112 bvList.append(binary.setBitVectorSize(BitVector(intVal=511),9))
113 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4))
114
115 return binary.joinBV(bvList)
116
117 -def decode(bv, validate=False):
118 '''Unpack a sls_wind message
119
120 Fields in params:
121 - time_month(uint): Time tag of measurement month 1..12
122 - time_day(uint): Time tag of measurement day of the month 1..31
123 - time_hour(uint): Time tag of measurement UTC hours 0..23
124 - time_min(uint): Time tag of measurement minutes
125 - stationid(aisstr6): Character identifier of the station
126 - pos_longitude(decimal): Location of measurement East West location
127 - pos_latitude(decimal): Location of measurement North South location
128 - speed(udecimal): Average wind speed
129 - gust(udecimal): Wind gust
130 - direction(uint): Wind direction
131 - reserved(uint): Reserved bits for future use (field automatically set to "0")
132 @type bv: BitVector
133 @param bv: Bits defining a message
134 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
135 @rtype: dict
136 @return: params
137 '''
138
139
140
141
142 r = {}
143 r['time_month']=int(bv[0:4])
144 r['time_day']=int(bv[4:9])
145 r['time_hour']=int(bv[9:14])
146 r['time_min']=int(bv[14:20])
147 r['stationid']=aisstring.decode(bv[20:62])
148 r['pos_longitude']=Decimal(binary.signedIntFromBV(bv[62:87]))/Decimal('60000')
149 r['pos_latitude']=Decimal(binary.signedIntFromBV(bv[87:111]))/Decimal('60000')
150 r['speed']=Decimal(int(bv[111:121]))/Decimal('10')
151 r['gust']=Decimal(int(bv[121:131]))/Decimal('10')
152 r['direction']=int(bv[131:140])
153 r['reserved']=0
154 return r
155
158
161
164
166 return int(bv[14:20])
167
170
173
176
178 return Decimal(int(bv[111:121]))/Decimal('10')
179
181 return Decimal(int(bv[121:131]))/Decimal('10')
182
184 return int(bv[131:140])
185
187 return 0
188
189
191 out.write("<h3>sls_wind<h3>\n")
192 out.write("<table border=\"1\">\n")
193 out.write("<tr bgcolor=\"orange\">\n")
194 out.write("<th align=\"left\">Field Name</th>\n")
195 out.write("<th align=\"left\">Type</th>\n")
196 out.write("<th align=\"left\">Value</th>\n")
197 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
198 out.write("<th align=\"left\">Units</th>\n")
199 out.write("\n")
200 out.write("<tr>\n")
201 out.write("<td>time_month</td>\n")
202 out.write("<td>uint</td>\n")
203 if 'time_month' in params:
204 out.write(" <td>"+str(params['time_month'])+"</td>\n")
205 out.write(" <td>"+str(params['time_month'])+"</td>\n")
206 out.write("</tr>\n")
207 out.write("\n")
208 out.write("<tr>\n")
209 out.write("<td>time_day</td>\n")
210 out.write("<td>uint</td>\n")
211 if 'time_day' in params:
212 out.write(" <td>"+str(params['time_day'])+"</td>\n")
213 out.write(" <td>"+str(params['time_day'])+"</td>\n")
214 out.write("</tr>\n")
215 out.write("\n")
216 out.write("<tr>\n")
217 out.write("<td>time_hour</td>\n")
218 out.write("<td>uint</td>\n")
219 if 'time_hour' in params:
220 out.write(" <td>"+str(params['time_hour'])+"</td>\n")
221 out.write(" <td>"+str(params['time_hour'])+"</td>\n")
222 out.write("</tr>\n")
223 out.write("\n")
224 out.write("<tr>\n")
225 out.write("<td>time_min</td>\n")
226 out.write("<td>uint</td>\n")
227 if 'time_min' in params:
228 out.write(" <td>"+str(params['time_min'])+"</td>\n")
229 out.write(" <td>"+str(params['time_min'])+"</td>\n")
230 out.write("</tr>\n")
231 out.write("\n")
232 out.write("<tr>\n")
233 out.write("<td>stationid</td>\n")
234 out.write("<td>aisstr6</td>\n")
235 if 'stationid' in params:
236 out.write(" <td>"+str(params['stationid'])+"</td>\n")
237 out.write(" <td>"+str(params['stationid'])+"</td>\n")
238 out.write("</tr>\n")
239 out.write("\n")
240 out.write("<tr>\n")
241 out.write("<td>pos_longitude</td>\n")
242 out.write("<td>decimal</td>\n")
243 if 'pos_longitude' in params:
244 out.write(" <td>"+str(params['pos_longitude'])+"</td>\n")
245 out.write(" <td>"+str(params['pos_longitude'])+"</td>\n")
246 out.write("<td>degrees</td>\n")
247 out.write("</tr>\n")
248 out.write("\n")
249 out.write("<tr>\n")
250 out.write("<td>pos_latitude</td>\n")
251 out.write("<td>decimal</td>\n")
252 if 'pos_latitude' in params:
253 out.write(" <td>"+str(params['pos_latitude'])+"</td>\n")
254 out.write(" <td>"+str(params['pos_latitude'])+"</td>\n")
255 out.write("<td>degrees</td>\n")
256 out.write("</tr>\n")
257 out.write("\n")
258 out.write("<tr>\n")
259 out.write("<td>speed</td>\n")
260 out.write("<td>udecimal</td>\n")
261 if 'speed' in params:
262 out.write(" <td>"+str(params['speed'])+"</td>\n")
263 if str(params['speed']) in speedDecodeLut:
264 out.write("<td>"+speedDecodeLut[str(params['speed'])]+"</td>")
265 else:
266 out.write("<td><i>Missing LUT entry</i></td>")
267 out.write("<td>kts</td>\n")
268 out.write("</tr>\n")
269 out.write("\n")
270 out.write("<tr>\n")
271 out.write("<td>gust</td>\n")
272 out.write("<td>udecimal</td>\n")
273 if 'gust' in params:
274 out.write(" <td>"+str(params['gust'])+"</td>\n")
275 if str(params['gust']) in gustDecodeLut:
276 out.write("<td>"+gustDecodeLut[str(params['gust'])]+"</td>")
277 else:
278 out.write("<td><i>Missing LUT entry</i></td>")
279 out.write("<td>kts</td>\n")
280 out.write("</tr>\n")
281 out.write("\n")
282 out.write("<tr>\n")
283 out.write("<td>direction</td>\n")
284 out.write("<td>uint</td>\n")
285 if 'direction' in params:
286 out.write(" <td>"+str(params['direction'])+"</td>\n")
287 out.write(" <td>"+str(params['direction'])+"</td>\n")
288 out.write("<td>degrees</td>\n")
289 out.write("</tr>\n")
290 out.write("\n")
291 out.write("<tr>\n")
292 out.write("<td>reserved</td>\n")
293 out.write("<td>uint</td>\n")
294 if 'reserved' in params:
295 out.write(" <td>"+str(params['reserved'])+"</td>\n")
296 out.write(" <td>"+str(params['reserved'])+"</td>\n")
297 out.write("</tr>\n")
298 out.write("</table>\n")
299
300
302 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer'''
303 out.write("\ <Placemark>\n")
304 out.write("\t <name>"+str(params['stationid'])+"</name>\n")
305 out.write("\t\t<description>\n")
306 import StringIO
307 buf = StringIO.StringIO()
308 printHtml(params,buf)
309 import cgi
310 out.write(cgi.escape(buf.getvalue()))
311 out.write("\t\t</description>\n")
312 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n")
313 out.write("\t\t<Point>\n")
314 out.write("\t\t\t<coordinates>")
315 out.write(str(params['pos_longitude']))
316 out.write(',')
317 out.write(str(params['pos_latitude']))
318 out.write(",0</coordinates>\n")
319 out.write("\t\t</Point>\n")
320 out.write("\t</Placemark>\n")
321
322 -def printFields(params, out=sys.stdout, format='std', fieldList=None):
323 '''Print a reserved message to stdout.
324
325 Fields in params:
326 - time_month(uint): Time tag of measurement month 1..12
327 - time_day(uint): Time tag of measurement day of the month 1..31
328 - time_hour(uint): Time tag of measurement UTC hours 0..23
329 - time_min(uint): Time tag of measurement minutes
330 - stationid(aisstr6): Character identifier of the station
331 - pos_longitude(decimal): Location of measurement East West location
332 - pos_latitude(decimal): Location of measurement North South location
333 - speed(udecimal): Average wind speed
334 - gust(udecimal): Wind gust
335 - direction(uint): Wind direction
336 - reserved(uint): Reserved bits for future use (field automatically set to "0")
337 @param params: Dictionary of field names/values.
338 @param out: File like object to write to
339 @rtype: stdout
340 @return: text to out
341 '''
342
343 if 'std'==format:
344 out.write("reserved:\n")
345 if 'time_month' in params: out.write(" time_month: "+str(params['time_month'])+"\n")
346 if 'time_day' in params: out.write(" time_day: "+str(params['time_day'])+"\n")
347 if 'time_hour' in params: out.write(" time_hour: "+str(params['time_hour'])+"\n")
348 if 'time_min' in params: out.write(" time_min: "+str(params['time_min'])+"\n")
349 if 'stationid' in params: out.write(" stationid: "+str(params['stationid'])+"\n")
350 if 'pos_longitude' in params: out.write(" pos_longitude: "+str(params['pos_longitude'])+"\n")
351 if 'pos_latitude' in params: out.write(" pos_latitude: "+str(params['pos_latitude'])+"\n")
352 if 'speed' in params: out.write(" speed: "+str(params['speed'])+"\n")
353 if 'gust' in params: out.write(" gust: "+str(params['gust'])+"\n")
354 if 'direction' in params: out.write(" direction: "+str(params['direction'])+"\n")
355 if 'reserved' in params: out.write(" reserved: "+str(params['reserved'])+"\n")
356 elif 'csv'==format:
357 if None == options.fieldList:
358 options.fieldList = fieldList
359 needComma = False;
360 for field in fieldList:
361 if needComma: out.write(',')
362 needComma = True
363 if field in params:
364 out.write(str(params[field]))
365
366 out.write("\n")
367 elif 'html'==format:
368 printHtml(params,out)
369 elif 'kml'==format:
370 printKml(params,out)
371 elif 'kml-full'==format:
372 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
373 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n")
374 out.write("<Document>\n")
375 out.write(" <name>Position</name>\n")
376 printKml(params,out)
377 out.write("</Document>\n")
378 out.write("</kml>\n")
379 else:
380 print "ERROR: unknown format:",format
381 assert False
382
383 return
384
385 speedEncodeLut = {
386 '102.2 kts or greater':'102.2',
387 }
388
389 speedDecodeLut = {
390 '102.2':'102.2 kts or greater',
391 }
392
393 gustEncodeLut = {
394 '102.2 kts or greater':'102.2',
395 }
396
397 gustDecodeLut = {
398 '102.2':'102.2 kts or greater',
399 }
400
401
402
403
404
405
406 import unittest
408 '''Return a params file base on the testvalue tags.
409 @rtype: dict
410 @return: params based on testvalue tags
411 '''
412 params = {}
413 params['time_month'] = 2
414 params['time_day'] = 28
415 params['time_hour'] = 23
416 params['time_min'] = 45
417 params['stationid'] = 'A345678'
418 params['pos_longitude'] = Decimal('-122.16328')
419 params['pos_latitude'] = Decimal('37.42446')
420 params['speed'] = Decimal('0.7')
421 params['gust'] = Decimal('0.7')
422 params['direction'] = 90
423 params['reserved'] = 0
424
425 return params
426
428 '''Use testvalue tag text from each type to build test case the sls_wind message'''
430
431 params = testParams()
432 bits = encode(params)
433 r = decode(bits)
434
435
436 self.failUnlessEqual(r['time_month'],params['time_month'])
437 self.failUnlessEqual(r['time_day'],params['time_day'])
438 self.failUnlessEqual(r['time_hour'],params['time_hour'])
439 self.failUnlessEqual(r['time_min'],params['time_min'])
440 self.failUnlessEqual(r['stationid'],params['stationid'])
441 self.failUnlessAlmostEqual(r['pos_longitude'],params['pos_longitude'],4)
442 self.failUnlessAlmostEqual(r['pos_latitude'],params['pos_latitude'],4)
443 self.failUnlessAlmostEqual(r['speed'],params['speed'],3)
444 self.failUnlessAlmostEqual(r['gust'],params['gust'],3)
445 self.failUnlessEqual(r['direction'],params['direction'])
446 self.failUnlessEqual(r['reserved'],params['reserved'])
447
449 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
450 help='decode a "sls_wind" AIS message')
451 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
452 help='encode a "sls_wind" AIS message')
453 parser.add_option('--time_month-field', dest='time_monthField',metavar='uint',type='int'
454 ,help='Field parameter value [default: %default]')
455 parser.add_option('--time_day-field', dest='time_dayField',metavar='uint',type='int'
456 ,help='Field parameter value [default: %default]')
457 parser.add_option('--time_hour-field', dest='time_hourField',metavar='uint',type='int'
458 ,help='Field parameter value [default: %default]')
459 parser.add_option('--time_min-field', dest='time_minField',metavar='uint',type='int'
460 ,help='Field parameter value [default: %default]')
461 parser.add_option('--stationid-field', dest='stationidField',default='@@@@@@@',metavar='aisstr6',type='string'
462 ,help='Field parameter value [default: %default]')
463 parser.add_option('--pos_longitude-field', dest='pos_longitudeField',default=Decimal('181'),metavar='decimal',type='string'
464 ,help='Field parameter value [default: %default]')
465 parser.add_option('--pos_latitude-field', dest='pos_latitudeField',default=Decimal('91'),metavar='decimal',type='string'
466 ,help='Field parameter value [default: %default]')
467 parser.add_option('--speed-field', dest='speedField',default=Decimal('102.3'),metavar='udecimal',type='string'
468 ,help='Field parameter value [default: %default]')
469 parser.add_option('--gust-field', dest='gustField',default=Decimal('102.3'),metavar='udecimal',type='string'
470 ,help='Field parameter value [default: %default]')
471 parser.add_option('--direction-field', dest='directionField',default=511,metavar='uint',type='int'
472 ,help='Field parameter value [default: %default]')
473
474
475 if __name__=='__main__':
476
477 from optparse import OptionParser
478 parser = OptionParser(usage="%prog [options]",
479 version="%prog "+__version__)
480
481 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
482 help='run the documentation tests')
483 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
484 help='run the unit tests')
485 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
486 help='Make the test output verbose')
487
488
489
490 typeChoices = ('binary','nmeapayload','nmea')
491 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
492 ,default='nmeapayload'
493 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]')
494
495
496 outputChoices = ('std','html','csv' , 'kml','kml-full')
497 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
498 ,default='std'
499 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
500
501 parser.add_option('-o','--output',dest='outputFileName',default=None,
502 help='Name of the python file to write [default: stdout]')
503
504 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append',
505 choices=fieldList,
506 help='Which fields to include in the output. Currently only for csv output [default: all]')
507
508 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true',
509 help='Print the field name for csv')
510
511 addMsgOptions(parser)
512
513 (options,args) = parser.parse_args()
514 success=True
515
516 if options.doctest:
517 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
518 sys.argv= [sys.argv[0]]
519 if options.verbose: sys.argv.append('-v')
520 import doctest
521 numfail,numtests=doctest.testmod()
522 if numfail==0: print 'ok'
523 else:
524 print 'FAILED'
525 success=False
526
527 if not success: sys.exit('Something Failed')
528 del success
529
530 if options.unittest:
531 sys.argv = [sys.argv[0]]
532 if options.verbose: sys.argv.append('-v')
533 unittest.main()
534
535 outfile = sys.stdout
536 if None!=options.outputFileName:
537 outfile = file(options.outputFileName,'w')
538
539
540 if options.doEncode:
541
542 if None==options.time_monthField: parser.error("missing value for time_monthField")
543 if None==options.time_dayField: parser.error("missing value for time_dayField")
544 if None==options.time_hourField: parser.error("missing value for time_hourField")
545 if None==options.time_minField: parser.error("missing value for time_minField")
546 if None==options.stationidField: parser.error("missing value for stationidField")
547 if None==options.pos_longitudeField: parser.error("missing value for pos_longitudeField")
548 if None==options.pos_latitudeField: parser.error("missing value for pos_latitudeField")
549 if None==options.speedField: parser.error("missing value for speedField")
550 if None==options.gustField: parser.error("missing value for gustField")
551 if None==options.directionField: parser.error("missing value for directionField")
552 msgDict={
553 'time_month': options.time_monthField,
554 'time_day': options.time_dayField,
555 'time_hour': options.time_hourField,
556 'time_min': options.time_minField,
557 'stationid': options.stationidField,
558 'pos_longitude': options.pos_longitudeField,
559 'pos_latitude': options.pos_latitudeField,
560 'speed': options.speedField,
561 'gust': options.gustField,
562 'direction': options.directionField,
563 'reserved': '0',
564 }
565
566 bits = encode(msgDict)
567 if 'binary'==options.ioType: print str(bits)
568 elif 'nmeapayload'==options.ioType:
569
570 print "bitLen",len(bits)
571 bitLen=len(bits)
572 if bitLen%6!=0:
573 bits = bits + BitVector(size=(6 - (bitLen%6)))
574 print "result:",binary.bitvectoais6(bits)[0]
575
576
577
578 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
579 else: sys.exit('ERROR: unknown ioType. Help!')
580
581 if options.printCsvfieldList:
582
583 if None == options.fieldList: options.fieldList = fieldList
584 import StringIO
585 buf = StringIO.StringIO()
586 for field in options.fieldList:
587 buf.write(field+',')
588 result = buf.getvalue()
589 if result[-1] == ',': print result[:-1]
590 else: print result
591
592 if options.doDecode:
593 for msg in args:
594 bv = None
595 if 'binary' == options.ioType: bv = BitVector(bitstring=msg)
596 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg)
597 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5])
598 else: sys.exit('ERROR: unknown ioType. Help!')
599
600 printFields(decode(bv),out=outfile,format=options.outputType,fieldList=options.fieldList)
601