1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2006-12-20 $'.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__ myparser
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 shipdata binary message payload to pack into an AIS Msg shipdata.
50
51 Fields in params:
52 - MessageID(uint): AIS message number. Must be 5 (field automatically set to "5")
53 - RepeatIndicator(uint): Indicated how many times a message has been repeated
54 - UserID(uint): Unique ship identification number (MMSI)
55 - AISversion(uint): Compliant with what edition. 0 is the first edition.
56 - IMOnumber(uint): vessel identification number (different than mmsi)
57 - callsign(aisstr6): Ship radio call sign
58 - name(aisstr6): Vessel name
59 - shipandcargo(uint): what
60 - dimA(uint): FIX: write a description
61 - dimB(uint): FIX: write a description
62 - dimC(uint): FIX: write a description
63 - dimD(uint): FIX: write a description
64 - fixtype(uint): Method used for positioning
65 - ETA(uint): FIX: break this out
66 - draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater
67 - destination(aisstr6): Where is the vessel going
68 - dte(uint): Data terminal ready
69 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
70 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
71 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
72 @rtype: BitVector
73 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
74 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
75 '''
76
77 bvList = []
78 bvList.append(binary.setBitVectorSize(BitVector(intVal=5),6))
79 if 'RepeatIndicator' in params:
80 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2))
81 else:
82 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2))
83 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30))
84 if 'AISversion' in params:
85 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['AISversion']),2))
86 else:
87 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2))
88 if 'IMOnumber' in params:
89 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['IMOnumber']),30))
90 else:
91 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),30))
92 if 'callsign' in params:
93 bvList.append(aisstring.encode(params['callsign'],42))
94 else:
95 bvList.append(aisstring.encode('@@@@@@@',42))
96 if 'name' in params:
97 bvList.append(aisstring.encode(params['name'],120))
98 else:
99 bvList.append(aisstring.encode('@@@@@@@@@@@@@@@@@@@@',120))
100 if 'shipandcargo' in params:
101 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['shipandcargo']),8))
102 else:
103 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),8))
104 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimA']),9))
105 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimB']),9))
106 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimC']),6))
107 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimD']),6))
108 if 'fixtype' in params:
109 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['fixtype']),4))
110 else:
111 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4))
112 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['ETA']),20))
113 if 'draught' in params:
114 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['draught'])*Decimal('10')))),8))
115 else:
116 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(0)),8))
117 if 'destination' in params:
118 bvList.append(aisstring.encode(params['destination'],120))
119 else:
120 bvList.append(aisstring.encode('@@@@@@@@@@@@@@@@@@@@',120))
121 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dte']),1))
122 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),1))
123
124 return binary.joinBV(bvList)
125
126 -def decode(bv, validate=False):
127 '''Unpack a shipdata message
128
129 Fields in params:
130 - MessageID(uint): AIS message number. Must be 5 (field automatically set to "5")
131 - RepeatIndicator(uint): Indicated how many times a message has been repeated
132 - UserID(uint): Unique ship identification number (MMSI)
133 - AISversion(uint): Compliant with what edition. 0 is the first edition.
134 - IMOnumber(uint): vessel identification number (different than mmsi)
135 - callsign(aisstr6): Ship radio call sign
136 - name(aisstr6): Vessel name
137 - shipandcargo(uint): what
138 - dimA(uint): FIX: write a description
139 - dimB(uint): FIX: write a description
140 - dimC(uint): FIX: write a description
141 - dimD(uint): FIX: write a description
142 - fixtype(uint): Method used for positioning
143 - ETA(uint): FIX: break this out
144 - draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater
145 - destination(aisstr6): Where is the vessel going
146 - dte(uint): Data terminal ready
147 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
148 @type bv: BitVector
149 @param bv: Bits defining a message
150 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
151 @rtype: dict
152 @return: params
153 '''
154
155
156
157
158 r = {}
159 r['MessageID']=5
160 r['RepeatIndicator']=int(bv[6:8])
161 r['UserID']=int(bv[8:38])
162 r['AISversion']=int(bv[38:40])
163 r['IMOnumber']=int(bv[40:70])
164 r['callsign']=aisstring.decode(bv[70:112])
165 r['name']=aisstring.decode(bv[112:232])
166 r['shipandcargo']=int(bv[232:240])
167 r['dimA']=int(bv[240:249])
168 r['dimB']=int(bv[249:258])
169 r['dimC']=int(bv[258:264])
170 r['dimD']=int(bv[264:270])
171 r['fixtype']=int(bv[270:274])
172 r['ETA']=int(bv[274:294])
173 r['draught']=Decimal(int(bv[294:302]))/Decimal('10')
174 r['destination']=aisstring.decode(bv[302:422])
175 r['dte']=int(bv[422:423])
176 r['Spare']=0
177 return r
178
180 return 5
181
184
187
189 return int(bv[38:40])
190
192 return int(bv[40:70])
193
196
199
201 return int(bv[232:240])
202
204 return int(bv[240:249])
205
207 return int(bv[249:258])
208
210 return int(bv[258:264])
211
213 return int(bv[264:270])
214
216 return int(bv[270:274])
217
219 return int(bv[274:294])
220
222 return Decimal(int(bv[294:302]))/Decimal('10')
223
226
228 return int(bv[422:423])
229
231 return 0
232
234 '''Print a shipdata message to stdout.
235
236 Fields in params:
237 - MessageID(uint): AIS message number. Must be 5 (field automatically set to "5")
238 - RepeatIndicator(uint): Indicated how many times a message has been repeated
239 - UserID(uint): Unique ship identification number (MMSI)
240 - AISversion(uint): Compliant with what edition. 0 is the first edition.
241 - IMOnumber(uint): vessel identification number (different than mmsi)
242 - callsign(aisstr6): Ship radio call sign
243 - name(aisstr6): Vessel name
244 - shipandcargo(uint): what
245 - dimA(uint): FIX: write a description
246 - dimB(uint): FIX: write a description
247 - dimC(uint): FIX: write a description
248 - dimD(uint): FIX: write a description
249 - fixtype(uint): Method used for positioning
250 - ETA(uint): FIX: break this out
251 - draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater
252 - destination(aisstr6): Where is the vessel going
253 - dte(uint): Data terminal ready
254 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
255 @param params: Dictionary of field names/values.
256 @param out: File like object to write to
257 @rtype: stdout
258 @return: text to out
259 '''
260
261 if 'std'==format:
262 out.write("shipdata:\n")
263 out.write(" MessageID: "+str(params['MessageID'])+"\n")
264 out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n")
265 out.write(" UserID: "+str(params['UserID'])+"\n")
266 out.write(" AISversion: "+str(params['AISversion'])+"\n")
267 out.write(" IMOnumber: "+str(params['IMOnumber'])+"\n")
268 out.write(" callsign: "+str(params['callsign'])+"\n")
269 out.write(" name: "+str(params['name'])+"\n")
270 out.write(" shipandcargo: "+str(params['shipandcargo'])+"\n")
271 out.write(" dimA: "+str(params['dimA'])+"\n")
272 out.write(" dimB: "+str(params['dimB'])+"\n")
273 out.write(" dimC: "+str(params['dimC'])+"\n")
274 out.write(" dimD: "+str(params['dimD'])+"\n")
275 out.write(" fixtype: "+str(params['fixtype'])+"\n")
276 out.write(" ETA: "+str(params['ETA'])+"\n")
277 out.write(" draught: "+str(params['draught'])+"\n")
278 out.write(" destination: "+str(params['destination'])+"\n")
279 out.write(" dte: "+str(params['dte'])+"\n")
280 out.write(" Spare: "+str(params['Spare'])+"\n")
281
282 return
283
284
285
286
287
288
289 import unittest
291 '''Return a params file base on the testvalue tags.
292 @rtype: dict
293 @return: params based on testvalue tags
294 '''
295 params = {}
296 params['MessageID'] = 5
297 params['RepeatIndicator'] = 1
298 params['UserID'] = 1193046
299 params['AISversion'] = 0
300 params['IMOnumber'] = 3210
301 params['callsign'] = 'PIRATE1'
302 params['name'] = 'BLACK PEARL@@@@@@@@@'
303 params['shipandcargo'] = 55
304 params['dimA'] = 10
305 params['dimB'] = 11
306 params['dimC'] = 12
307 params['dimD'] = 13
308 params['fixtype'] = 1
309 params['ETA'] = 0
310 params['draught'] = Decimal('21.1')
311 params['destination'] = 'NOWHERE@@@@@@@@@@@@@'
312 params['dte'] = 0
313 params['Spare'] = 0
314
315 return params
316
318 '''Use testvalue tag text from each type to build test case the shipdata message'''
320
321 params = testParams()
322 bits = encode(params)
323 r = decode(bits)
324
325
326 self.failUnlessEqual(r['MessageID'],params['MessageID'])
327 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator'])
328 self.failUnlessEqual(r['UserID'],params['UserID'])
329 self.failUnlessEqual(r['AISversion'],params['AISversion'])
330 self.failUnlessEqual(r['IMOnumber'],params['IMOnumber'])
331 self.failUnlessEqual(r['callsign'],params['callsign'])
332 self.failUnlessEqual(r['name'],params['name'])
333 self.failUnlessEqual(r['shipandcargo'],params['shipandcargo'])
334 self.failUnlessEqual(r['dimA'],params['dimA'])
335 self.failUnlessEqual(r['dimB'],params['dimB'])
336 self.failUnlessEqual(r['dimC'],params['dimC'])
337 self.failUnlessEqual(r['dimD'],params['dimD'])
338 self.failUnlessEqual(r['fixtype'],params['fixtype'])
339 self.failUnlessEqual(r['ETA'],params['ETA'])
340 self.failUnlessAlmostEqual(r['draught'],params['draught'],7)
341 self.failUnlessEqual(r['destination'],params['destination'])
342 self.failUnlessEqual(r['dte'],params['dte'])
343 self.failUnlessEqual(r['Spare'],params['Spare'])
344
345
346 if __name__=='__main__':
347
348 from optparse import OptionParser
349 myparser = OptionParser(usage="%prog [options]",
350 version="%prog "+__version__)
351
352
353 myparser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
354 help='run the documentation tests')
355 myparser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
356 help='run the unit tests')
357 myparser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
358 help='Make the test output verbose')
359
360
361 myparser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
362 help='decode a "shipdata" AIS message')
363 myparser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
364 help='encode a "shipdata" AIS message')
365
366
367
368
369 typeChoices = ('binary','nmeapayload','nmea')
370 myparser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
371 ,default='nmeapayload'
372 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]')
373
374 myparser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0
375 ,help='Field parameter value [default: %default]'
376 ,metavar='uint'
377 ,type='int'
378 )
379 myparser.add_option('--UserID-field', dest='UserIDField'
380 ,help='Field parameter value [default: %default]'
381 ,metavar='uint'
382 ,type='int'
383 )
384 myparser.add_option('--AISversion-field', dest='AISversionField',default=0
385 ,help='Field parameter value [default: %default]'
386 ,metavar='uint'
387 ,type='int'
388 )
389 myparser.add_option('--IMOnumber-field', dest='IMOnumberField',default=0
390 ,help='Field parameter value [default: %default]'
391 ,metavar='uint'
392 ,type='int'
393 )
394 myparser.add_option('--callsign-field', dest='callsignField',default='@@@@@@@'
395 ,help='Field parameter value [default: %default]'
396 ,metavar='aisstr6'
397 ,type='string'
398 )
399 myparser.add_option('--name-field', dest='nameField',default='@@@@@@@@@@@@@@@@@@@@'
400 ,help='Field parameter value [default: %default]'
401 ,metavar='aisstr6'
402 ,type='string'
403 )
404 myparser.add_option('--shipandcargo-field', dest='shipandcargoField',default=0
405 ,help='Field parameter value [default: %default]'
406 ,metavar='uint'
407 ,type='int'
408 )
409 myparser.add_option('--dimA-field', dest='dimAField'
410 ,help='Field parameter value [default: %default]'
411 ,metavar='uint'
412 ,type='int'
413 )
414 myparser.add_option('--dimB-field', dest='dimBField'
415 ,help='Field parameter value [default: %default]'
416 ,metavar='uint'
417 ,type='int'
418 )
419 myparser.add_option('--dimC-field', dest='dimCField'
420 ,help='Field parameter value [default: %default]'
421 ,metavar='uint'
422 ,type='int'
423 )
424 myparser.add_option('--dimD-field', dest='dimDField'
425 ,help='Field parameter value [default: %default]'
426 ,metavar='uint'
427 ,type='int'
428 )
429 myparser.add_option('--fixtype-field', dest='fixtypeField',default=0
430 ,help='Field parameter value [default: %default]'
431 ,metavar='uint'
432 ,type='int'
433 )
434 myparser.add_option('--ETA-field', dest='ETAField'
435 ,help='Field parameter value [default: %default]'
436 ,metavar='uint'
437 ,type='int'
438 )
439 myparser.add_option('--draught-field', dest='draughtField',default=Decimal('0')
440 ,help='Field parameter value [default: %default]'
441 ,metavar='udecimal'
442 ,type='string'
443 )
444 myparser.add_option('--destination-field', dest='destinationField',default='@@@@@@@@@@@@@@@@@@@@'
445 ,help='Field parameter value [default: %default]'
446 ,metavar='aisstr6'
447 ,type='string'
448 )
449 myparser.add_option('--dte-field', dest='dteField'
450 ,help='Field parameter value [default: %default]'
451 ,metavar='uint'
452 ,type='int'
453 )
454
455 (options,args) = myparser.parse_args()
456 success=True
457
458 if options.doctest:
459 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
460 sys.argv= [sys.argv[0]]
461 if options.verbose: sys.argv.append('-v')
462 import doctest
463 numfail,numtests=doctest.testmod()
464 if numfail==0: print 'ok'
465 else:
466 print 'FAILED'
467 success=False
468
469 if not success:
470 sys.exit('Something Failed')
471
472 del success
473
474 if options.unittest:
475 sys.argv = [sys.argv[0]]
476 if options.verbose: sys.argv.append('-v')
477 unittest.main()
478
479 if options.doEncode:
480
481 if None==options.RepeatIndicatorField: myparser.error("missing value for RepeatIndicatorField")
482 if None==options.UserIDField: myparser.error("missing value for UserIDField")
483 if None==options.AISversionField: myparser.error("missing value for AISversionField")
484 if None==options.IMOnumberField: myparser.error("missing value for IMOnumberField")
485 if None==options.callsignField: myparser.error("missing value for callsignField")
486 if None==options.nameField: myparser.error("missing value for nameField")
487 if None==options.shipandcargoField: myparser.error("missing value for shipandcargoField")
488 if None==options.dimAField: myparser.error("missing value for dimAField")
489 if None==options.dimBField: myparser.error("missing value for dimBField")
490 if None==options.dimCField: myparser.error("missing value for dimCField")
491 if None==options.dimDField: myparser.error("missing value for dimDField")
492 if None==options.fixtypeField: myparser.error("missing value for fixtypeField")
493 if None==options.ETAField: myparser.error("missing value for ETAField")
494 if None==options.draughtField: myparser.error("missing value for draughtField")
495 if None==options.destinationField: myparser.error("missing value for destinationField")
496 if None==options.dteField: myparser.error("missing value for dteField")
497 msgDict={
498 'MessageID': '5',
499 'RepeatIndicator': options.RepeatIndicatorField,
500 'UserID': options.UserIDField,
501 'AISversion': options.AISversionField,
502 'IMOnumber': options.IMOnumberField,
503 'callsign': options.callsignField,
504 'name': options.nameField,
505 'shipandcargo': options.shipandcargoField,
506 'dimA': options.dimAField,
507 'dimB': options.dimBField,
508 'dimC': options.dimCField,
509 'dimD': options.dimDField,
510 'fixtype': options.fixtypeField,
511 'ETA': options.ETAField,
512 'draught': options.draughtField,
513 'destination': options.destinationField,
514 'dte': options.dteField,
515 'Spare': '0',
516 }
517 bits = encode(msgDict)
518 if 'binary'==options.ioType: print str(bits)
519 elif 'nmeapayload'==options.ioType:
520 print "bitLen",len(bits)
521 bitLen=len(bits)
522 if bitLen%6!=0:
523 bits = bits + BitVector(size=(6 - (bitLen%6)))
524 print "result:",binary.bitvectoais6(bits)[0]
525 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
526 else: sys.exit('ERROR: unknown ioType. Help!')
527
528 if options.doDecode:
529 for msg in args:
530 if 'binary'==options.ioType:
531 bv = BitVector(bitstring=msg)
532 printFields(decode(bv))
533 elif 'nmeapayload'==options.ioType:
534 bv = binary.ais6tobitvec(msg)
535 printFields(decode(bv))
536 elif 'nmea'==options.ioType:
537 bv = binary.ais6tobitvec(msg.split(',')[5])
538 printFields(decode(bv))
539 else: sys.exit('ERROR: unknown ioType. Help!')
540