1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-01-04 $'.split()[1]
5 __author__ = 'xmlbinmsg'
6
7 __doc__='''
8
9 Autogenerated python functions to serialize/deserialize binary messages.
10
11 Generated by: ./aisxmlbinmsg2py.py
12
13 Need to then wrap these functions with the outer AIS packet and then
14 convert the whole binary blob to a NMEA string. Those functions are
15 not currently provided in this file.
16
17 serialize: python to ais binary
18 deserialize: ais binary to python
19
20 The generated code uses translators.py, binary.py, and aisstring.py
21 which should be packaged with the resulting files.
22
23
24 @requires: U{epydoc<http://epydoc.sourceforge.net/>} > 3.0alpha3
25 @requires: U{BitVector<http://cheeseshop.python.org/pypi/BitVector>}
26
27 @author: '''+__author__+'''
28 @version: ''' + __version__ +'''
29 @var __date__: Date of last svn commit
30 @undocumented: __version__ __author__ __doc__ parser
31 @status: under development
32 @license: Generated code has no license
33 '''
34
35 import sys
36 from decimal import Decimal
37 from BitVector import BitVector
38
39 import binary, aisstring
40
41
42 TrueBV = BitVector(bitstring="1")
43 "Why always rebuild the True bit? This should speed things up a bunch"
44 FalseBV = BitVector(bitstring="0")
45 "Why always rebuild the False bit? This should speed things up a bunch"
46
47
48 -def encode(params, validate=False):
49 '''Create a 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 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n")
264 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n")
265 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n")
266 if 'AISversion' in params: out.write(" AISversion: "+str(params['AISversion'])+"\n")
267 if 'IMOnumber' in params: out.write(" IMOnumber: "+str(params['IMOnumber'])+"\n")
268 if 'callsign' in params: out.write(" callsign: "+str(params['callsign'])+"\n")
269 if 'name' in params: out.write(" name: "+str(params['name'])+"\n")
270 if 'shipandcargo' in params: out.write(" shipandcargo: "+str(params['shipandcargo'])+"\n")
271 if 'dimA' in params: out.write(" dimA: "+str(params['dimA'])+"\n")
272 if 'dimB' in params: out.write(" dimB: "+str(params['dimB'])+"\n")
273 if 'dimC' in params: out.write(" dimC: "+str(params['dimC'])+"\n")
274 if 'dimD' in params: out.write(" dimD: "+str(params['dimD'])+"\n")
275 if 'fixtype' in params: out.write(" fixtype: "+str(params['fixtype'])+"\n")
276 if 'ETA' in params: out.write(" ETA: "+str(params['ETA'])+"\n")
277 if 'draught' in params: out.write(" draught: "+str(params['draught'])+"\n")
278 if 'destination' in params: out.write(" destination: "+str(params['destination'])+"\n")
279 if 'dte' in params: out.write(" dte: "+str(params['dte'])+"\n")
280 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n")
281 elif 'html'==format:
282 out.write("<h3>Spare<h3>\n")
283 out.write("<table border=\"1\">\n")
284 out.write("<tr bgcolor=\"orange\">\n")
285 out.write("<th align=\"left\">Field Name</th>\n")
286 out.write("<th align=\"left\">Type</th>\n")
287 out.write("<th align=\"left\">Value</th>\n")
288 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
289 out.write("\n")
290 out.write("<tr>\n")
291 out.write("<td>MessageID</td>\n")
292 out.write("<td>uint</td>\n")
293 if 'MessageID' in params:
294 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
295 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
296 out.write("</tr>\n")
297 out.write("\n")
298 out.write("<tr>\n")
299 out.write("<td>RepeatIndicator</td>\n")
300 out.write("<td>uint</td>\n")
301 if 'RepeatIndicator' in params:
302 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n")
303 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut:
304 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>")
305 else:
306 out.write("<td><i>Missing LUT entry</i></td>")
307 out.write("</tr>\n")
308 out.write("\n")
309 out.write("<tr>\n")
310 out.write("<td>UserID</td>\n")
311 out.write("<td>uint</td>\n")
312 if 'UserID' in params:
313 out.write(" <td>"+str(params['UserID'])+"</td>\n")
314 out.write(" <td>"+str(params['UserID'])+"</td>\n")
315 out.write("</tr>\n")
316 out.write("\n")
317 out.write("<tr>\n")
318 out.write("<td>AISversion</td>\n")
319 out.write("<td>uint</td>\n")
320 if 'AISversion' in params:
321 out.write(" <td>"+str(params['AISversion'])+"</td>\n")
322 out.write(" <td>"+str(params['AISversion'])+"</td>\n")
323 out.write("</tr>\n")
324 out.write("\n")
325 out.write("<tr>\n")
326 out.write("<td>IMOnumber</td>\n")
327 out.write("<td>uint</td>\n")
328 if 'IMOnumber' in params:
329 out.write(" <td>"+str(params['IMOnumber'])+"</td>\n")
330 out.write(" <td>"+str(params['IMOnumber'])+"</td>\n")
331 out.write("</tr>\n")
332 out.write("\n")
333 out.write("<tr>\n")
334 out.write("<td>callsign</td>\n")
335 out.write("<td>aisstr6</td>\n")
336 if 'callsign' in params:
337 out.write(" <td>"+str(params['callsign'])+"</td>\n")
338 out.write(" <td>"+str(params['callsign'])+"</td>\n")
339 out.write("</tr>\n")
340 out.write("\n")
341 out.write("<tr>\n")
342 out.write("<td>name</td>\n")
343 out.write("<td>aisstr6</td>\n")
344 if 'name' in params:
345 out.write(" <td>"+str(params['name'])+"</td>\n")
346 out.write(" <td>"+str(params['name'])+"</td>\n")
347 out.write("</tr>\n")
348 out.write("\n")
349 out.write("<tr>\n")
350 out.write("<td>shipandcargo</td>\n")
351 out.write("<td>uint</td>\n")
352 if 'shipandcargo' in params:
353 out.write(" <td>"+str(params['shipandcargo'])+"</td>\n")
354 out.write(" <td>"+str(params['shipandcargo'])+"</td>\n")
355 out.write("</tr>\n")
356 out.write("\n")
357 out.write("<tr>\n")
358 out.write("<td>dimA</td>\n")
359 out.write("<td>uint</td>\n")
360 if 'dimA' in params:
361 out.write(" <td>"+str(params['dimA'])+"</td>\n")
362 out.write(" <td>"+str(params['dimA'])+"</td>\n")
363 out.write("</tr>\n")
364 out.write("\n")
365 out.write("<tr>\n")
366 out.write("<td>dimB</td>\n")
367 out.write("<td>uint</td>\n")
368 if 'dimB' in params:
369 out.write(" <td>"+str(params['dimB'])+"</td>\n")
370 out.write(" <td>"+str(params['dimB'])+"</td>\n")
371 out.write("</tr>\n")
372 out.write("\n")
373 out.write("<tr>\n")
374 out.write("<td>dimC</td>\n")
375 out.write("<td>uint</td>\n")
376 if 'dimC' in params:
377 out.write(" <td>"+str(params['dimC'])+"</td>\n")
378 out.write(" <td>"+str(params['dimC'])+"</td>\n")
379 out.write("</tr>\n")
380 out.write("\n")
381 out.write("<tr>\n")
382 out.write("<td>dimD</td>\n")
383 out.write("<td>uint</td>\n")
384 if 'dimD' in params:
385 out.write(" <td>"+str(params['dimD'])+"</td>\n")
386 out.write(" <td>"+str(params['dimD'])+"</td>\n")
387 out.write("</tr>\n")
388 out.write("\n")
389 out.write("<tr>\n")
390 out.write("<td>fixtype</td>\n")
391 out.write("<td>uint</td>\n")
392 if 'fixtype' in params:
393 out.write(" <td>"+str(params['fixtype'])+"</td>\n")
394 if str(params['fixtype']) in fixtypeDecodeLut:
395 out.write("<td>"+fixtypeDecodeLut[str(params['fixtype'])]+"</td>")
396 else:
397 out.write("<td><i>Missing LUT entry</i></td>")
398 out.write("</tr>\n")
399 out.write("\n")
400 out.write("<tr>\n")
401 out.write("<td>ETA</td>\n")
402 out.write("<td>uint</td>\n")
403 if 'ETA' in params:
404 out.write(" <td>"+str(params['ETA'])+"</td>\n")
405 out.write(" <td>"+str(params['ETA'])+"</td>\n")
406 out.write("</tr>\n")
407 out.write("\n")
408 out.write("<tr>\n")
409 out.write("<td>draught</td>\n")
410 out.write("<td>udecimal</td>\n")
411 if 'draught' in params:
412 out.write(" <td>"+str(params['draught'])+"</td>\n")
413 out.write(" <td>"+str(params['draught'])+"</td>\n")
414 out.write("</tr>\n")
415 out.write("\n")
416 out.write("<tr>\n")
417 out.write("<td>destination</td>\n")
418 out.write("<td>aisstr6</td>\n")
419 if 'destination' in params:
420 out.write(" <td>"+str(params['destination'])+"</td>\n")
421 out.write(" <td>"+str(params['destination'])+"</td>\n")
422 out.write("</tr>\n")
423 out.write("\n")
424 out.write("<tr>\n")
425 out.write("<td>dte</td>\n")
426 out.write("<td>uint</td>\n")
427 if 'dte' in params:
428 out.write(" <td>"+str(params['dte'])+"</td>\n")
429 if str(params['dte']) in dteDecodeLut:
430 out.write("<td>"+dteDecodeLut[str(params['dte'])]+"</td>")
431 else:
432 out.write("<td><i>Missing LUT entry</i></td>")
433 out.write("</tr>\n")
434 out.write("\n")
435 out.write("<tr>\n")
436 out.write("<td>Spare</td>\n")
437 out.write("<td>uint</td>\n")
438 if 'Spare' in params:
439 out.write(" <td>"+str(params['Spare'])+"</td>\n")
440 out.write(" <td>"+str(params['Spare'])+"</td>\n")
441 out.write("</tr>\n")
442 out.write("</table>\n")
443 else:
444 print "ERROR: unknown format:",format
445 assert False
446
447 return
448
449 RepeatIndicatorEncodeLut = {
450 'default':'0',
451 'do not repeat any more':'3',
452 }
453
454 RepeatIndicatorDecodeLut = {
455 '0':'default',
456 '3':'do not repeat any more',
457 }
458
459 fixtypeEncodeLut = {
460 'undefined':'0',
461 'GPS':'1',
462 'GLONASS':'2',
463 'combined GPS/GLONASS':'3',
464 'Loran-C':'4',
465 'Chayka':'5',
466 'integrated navigation system':'6',
467 'surveyed':'7',
468 }
469
470 fixtypeDecodeLut = {
471 '0':'undefined',
472 '1':'GPS',
473 '2':'GLONASS',
474 '3':'combined GPS/GLONASS',
475 '4':'Loran-C',
476 '5':'Chayka',
477 '6':'integrated navigation system',
478 '7':'surveyed',
479 }
480
481 dteEncodeLut = {
482 'available':'0',
483 'not available':'1',
484 }
485
486 dteDecodeLut = {
487 '0':'available',
488 '1':'not available',
489 }
490
491
492
493
494
495
496 import unittest
498 '''Return a params file base on the testvalue tags.
499 @rtype: dict
500 @return: params based on testvalue tags
501 '''
502 params = {}
503 params['MessageID'] = 5
504 params['RepeatIndicator'] = 1
505 params['UserID'] = 1193046
506 params['AISversion'] = 0
507 params['IMOnumber'] = 3210
508 params['callsign'] = 'PIRATE1'
509 params['name'] = 'BLACK PEARL@@@@@@@@@'
510 params['shipandcargo'] = 55
511 params['dimA'] = 10
512 params['dimB'] = 11
513 params['dimC'] = 12
514 params['dimD'] = 13
515 params['fixtype'] = 1
516 params['ETA'] = 0
517 params['draught'] = Decimal('21.1')
518 params['destination'] = 'NOWHERE@@@@@@@@@@@@@'
519 params['dte'] = 0
520 params['Spare'] = 0
521
522 return params
523
525 '''Use testvalue tag text from each type to build test case the shipdata message'''
527
528 params = testParams()
529 bits = encode(params)
530 r = decode(bits)
531
532
533 self.failUnlessEqual(r['MessageID'],params['MessageID'])
534 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator'])
535 self.failUnlessEqual(r['UserID'],params['UserID'])
536 self.failUnlessEqual(r['AISversion'],params['AISversion'])
537 self.failUnlessEqual(r['IMOnumber'],params['IMOnumber'])
538 self.failUnlessEqual(r['callsign'],params['callsign'])
539 self.failUnlessEqual(r['name'],params['name'])
540 self.failUnlessEqual(r['shipandcargo'],params['shipandcargo'])
541 self.failUnlessEqual(r['dimA'],params['dimA'])
542 self.failUnlessEqual(r['dimB'],params['dimB'])
543 self.failUnlessEqual(r['dimC'],params['dimC'])
544 self.failUnlessEqual(r['dimD'],params['dimD'])
545 self.failUnlessEqual(r['fixtype'],params['fixtype'])
546 self.failUnlessEqual(r['ETA'],params['ETA'])
547 self.failUnlessAlmostEqual(r['draught'],params['draught'],3)
548 self.failUnlessEqual(r['destination'],params['destination'])
549 self.failUnlessEqual(r['dte'],params['dte'])
550 self.failUnlessEqual(r['Spare'],params['Spare'])
551
553 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
554 help='decode a "shipdata" AIS message')
555 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
556 help='encode a "shipdata" AIS message')
557 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int'
558 ,help='Field parameter value [default: %default]')
559 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int'
560 ,help='Field parameter value [default: %default]')
561 parser.add_option('--AISversion-field', dest='AISversionField',default=0,metavar='uint',type='int'
562 ,help='Field parameter value [default: %default]')
563 parser.add_option('--IMOnumber-field', dest='IMOnumberField',default=0,metavar='uint',type='int'
564 ,help='Field parameter value [default: %default]')
565 parser.add_option('--callsign-field', dest='callsignField',default='@@@@@@@',metavar='aisstr6',type='string'
566 ,help='Field parameter value [default: %default]')
567 parser.add_option('--name-field', dest='nameField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string'
568 ,help='Field parameter value [default: %default]')
569 parser.add_option('--shipandcargo-field', dest='shipandcargoField',default=0,metavar='uint',type='int'
570 ,help='Field parameter value [default: %default]')
571 parser.add_option('--dimA-field', dest='dimAField',metavar='uint',type='int'
572 ,help='Field parameter value [default: %default]')
573 parser.add_option('--dimB-field', dest='dimBField',metavar='uint',type='int'
574 ,help='Field parameter value [default: %default]')
575 parser.add_option('--dimC-field', dest='dimCField',metavar='uint',type='int'
576 ,help='Field parameter value [default: %default]')
577 parser.add_option('--dimD-field', dest='dimDField',metavar='uint',type='int'
578 ,help='Field parameter value [default: %default]')
579 parser.add_option('--fixtype-field', dest='fixtypeField',default=0,metavar='uint',type='int'
580 ,help='Field parameter value [default: %default]')
581 parser.add_option('--ETA-field', dest='ETAField',metavar='uint',type='int'
582 ,help='Field parameter value [default: %default]')
583 parser.add_option('--draught-field', dest='draughtField',default=Decimal('0'),metavar='udecimal',type='string'
584 ,help='Field parameter value [default: %default]')
585 parser.add_option('--destination-field', dest='destinationField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string'
586 ,help='Field parameter value [default: %default]')
587 parser.add_option('--dte-field', dest='dteField',metavar='uint',type='int'
588 ,help='Field parameter value [default: %default]')
589
590
591 if __name__=='__main__':
592
593 from optparse import OptionParser
594 parser = OptionParser(usage="%prog [options]",
595 version="%prog "+__version__)
596
597 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
598 help='run the documentation tests')
599 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
600 help='run the unit tests')
601 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
602 help='Make the test output verbose')
603
604
605
606 typeChoices = ('binary','nmeapayload','nmea')
607 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
608 ,default='nmeapayload'
609 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]')
610
611 outputChoices = ('std','html','xml')
612 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
613 ,default='std'
614 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
615
616 parser.add_option('-o','--output',dest='outputFileName',default=None,
617 help='Name of the python file to write [default: stdout]')
618
619 addMsgOptions(parser)
620
621 (options,args) = parser.parse_args()
622 success=True
623
624 if options.doctest:
625 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
626 sys.argv= [sys.argv[0]]
627 if options.verbose: sys.argv.append('-v')
628 import doctest
629 numfail,numtests=doctest.testmod()
630 if numfail==0: print 'ok'
631 else:
632 print 'FAILED'
633 success=False
634
635 if not success: sys.exit('Something Failed')
636 del success
637
638 if options.unittest:
639 sys.argv = [sys.argv[0]]
640 if options.verbose: sys.argv.append('-v')
641 unittest.main()
642
643 outfile = sys.stdout
644 if None!=options.outputFileName:
645 outfile = file(options.outputFileName,'w')
646
647
648 if options.doEncode:
649
650 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField")
651 if None==options.UserIDField: parser.error("missing value for UserIDField")
652 if None==options.AISversionField: parser.error("missing value for AISversionField")
653 if None==options.IMOnumberField: parser.error("missing value for IMOnumberField")
654 if None==options.callsignField: parser.error("missing value for callsignField")
655 if None==options.nameField: parser.error("missing value for nameField")
656 if None==options.shipandcargoField: parser.error("missing value for shipandcargoField")
657 if None==options.dimAField: parser.error("missing value for dimAField")
658 if None==options.dimBField: parser.error("missing value for dimBField")
659 if None==options.dimCField: parser.error("missing value for dimCField")
660 if None==options.dimDField: parser.error("missing value for dimDField")
661 if None==options.fixtypeField: parser.error("missing value for fixtypeField")
662 if None==options.ETAField: parser.error("missing value for ETAField")
663 if None==options.draughtField: parser.error("missing value for draughtField")
664 if None==options.destinationField: parser.error("missing value for destinationField")
665 if None==options.dteField: parser.error("missing value for dteField")
666 msgDict={
667 'MessageID': '5',
668 'RepeatIndicator': options.RepeatIndicatorField,
669 'UserID': options.UserIDField,
670 'AISversion': options.AISversionField,
671 'IMOnumber': options.IMOnumberField,
672 'callsign': options.callsignField,
673 'name': options.nameField,
674 'shipandcargo': options.shipandcargoField,
675 'dimA': options.dimAField,
676 'dimB': options.dimBField,
677 'dimC': options.dimCField,
678 'dimD': options.dimDField,
679 'fixtype': options.fixtypeField,
680 'ETA': options.ETAField,
681 'draught': options.draughtField,
682 'destination': options.destinationField,
683 'dte': options.dteField,
684 'Spare': '0',
685 }
686
687 bits = encode(msgDict)
688 if 'binary'==options.ioType: print str(bits)
689 elif 'nmeapayload'==options.ioType:
690
691 print "bitLen",len(bits)
692 bitLen=len(bits)
693 if bitLen%6!=0:
694 bits = bits + BitVector(size=(6 - (bitLen%6)))
695 print "result:",binary.bitvectoais6(bits)[0]
696
697
698
699 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
700 else: sys.exit('ERROR: unknown ioType. Help!')
701
702 if options.doDecode:
703 for msg in args:
704 bv = None
705 if 'binary' == options.ioType: bv = BitVector(bitstring=msg)
706 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg)
707 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5])
708 else: sys.exit('ERROR: unknown ioType. Help!')
709
710 printFields(decode(bv),out=outfile,format=options.outputType)
711