Package ais :: Module ais_msg_5
[hide private]
[frames] | no frames]

Source Code for Module ais.ais_msg_5

  1  #!/usr/bin/env python 
  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  # FIX: check to see if these will be needed 
 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 #Would be nice to check the bit count here.. 156 #if validate: 157 # assert (len(bv)==FIX: SOME NUMBER) 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
179 -def decodeMessageID(bv, validate=False):
180 return 5
181
182 -def decodeRepeatIndicator(bv, validate=False):
183 return int(bv[6:8])
184
185 -def decodeUserID(bv, validate=False):
186 return int(bv[8:38])
187
188 -def decodeAISversion(bv, validate=False):
189 return int(bv[38:40])
190
191 -def decodeIMOnumber(bv, validate=False):
192 return int(bv[40:70])
193
194 -def decodecallsign(bv, validate=False):
195 return aisstring.decode(bv[70:112])
196
197 -def decodename(bv, validate=False):
198 return aisstring.decode(bv[112:232])
199
200 -def decodeshipandcargo(bv, validate=False):
201 return int(bv[232:240])
202
203 -def decodedimA(bv, validate=False):
204 return int(bv[240:249])
205
206 -def decodedimB(bv, validate=False):
207 return int(bv[249:258])
208
209 -def decodedimC(bv, validate=False):
210 return int(bv[258:264])
211
212 -def decodedimD(bv, validate=False):
213 return int(bv[264:270])
214
215 -def decodefixtype(bv, validate=False):
216 return int(bv[270:274])
217
218 -def decodeETA(bv, validate=False):
219 return int(bv[274:294])
220
221 -def decodedraught(bv, validate=False):
222 return Decimal(int(bv[294:302]))/Decimal('10')
223
224 -def decodedestination(bv, validate=False):
225 return aisstring.decode(bv[302:422])
226
227 -def decodedte(bv, validate=False):
228 return int(bv[422:423])
229
230 -def decodeSpare(bv, validate=False):
231 return 0
232 233
234 -def printHtml(params, out=sys.stdout):
235 out.write("<h3>shipdata<h3>\n") 236 out.write("<table border=\"1\">\n") 237 out.write("<tr bgcolor=\"orange\">\n") 238 out.write("<th align=\"left\">Field Name</th>\n") 239 out.write("<th align=\"left\">Type</th>\n") 240 out.write("<th align=\"left\">Value</th>\n") 241 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 242 out.write("<th align=\"left\">Units</th>\n") 243 out.write("\n") 244 out.write("<tr>\n") 245 out.write("<td>MessageID</td>\n") 246 out.write("<td>uint</td>\n") 247 if 'MessageID' in params: 248 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 249 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 250 out.write("</tr>\n") 251 out.write("\n") 252 out.write("<tr>\n") 253 out.write("<td>RepeatIndicator</td>\n") 254 out.write("<td>uint</td>\n") 255 if 'RepeatIndicator' in params: 256 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n") 257 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut: 258 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>") 259 else: 260 out.write("<td><i>Missing LUT entry</i></td>") 261 out.write("</tr>\n") 262 out.write("\n") 263 out.write("<tr>\n") 264 out.write("<td>UserID</td>\n") 265 out.write("<td>uint</td>\n") 266 if 'UserID' in params: 267 out.write(" <td>"+str(params['UserID'])+"</td>\n") 268 out.write(" <td>"+str(params['UserID'])+"</td>\n") 269 out.write("</tr>\n") 270 out.write("\n") 271 out.write("<tr>\n") 272 out.write("<td>AISversion</td>\n") 273 out.write("<td>uint</td>\n") 274 if 'AISversion' in params: 275 out.write(" <td>"+str(params['AISversion'])+"</td>\n") 276 out.write(" <td>"+str(params['AISversion'])+"</td>\n") 277 out.write("</tr>\n") 278 out.write("\n") 279 out.write("<tr>\n") 280 out.write("<td>IMOnumber</td>\n") 281 out.write("<td>uint</td>\n") 282 if 'IMOnumber' in params: 283 out.write(" <td>"+str(params['IMOnumber'])+"</td>\n") 284 out.write(" <td>"+str(params['IMOnumber'])+"</td>\n") 285 out.write("</tr>\n") 286 out.write("\n") 287 out.write("<tr>\n") 288 out.write("<td>callsign</td>\n") 289 out.write("<td>aisstr6</td>\n") 290 if 'callsign' in params: 291 out.write(" <td>"+str(params['callsign'])+"</td>\n") 292 out.write(" <td>"+str(params['callsign'])+"</td>\n") 293 out.write("</tr>\n") 294 out.write("\n") 295 out.write("<tr>\n") 296 out.write("<td>name</td>\n") 297 out.write("<td>aisstr6</td>\n") 298 if 'name' in params: 299 out.write(" <td>"+str(params['name'])+"</td>\n") 300 out.write(" <td>"+str(params['name'])+"</td>\n") 301 out.write("</tr>\n") 302 out.write("\n") 303 out.write("<tr>\n") 304 out.write("<td>shipandcargo</td>\n") 305 out.write("<td>uint</td>\n") 306 if 'shipandcargo' in params: 307 out.write(" <td>"+str(params['shipandcargo'])+"</td>\n") 308 out.write(" <td>"+str(params['shipandcargo'])+"</td>\n") 309 out.write("</tr>\n") 310 out.write("\n") 311 out.write("<tr>\n") 312 out.write("<td>dimA</td>\n") 313 out.write("<td>uint</td>\n") 314 if 'dimA' in params: 315 out.write(" <td>"+str(params['dimA'])+"</td>\n") 316 out.write(" <td>"+str(params['dimA'])+"</td>\n") 317 out.write("<td>m</td>\n") 318 out.write("</tr>\n") 319 out.write("\n") 320 out.write("<tr>\n") 321 out.write("<td>dimB</td>\n") 322 out.write("<td>uint</td>\n") 323 if 'dimB' in params: 324 out.write(" <td>"+str(params['dimB'])+"</td>\n") 325 out.write(" <td>"+str(params['dimB'])+"</td>\n") 326 out.write("<td>m</td>\n") 327 out.write("</tr>\n") 328 out.write("\n") 329 out.write("<tr>\n") 330 out.write("<td>dimC</td>\n") 331 out.write("<td>uint</td>\n") 332 if 'dimC' in params: 333 out.write(" <td>"+str(params['dimC'])+"</td>\n") 334 out.write(" <td>"+str(params['dimC'])+"</td>\n") 335 out.write("<td>m</td>\n") 336 out.write("</tr>\n") 337 out.write("\n") 338 out.write("<tr>\n") 339 out.write("<td>dimD</td>\n") 340 out.write("<td>uint</td>\n") 341 if 'dimD' in params: 342 out.write(" <td>"+str(params['dimD'])+"</td>\n") 343 out.write(" <td>"+str(params['dimD'])+"</td>\n") 344 out.write("<td>m</td>\n") 345 out.write("</tr>\n") 346 out.write("\n") 347 out.write("<tr>\n") 348 out.write("<td>fixtype</td>\n") 349 out.write("<td>uint</td>\n") 350 if 'fixtype' in params: 351 out.write(" <td>"+str(params['fixtype'])+"</td>\n") 352 if str(params['fixtype']) in fixtypeDecodeLut: 353 out.write("<td>"+fixtypeDecodeLut[str(params['fixtype'])]+"</td>") 354 else: 355 out.write("<td><i>Missing LUT entry</i></td>") 356 out.write("</tr>\n") 357 out.write("\n") 358 out.write("<tr>\n") 359 out.write("<td>ETA</td>\n") 360 out.write("<td>uint</td>\n") 361 if 'ETA' in params: 362 out.write(" <td>"+str(params['ETA'])+"</td>\n") 363 out.write(" <td>"+str(params['ETA'])+"</td>\n") 364 out.write("</tr>\n") 365 out.write("\n") 366 out.write("<tr>\n") 367 out.write("<td>draught</td>\n") 368 out.write("<td>udecimal</td>\n") 369 if 'draught' in params: 370 out.write(" <td>"+str(params['draught'])+"</td>\n") 371 out.write(" <td>"+str(params['draught'])+"</td>\n") 372 out.write("<td>m</td>\n") 373 out.write("</tr>\n") 374 out.write("\n") 375 out.write("<tr>\n") 376 out.write("<td>destination</td>\n") 377 out.write("<td>aisstr6</td>\n") 378 if 'destination' in params: 379 out.write(" <td>"+str(params['destination'])+"</td>\n") 380 out.write(" <td>"+str(params['destination'])+"</td>\n") 381 out.write("</tr>\n") 382 out.write("\n") 383 out.write("<tr>\n") 384 out.write("<td>dte</td>\n") 385 out.write("<td>uint</td>\n") 386 if 'dte' in params: 387 out.write(" <td>"+str(params['dte'])+"</td>\n") 388 if str(params['dte']) in dteDecodeLut: 389 out.write("<td>"+dteDecodeLut[str(params['dte'])]+"</td>") 390 else: 391 out.write("<td><i>Missing LUT entry</i></td>") 392 out.write("</tr>\n") 393 out.write("\n") 394 out.write("<tr>\n") 395 out.write("<td>Spare</td>\n") 396 out.write("<td>uint</td>\n") 397 if 'Spare' in params: 398 out.write(" <td>"+str(params['Spare'])+"</td>\n") 399 out.write(" <td>"+str(params['Spare'])+"</td>\n") 400 out.write("</tr>\n") 401 out.write("</table>\n")
402 -def printFields(params, out=sys.stdout, format='std'):
403 '''Print a Spare message to stdout. 404 405 Fields in params: 406 - MessageID(uint): AIS message number. Must be 5 (field automatically set to "5") 407 - RepeatIndicator(uint): Indicated how many times a message has been repeated 408 - UserID(uint): Unique ship identification number (MMSI) 409 - AISversion(uint): Compliant with what edition. 0 is the first edition. 410 - IMOnumber(uint): vessel identification number (different than mmsi) 411 - callsign(aisstr6): Ship radio call sign 412 - name(aisstr6): Vessel name 413 - shipandcargo(uint): what 414 - dimA(uint): FIX: write a description 415 - dimB(uint): FIX: write a description 416 - dimC(uint): FIX: write a description 417 - dimD(uint): FIX: write a description 418 - fixtype(uint): Method used for positioning 419 - ETA(uint): FIX: break this out 420 - draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater 421 - destination(aisstr6): Where is the vessel going 422 - dte(uint): Data terminal ready 423 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0") 424 @param params: Dictionary of field names/values. 425 @param out: File like object to write to 426 @rtype: stdout 427 @return: text to out 428 ''' 429 430 if 'std'==format: 431 out.write("Spare:\n") 432 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n") 433 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n") 434 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n") 435 if 'AISversion' in params: out.write(" AISversion: "+str(params['AISversion'])+"\n") 436 if 'IMOnumber' in params: out.write(" IMOnumber: "+str(params['IMOnumber'])+"\n") 437 if 'callsign' in params: out.write(" callsign: "+str(params['callsign'])+"\n") 438 if 'name' in params: out.write(" name: "+str(params['name'])+"\n") 439 if 'shipandcargo' in params: out.write(" shipandcargo: "+str(params['shipandcargo'])+"\n") 440 if 'dimA' in params: out.write(" dimA: "+str(params['dimA'])+"\n") 441 if 'dimB' in params: out.write(" dimB: "+str(params['dimB'])+"\n") 442 if 'dimC' in params: out.write(" dimC: "+str(params['dimC'])+"\n") 443 if 'dimD' in params: out.write(" dimD: "+str(params['dimD'])+"\n") 444 if 'fixtype' in params: out.write(" fixtype: "+str(params['fixtype'])+"\n") 445 if 'ETA' in params: out.write(" ETA: "+str(params['ETA'])+"\n") 446 if 'draught' in params: out.write(" draught: "+str(params['draught'])+"\n") 447 if 'destination' in params: out.write(" destination: "+str(params['destination'])+"\n") 448 if 'dte' in params: out.write(" dte: "+str(params['dte'])+"\n") 449 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n") 450 elif 'html'==format: 451 printHtml(params,out) 452 else: 453 print "ERROR: unknown format:",format 454 assert False 455 456 return # Nothing to return
457 458 RepeatIndicatorEncodeLut = { 459 'default':'0', 460 'do not repeat any more':'3', 461 } #RepeatIndicatorEncodeLut 462 463 RepeatIndicatorDecodeLut = { 464 '0':'default', 465 '3':'do not repeat any more', 466 } # RepeatIndicatorEncodeLut 467 468 fixtypeEncodeLut = { 469 'undefined':'0', 470 'GPS':'1', 471 'GLONASS':'2', 472 'combined GPS/GLONASS':'3', 473 'Loran-C':'4', 474 'Chayka':'5', 475 'integrated navigation system':'6', 476 'surveyed':'7', 477 } #fixtypeEncodeLut 478 479 fixtypeDecodeLut = { 480 '0':'undefined', 481 '1':'GPS', 482 '2':'GLONASS', 483 '3':'combined GPS/GLONASS', 484 '4':'Loran-C', 485 '5':'Chayka', 486 '6':'integrated navigation system', 487 '7':'surveyed', 488 } # fixtypeEncodeLut 489 490 dteEncodeLut = { 491 'available':'0', 492 'not available':'1', 493 } #dteEncodeLut 494 495 dteDecodeLut = { 496 '0':'available', 497 '1':'not available', 498 } # dteEncodeLut 499 500 501 502 ###################################################################### 503 # UNIT TESTING 504 ###################################################################### 505 import unittest
506 -def testParams():
507 '''Return a params file base on the testvalue tags. 508 @rtype: dict 509 @return: params based on testvalue tags 510 ''' 511 params = {} 512 params['MessageID'] = 5 513 params['RepeatIndicator'] = 1 514 params['UserID'] = 1193046 515 params['AISversion'] = 0 516 params['IMOnumber'] = 3210 517 params['callsign'] = 'PIRATE1' 518 params['name'] = 'BLACK PEARL@@@@@@@@@' 519 params['shipandcargo'] = 55 520 params['dimA'] = 10 521 params['dimB'] = 11 522 params['dimC'] = 12 523 params['dimD'] = 13 524 params['fixtype'] = 1 525 params['ETA'] = 0 526 params['draught'] = Decimal('21.1') 527 params['destination'] = 'NOWHERE@@@@@@@@@@@@@' 528 params['dte'] = 0 529 params['Spare'] = 0 530 531 return params
532
533 -class Testshipdata(unittest.TestCase):
534 '''Use testvalue tag text from each type to build test case the shipdata message'''
535 - def testEncodeDecode(self):
536 537 params = testParams() 538 bits = encode(params) 539 r = decode(bits) 540 541 # Check that each parameter came through ok. 542 self.failUnlessEqual(r['MessageID'],params['MessageID']) 543 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator']) 544 self.failUnlessEqual(r['UserID'],params['UserID']) 545 self.failUnlessEqual(r['AISversion'],params['AISversion']) 546 self.failUnlessEqual(r['IMOnumber'],params['IMOnumber']) 547 self.failUnlessEqual(r['callsign'],params['callsign']) 548 self.failUnlessEqual(r['name'],params['name']) 549 self.failUnlessEqual(r['shipandcargo'],params['shipandcargo']) 550 self.failUnlessEqual(r['dimA'],params['dimA']) 551 self.failUnlessEqual(r['dimB'],params['dimB']) 552 self.failUnlessEqual(r['dimC'],params['dimC']) 553 self.failUnlessEqual(r['dimD'],params['dimD']) 554 self.failUnlessEqual(r['fixtype'],params['fixtype']) 555 self.failUnlessEqual(r['ETA'],params['ETA']) 556 self.failUnlessAlmostEqual(r['draught'],params['draught'],3) 557 self.failUnlessEqual(r['destination'],params['destination']) 558 self.failUnlessEqual(r['dte'],params['dte']) 559 self.failUnlessEqual(r['Spare'],params['Spare'])
560
561 -def addMsgOptions(parser):
562 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 563 help='decode a "shipdata" AIS message') 564 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 565 help='encode a "shipdata" AIS message') 566 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 567 ,help='Field parameter value [default: %default]') 568 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 569 ,help='Field parameter value [default: %default]') 570 parser.add_option('--AISversion-field', dest='AISversionField',default=0,metavar='uint',type='int' 571 ,help='Field parameter value [default: %default]') 572 parser.add_option('--IMOnumber-field', dest='IMOnumberField',default=0,metavar='uint',type='int' 573 ,help='Field parameter value [default: %default]') 574 parser.add_option('--callsign-field', dest='callsignField',default='@@@@@@@',metavar='aisstr6',type='string' 575 ,help='Field parameter value [default: %default]') 576 parser.add_option('--name-field', dest='nameField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string' 577 ,help='Field parameter value [default: %default]') 578 parser.add_option('--shipandcargo-field', dest='shipandcargoField',default=0,metavar='uint',type='int' 579 ,help='Field parameter value [default: %default]') 580 parser.add_option('--dimA-field', dest='dimAField',metavar='uint',type='int' 581 ,help='Field parameter value [default: %default]') 582 parser.add_option('--dimB-field', dest='dimBField',metavar='uint',type='int' 583 ,help='Field parameter value [default: %default]') 584 parser.add_option('--dimC-field', dest='dimCField',metavar='uint',type='int' 585 ,help='Field parameter value [default: %default]') 586 parser.add_option('--dimD-field', dest='dimDField',metavar='uint',type='int' 587 ,help='Field parameter value [default: %default]') 588 parser.add_option('--fixtype-field', dest='fixtypeField',default=0,metavar='uint',type='int' 589 ,help='Field parameter value [default: %default]') 590 parser.add_option('--ETA-field', dest='ETAField',metavar='uint',type='int' 591 ,help='Field parameter value [default: %default]') 592 parser.add_option('--draught-field', dest='draughtField',default=Decimal('0'),metavar='udecimal',type='string' 593 ,help='Field parameter value [default: %default]') 594 parser.add_option('--destination-field', dest='destinationField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string' 595 ,help='Field parameter value [default: %default]') 596 parser.add_option('--dte-field', dest='dteField',metavar='uint',type='int' 597 ,help='Field parameter value [default: %default]')
598 599 ############################################################ 600 if __name__=='__main__': 601 602 from optparse import OptionParser 603 parser = OptionParser(usage="%prog [options]", 604 version="%prog "+__version__) 605 606 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 607 help='run the documentation tests') 608 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 609 help='run the unit tests') 610 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 611 help='Make the test output verbose') 612 613 # FIX: remove nmea from binary messages. No way to build the whole packet? 614 # FIX: or build the surrounding msg 8 for a broadcast? 615 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 616 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 617 ,default='nmeapayload' 618 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]') 619 620 621 outputChoices = ('std','html','xml' ) 622 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 623 ,default='std' 624 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 625 626 parser.add_option('-o','--output',dest='outputFileName',default=None, 627 help='Name of the python file to write [default: stdout]') 628 629 addMsgOptions(parser) 630 631 (options,args) = parser.parse_args() 632 success=True 633 634 if options.doctest: 635 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 636 sys.argv= [sys.argv[0]] 637 if options.verbose: sys.argv.append('-v') 638 import doctest 639 numfail,numtests=doctest.testmod() 640 if numfail==0: print 'ok' 641 else: 642 print 'FAILED' 643 success=False 644 645 if not success: sys.exit('Something Failed') 646 del success # Hide success from epydoc 647 648 if options.unittest: 649 sys.argv = [sys.argv[0]] 650 if options.verbose: sys.argv.append('-v') 651 unittest.main() 652 653 outfile = sys.stdout 654 if None!=options.outputFileName: 655 outfile = file(options.outputFileName,'w') 656 657 658 if options.doEncode: 659 # First make sure all non required options are specified 660 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField") 661 if None==options.UserIDField: parser.error("missing value for UserIDField") 662 if None==options.AISversionField: parser.error("missing value for AISversionField") 663 if None==options.IMOnumberField: parser.error("missing value for IMOnumberField") 664 if None==options.callsignField: parser.error("missing value for callsignField") 665 if None==options.nameField: parser.error("missing value for nameField") 666 if None==options.shipandcargoField: parser.error("missing value for shipandcargoField") 667 if None==options.dimAField: parser.error("missing value for dimAField") 668 if None==options.dimBField: parser.error("missing value for dimBField") 669 if None==options.dimCField: parser.error("missing value for dimCField") 670 if None==options.dimDField: parser.error("missing value for dimDField") 671 if None==options.fixtypeField: parser.error("missing value for fixtypeField") 672 if None==options.ETAField: parser.error("missing value for ETAField") 673 if None==options.draughtField: parser.error("missing value for draughtField") 674 if None==options.destinationField: parser.error("missing value for destinationField") 675 if None==options.dteField: parser.error("missing value for dteField") 676 msgDict={ 677 'MessageID': '5', 678 'RepeatIndicator': options.RepeatIndicatorField, 679 'UserID': options.UserIDField, 680 'AISversion': options.AISversionField, 681 'IMOnumber': options.IMOnumberField, 682 'callsign': options.callsignField, 683 'name': options.nameField, 684 'shipandcargo': options.shipandcargoField, 685 'dimA': options.dimAField, 686 'dimB': options.dimBField, 687 'dimC': options.dimCField, 688 'dimD': options.dimDField, 689 'fixtype': options.fixtypeField, 690 'ETA': options.ETAField, 691 'draught': options.draughtField, 692 'destination': options.destinationField, 693 'dte': options.dteField, 694 'Spare': '0', 695 } 696 697 bits = encode(msgDict) 698 if 'binary'==options.ioType: print str(bits) 699 elif 'nmeapayload'==options.ioType: 700 # FIX: figure out if this might be necessary at compile time 701 print "bitLen",len(bits) 702 bitLen=len(bits) 703 if bitLen%6!=0: 704 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 705 print "result:",binary.bitvectoais6(bits)[0] 706 707 708 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 709 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 710 else: sys.exit('ERROR: unknown ioType. Help!') 711 712 if options.doDecode: 713 for msg in args: 714 bv = None 715 if 'binary' == options.ioType: bv = BitVector(bitstring=msg) 716 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg) 717 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5]) 718 else: sys.exit('ERROR: unknown ioType. Help!') 719 720 printFields(decode(bv),out=outfile,format=options.outputType) 721