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

Source Code for Module ais.ais_msg_9

   1  #!/usr/bin/env python 
   2   
   3  __version__ = '$Revision: 4791 $'.split()[1] 
   4  __date__ = '$Date: 2007-03-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  @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          'Altitude', 
  54          'SOG', 
  55          'PositionAccuracy', 
  56          'Position_longitude', 
  57          'Position_latitude', 
  58          'COG', 
  59          'TimeStamp', 
  60          'Reserved', 
  61          'DTE', 
  62          'Spare', 
  63          'RAIM', 
  64          'state_syncstate', 
  65          'state_slottimeout', 
  66          'state_slotoffset', 
  67  ) 
  68   
  69  fieldListPostgres = ( 
  70          'MessageID', 
  71          'RepeatIndicator', 
  72          'UserID', 
  73          'Altitude', 
  74          'SOG', 
  75          'PositionAccuracy', 
  76          'Position',     # PostGIS data type 
  77          'COG', 
  78          'TimeStamp', 
  79          'Reserved', 
  80          'DTE', 
  81          'Spare', 
  82          'RAIM', 
  83          'state_syncstate', 
  84          'state_slottimeout', 
  85          'state_slotoffset', 
  86  ) 
  87   
  88  toPgFields = { 
  89          'Position_longitude':'Position', 
  90          'Position_latitude':'Position', 
  91  } 
  92  ''' 
  93  Go to the Postgis field names from the straight field name 
  94  ''' 
  95   
  96  fromPgFields = { 
  97          'Position':('Position_longitude','Position_latitude',), 
  98  } 
  99  ''' 
 100  Go from the Postgis field names to the straight field name 
 101  ''' 
 102   
 103  pgTypes = { 
 104          'Position':'POINT', 
 105  } 
 106  ''' 
 107  Lookup table for each postgis field name to get its type. 
 108  ''' 
 109   
110 -def encode(params, validate=False):
111 '''Create a SARposition binary message payload to pack into an AIS Msg SARposition. 112 113 Fields in params: 114 - MessageID(uint): AIS message number. Must be 9 (field automatically set to "9") 115 - RepeatIndicator(uint): Indicated how many times a message has been repeated 116 - UserID(uint): Unique ship identification number (MMSI) 117 - Altitude(uint): Altitude (GNSS) 118 - SOG(udecimal): Speed over ground 119 - PositionAccuracy(uint): Accuracy of positioning fixes 120 - Position_longitude(decimal): Location of the vessel East West location 121 - Position_latitude(decimal): Location of the vessel North South location 122 - COG(udecimal): Course over ground 123 - TimeStamp(uint): UTC second when the report was generated 124 - Reserved(uint): Reserved for regional applications. Should be set to zero. (field automatically set to "0") 125 - DTE(bool): Dtta terminal ready 126 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 127 - RAIM(bool): Receiver autonomous integrity monitoring flag 128 - state_syncstate(uint): Communications State - SOTDMA Sycronization state 129 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected 130 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN 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=9),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 'Altitude' in params: 146 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['Altitude']),12)) 147 else: 148 bvList.append(binary.setBitVectorSize(BitVector(intVal=4095),12)) 149 if 'SOG' in params: 150 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['SOG'])*Decimal('10')))),10)) 151 else: 152 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(1023)),10)) 153 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['PositionAccuracy']),1)) 154 if 'Position_longitude' in params: 155 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_longitude'])*Decimal('600000')),28)) 156 else: 157 bvList.append(binary.bvFromSignedInt(108600000,28)) 158 if 'Position_latitude' in params: 159 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_latitude'])*Decimal('600000')),27)) 160 else: 161 bvList.append(binary.bvFromSignedInt(54600000,27)) 162 if 'COG' in params: 163 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['COG'])*Decimal('10')))),12)) 164 else: 165 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(3600)),12)) 166 if 'TimeStamp' in params: 167 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['TimeStamp']),6)) 168 else: 169 bvList.append(binary.setBitVectorSize(BitVector(intVal=60),6)) 170 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),8)) 171 if params["DTE"]: bvList.append(TrueBV) 172 else: bvList.append(FalseBV) 173 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),5)) 174 if params["RAIM"]: bvList.append(TrueBV) 175 else: bvList.append(FalseBV) 176 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_syncstate']),2)) 177 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_slottimeout']),3)) 178 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_slotoffset']),14)) 179 180 return binary.joinBV(bvList)
181
182 -def decode(bv, validate=False):
183 '''Unpack a SARposition message 184 185 Fields in params: 186 - MessageID(uint): AIS message number. Must be 9 (field automatically set to "9") 187 - RepeatIndicator(uint): Indicated how many times a message has been repeated 188 - UserID(uint): Unique ship identification number (MMSI) 189 - Altitude(uint): Altitude (GNSS) 190 - SOG(udecimal): Speed over ground 191 - PositionAccuracy(uint): Accuracy of positioning fixes 192 - Position_longitude(decimal): Location of the vessel East West location 193 - Position_latitude(decimal): Location of the vessel North South location 194 - COG(udecimal): Course over ground 195 - TimeStamp(uint): UTC second when the report was generated 196 - Reserved(uint): Reserved for regional applications. Should be set to zero. (field automatically set to "0") 197 - DTE(bool): Dtta terminal ready 198 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 199 - RAIM(bool): Receiver autonomous integrity monitoring flag 200 - state_syncstate(uint): Communications State - SOTDMA Sycronization state 201 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected 202 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN 203 @type bv: BitVector 204 @param bv: Bits defining a message 205 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 206 @rtype: dict 207 @return: params 208 ''' 209 210 #Would be nice to check the bit count here.. 211 #if validate: 212 # assert (len(bv)==FIX: SOME NUMBER) 213 r = {} 214 r['MessageID']=9 215 r['RepeatIndicator']=int(bv[6:8]) 216 r['UserID']=int(bv[8:38]) 217 r['Altitude']=int(bv[38:50]) 218 r['SOG']=Decimal(int(bv[50:60]))/Decimal('10') 219 r['PositionAccuracy']=int(bv[60:61]) 220 r['Position_longitude']=Decimal(binary.signedIntFromBV(bv[61:89]))/Decimal('600000') 221 r['Position_latitude']=Decimal(binary.signedIntFromBV(bv[89:116]))/Decimal('600000') 222 r['COG']=Decimal(int(bv[116:128]))/Decimal('10') 223 r['TimeStamp']=int(bv[128:134]) 224 r['Reserved']=0 225 r['DTE']=bool(int(bv[142:143])) 226 r['Spare']=0 227 r['RAIM']=bool(int(bv[148:149])) 228 r['state_syncstate']=int(bv[149:151]) 229 r['state_slottimeout']=int(bv[151:154]) 230 r['state_slotoffset']=int(bv[154:168]) 231 return r
232
233 -def decodeMessageID(bv, validate=False):
234 return 9
235
236 -def decodeRepeatIndicator(bv, validate=False):
237 return int(bv[6:8])
238
239 -def decodeUserID(bv, validate=False):
240 return int(bv[8:38])
241
242 -def decodeAltitude(bv, validate=False):
243 return int(bv[38:50])
244
245 -def decodeSOG(bv, validate=False):
246 return Decimal(int(bv[50:60]))/Decimal('10')
247
248 -def decodePositionAccuracy(bv, validate=False):
249 return int(bv[60:61])
250
251 -def decodePosition_longitude(bv, validate=False):
252 return Decimal(binary.signedIntFromBV(bv[61:89]))/Decimal('600000')
253
254 -def decodePosition_latitude(bv, validate=False):
255 return Decimal(binary.signedIntFromBV(bv[89:116]))/Decimal('600000')
256
257 -def decodeCOG(bv, validate=False):
258 return Decimal(int(bv[116:128]))/Decimal('10')
259
260 -def decodeTimeStamp(bv, validate=False):
261 return int(bv[128:134])
262
263 -def decodeReserved(bv, validate=False):
264 return 0
265
266 -def decodeDTE(bv, validate=False):
267 return bool(int(bv[142:143]))
268
269 -def decodeSpare(bv, validate=False):
270 return 0
271
272 -def decodeRAIM(bv, validate=False):
273 return bool(int(bv[148:149]))
274
275 -def decodestate_syncstate(bv, validate=False):
276 return int(bv[149:151])
277
278 -def decodestate_slottimeout(bv, validate=False):
279 return int(bv[151:154])
280
281 -def decodestate_slotoffset(bv, validate=False):
282 return int(bv[154:168])
283 284
285 -def printHtml(params, out=sys.stdout):
286 out.write("<h3>SARposition<h3>\n") 287 out.write("<table border=\"1\">\n") 288 out.write("<tr bgcolor=\"orange\">\n") 289 out.write("<th align=\"left\">Field Name</th>\n") 290 out.write("<th align=\"left\">Type</th>\n") 291 out.write("<th align=\"left\">Value</th>\n") 292 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 293 out.write("<th align=\"left\">Units</th>\n") 294 out.write("\n") 295 out.write("<tr>\n") 296 out.write("<td>MessageID</td>\n") 297 out.write("<td>uint</td>\n") 298 if 'MessageID' in params: 299 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 300 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 301 out.write("</tr>\n") 302 out.write("\n") 303 out.write("<tr>\n") 304 out.write("<td>RepeatIndicator</td>\n") 305 out.write("<td>uint</td>\n") 306 if 'RepeatIndicator' in params: 307 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n") 308 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut: 309 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>") 310 else: 311 out.write("<td><i>Missing LUT entry</i></td>") 312 out.write("</tr>\n") 313 out.write("\n") 314 out.write("<tr>\n") 315 out.write("<td>UserID</td>\n") 316 out.write("<td>uint</td>\n") 317 if 'UserID' in params: 318 out.write(" <td>"+str(params['UserID'])+"</td>\n") 319 out.write(" <td>"+str(params['UserID'])+"</td>\n") 320 out.write("</tr>\n") 321 out.write("\n") 322 out.write("<tr>\n") 323 out.write("<td>Altitude</td>\n") 324 out.write("<td>uint</td>\n") 325 if 'Altitude' in params: 326 out.write(" <td>"+str(params['Altitude'])+"</td>\n") 327 if str(params['Altitude']) in AltitudeDecodeLut: 328 out.write("<td>"+AltitudeDecodeLut[str(params['Altitude'])]+"</td>") 329 else: 330 out.write("<td><i>Missing LUT entry</i></td>") 331 out.write("<td>meters</td>\n") 332 out.write("</tr>\n") 333 out.write("\n") 334 out.write("<tr>\n") 335 out.write("<td>SOG</td>\n") 336 out.write("<td>udecimal</td>\n") 337 if 'SOG' in params: 338 out.write(" <td>"+str(params['SOG'])+"</td>\n") 339 if str(params['SOG']) in SOGDecodeLut: 340 out.write("<td>"+SOGDecodeLut[str(params['SOG'])]+"</td>") 341 else: 342 out.write("<td><i>Missing LUT entry</i></td>") 343 out.write("<td>knots</td>\n") 344 out.write("</tr>\n") 345 out.write("\n") 346 out.write("<tr>\n") 347 out.write("<td>PositionAccuracy</td>\n") 348 out.write("<td>uint</td>\n") 349 if 'PositionAccuracy' in params: 350 out.write(" <td>"+str(params['PositionAccuracy'])+"</td>\n") 351 if str(params['PositionAccuracy']) in PositionAccuracyDecodeLut: 352 out.write("<td>"+PositionAccuracyDecodeLut[str(params['PositionAccuracy'])]+"</td>") 353 else: 354 out.write("<td><i>Missing LUT entry</i></td>") 355 out.write("</tr>\n") 356 out.write("\n") 357 out.write("<tr>\n") 358 out.write("<td>Position_longitude</td>\n") 359 out.write("<td>decimal</td>\n") 360 if 'Position_longitude' in params: 361 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n") 362 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n") 363 out.write("<td>degrees</td>\n") 364 out.write("</tr>\n") 365 out.write("\n") 366 out.write("<tr>\n") 367 out.write("<td>Position_latitude</td>\n") 368 out.write("<td>decimal</td>\n") 369 if 'Position_latitude' in params: 370 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n") 371 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n") 372 out.write("<td>degrees</td>\n") 373 out.write("</tr>\n") 374 out.write("\n") 375 out.write("<tr>\n") 376 out.write("<td>COG</td>\n") 377 out.write("<td>udecimal</td>\n") 378 if 'COG' in params: 379 out.write(" <td>"+str(params['COG'])+"</td>\n") 380 out.write(" <td>"+str(params['COG'])+"</td>\n") 381 out.write("<td>degrees</td>\n") 382 out.write("</tr>\n") 383 out.write("\n") 384 out.write("<tr>\n") 385 out.write("<td>TimeStamp</td>\n") 386 out.write("<td>uint</td>\n") 387 if 'TimeStamp' in params: 388 out.write(" <td>"+str(params['TimeStamp'])+"</td>\n") 389 if str(params['TimeStamp']) in TimeStampDecodeLut: 390 out.write("<td>"+TimeStampDecodeLut[str(params['TimeStamp'])]+"</td>") 391 else: 392 out.write("<td><i>Missing LUT entry</i></td>") 393 out.write("<td>seconds</td>\n") 394 out.write("</tr>\n") 395 out.write("\n") 396 out.write("<tr>\n") 397 out.write("<td>Reserved</td>\n") 398 out.write("<td>uint</td>\n") 399 if 'Reserved' in params: 400 out.write(" <td>"+str(params['Reserved'])+"</td>\n") 401 out.write(" <td>"+str(params['Reserved'])+"</td>\n") 402 out.write("</tr>\n") 403 out.write("\n") 404 out.write("<tr>\n") 405 out.write("<td>DTE</td>\n") 406 out.write("<td>bool</td>\n") 407 if 'DTE' in params: 408 out.write(" <td>"+str(params['DTE'])+"</td>\n") 409 out.write(" <td>"+str(params['DTE'])+"</td>\n") 410 out.write("</tr>\n") 411 out.write("\n") 412 out.write("<tr>\n") 413 out.write("<td>Spare</td>\n") 414 out.write("<td>uint</td>\n") 415 if 'Spare' in params: 416 out.write(" <td>"+str(params['Spare'])+"</td>\n") 417 out.write(" <td>"+str(params['Spare'])+"</td>\n") 418 out.write("</tr>\n") 419 out.write("\n") 420 out.write("<tr>\n") 421 out.write("<td>RAIM</td>\n") 422 out.write("<td>bool</td>\n") 423 if 'RAIM' in params: 424 out.write(" <td>"+str(params['RAIM'])+"</td>\n") 425 if str(params['RAIM']) in RAIMDecodeLut: 426 out.write("<td>"+RAIMDecodeLut[str(params['RAIM'])]+"</td>") 427 else: 428 out.write("<td><i>Missing LUT entry</i></td>") 429 out.write("</tr>\n") 430 out.write("\n") 431 out.write("<tr>\n") 432 out.write("<td>state_syncstate</td>\n") 433 out.write("<td>uint</td>\n") 434 if 'state_syncstate' in params: 435 out.write(" <td>"+str(params['state_syncstate'])+"</td>\n") 436 if str(params['state_syncstate']) in state_syncstateDecodeLut: 437 out.write("<td>"+state_syncstateDecodeLut[str(params['state_syncstate'])]+"</td>") 438 else: 439 out.write("<td><i>Missing LUT entry</i></td>") 440 out.write("</tr>\n") 441 out.write("\n") 442 out.write("<tr>\n") 443 out.write("<td>state_slottimeout</td>\n") 444 out.write("<td>uint</td>\n") 445 if 'state_slottimeout' in params: 446 out.write(" <td>"+str(params['state_slottimeout'])+"</td>\n") 447 if str(params['state_slottimeout']) in state_slottimeoutDecodeLut: 448 out.write("<td>"+state_slottimeoutDecodeLut[str(params['state_slottimeout'])]+"</td>") 449 else: 450 out.write("<td><i>Missing LUT entry</i></td>") 451 out.write("<td>frames</td>\n") 452 out.write("</tr>\n") 453 out.write("\n") 454 out.write("<tr>\n") 455 out.write("<td>state_slotoffset</td>\n") 456 out.write("<td>uint</td>\n") 457 if 'state_slotoffset' in params: 458 out.write(" <td>"+str(params['state_slotoffset'])+"</td>\n") 459 out.write(" <td>"+str(params['state_slotoffset'])+"</td>\n") 460 out.write("</tr>\n") 461 out.write("</table>\n")
462 463
464 -def printKml(params, out=sys.stdout):
465 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer''' 466 out.write("\ <Placemark>\n") 467 out.write("\t <name>"+str(params['UserID'])+"</name>\n") 468 out.write("\t\t<description>\n") 469 import StringIO 470 buf = StringIO.StringIO() 471 printHtml(params,buf) 472 import cgi 473 out.write(cgi.escape(buf.getvalue())) 474 out.write("\t\t</description>\n") 475 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n") 476 out.write("\t\t<Point>\n") 477 out.write("\t\t\t<coordinates>") 478 out.write(str(params['Position_longitude'])) 479 out.write(',') 480 out.write(str(params['Position_latitude'])) 481 out.write(",0</coordinates>\n") 482 out.write("\t\t</Point>\n") 483 out.write("\t</Placemark>\n")
484
485 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):
486 '''Print a SARposition message to stdout. 487 488 Fields in params: 489 - MessageID(uint): AIS message number. Must be 9 (field automatically set to "9") 490 - RepeatIndicator(uint): Indicated how many times a message has been repeated 491 - UserID(uint): Unique ship identification number (MMSI) 492 - Altitude(uint): Altitude (GNSS) 493 - SOG(udecimal): Speed over ground 494 - PositionAccuracy(uint): Accuracy of positioning fixes 495 - Position_longitude(decimal): Location of the vessel East West location 496 - Position_latitude(decimal): Location of the vessel North South location 497 - COG(udecimal): Course over ground 498 - TimeStamp(uint): UTC second when the report was generated 499 - Reserved(uint): Reserved for regional applications. Should be set to zero. (field automatically set to "0") 500 - DTE(bool): Dtta terminal ready 501 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 502 - RAIM(bool): Receiver autonomous integrity monitoring flag 503 - state_syncstate(uint): Communications State - SOTDMA Sycronization state 504 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected 505 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN 506 @param params: Dictionary of field names/values. 507 @param out: File like object to write to 508 @rtype: stdout 509 @return: text to out 510 ''' 511 512 if 'std'==format: 513 out.write("SARposition:\n") 514 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n") 515 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n") 516 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n") 517 if 'Altitude' in params: out.write(" Altitude: "+str(params['Altitude'])+"\n") 518 if 'SOG' in params: out.write(" SOG: "+str(params['SOG'])+"\n") 519 if 'PositionAccuracy' in params: out.write(" PositionAccuracy: "+str(params['PositionAccuracy'])+"\n") 520 if 'Position_longitude' in params: out.write(" Position_longitude: "+str(params['Position_longitude'])+"\n") 521 if 'Position_latitude' in params: out.write(" Position_latitude: "+str(params['Position_latitude'])+"\n") 522 if 'COG' in params: out.write(" COG: "+str(params['COG'])+"\n") 523 if 'TimeStamp' in params: out.write(" TimeStamp: "+str(params['TimeStamp'])+"\n") 524 if 'Reserved' in params: out.write(" Reserved: "+str(params['Reserved'])+"\n") 525 if 'DTE' in params: out.write(" DTE: "+str(params['DTE'])+"\n") 526 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n") 527 if 'RAIM' in params: out.write(" RAIM: "+str(params['RAIM'])+"\n") 528 if 'state_syncstate' in params: out.write(" state_syncstate: "+str(params['state_syncstate'])+"\n") 529 if 'state_slottimeout' in params: out.write(" state_slottimeout: "+str(params['state_slottimeout'])+"\n") 530 if 'state_slotoffset' in params: out.write(" state_slotoffset: "+str(params['state_slotoffset'])+"\n") 531 elif 'csv'==format: 532 if None == options.fieldList: 533 options.fieldList = fieldList 534 needComma = False; 535 for field in fieldList: 536 if needComma: out.write(',') 537 needComma = True 538 if field in params: 539 out.write(str(params[field])) 540 # else: leave it empty 541 out.write("\n") 542 elif 'html'==format: 543 printHtml(params,out) 544 elif 'sql'==format: 545 sqlInsertStr(params,out,dbType=dbType) 546 elif 'kml'==format: 547 printKml(params,out) 548 elif 'kml-full'==format: 549 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n") 550 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n") 551 out.write("<Document>\n") 552 out.write(" <name>SARposition</name>\n") 553 printKml(params,out) 554 out.write("</Document>\n") 555 out.write("</kml>\n") 556 else: 557 print "ERROR: unknown format:",format 558 assert False 559 560 return # Nothing to return
561 562 RepeatIndicatorEncodeLut = { 563 'default':'0', 564 'do not repeat any more':'3', 565 } #RepeatIndicatorEncodeLut 566 567 RepeatIndicatorDecodeLut = { 568 '0':'default', 569 '3':'do not repeat any more', 570 } # RepeatIndicatorEncodeLut 571 572 AltitudeEncodeLut = { 573 '4095 or higher':'4095', 574 } #AltitudeEncodeLut 575 576 AltitudeDecodeLut = { 577 '4095':'4095 or higher', 578 } # AltitudeEncodeLut 579 580 SOGEncodeLut = { 581 '102.2 knots or higher':'102.2', 582 } #SOGEncodeLut 583 584 SOGDecodeLut = { 585 '102.2':'102.2 knots or higher', 586 } # SOGEncodeLut 587 588 PositionAccuracyEncodeLut = { 589 'low (greater than 10 m)':'0', 590 'high (less than 10 m)':'1', 591 } #PositionAccuracyEncodeLut 592 593 PositionAccuracyDecodeLut = { 594 '0':'low (greater than 10 m)', 595 '1':'high (less than 10 m)', 596 } # PositionAccuracyEncodeLut 597 598 TimeStampEncodeLut = { 599 'not available/default':'60', 600 'manual input':'61', 601 'dead reckoning':'62', 602 'inoperative':'63', 603 } #TimeStampEncodeLut 604 605 TimeStampDecodeLut = { 606 '60':'not available/default', 607 '61':'manual input', 608 '62':'dead reckoning', 609 '63':'inoperative', 610 } # TimeStampEncodeLut 611 612 RAIMEncodeLut = { 613 'not in use':'False', 614 'in use':'True', 615 } #RAIMEncodeLut 616 617 RAIMDecodeLut = { 618 'False':'not in use', 619 'True':'in use', 620 } # RAIMEncodeLut 621 622 state_syncstateEncodeLut = { 623 'UTC direct':'0', 624 'UTC indirect':'1', 625 'synchronized to a base station':'2', 626 'synchronized to another station':'3', 627 } #state_syncstateEncodeLut 628 629 state_syncstateDecodeLut = { 630 '0':'UTC direct', 631 '1':'UTC indirect', 632 '2':'synchronized to a base station', 633 '3':'synchronized to another station', 634 } # state_syncstateEncodeLut 635 636 state_slottimeoutEncodeLut = { 637 'Last frame in this slot':'0', 638 '1 frames left':'1', 639 '2 frames left':'2', 640 '3 frames left':'3', 641 '4 frames left':'4', 642 '5 frames left':'5', 643 '6 frames left':'6', 644 '7 frames left':'7', 645 } #state_slottimeoutEncodeLut 646 647 state_slottimeoutDecodeLut = { 648 '0':'Last frame in this slot', 649 '1':'1 frames left', 650 '2':'2 frames left', 651 '3':'3 frames left', 652 '4':'4 frames left', 653 '5':'5 frames left', 654 '6':'6 frames left', 655 '7':'7 frames left', 656 } # state_slottimeoutEncodeLut 657 658 ###################################################################### 659 # SQL SUPPORT 660 ###################################################################### 661
662 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 663 ,addCoastGuardFields=True 664 ,dbType='postgres' 665 ):
666 ''' 667 Return the SQL CREATE command for this message type 668 @param outfile: file like object to print to. 669 @param fields: which fields to put in the create. Defaults to all. 670 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 671 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 672 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 673 @type addCoastGuardFields: bool 674 @return: sql create string 675 @rtype: str 676 677 @see: sqlCreate 678 ''' 679 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
680
681 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
682 ''' 683 Return the sqlhelp object to create the table. 684 685 @param fields: which fields to put in the create. Defaults to all. 686 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 687 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 688 @type addCoastGuardFields: bool 689 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 690 @return: An object that can be used to generate a return 691 @rtype: sqlhelp.create 692 ''' 693 if None == fields: fields = fieldList 694 import sqlhelp 695 c = sqlhelp.create('SARposition',dbType=dbType) 696 c.addPrimaryKey() 697 if 'MessageID' in fields: c.addInt ('MessageID') 698 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator') 699 if 'UserID' in fields: c.addInt ('UserID') 700 if 'Altitude' in fields: c.addInt ('Altitude') 701 if 'SOG' in fields: c.addDecimal('SOG',4,1) 702 if 'PositionAccuracy' in fields: c.addInt ('PositionAccuracy') 703 if dbType != 'postgres': 704 if 'Position_longitude' in fields: c.addDecimal('Position_longitude',8,5) 705 if dbType != 'postgres': 706 if 'Position_latitude' in fields: c.addDecimal('Position_latitude',8,5) 707 if 'COG' in fields: c.addDecimal('COG',4,1) 708 if 'TimeStamp' in fields: c.addInt ('TimeStamp') 709 if 'Reserved' in fields: c.addInt ('Reserved') 710 if 'DTE' in fields: c.addBool('DTE') 711 if 'Spare' in fields: c.addInt ('Spare') 712 if 'RAIM' in fields: c.addBool('RAIM') 713 if 'state_syncstate' in fields: c.addInt ('state_syncstate') 714 if 'state_slottimeout' in fields: c.addInt ('state_slottimeout') 715 if 'state_slotoffset' in fields: c.addInt ('state_slotoffset') 716 717 if addCoastGuardFields: 718 # c.addInt('cg_rssi') # Relative signal strength indicator 719 # c.addInt('cg_d') # dBm receive strength 720 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 721 # c.addInt('cg_S') # Slot received in 722 # c.addVarChar('cg_x',10) # Idonno 723 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 724 c.addInt('cg_sec') # UTC seconds since the epoch 725 726 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 727 728 if dbType == 'postgres': 729 c.addPostGIS('Position','POINT',2); 730 731 return c
732
733 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
734 ''' 735 Return the SQL INSERT command for this message type 736 @param params: dictionary of values keyed by field name 737 @param outfile: file like object to print to. 738 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 739 @return: sql create string 740 @rtype: str 741 742 @see: sqlCreate 743 ''' 744 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
745 746
747 -def sqlInsert(params,extraParams=None,dbType='postgres'):
748 ''' 749 Give the SQL INSERT statement 750 @param params: dict keyed by field name of values 751 @param extraParams: any extra fields that you have created beyond the normal ais message fields 752 @rtype: sqlhelp.insert 753 @return: insert class instance 754 @todo: allow optional type checking of params? 755 @warning: this will take invalid keys happily and do what??? 756 ''' 757 import sqlhelp 758 i = sqlhelp.insert('SARposition',dbType=dbType) 759 760 if dbType=='postgres': 761 finished = [] 762 for key in params: 763 if key in finished: 764 continue 765 766 if key not in toPgFields and key not in fromPgFields: 767 if type(params[key])==Decimal: i.add(key,float(params[key])) 768 else: i.add(key,params[key]) 769 else: 770 if key in fromPgFields: 771 val = params[key] 772 # Had better be a WKT type like POINT(-88.1 30.321) 773 i.addPostGIS(key,val) 774 finished.append(key) 775 else: 776 # Need to construct the type. 777 pgName = toPgFields[key] 778 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 779 valStr=pgTypes[pgName]+'(' 780 vals = [] 781 for nonPgKey in fromPgFields[pgName]: 782 vals.append(str(params[nonPgKey])) 783 finished.append(nonPgKey) 784 valStr+=' '.join(vals)+')' 785 i.addPostGIS(pgName,valStr) 786 else: 787 for key in params: 788 if type(params[key])==Decimal: i.add(key,float(params[key])) 789 else: i.add(key,params[key]) 790 791 if None != extraParams: 792 for key in extraParams: 793 i.add(key,extraParams[key]) 794 795 return i
796 797 798 ###################################################################### 799 # UNIT TESTING 800 ###################################################################### 801 import unittest
802 -def testParams():
803 '''Return a params file base on the testvalue tags. 804 @rtype: dict 805 @return: params based on testvalue tags 806 ''' 807 params = {} 808 params['MessageID'] = 9 809 params['RepeatIndicator'] = 1 810 params['UserID'] = 1193046 811 params['Altitude'] = 1001 812 params['SOG'] = Decimal('101.9') 813 params['PositionAccuracy'] = 1 814 params['Position_longitude'] = Decimal('-122.16328055555556') 815 params['Position_latitude'] = Decimal('37.424458333333334') 816 params['COG'] = Decimal('34.5') 817 params['TimeStamp'] = 35 818 params['Reserved'] = 0 819 params['DTE'] = False 820 params['Spare'] = 0 821 params['RAIM'] = False 822 params['state_syncstate'] = 2 823 params['state_slottimeout'] = 0 824 params['state_slotoffset'] = 1221 825 826 return params
827
828 -class TestSARposition(unittest.TestCase):
829 '''Use testvalue tag text from each type to build test case the SARposition message'''
830 - def testEncodeDecode(self):
831 832 params = testParams() 833 bits = encode(params) 834 r = decode(bits) 835 836 # Check that each parameter came through ok. 837 self.failUnlessEqual(r['MessageID'],params['MessageID']) 838 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator']) 839 self.failUnlessEqual(r['UserID'],params['UserID']) 840 self.failUnlessEqual(r['Altitude'],params['Altitude']) 841 self.failUnlessAlmostEqual(r['SOG'],params['SOG'],1) 842 self.failUnlessEqual(r['PositionAccuracy'],params['PositionAccuracy']) 843 self.failUnlessAlmostEqual(r['Position_longitude'],params['Position_longitude'],5) 844 self.failUnlessAlmostEqual(r['Position_latitude'],params['Position_latitude'],5) 845 self.failUnlessAlmostEqual(r['COG'],params['COG'],1) 846 self.failUnlessEqual(r['TimeStamp'],params['TimeStamp']) 847 self.failUnlessEqual(r['Reserved'],params['Reserved']) 848 self.failUnlessEqual(r['DTE'],params['DTE']) 849 self.failUnlessEqual(r['Spare'],params['Spare']) 850 self.failUnlessEqual(r['RAIM'],params['RAIM']) 851 self.failUnlessEqual(r['state_syncstate'],params['state_syncstate']) 852 self.failUnlessEqual(r['state_slottimeout'],params['state_slottimeout']) 853 self.failUnlessEqual(r['state_slotoffset'],params['state_slotoffset'])
854
855 -def addMsgOptions(parser):
856 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 857 help='decode a "SARposition" AIS message') 858 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 859 help='encode a "SARposition" AIS message') 860 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 861 ,help='Field parameter value [default: %default]') 862 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 863 ,help='Field parameter value [default: %default]') 864 parser.add_option('--Altitude-field', dest='AltitudeField',default=4095,metavar='uint',type='int' 865 ,help='Field parameter value [default: %default]') 866 parser.add_option('--SOG-field', dest='SOGField',default=Decimal('102.3'),metavar='udecimal',type='string' 867 ,help='Field parameter value [default: %default]') 868 parser.add_option('--PositionAccuracy-field', dest='PositionAccuracyField',metavar='uint',type='int' 869 ,help='Field parameter value [default: %default]') 870 parser.add_option('--Position_longitude-field', dest='Position_longitudeField',default=Decimal('181'),metavar='decimal',type='string' 871 ,help='Field parameter value [default: %default]') 872 parser.add_option('--Position_latitude-field', dest='Position_latitudeField',default=Decimal('91'),metavar='decimal',type='string' 873 ,help='Field parameter value [default: %default]') 874 parser.add_option('--COG-field', dest='COGField',default=Decimal('360'),metavar='udecimal',type='string' 875 ,help='Field parameter value [default: %default]') 876 parser.add_option('--TimeStamp-field', dest='TimeStampField',default=60,metavar='uint',type='int' 877 ,help='Field parameter value [default: %default]') 878 parser.add_option('--DTE-field', dest='DTEField',metavar='bool',type='int' 879 ,help='Field parameter value [default: %default]') 880 parser.add_option('--RAIM-field', dest='RAIMField',metavar='bool',type='int' 881 ,help='Field parameter value [default: %default]') 882 parser.add_option('--state_syncstate-field', dest='state_syncstateField',metavar='uint',type='int' 883 ,help='Field parameter value [default: %default]') 884 parser.add_option('--state_slottimeout-field', dest='state_slottimeoutField',metavar='uint',type='int' 885 ,help='Field parameter value [default: %default]') 886 parser.add_option('--state_slotoffset-field', dest='state_slotoffsetField',metavar='uint',type='int' 887 ,help='Field parameter value [default: %default]')
888 889 ############################################################ 890 if __name__=='__main__': 891 892 from optparse import OptionParser 893 parser = OptionParser(usage="%prog [options]", 894 version="%prog "+__version__) 895 896 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 897 help='run the documentation tests') 898 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 899 help='run the unit tests') 900 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 901 help='Make the test output verbose') 902 903 # FIX: remove nmea from binary messages. No way to build the whole packet? 904 # FIX: or build the surrounding msg 8 for a broadcast? 905 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 906 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 907 ,default='nmeapayload' 908 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]') 909 910 911 outputChoices = ('std','html','csv','sql' , 'kml','kml-full') 912 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 913 ,default='std' 914 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 915 916 parser.add_option('-o','--output',dest='outputFileName',default=None, 917 help='Name of the python file to write [default: stdout]') 918 919 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append', 920 choices=fieldList, 921 help='Which fields to include in the output. Currently only for csv output [default: all]') 922 923 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true', 924 help='Print the field name for csv') 925 926 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true', 927 help='Print out an sql create command for the table.') 928 929 dbChoices = ('sqlite','postgres') 930 parser.add_option('-D','--db-type',dest='dbType',default='postgres' 931 ,choices=dbChoices,type='choice' 932 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]') 933 934 addMsgOptions(parser) 935 936 (options,args) = parser.parse_args() 937 success=True 938 939 if options.doctest: 940 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 941 sys.argv= [sys.argv[0]] 942 if options.verbose: sys.argv.append('-v') 943 import doctest 944 numfail,numtests=doctest.testmod() 945 if numfail==0: print 'ok' 946 else: 947 print 'FAILED' 948 success=False 949 950 if not success: sys.exit('Something Failed') 951 del success # Hide success from epydoc 952 953 if options.unittest: 954 sys.argv = [sys.argv[0]] 955 if options.verbose: sys.argv.append('-v') 956 unittest.main() 957 958 outfile = sys.stdout 959 if None!=options.outputFileName: 960 outfile = file(options.outputFileName,'w') 961 962 963 if options.doEncode: 964 # First make sure all non required options are specified 965 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField") 966 if None==options.UserIDField: parser.error("missing value for UserIDField") 967 if None==options.AltitudeField: parser.error("missing value for AltitudeField") 968 if None==options.SOGField: parser.error("missing value for SOGField") 969 if None==options.PositionAccuracyField: parser.error("missing value for PositionAccuracyField") 970 if None==options.Position_longitudeField: parser.error("missing value for Position_longitudeField") 971 if None==options.Position_latitudeField: parser.error("missing value for Position_latitudeField") 972 if None==options.COGField: parser.error("missing value for COGField") 973 if None==options.TimeStampField: parser.error("missing value for TimeStampField") 974 if None==options.DTEField: parser.error("missing value for DTEField") 975 if None==options.RAIMField: parser.error("missing value for RAIMField") 976 if None==options.state_syncstateField: parser.error("missing value for state_syncstateField") 977 if None==options.state_slottimeoutField: parser.error("missing value for state_slottimeoutField") 978 if None==options.state_slotoffsetField: parser.error("missing value for state_slotoffsetField") 979 msgDict={ 980 'MessageID': '9', 981 'RepeatIndicator': options.RepeatIndicatorField, 982 'UserID': options.UserIDField, 983 'Altitude': options.AltitudeField, 984 'SOG': options.SOGField, 985 'PositionAccuracy': options.PositionAccuracyField, 986 'Position_longitude': options.Position_longitudeField, 987 'Position_latitude': options.Position_latitudeField, 988 'COG': options.COGField, 989 'TimeStamp': options.TimeStampField, 990 'Reserved': '0', 991 'DTE': options.DTEField, 992 'Spare': '0', 993 'RAIM': options.RAIMField, 994 'state_syncstate': options.state_syncstateField, 995 'state_slottimeout': options.state_slottimeoutField, 996 'state_slotoffset': options.state_slotoffsetField, 997 } 998 999 bits = encode(msgDict) 1000 if 'binary'==options.ioType: print str(bits) 1001 elif 'nmeapayload'==options.ioType: 1002 # FIX: figure out if this might be necessary at compile time 1003 print "bitLen",len(bits) 1004 bitLen=len(bits) 1005 if bitLen%6!=0: 1006 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 1007 print "result:",binary.bitvectoais6(bits)[0] 1008 1009 1010 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 1011 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 1012 else: sys.exit('ERROR: unknown ioType. Help!') 1013 1014 1015 if options.sqlCreate: 1016 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType) 1017 1018 if options.printCsvfieldList: 1019 # Make a csv separated list of fields that will be displayed for csv 1020 if None == options.fieldList: options.fieldList = fieldList 1021 import StringIO 1022 buf = StringIO.StringIO() 1023 for field in options.fieldList: 1024 buf.write(field+',') 1025 result = buf.getvalue() 1026 if result[-1] == ',': print result[:-1] 1027 else: print result 1028 1029 if options.doDecode: 1030 for msg in args: 1031 bv = None 1032 1033 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'): 1034 # Found nmea 1035 # FIX: do checksum 1036 bv = binary.ais6tobitvec(msg.split(',')[5]) 1037 else: # either binary or nmeapayload... expect mostly nmeapayloads 1038 # assumes that an all 0 and 1 string can not be a nmeapayload 1039 binaryMsg=True 1040 for c in msg: 1041 if c not in ('0','1'): 1042 binaryMsg=False 1043 break 1044 if binaryMsg: 1045 bv = BitVector(bitstring=msg) 1046 else: # nmeapayload 1047 bv = binary.ais6tobitvec(msg) 1048 1049 printFields(decode(bv) 1050 ,out=outfile 1051 ,format=options.outputType 1052 ,fieldList=options.fieldList 1053 ,dbType=options.dbType 1054 ) 1055