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