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-02 $'.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 -def printFields(params, out=sys.stdout, format='std'):
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 282 return # Nothing to return
283 284 285 286 ###################################################################### 287 # UNIT TESTING 288 ###################################################################### 289 import unittest
290 -def testParams():
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
317 -class Testshipdata(unittest.TestCase):
318 '''Use testvalue tag text from each type to build test case the shipdata message'''
319 - def testEncodeDecode(self):
320 321 params = testParams() 322 bits = encode(params) 323 r = decode(bits) 324 325 # Check that each parameter came through ok. 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'],3) 341 self.failUnlessEqual(r['destination'],params['destination']) 342 self.failUnlessEqual(r['dte'],params['dte']) 343 self.failUnlessEqual(r['Spare'],params['Spare'])
344
345 -def addMsgOptions(parser):
346 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 347 help='decode a "shipdata" AIS message') 348 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 349 help='encode a "shipdata" AIS message') 350 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 351 ,help='Field parameter value [default: %default]') 352 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 353 ,help='Field parameter value [default: %default]') 354 parser.add_option('--AISversion-field', dest='AISversionField',default=0,metavar='uint',type='int' 355 ,help='Field parameter value [default: %default]') 356 parser.add_option('--IMOnumber-field', dest='IMOnumberField',default=0,metavar='uint',type='int' 357 ,help='Field parameter value [default: %default]') 358 parser.add_option('--callsign-field', dest='callsignField',default='@@@@@@@',metavar='aisstr6',type='string' 359 ,help='Field parameter value [default: %default]') 360 parser.add_option('--name-field', dest='nameField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string' 361 ,help='Field parameter value [default: %default]') 362 parser.add_option('--shipandcargo-field', dest='shipandcargoField',default=0,metavar='uint',type='int' 363 ,help='Field parameter value [default: %default]') 364 parser.add_option('--dimA-field', dest='dimAField',metavar='uint',type='int' 365 ,help='Field parameter value [default: %default]') 366 parser.add_option('--dimB-field', dest='dimBField',metavar='uint',type='int' 367 ,help='Field parameter value [default: %default]') 368 parser.add_option('--dimC-field', dest='dimCField',metavar='uint',type='int' 369 ,help='Field parameter value [default: %default]') 370 parser.add_option('--dimD-field', dest='dimDField',metavar='uint',type='int' 371 ,help='Field parameter value [default: %default]') 372 parser.add_option('--fixtype-field', dest='fixtypeField',default=0,metavar='uint',type='int' 373 ,help='Field parameter value [default: %default]') 374 parser.add_option('--ETA-field', dest='ETAField',metavar='uint',type='int' 375 ,help='Field parameter value [default: %default]') 376 parser.add_option('--draught-field', dest='draughtField',default=Decimal('0'),metavar='udecimal',type='string' 377 ,help='Field parameter value [default: %default]') 378 parser.add_option('--destination-field', dest='destinationField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string' 379 ,help='Field parameter value [default: %default]') 380 parser.add_option('--dte-field', dest='dteField',metavar='uint',type='int' 381 ,help='Field parameter value [default: %default]')
382 383 ############################################################ 384 if __name__=='__main__': 385 386 from optparse import OptionParser 387 parser = OptionParser(usage="%prog [options]", 388 version="%prog "+__version__) 389 390 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 391 help='run the documentation tests') 392 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 393 help='run the unit tests') 394 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 395 help='Make the test output verbose') 396 397 # FIX: remove nmea from binary messages. No way to build the whole packet? 398 # FIX: or build the surrounding msg 8 for a broadcast? 399 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 400 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 401 ,default='nmeapayload' 402 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]') 403 addMsgOptions(parser) 404 405 (options,args) = parser.parse_args() 406 success=True 407 408 if options.doctest: 409 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 410 sys.argv= [sys.argv[0]] 411 if options.verbose: sys.argv.append('-v') 412 import doctest 413 numfail,numtests=doctest.testmod() 414 if numfail==0: print 'ok' 415 else: 416 print 'FAILED' 417 success=False 418 419 if not success: sys.exit('Something Failed') 420 del success # Hide success from epydoc 421 422 if options.unittest: 423 sys.argv = [sys.argv[0]] 424 if options.verbose: sys.argv.append('-v') 425 unittest.main() 426 427 if options.doEncode: 428 # First make sure all non required options are specified 429 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField") 430 if None==options.UserIDField: parser.error("missing value for UserIDField") 431 if None==options.AISversionField: parser.error("missing value for AISversionField") 432 if None==options.IMOnumberField: parser.error("missing value for IMOnumberField") 433 if None==options.callsignField: parser.error("missing value for callsignField") 434 if None==options.nameField: parser.error("missing value for nameField") 435 if None==options.shipandcargoField: parser.error("missing value for shipandcargoField") 436 if None==options.dimAField: parser.error("missing value for dimAField") 437 if None==options.dimBField: parser.error("missing value for dimBField") 438 if None==options.dimCField: parser.error("missing value for dimCField") 439 if None==options.dimDField: parser.error("missing value for dimDField") 440 if None==options.fixtypeField: parser.error("missing value for fixtypeField") 441 if None==options.ETAField: parser.error("missing value for ETAField") 442 if None==options.draughtField: parser.error("missing value for draughtField") 443 if None==options.destinationField: parser.error("missing value for destinationField") 444 if None==options.dteField: parser.error("missing value for dteField") 445 msgDict={ 446 'MessageID': '5', 447 'RepeatIndicator': options.RepeatIndicatorField, 448 'UserID': options.UserIDField, 449 'AISversion': options.AISversionField, 450 'IMOnumber': options.IMOnumberField, 451 'callsign': options.callsignField, 452 'name': options.nameField, 453 'shipandcargo': options.shipandcargoField, 454 'dimA': options.dimAField, 455 'dimB': options.dimBField, 456 'dimC': options.dimCField, 457 'dimD': options.dimDField, 458 'fixtype': options.fixtypeField, 459 'ETA': options.ETAField, 460 'draught': options.draughtField, 461 'destination': options.destinationField, 462 'dte': options.dteField, 463 'Spare': '0', 464 } 465 466 bits = encode(msgDict) 467 if 'binary'==options.ioType: print str(bits) 468 elif 'nmeapayload'==options.ioType: 469 # FIX: figure out if this might be necessary at compile time 470 print "bitLen",len(bits) 471 bitLen=len(bits) 472 if bitLen%6!=0: 473 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 474 print "result:",binary.bitvectoais6(bits)[0] 475 476 477 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 478 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 479 else: sys.exit('ERROR: unknown ioType. Help!') 480 481 if options.doDecode: 482 for msg in args: 483 if 'binary'==options.ioType: 484 bv = BitVector(bitstring=msg) 485 printFields(decode(bv)) 486 487 elif 'nmeapayload'==options.ioType: 488 bv = binary.ais6tobitvec(msg) 489 printFields(decode(bv)) 490 491 elif 'nmea'==options.ioType: 492 bv = binary.ais6tobitvec(msg.split(',')[5]) 493 printFields(decode(bv)) 494 else: sys.exit('ERROR: unknown ioType. Help!') 495