1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-03-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 @todo: FIX: put in a description of the message here with fields and types.
34 '''
35
36 import sys
37 from decimal import Decimal
38 from BitVector import BitVector
39
40 import binary, aisstring
41
42
43 TrueBV = BitVector(bitstring="1")
44 "Why always rebuild the True bit? This should speed things up a bunch"
45 FalseBV = BitVector(bitstring="0")
46 "Why always rebuild the False bit? This should speed things up a bunch"
47
48
49 fieldList = (
50 'MessageID',
51 'RepeatIndicator',
52 'UserID',
53 'SeqNum',
54 'DestinationID',
55 'RetransmitFlag',
56 'Spare',
57 )
58
59 fieldListPostgres = (
60 'MessageID',
61 'RepeatIndicator',
62 'UserID',
63 'SeqNum',
64 'DestinationID',
65 'RetransmitFlag',
66 'Spare',
67 )
68
69 toPgFields = {
70 }
71 '''
72 Go to the Postgis field names from the straight field name
73 '''
74
75 fromPgFields = {
76 }
77 '''
78 Go from the Postgis field names to the straight field name
79 '''
80
81 pgTypes = {
82 }
83 '''
84 Lookup table for each postgis field name to get its type.
85 '''
86
87 -def encode(params, validate=False):
88 '''Create a asrm binary message payload to pack into an AIS Msg asrm.
89
90 Fields in params:
91 - MessageID(uint): AIS message number. Must be 6 (field automatically set to "6")
92 - RepeatIndicator(uint): Indicated how many times a message has been repeated
93 - UserID(uint): Unique ship identification number (MMSI). Also known as the Source ID
94 - SeqNum(uint): Sequence number as described in 5.3.1. Assigned to each station
95 - DestinationID(uint): Unique ship identification number (MMSI).
96 - RetransmitFlag(bool): Should the message be restransmitted?
97 - Spare(uint): Must be 0 (field automatically set to "0")
98 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
99 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
100 @rtype: BitVector
101 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
102 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
103 '''
104
105 bvList = []
106 bvList.append(binary.setBitVectorSize(BitVector(intVal=6),6))
107 if 'RepeatIndicator' in params:
108 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2))
109 else:
110 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2))
111 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30))
112 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['SeqNum']),2))
113 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['DestinationID']),30))
114 if params["RetransmitFlag"]: bvList.append(TrueBV)
115 else: bvList.append(FalseBV)
116 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),1))
117
118 return binary.joinBV(bvList)
119
120 -def decode(bv, validate=False):
121 '''Unpack a asrm message
122
123 Fields in params:
124 - MessageID(uint): AIS message number. Must be 6 (field automatically set to "6")
125 - RepeatIndicator(uint): Indicated how many times a message has been repeated
126 - UserID(uint): Unique ship identification number (MMSI). Also known as the Source ID
127 - SeqNum(uint): Sequence number as described in 5.3.1. Assigned to each station
128 - DestinationID(uint): Unique ship identification number (MMSI).
129 - RetransmitFlag(bool): Should the message be restransmitted?
130 - Spare(uint): Must be 0 (field automatically set to "0")
131 @type bv: BitVector
132 @param bv: Bits defining a message
133 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
134 @rtype: dict
135 @return: params
136 '''
137
138
139
140
141 r = {}
142 r['MessageID']=6
143 r['RepeatIndicator']=int(bv[6:8])
144 r['UserID']=int(bv[8:38])
145 r['SeqNum']=int(bv[38:40])
146 r['DestinationID']=int(bv[40:70])
147 r['RetransmitFlag']=bool(int(bv[70:71]))
148 r['Spare']=0
149 return r
150
153
156
159
161 return int(bv[38:40])
162
164 return int(bv[40:70])
165
167 return bool(int(bv[70:71]))
168
171
172
174 out.write("<h3>asrm<h3>\n")
175 out.write("<table border=\"1\">\n")
176 out.write("<tr bgcolor=\"orange\">\n")
177 out.write("<th align=\"left\">Field Name</th>\n")
178 out.write("<th align=\"left\">Type</th>\n")
179 out.write("<th align=\"left\">Value</th>\n")
180 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
181 out.write("<th align=\"left\">Units</th>\n")
182 out.write("\n")
183 out.write("<tr>\n")
184 out.write("<td>MessageID</td>\n")
185 out.write("<td>uint</td>\n")
186 if 'MessageID' in params:
187 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
188 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
189 out.write("</tr>\n")
190 out.write("\n")
191 out.write("<tr>\n")
192 out.write("<td>RepeatIndicator</td>\n")
193 out.write("<td>uint</td>\n")
194 if 'RepeatIndicator' in params:
195 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n")
196 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut:
197 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>")
198 else:
199 out.write("<td><i>Missing LUT entry</i></td>")
200 out.write("</tr>\n")
201 out.write("\n")
202 out.write("<tr>\n")
203 out.write("<td>UserID</td>\n")
204 out.write("<td>uint</td>\n")
205 if 'UserID' in params:
206 out.write(" <td>"+str(params['UserID'])+"</td>\n")
207 out.write(" <td>"+str(params['UserID'])+"</td>\n")
208 out.write("</tr>\n")
209 out.write("\n")
210 out.write("<tr>\n")
211 out.write("<td>SeqNum</td>\n")
212 out.write("<td>uint</td>\n")
213 if 'SeqNum' in params:
214 out.write(" <td>"+str(params['SeqNum'])+"</td>\n")
215 out.write(" <td>"+str(params['SeqNum'])+"</td>\n")
216 out.write("</tr>\n")
217 out.write("\n")
218 out.write("<tr>\n")
219 out.write("<td>DestinationID</td>\n")
220 out.write("<td>uint</td>\n")
221 if 'DestinationID' in params:
222 out.write(" <td>"+str(params['DestinationID'])+"</td>\n")
223 out.write(" <td>"+str(params['DestinationID'])+"</td>\n")
224 out.write("</tr>\n")
225 out.write("\n")
226 out.write("<tr>\n")
227 out.write("<td>RetransmitFlag</td>\n")
228 out.write("<td>bool</td>\n")
229 if 'RetransmitFlag' in params:
230 out.write(" <td>"+str(params['RetransmitFlag'])+"</td>\n")
231 out.write(" <td>"+str(params['RetransmitFlag'])+"</td>\n")
232 out.write("</tr>\n")
233 out.write("\n")
234 out.write("<tr>\n")
235 out.write("<td>Spare</td>\n")
236 out.write("<td>uint</td>\n")
237 if 'Spare' in params:
238 out.write(" <td>"+str(params['Spare'])+"</td>\n")
239 out.write(" <td>"+str(params['Spare'])+"</td>\n")
240 out.write("</tr>\n")
241 out.write("</table>\n")
242
243 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):
244 '''Print a asrm message to stdout.
245
246 Fields in params:
247 - MessageID(uint): AIS message number. Must be 6 (field automatically set to "6")
248 - RepeatIndicator(uint): Indicated how many times a message has been repeated
249 - UserID(uint): Unique ship identification number (MMSI). Also known as the Source ID
250 - SeqNum(uint): Sequence number as described in 5.3.1. Assigned to each station
251 - DestinationID(uint): Unique ship identification number (MMSI).
252 - RetransmitFlag(bool): Should the message be restransmitted?
253 - Spare(uint): Must be 0 (field automatically set to "0")
254 @param params: Dictionary of field names/values.
255 @param out: File like object to write to
256 @rtype: stdout
257 @return: text to out
258 '''
259
260 if 'std'==format:
261 out.write("asrm:\n")
262 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n")
263 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n")
264 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n")
265 if 'SeqNum' in params: out.write(" SeqNum: "+str(params['SeqNum'])+"\n")
266 if 'DestinationID' in params: out.write(" DestinationID: "+str(params['DestinationID'])+"\n")
267 if 'RetransmitFlag' in params: out.write(" RetransmitFlag: "+str(params['RetransmitFlag'])+"\n")
268 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n")
269 elif 'csv'==format:
270 if None == options.fieldList:
271 options.fieldList = fieldList
272 needComma = False;
273 for field in fieldList:
274 if needComma: out.write(',')
275 needComma = True
276 if field in params:
277 out.write(str(params[field]))
278
279 out.write("\n")
280 elif 'html'==format:
281 printHtml(params,out)
282 elif 'sql'==format:
283 sqlInsertStr(params,out,dbType=dbType)
284 else:
285 print "ERROR: unknown format:",format
286 assert False
287
288 return
289
290 RepeatIndicatorEncodeLut = {
291 'default':'0',
292 'do not repeat any more':'3',
293 }
294
295 RepeatIndicatorDecodeLut = {
296 '0':'default',
297 '3':'do not repeat any more',
298 }
299
300
301
302
303
304 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None
305 ,addCoastGuardFields=True
306 ,dbType='postgres'
307 ):
308 '''
309 Return the SQL CREATE command for this message type
310 @param outfile: file like object to print to.
311 @param fields: which fields to put in the create. Defaults to all.
312 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
313 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
314 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
315 @type addCoastGuardFields: bool
316 @return: sql create string
317 @rtype: str
318
319 @see: sqlCreate
320 '''
321 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
322
323 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
324 '''
325 Return the sqlhelp object to create the table.
326
327 @param fields: which fields to put in the create. Defaults to all.
328 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
329 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
330 @type addCoastGuardFields: bool
331 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
332 @return: An object that can be used to generate a return
333 @rtype: sqlhelp.create
334 '''
335 if None == fields: fields = fieldList
336 import sqlhelp
337 c = sqlhelp.create('asrm',dbType=dbType)
338 c.addPrimaryKey()
339 if 'MessageID' in fields: c.addInt ('MessageID')
340 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator')
341 if 'UserID' in fields: c.addInt ('UserID')
342 if 'SeqNum' in fields: c.addInt ('SeqNum')
343 if 'DestinationID' in fields: c.addInt ('DestinationID')
344 if 'RetransmitFlag' in fields: c.addBool('RetransmitFlag')
345 if 'Spare' in fields: c.addInt ('Spare')
346
347 if addCoastGuardFields:
348
349
350
351
352
353 c.addVarChar('cg_r',15)
354 c.addInt('cg_sec')
355
356 c.addTimestamp('cg_timestamp')
357
358 return c
359
360 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
361 '''
362 Return the SQL INSERT command for this message type
363 @param params: dictionary of values keyed by field name
364 @param outfile: file like object to print to.
365 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields
366 @return: sql create string
367 @rtype: str
368
369 @see: sqlCreate
370 '''
371 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
372
373
374 -def sqlInsert(params,extraParams=None,dbType='postgres'):
375 '''
376 Give the SQL INSERT statement
377 @param params: dict keyed by field name of values
378 @param extraParams: any extra fields that you have created beyond the normal ais message fields
379 @rtype: sqlhelp.insert
380 @return: insert class instance
381 @todo: allow optional type checking of params?
382 @warning: this will take invalid keys happily and do what???
383 '''
384 import sqlhelp
385 i = sqlhelp.insert('asrm',dbType=dbType)
386
387 if dbType=='postgres':
388 finished = []
389 for key in params:
390 if key in finished:
391 continue
392
393 if key not in toPgFields and key not in fromPgFields:
394 if type(params[key])==Decimal: i.add(key,float(params[key]))
395 else: i.add(key,params[key])
396 else:
397 if key in fromPgFields:
398 val = params[key]
399
400 i.addPostGIS(key,val)
401 finished.append(key)
402 else:
403
404 pgName = toPgFields[key]
405
406 valStr=pgTypes[pgName]+'('
407 vals = []
408 for nonPgKey in fromPgFields[pgName]:
409 vals.append(str(params[nonPgKey]))
410 finished.append(nonPgKey)
411 valStr+=' '.join(vals)+')'
412 i.addPostGIS(pgName,valStr)
413 else:
414 for key in params:
415 if type(params[key])==Decimal: i.add(key,float(params[key]))
416 else: i.add(key,params[key])
417
418 if None != extraParams:
419 for key in extraParams:
420 i.add(key,extraParams[key])
421
422 return i
423
424
425
426
427
428 import unittest
430 '''Return a params file base on the testvalue tags.
431 @rtype: dict
432 @return: params based on testvalue tags
433 '''
434 params = {}
435 params['MessageID'] = 6
436 params['RepeatIndicator'] = 1
437 params['UserID'] = 1193046
438 params['SeqNum'] = 3
439 params['DestinationID'] = 1193047
440 params['RetransmitFlag'] = True
441 params['Spare'] = 0
442
443 return params
444
446 '''Use testvalue tag text from each type to build test case the asrm message'''
448
449 params = testParams()
450 bits = encode(params)
451 r = decode(bits)
452
453
454 self.failUnlessEqual(r['MessageID'],params['MessageID'])
455 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator'])
456 self.failUnlessEqual(r['UserID'],params['UserID'])
457 self.failUnlessEqual(r['SeqNum'],params['SeqNum'])
458 self.failUnlessEqual(r['DestinationID'],params['DestinationID'])
459 self.failUnlessEqual(r['RetransmitFlag'],params['RetransmitFlag'])
460 self.failUnlessEqual(r['Spare'],params['Spare'])
461
463 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
464 help='decode a "asrm" AIS message')
465 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
466 help='encode a "asrm" AIS message')
467 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int'
468 ,help='Field parameter value [default: %default]')
469 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int'
470 ,help='Field parameter value [default: %default]')
471 parser.add_option('--SeqNum-field', dest='SeqNumField',metavar='uint',type='int'
472 ,help='Field parameter value [default: %default]')
473 parser.add_option('--DestinationID-field', dest='DestinationIDField',metavar='uint',type='int'
474 ,help='Field parameter value [default: %default]')
475 parser.add_option('--RetransmitFlag-field', dest='RetransmitFlagField',metavar='bool',type='int'
476 ,help='Field parameter value [default: %default]')
477
478
479 if __name__=='__main__':
480
481 from optparse import OptionParser
482 parser = OptionParser(usage="%prog [options]",
483 version="%prog "+__version__)
484
485 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
486 help='run the documentation tests')
487 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
488 help='run the unit tests')
489 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
490 help='Make the test output verbose')
491
492
493
494 typeChoices = ('binary','nmeapayload','nmea')
495 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
496 ,default='nmeapayload'
497 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]')
498
499
500 outputChoices = ('std','html','csv','sql' )
501 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
502 ,default='std'
503 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
504
505 parser.add_option('-o','--output',dest='outputFileName',default=None,
506 help='Name of the python file to write [default: stdout]')
507
508 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append',
509 choices=fieldList,
510 help='Which fields to include in the output. Currently only for csv output [default: all]')
511
512 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true',
513 help='Print the field name for csv')
514
515 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true',
516 help='Print out an sql create command for the table.')
517
518 dbChoices = ('sqlite','postgres')
519 parser.add_option('-D','--db-type',dest='dbType',default='postgres'
520 ,choices=dbChoices,type='choice'
521 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]')
522
523 addMsgOptions(parser)
524
525 (options,args) = parser.parse_args()
526 success=True
527
528 if options.doctest:
529 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
530 sys.argv= [sys.argv[0]]
531 if options.verbose: sys.argv.append('-v')
532 import doctest
533 numfail,numtests=doctest.testmod()
534 if numfail==0: print 'ok'
535 else:
536 print 'FAILED'
537 success=False
538
539 if not success: sys.exit('Something Failed')
540 del success
541
542 if options.unittest:
543 sys.argv = [sys.argv[0]]
544 if options.verbose: sys.argv.append('-v')
545 unittest.main()
546
547 outfile = sys.stdout
548 if None!=options.outputFileName:
549 outfile = file(options.outputFileName,'w')
550
551
552 if options.doEncode:
553
554 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField")
555 if None==options.UserIDField: parser.error("missing value for UserIDField")
556 if None==options.SeqNumField: parser.error("missing value for SeqNumField")
557 if None==options.DestinationIDField: parser.error("missing value for DestinationIDField")
558 if None==options.RetransmitFlagField: parser.error("missing value for RetransmitFlagField")
559 msgDict={
560 'MessageID': '6',
561 'RepeatIndicator': options.RepeatIndicatorField,
562 'UserID': options.UserIDField,
563 'SeqNum': options.SeqNumField,
564 'DestinationID': options.DestinationIDField,
565 'RetransmitFlag': options.RetransmitFlagField,
566 'Spare': '0',
567 }
568
569 bits = encode(msgDict)
570 if 'binary'==options.ioType: print str(bits)
571 elif 'nmeapayload'==options.ioType:
572
573 print "bitLen",len(bits)
574 bitLen=len(bits)
575 if bitLen%6!=0:
576 bits = bits + BitVector(size=(6 - (bitLen%6)))
577 print "result:",binary.bitvectoais6(bits)[0]
578
579
580
581 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
582 else: sys.exit('ERROR: unknown ioType. Help!')
583
584
585 if options.sqlCreate:
586 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType)
587
588 if options.printCsvfieldList:
589
590 if None == options.fieldList: options.fieldList = fieldList
591 import StringIO
592 buf = StringIO.StringIO()
593 for field in options.fieldList:
594 buf.write(field+',')
595 result = buf.getvalue()
596 if result[-1] == ',': print result[:-1]
597 else: print result
598
599 if options.doDecode:
600 for msg in args:
601 bv = None
602
603 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'):
604
605
606 bv = binary.ais6tobitvec(msg.split(',')[5])
607 else:
608
609 binaryMsg=True
610 for c in msg:
611 if c not in ('0','1'):
612 binaryMsg=False
613 break
614 if binaryMsg:
615 bv = BitVector(bitstring=msg)
616 else:
617 bv = binary.ais6tobitvec(msg)
618
619 printFields(decode(bv)
620 ,out=outfile
621 ,format=options.outputType
622 ,fieldList=options.fieldList
623 ,dbType=options.dbType
624 )
625