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-02-16 $'.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  @todo: FIX: put in a description of the message here with fields and types. 
 34  ''' 
 35   
 36  import sys 
 37  from decimal import Decimal 
 38  from BitVector import BitVector 
 39   
 40  import binary, aisstring 
 41   
 42  # FIX: check to see if these will be needed 
 43  TrueBV  = BitVector(bitstring="1") 
 44  "Why always rebuild the True bit?  This should speed things up a bunch" 
 45  FalseBV = BitVector(bitstring="0") 
 46  "Why always rebuild the False bit?  This should speed things up a bunch" 
 47   
 48   
 49  fieldList = ( 
 50          'MessageID', 
 51          'RepeatIndicator', 
 52          'UserID', 
 53          'AISversion', 
 54          'IMOnumber', 
 55          'callsign', 
 56          'name', 
 57          'shipandcargo', 
 58          'dimA', 
 59          'dimB', 
 60          'dimC', 
 61          'dimD', 
 62          'fixtype', 
 63          'ETA', 
 64          'draught', 
 65          'destination', 
 66          'dte', 
 67          'Spare', 
 68  ) 
 69   
 70  fieldListPostgres = ( 
 71          'MessageID', 
 72          'RepeatIndicator', 
 73          'UserID', 
 74          'AISversion', 
 75          'IMOnumber', 
 76          'callsign', 
 77          'name', 
 78          'shipandcargo', 
 79          'dimA', 
 80          'dimB', 
 81          'dimC', 
 82          'dimD', 
 83          'fixtype', 
 84          'ETA', 
 85          'draught', 
 86          'destination', 
 87          'dte', 
 88          'Spare', 
 89  ) 
 90   
 91  toPgFields = { 
 92  } 
 93  ''' 
 94  Go to the Postgis field names from the straight field name 
 95  ''' 
 96   
 97  fromPgFields = { 
 98  } 
 99  ''' 
100  Go from the Postgis field names to the straight field name 
101  ''' 
102   
103  pgTypes = { 
104  } 
105  ''' 
106  Lookup table for each postgis field name to get its type. 
107  ''' 
108   
109 -def encode(params, validate=False):
110 '''Create a shipdata binary message payload to pack into an AIS Msg shipdata. 111 112 Fields in params: 113 - MessageID(uint): AIS message number. Must be 5 (field automatically set to "5") 114 - RepeatIndicator(uint): Indicated how many times a message has been repeated 115 - UserID(uint): Unique ship identification number (MMSI) 116 - AISversion(uint): Compliant with what edition. 0 is the first edition. 117 - IMOnumber(uint): vessel identification number (different than mmsi) 118 - callsign(aisstr6): Ship radio call sign 119 - name(aisstr6): Vessel name 120 - shipandcargo(uint): what 121 - dimA(uint): FIX: write a description 122 - dimB(uint): FIX: write a description 123 - dimC(uint): FIX: write a description 124 - dimD(uint): FIX: write a description 125 - fixtype(uint): Method used for positioning 126 - ETA(uint): FIX: break this out 127 - draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater 128 - destination(aisstr6): Where is the vessel going 129 - dte(uint): Data terminal ready 130 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0") 131 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing 132 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 133 @rtype: BitVector 134 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8 135 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits. 136 ''' 137 138 bvList = [] 139 bvList.append(binary.setBitVectorSize(BitVector(intVal=5),6)) 140 if 'RepeatIndicator' in params: 141 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2)) 142 else: 143 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 144 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30)) 145 if 'AISversion' in params: 146 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['AISversion']),2)) 147 else: 148 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 149 if 'IMOnumber' in params: 150 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['IMOnumber']),30)) 151 else: 152 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),30)) 153 if 'callsign' in params: 154 bvList.append(aisstring.encode(params['callsign'],42)) 155 else: 156 bvList.append(aisstring.encode('@@@@@@@',42)) 157 if 'name' in params: 158 bvList.append(aisstring.encode(params['name'],120)) 159 else: 160 bvList.append(aisstring.encode('@@@@@@@@@@@@@@@@@@@@',120)) 161 if 'shipandcargo' in params: 162 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['shipandcargo']),8)) 163 else: 164 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),8)) 165 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimA']),9)) 166 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimB']),9)) 167 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimC']),6)) 168 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dimD']),6)) 169 if 'fixtype' in params: 170 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['fixtype']),4)) 171 else: 172 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4)) 173 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['ETA']),20)) 174 if 'draught' in params: 175 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['draught'])*Decimal('10')))),8)) 176 else: 177 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(0)),8)) 178 if 'destination' in params: 179 bvList.append(aisstring.encode(params['destination'],120)) 180 else: 181 bvList.append(aisstring.encode('@@@@@@@@@@@@@@@@@@@@',120)) 182 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['dte']),1)) 183 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),1)) 184 185 return binary.joinBV(bvList)
186
187 -def decode(bv, validate=False):
188 '''Unpack a shipdata message 189 190 Fields in params: 191 - MessageID(uint): AIS message number. Must be 5 (field automatically set to "5") 192 - RepeatIndicator(uint): Indicated how many times a message has been repeated 193 - UserID(uint): Unique ship identification number (MMSI) 194 - AISversion(uint): Compliant with what edition. 0 is the first edition. 195 - IMOnumber(uint): vessel identification number (different than mmsi) 196 - callsign(aisstr6): Ship radio call sign 197 - name(aisstr6): Vessel name 198 - shipandcargo(uint): what 199 - dimA(uint): FIX: write a description 200 - dimB(uint): FIX: write a description 201 - dimC(uint): FIX: write a description 202 - dimD(uint): FIX: write a description 203 - fixtype(uint): Method used for positioning 204 - ETA(uint): FIX: break this out 205 - draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater 206 - destination(aisstr6): Where is the vessel going 207 - dte(uint): Data terminal ready 208 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0") 209 @type bv: BitVector 210 @param bv: Bits defining a message 211 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 212 @rtype: dict 213 @return: params 214 ''' 215 216 #Would be nice to check the bit count here.. 217 #if validate: 218 # assert (len(bv)==FIX: SOME NUMBER) 219 r = {} 220 r['MessageID']=5 221 r['RepeatIndicator']=int(bv[6:8]) 222 r['UserID']=int(bv[8:38]) 223 r['AISversion']=int(bv[38:40]) 224 r['IMOnumber']=int(bv[40:70]) 225 r['callsign']=aisstring.decode(bv[70:112]) 226 r['name']=aisstring.decode(bv[112:232]) 227 r['shipandcargo']=int(bv[232:240]) 228 r['dimA']=int(bv[240:249]) 229 r['dimB']=int(bv[249:258]) 230 r['dimC']=int(bv[258:264]) 231 r['dimD']=int(bv[264:270]) 232 r['fixtype']=int(bv[270:274]) 233 r['ETA']=int(bv[274:294]) 234 r['draught']=Decimal(int(bv[294:302]))/Decimal('10') 235 r['destination']=aisstring.decode(bv[302:422]) 236 r['dte']=int(bv[422:423]) 237 r['Spare']=0 238 return r
239
240 -def decodeMessageID(bv, validate=False):
241 return 5
242
243 -def decodeRepeatIndicator(bv, validate=False):
244 return int(bv[6:8])
245
246 -def decodeUserID(bv, validate=False):
247 return int(bv[8:38])
248
249 -def decodeAISversion(bv, validate=False):
250 return int(bv[38:40])
251
252 -def decodeIMOnumber(bv, validate=False):
253 return int(bv[40:70])
254
255 -def decodecallsign(bv, validate=False):
256 return aisstring.decode(bv[70:112])
257
258 -def decodename(bv, validate=False):
259 return aisstring.decode(bv[112:232])
260
261 -def decodeshipandcargo(bv, validate=False):
262 return int(bv[232:240])
263
264 -def decodedimA(bv, validate=False):
265 return int(bv[240:249])
266
267 -def decodedimB(bv, validate=False):
268 return int(bv[249:258])
269
270 -def decodedimC(bv, validate=False):
271 return int(bv[258:264])
272
273 -def decodedimD(bv, validate=False):
274 return int(bv[264:270])
275
276 -def decodefixtype(bv, validate=False):
277 return int(bv[270:274])
278
279 -def decodeETA(bv, validate=False):
280 return int(bv[274:294])
281
282 -def decodedraught(bv, validate=False):
283 return Decimal(int(bv[294:302]))/Decimal('10')
284
285 -def decodedestination(bv, validate=False):
286 return aisstring.decode(bv[302:422])
287
288 -def decodedte(bv, validate=False):
289 return int(bv[422:423])
290
291 -def decodeSpare(bv, validate=False):
292 return 0
293 294
295 -def printHtml(params, out=sys.stdout):
296 out.write("<h3>shipdata<h3>\n") 297 out.write("<table border=\"1\">\n") 298 out.write("<tr bgcolor=\"orange\">\n") 299 out.write("<th align=\"left\">Field Name</th>\n") 300 out.write("<th align=\"left\">Type</th>\n") 301 out.write("<th align=\"left\">Value</th>\n") 302 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 303 out.write("<th align=\"left\">Units</th>\n") 304 out.write("\n") 305 out.write("<tr>\n") 306 out.write("<td>MessageID</td>\n") 307 out.write("<td>uint</td>\n") 308 if 'MessageID' in params: 309 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 310 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 311 out.write("</tr>\n") 312 out.write("\n") 313 out.write("<tr>\n") 314 out.write("<td>RepeatIndicator</td>\n") 315 out.write("<td>uint</td>\n") 316 if 'RepeatIndicator' in params: 317 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n") 318 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut: 319 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>") 320 else: 321 out.write("<td><i>Missing LUT entry</i></td>") 322 out.write("</tr>\n") 323 out.write("\n") 324 out.write("<tr>\n") 325 out.write("<td>UserID</td>\n") 326 out.write("<td>uint</td>\n") 327 if 'UserID' in params: 328 out.write(" <td>"+str(params['UserID'])+"</td>\n") 329 out.write(" <td>"+str(params['UserID'])+"</td>\n") 330 out.write("</tr>\n") 331 out.write("\n") 332 out.write("<tr>\n") 333 out.write("<td>AISversion</td>\n") 334 out.write("<td>uint</td>\n") 335 if 'AISversion' in params: 336 out.write(" <td>"+str(params['AISversion'])+"</td>\n") 337 out.write(" <td>"+str(params['AISversion'])+"</td>\n") 338 out.write("</tr>\n") 339 out.write("\n") 340 out.write("<tr>\n") 341 out.write("<td>IMOnumber</td>\n") 342 out.write("<td>uint</td>\n") 343 if 'IMOnumber' in params: 344 out.write(" <td>"+str(params['IMOnumber'])+"</td>\n") 345 out.write(" <td>"+str(params['IMOnumber'])+"</td>\n") 346 out.write("</tr>\n") 347 out.write("\n") 348 out.write("<tr>\n") 349 out.write("<td>callsign</td>\n") 350 out.write("<td>aisstr6</td>\n") 351 if 'callsign' in params: 352 out.write(" <td>"+str(params['callsign'])+"</td>\n") 353 out.write(" <td>"+str(params['callsign'])+"</td>\n") 354 out.write("</tr>\n") 355 out.write("\n") 356 out.write("<tr>\n") 357 out.write("<td>name</td>\n") 358 out.write("<td>aisstr6</td>\n") 359 if 'name' in params: 360 out.write(" <td>"+str(params['name'])+"</td>\n") 361 out.write(" <td>"+str(params['name'])+"</td>\n") 362 out.write("</tr>\n") 363 out.write("\n") 364 out.write("<tr>\n") 365 out.write("<td>shipandcargo</td>\n") 366 out.write("<td>uint</td>\n") 367 if 'shipandcargo' in params: 368 out.write(" <td>"+str(params['shipandcargo'])+"</td>\n") 369 out.write(" <td>"+str(params['shipandcargo'])+"</td>\n") 370 out.write("</tr>\n") 371 out.write("\n") 372 out.write("<tr>\n") 373 out.write("<td>dimA</td>\n") 374 out.write("<td>uint</td>\n") 375 if 'dimA' in params: 376 out.write(" <td>"+str(params['dimA'])+"</td>\n") 377 out.write(" <td>"+str(params['dimA'])+"</td>\n") 378 out.write("<td>m</td>\n") 379 out.write("</tr>\n") 380 out.write("\n") 381 out.write("<tr>\n") 382 out.write("<td>dimB</td>\n") 383 out.write("<td>uint</td>\n") 384 if 'dimB' in params: 385 out.write(" <td>"+str(params['dimB'])+"</td>\n") 386 out.write(" <td>"+str(params['dimB'])+"</td>\n") 387 out.write("<td>m</td>\n") 388 out.write("</tr>\n") 389 out.write("\n") 390 out.write("<tr>\n") 391 out.write("<td>dimC</td>\n") 392 out.write("<td>uint</td>\n") 393 if 'dimC' in params: 394 out.write(" <td>"+str(params['dimC'])+"</td>\n") 395 out.write(" <td>"+str(params['dimC'])+"</td>\n") 396 out.write("<td>m</td>\n") 397 out.write("</tr>\n") 398 out.write("\n") 399 out.write("<tr>\n") 400 out.write("<td>dimD</td>\n") 401 out.write("<td>uint</td>\n") 402 if 'dimD' in params: 403 out.write(" <td>"+str(params['dimD'])+"</td>\n") 404 out.write(" <td>"+str(params['dimD'])+"</td>\n") 405 out.write("<td>m</td>\n") 406 out.write("</tr>\n") 407 out.write("\n") 408 out.write("<tr>\n") 409 out.write("<td>fixtype</td>\n") 410 out.write("<td>uint</td>\n") 411 if 'fixtype' in params: 412 out.write(" <td>"+str(params['fixtype'])+"</td>\n") 413 if str(params['fixtype']) in fixtypeDecodeLut: 414 out.write("<td>"+fixtypeDecodeLut[str(params['fixtype'])]+"</td>") 415 else: 416 out.write("<td><i>Missing LUT entry</i></td>") 417 out.write("</tr>\n") 418 out.write("\n") 419 out.write("<tr>\n") 420 out.write("<td>ETA</td>\n") 421 out.write("<td>uint</td>\n") 422 if 'ETA' in params: 423 out.write(" <td>"+str(params['ETA'])+"</td>\n") 424 out.write(" <td>"+str(params['ETA'])+"</td>\n") 425 out.write("</tr>\n") 426 out.write("\n") 427 out.write("<tr>\n") 428 out.write("<td>draught</td>\n") 429 out.write("<td>udecimal</td>\n") 430 if 'draught' in params: 431 out.write(" <td>"+str(params['draught'])+"</td>\n") 432 out.write(" <td>"+str(params['draught'])+"</td>\n") 433 out.write("<td>m</td>\n") 434 out.write("</tr>\n") 435 out.write("\n") 436 out.write("<tr>\n") 437 out.write("<td>destination</td>\n") 438 out.write("<td>aisstr6</td>\n") 439 if 'destination' in params: 440 out.write(" <td>"+str(params['destination'])+"</td>\n") 441 out.write(" <td>"+str(params['destination'])+"</td>\n") 442 out.write("</tr>\n") 443 out.write("\n") 444 out.write("<tr>\n") 445 out.write("<td>dte</td>\n") 446 out.write("<td>uint</td>\n") 447 if 'dte' in params: 448 out.write(" <td>"+str(params['dte'])+"</td>\n") 449 if str(params['dte']) in dteDecodeLut: 450 out.write("<td>"+dteDecodeLut[str(params['dte'])]+"</td>") 451 else: 452 out.write("<td><i>Missing LUT entry</i></td>") 453 out.write("</tr>\n") 454 out.write("\n") 455 out.write("<tr>\n") 456 out.write("<td>Spare</td>\n") 457 out.write("<td>uint</td>\n") 458 if 'Spare' in params: 459 out.write(" <td>"+str(params['Spare'])+"</td>\n") 460 out.write(" <td>"+str(params['Spare'])+"</td>\n") 461 out.write("</tr>\n") 462 out.write("</table>\n")
463
464 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):
465 '''Print a Spare message to stdout. 466 467 Fields in params: 468 - MessageID(uint): AIS message number. Must be 5 (field automatically set to "5") 469 - RepeatIndicator(uint): Indicated how many times a message has been repeated 470 - UserID(uint): Unique ship identification number (MMSI) 471 - AISversion(uint): Compliant with what edition. 0 is the first edition. 472 - IMOnumber(uint): vessel identification number (different than mmsi) 473 - callsign(aisstr6): Ship radio call sign 474 - name(aisstr6): Vessel name 475 - shipandcargo(uint): what 476 - dimA(uint): FIX: write a description 477 - dimB(uint): FIX: write a description 478 - dimC(uint): FIX: write a description 479 - dimD(uint): FIX: write a description 480 - fixtype(uint): Method used for positioning 481 - ETA(uint): FIX: break this out 482 - draught(udecimal): Maximum present static draught. 25.5 is 25.5 m or greater 483 - destination(aisstr6): Where is the vessel going 484 - dte(uint): Data terminal ready 485 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0") 486 @param params: Dictionary of field names/values. 487 @param out: File like object to write to 488 @rtype: stdout 489 @return: text to out 490 ''' 491 492 if 'std'==format: 493 out.write("Spare:\n") 494 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n") 495 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n") 496 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n") 497 if 'AISversion' in params: out.write(" AISversion: "+str(params['AISversion'])+"\n") 498 if 'IMOnumber' in params: out.write(" IMOnumber: "+str(params['IMOnumber'])+"\n") 499 if 'callsign' in params: out.write(" callsign: "+str(params['callsign'])+"\n") 500 if 'name' in params: out.write(" name: "+str(params['name'])+"\n") 501 if 'shipandcargo' in params: out.write(" shipandcargo: "+str(params['shipandcargo'])+"\n") 502 if 'dimA' in params: out.write(" dimA: "+str(params['dimA'])+"\n") 503 if 'dimB' in params: out.write(" dimB: "+str(params['dimB'])+"\n") 504 if 'dimC' in params: out.write(" dimC: "+str(params['dimC'])+"\n") 505 if 'dimD' in params: out.write(" dimD: "+str(params['dimD'])+"\n") 506 if 'fixtype' in params: out.write(" fixtype: "+str(params['fixtype'])+"\n") 507 if 'ETA' in params: out.write(" ETA: "+str(params['ETA'])+"\n") 508 if 'draught' in params: out.write(" draught: "+str(params['draught'])+"\n") 509 if 'destination' in params: out.write(" destination: "+str(params['destination'])+"\n") 510 if 'dte' in params: out.write(" dte: "+str(params['dte'])+"\n") 511 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n") 512 elif 'csv'==format: 513 if None == options.fieldList: 514 options.fieldList = fieldList 515 needComma = False; 516 for field in fieldList: 517 if needComma: out.write(',') 518 needComma = True 519 if field in params: 520 out.write(str(params[field])) 521 # else: leave it empty 522 out.write("\n") 523 elif 'html'==format: 524 printHtml(params,out) 525 elif 'sql'==format: 526 sqlInsertStr(params,out,dbType=dbType) 527 else: 528 print "ERROR: unknown format:",format 529 assert False 530 531 return # Nothing to return
532 533 RepeatIndicatorEncodeLut = { 534 'default':'0', 535 'do not repeat any more':'3', 536 } #RepeatIndicatorEncodeLut 537 538 RepeatIndicatorDecodeLut = { 539 '0':'default', 540 '3':'do not repeat any more', 541 } # RepeatIndicatorEncodeLut 542 543 fixtypeEncodeLut = { 544 'undefined':'0', 545 'GPS':'1', 546 'GLONASS':'2', 547 'combined GPS/GLONASS':'3', 548 'Loran-C':'4', 549 'Chayka':'5', 550 'integrated navigation system':'6', 551 'surveyed':'7', 552 } #fixtypeEncodeLut 553 554 fixtypeDecodeLut = { 555 '0':'undefined', 556 '1':'GPS', 557 '2':'GLONASS', 558 '3':'combined GPS/GLONASS', 559 '4':'Loran-C', 560 '5':'Chayka', 561 '6':'integrated navigation system', 562 '7':'surveyed', 563 } # fixtypeEncodeLut 564 565 dteEncodeLut = { 566 'available':'0', 567 'not available':'1', 568 } #dteEncodeLut 569 570 dteDecodeLut = { 571 '0':'available', 572 '1':'not available', 573 } # dteEncodeLut 574 575 ###################################################################### 576 # SQL SUPPORT 577 ###################################################################### 578
579 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 580 ,addCoastGuardFields=True 581 ,dbType='postgres' 582 ):
583 ''' 584 Return the SQL CREATE command for this message type 585 @param outfile: file like object to print to. 586 @param fields: which fields to put in the create. Defaults to all. 587 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 588 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 589 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 590 @type addCoastGuardFields: bool 591 @return: sql create string 592 @rtype: str 593 594 @see: sqlCreate 595 ''' 596 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
597
598 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
599 ''' 600 Return the sqlhelp object to create the table. 601 602 @param fields: which fields to put in the create. Defaults to all. 603 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 604 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 605 @type addCoastGuardFields: bool 606 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 607 @return: An object that can be used to generate a return 608 @rtype: sqlhelp.create 609 ''' 610 if None == fields: fields = fieldList 611 import sqlhelp 612 c = sqlhelp.create('shipdata',dbType=dbType) 613 c.addPrimaryKey() 614 if 'MessageID' in fields: c.addInt ('MessageID') 615 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator') 616 if 'UserID' in fields: c.addInt ('UserID') 617 if 'AISversion' in fields: c.addInt ('AISversion') 618 if 'IMOnumber' in fields: c.addInt ('IMOnumber') 619 if 'callsign' in fields: c.addVarChar('callsign',7) 620 if 'name' in fields: c.addVarChar('name',20) 621 if 'shipandcargo' in fields: c.addInt ('shipandcargo') 622 if 'dimA' in fields: c.addInt ('dimA') 623 if 'dimB' in fields: c.addInt ('dimB') 624 if 'dimC' in fields: c.addInt ('dimC') 625 if 'dimD' in fields: c.addInt ('dimD') 626 if 'fixtype' in fields: c.addInt ('fixtype') 627 if 'ETA' in fields: c.addInt ('ETA') 628 if 'draught' in fields: c.addDecimal('draught',3,1) 629 if 'destination' in fields: c.addVarChar('destination',20) 630 if 'dte' in fields: c.addInt ('dte') 631 if 'Spare' in fields: c.addInt ('Spare') 632 633 if addCoastGuardFields: 634 # c.addInt('cg_rssi') # Relative signal strength indicator 635 # c.addInt('cg_d') # dBm receive strength 636 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 637 # c.addInt('cg_S') # Slot received in 638 # c.addVarChar('cg_x',10) # Idonno 639 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 640 c.addInt('cg_sec') # UTC seconds since the epoch 641 642 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 643 644 return c
645
646 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
647 ''' 648 Return the SQL INSERT command for this message type 649 @param params: dictionary of values keyed by field name 650 @param outfile: file like object to print to. 651 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 652 @return: sql create string 653 @rtype: str 654 655 @see: sqlCreate 656 ''' 657 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
658 659
660 -def sqlInsert(params,extraParams=None,dbType='postgres'):
661 ''' 662 Give the SQL INSERT statement 663 @param params: dict keyed by field name of values 664 @param extraParams: any extra fields that you have created beyond the normal ais message fields 665 @rtype: sqlhelp.insert 666 @return: insert class instance 667 @todo: allow optional type checking of params? 668 @warning: this will take invalid keys happily and do what??? 669 ''' 670 import sqlhelp 671 i = sqlhelp.insert('shipdata',dbType=dbType) 672 673 if dbType=='postgres': 674 finished = [] 675 for key in params: 676 if key in finished: 677 #print 'already did key',key 678 continue 679 680 if key not in toPgFields and key not in fromPgFields: 681 if type(params[key])==Decimal: i.add(key,float(params[key])) 682 else: i.add(key,params[key]) 683 else: 684 if key in fromPgFields: 685 val = params[key] 686 # Had better be a WKT type like POINT(-88.1 30.321) 687 i.addPostGIS(key,val) 688 finished.append(key) 689 else: 690 # Need to construct the type. 691 pgName = toPgFields[key] 692 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 693 valStr=pgTypes[pgName]+'(' 694 vals = [] 695 for nonPgKey in fromPgFields[pgName]: 696 vals.append(str(params[nonPgKey])) 697 finished.append(nonPgKey) 698 valStr+=' '.join(vals)+')' 699 i.addPostGIS(pgName,valStr) 700 else: 701 for key in params: 702 if type(params[key])==Decimal: i.add(key,float(params[key])) 703 else: i.add(key,params[key]) 704 705 if None != extraParams: 706 for key in extraParams: 707 i.add(key,extraParams[key]) 708 709 return i
710 711 712 ###################################################################### 713 # UNIT TESTING 714 ###################################################################### 715 import unittest
716 -def testParams():
717 '''Return a params file base on the testvalue tags. 718 @rtype: dict 719 @return: params based on testvalue tags 720 ''' 721 params = {} 722 params['MessageID'] = 5 723 params['RepeatIndicator'] = 1 724 params['UserID'] = 1193046 725 params['AISversion'] = 0 726 params['IMOnumber'] = 3210 727 params['callsign'] = 'PIRATE1' 728 params['name'] = 'BLACK PEARL@@@@@@@@@' 729 params['shipandcargo'] = 55 730 params['dimA'] = 10 731 params['dimB'] = 11 732 params['dimC'] = 12 733 params['dimD'] = 13 734 params['fixtype'] = 1 735 params['ETA'] = 0 736 params['draught'] = Decimal('21.1') 737 params['destination'] = 'NOWHERE@@@@@@@@@@@@@' 738 params['dte'] = 0 739 params['Spare'] = 0 740 741 return params
742
743 -class Testshipdata(unittest.TestCase):
744 '''Use testvalue tag text from each type to build test case the shipdata message'''
745 - def testEncodeDecode(self):
746 747 params = testParams() 748 bits = encode(params) 749 r = decode(bits) 750 751 # Check that each parameter came through ok. 752 self.failUnlessEqual(r['MessageID'],params['MessageID']) 753 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator']) 754 self.failUnlessEqual(r['UserID'],params['UserID']) 755 self.failUnlessEqual(r['AISversion'],params['AISversion']) 756 self.failUnlessEqual(r['IMOnumber'],params['IMOnumber']) 757 self.failUnlessEqual(r['callsign'],params['callsign']) 758 self.failUnlessEqual(r['name'],params['name']) 759 self.failUnlessEqual(r['shipandcargo'],params['shipandcargo']) 760 self.failUnlessEqual(r['dimA'],params['dimA']) 761 self.failUnlessEqual(r['dimB'],params['dimB']) 762 self.failUnlessEqual(r['dimC'],params['dimC']) 763 self.failUnlessEqual(r['dimD'],params['dimD']) 764 self.failUnlessEqual(r['fixtype'],params['fixtype']) 765 self.failUnlessEqual(r['ETA'],params['ETA']) 766 self.failUnlessAlmostEqual(r['draught'],params['draught'],1) 767 self.failUnlessEqual(r['destination'],params['destination']) 768 self.failUnlessEqual(r['dte'],params['dte']) 769 self.failUnlessEqual(r['Spare'],params['Spare'])
770
771 -def addMsgOptions(parser):
772 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 773 help='decode a "shipdata" AIS message') 774 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 775 help='encode a "shipdata" AIS message') 776 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 777 ,help='Field parameter value [default: %default]') 778 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 779 ,help='Field parameter value [default: %default]') 780 parser.add_option('--AISversion-field', dest='AISversionField',default=0,metavar='uint',type='int' 781 ,help='Field parameter value [default: %default]') 782 parser.add_option('--IMOnumber-field', dest='IMOnumberField',default=0,metavar='uint',type='int' 783 ,help='Field parameter value [default: %default]') 784 parser.add_option('--callsign-field', dest='callsignField',default='@@@@@@@',metavar='aisstr6',type='string' 785 ,help='Field parameter value [default: %default]') 786 parser.add_option('--name-field', dest='nameField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string' 787 ,help='Field parameter value [default: %default]') 788 parser.add_option('--shipandcargo-field', dest='shipandcargoField',default=0,metavar='uint',type='int' 789 ,help='Field parameter value [default: %default]') 790 parser.add_option('--dimA-field', dest='dimAField',metavar='uint',type='int' 791 ,help='Field parameter value [default: %default]') 792 parser.add_option('--dimB-field', dest='dimBField',metavar='uint',type='int' 793 ,help='Field parameter value [default: %default]') 794 parser.add_option('--dimC-field', dest='dimCField',metavar='uint',type='int' 795 ,help='Field parameter value [default: %default]') 796 parser.add_option('--dimD-field', dest='dimDField',metavar='uint',type='int' 797 ,help='Field parameter value [default: %default]') 798 parser.add_option('--fixtype-field', dest='fixtypeField',default=0,metavar='uint',type='int' 799 ,help='Field parameter value [default: %default]') 800 parser.add_option('--ETA-field', dest='ETAField',metavar='uint',type='int' 801 ,help='Field parameter value [default: %default]') 802 parser.add_option('--draught-field', dest='draughtField',default=Decimal('0'),metavar='udecimal',type='string' 803 ,help='Field parameter value [default: %default]') 804 parser.add_option('--destination-field', dest='destinationField',default='@@@@@@@@@@@@@@@@@@@@',metavar='aisstr6',type='string' 805 ,help='Field parameter value [default: %default]') 806 parser.add_option('--dte-field', dest='dteField',metavar='uint',type='int' 807 ,help='Field parameter value [default: %default]')
808 809 ############################################################ 810 if __name__=='__main__': 811 812 from optparse import OptionParser 813 parser = OptionParser(usage="%prog [options]", 814 version="%prog "+__version__) 815 816 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 817 help='run the documentation tests') 818 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 819 help='run the unit tests') 820 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 821 help='Make the test output verbose') 822 823 # FIX: remove nmea from binary messages. No way to build the whole packet? 824 # FIX: or build the surrounding msg 8 for a broadcast? 825 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 826 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 827 ,default='nmeapayload' 828 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]') 829 830 831 outputChoices = ('std','html','csv','sql' ) 832 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 833 ,default='std' 834 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 835 836 parser.add_option('-o','--output',dest='outputFileName',default=None, 837 help='Name of the python file to write [default: stdout]') 838 839 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append', 840 choices=fieldList, 841 help='Which fields to include in the output. Currently only for csv output [default: all]') 842 843 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true', 844 help='Print the field name for csv') 845 846 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true', 847 help='Print out an sql create command for the table.') 848 849 dbChoices = ('sqlite','postgres') 850 parser.add_option('-D','--db-type',dest='dbType',default='postgres' 851 ,choices=dbChoices,type='choice' 852 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]') 853 854 addMsgOptions(parser) 855 856 (options,args) = parser.parse_args() 857 success=True 858 859 if options.doctest: 860 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 861 sys.argv= [sys.argv[0]] 862 if options.verbose: sys.argv.append('-v') 863 import doctest 864 numfail,numtests=doctest.testmod() 865 if numfail==0: print 'ok' 866 else: 867 print 'FAILED' 868 success=False 869 870 if not success: sys.exit('Something Failed') 871 del success # Hide success from epydoc 872 873 if options.unittest: 874 sys.argv = [sys.argv[0]] 875 if options.verbose: sys.argv.append('-v') 876 unittest.main() 877 878 outfile = sys.stdout 879 if None!=options.outputFileName: 880 outfile = file(options.outputFileName,'w') 881 882 883 if options.doEncode: 884 # First make sure all non required options are specified 885 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField") 886 if None==options.UserIDField: parser.error("missing value for UserIDField") 887 if None==options.AISversionField: parser.error("missing value for AISversionField") 888 if None==options.IMOnumberField: parser.error("missing value for IMOnumberField") 889 if None==options.callsignField: parser.error("missing value for callsignField") 890 if None==options.nameField: parser.error("missing value for nameField") 891 if None==options.shipandcargoField: parser.error("missing value for shipandcargoField") 892 if None==options.dimAField: parser.error("missing value for dimAField") 893 if None==options.dimBField: parser.error("missing value for dimBField") 894 if None==options.dimCField: parser.error("missing value for dimCField") 895 if None==options.dimDField: parser.error("missing value for dimDField") 896 if None==options.fixtypeField: parser.error("missing value for fixtypeField") 897 if None==options.ETAField: parser.error("missing value for ETAField") 898 if None==options.draughtField: parser.error("missing value for draughtField") 899 if None==options.destinationField: parser.error("missing value for destinationField") 900 if None==options.dteField: parser.error("missing value for dteField") 901 msgDict={ 902 'MessageID': '5', 903 'RepeatIndicator': options.RepeatIndicatorField, 904 'UserID': options.UserIDField, 905 'AISversion': options.AISversionField, 906 'IMOnumber': options.IMOnumberField, 907 'callsign': options.callsignField, 908 'name': options.nameField, 909 'shipandcargo': options.shipandcargoField, 910 'dimA': options.dimAField, 911 'dimB': options.dimBField, 912 'dimC': options.dimCField, 913 'dimD': options.dimDField, 914 'fixtype': options.fixtypeField, 915 'ETA': options.ETAField, 916 'draught': options.draughtField, 917 'destination': options.destinationField, 918 'dte': options.dteField, 919 'Spare': '0', 920 } 921 922 bits = encode(msgDict) 923 if 'binary'==options.ioType: print str(bits) 924 elif 'nmeapayload'==options.ioType: 925 # FIX: figure out if this might be necessary at compile time 926 print "bitLen",len(bits) 927 bitLen=len(bits) 928 if bitLen%6!=0: 929 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 930 print "result:",binary.bitvectoais6(bits)[0] 931 932 933 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 934 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 935 else: sys.exit('ERROR: unknown ioType. Help!') 936 937 938 if options.sqlCreate: 939 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType) 940 941 if options.printCsvfieldList: 942 # Make a csv separated list of fields that will be displayed for csv 943 if None == options.fieldList: options.fieldList = fieldList 944 import StringIO 945 buf = StringIO.StringIO() 946 for field in options.fieldList: 947 buf.write(field+',') 948 result = buf.getvalue() 949 if result[-1] == ',': print result[:-1] 950 else: print result 951 952 if options.doDecode: 953 for msg in args: 954 bv = None 955 956 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'): 957 # Found nmea 958 # FIX: do checksum 959 bv = binary.ais6tobitvec(msg.split(',')[5]) 960 else: # either binary or nmeapayload... expect mostly nmeapayloads 961 # assumes that an all 0 and 1 string can not be a nmeapayload 962 binaryMsg=True 963 for c in msg: 964 if c not in ('0','1'): 965 binaryMsg=False 966 break 967 if binaryMsg: 968 bv = BitVector(bitstring=msg) 969 else: # nmeapayload 970 bv = binary.ais6tobitvec(msg) 971 972 printFields(decode(bv) 973 ,out=outfile 974 ,format=options.outputType 975 ,fieldList=options.fieldList 976 ,dbType=options.dbType 977 ) 978