ais.ais_msg

1 #!/usr/bin/env python 2 3 __version__ = '$Revision: 4791 $'.split()[1] 4 __date__ = '$Date: 2007-12-04 $'.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 # FIX: should this sqlCreate be the same as in LaTeX (createFuncName) rather than hard coded? 680 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))

681

682 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):

683 ''' 684 Return the sqlhelp object to create the table. 685 686 @param fields: which fields to put in the create. Defaults to all. 687 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 688 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 689 @type addCoastGuardFields: bool 690 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 691 @return: An object that can be used to generate a return 692 @rtype: sqlhelp.create 693 ''' 694 if None == fields: fields = fieldList 695 import sqlhelp 696 c = sqlhelp.create('SARposition',dbType=dbType) 697 c.addPrimaryKey() 698 if 'MessageID' in fields: c.addInt ('MessageID') 699 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator') 700 if 'UserID' in fields: c.addInt ('UserID') 701 if 'Altitude' in fields: c.addInt ('Altitude') 702 if 'SOG' in fields: c.addDecimal('SOG',4,1) 703 if 'PositionAccuracy' in fields: c.addInt ('PositionAccuracy') 704 if dbType != 'postgres': 705 if 'Position_longitude' in fields: c.addDecimal('Position_longitude',8,5) 706 if dbType != 'postgres': 707 if 'Position_latitude' in fields: c.addDecimal('Position_latitude',8,5) 708 if 'COG' in fields: c.addDecimal('COG',4,1) 709 if 'TimeStamp' in fields: c.addInt ('TimeStamp') 710 if 'Reserved' in fields: c.addInt ('Reserved') 711 if 'DTE' in fields: c.addBool('DTE') 712 if 'Spare' in fields: c.addInt ('Spare') 713 if 'RAIM' in fields: c.addBool('RAIM') 714 if 'state_syncstate' in fields: c.addInt ('state_syncstate') 715 if 'state_slottimeout' in fields: c.addInt ('state_slottimeout') 716 if 'state_slotoffset' in fields: c.addInt ('state_slotoffset') 717 718 if addCoastGuardFields: 719 # c.addInt('cg_rssi') # Relative signal strength indicator 720 # c.addInt('cg_d') # dBm receive strength 721 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 722 # c.addInt('cg_S') # Slot received in 723 # c.addVarChar('cg_x',10) # Idonno 724 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 725 c.addInt('cg_sec') # UTC seconds since the epoch 726 727 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 728 729 if dbType == 'postgres': 730 #--- EPSG 4326 : WGS 84 731 #INSERT INTO "spatial_ref_sys" ("srid","auth_name","auth_srid","srtext","proj4text") VALUES (4326,'EPSG',4326,'GEOGCS["WGS 84",DATUM["WGS_1984",SPHEROID["WGS 84",6378137,298.257223563,AUTHORITY["EPSG","7030"]],TOWGS84[0,0,0,0,0,0,0],AUTHORITY["EPSG","6326"]],PRIMEM["Greenwich",0,AUTHORITY["EPSG","8901"]],UNIT["degree",0.01745329251994328,AUTHORITY["EPSG","9122"]],AUTHORITY["EPSG","4326"]]','+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs '); 732 c.addPostGIS('Position','POINT',2,SRID=4326); 733 734 return c

735

736 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):

737 ''' 738 Return the SQL INSERT command for this message type 739 @param params: dictionary of values keyed by field name 740 @param outfile: file like object to print to. 741 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 742 @return: sql create string 743 @rtype: str 744 745 @see: sqlCreate 746 ''' 747 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))

748 749

750 -def sqlInsert(params,extraParams=None,dbType='postgres'):

751 ''' 752 Give the SQL INSERT statement 753 @param params: dict keyed by field name of values 754 @param extraParams: any extra fields that you have created beyond the normal ais message fields 755 @rtype: sqlhelp.insert 756 @return: insert class instance 757 @todo: allow optional type checking of params? 758 @warning: this will take invalid keys happily and do what??? 759 ''' 760 import sqlhelp 761 i = sqlhelp.insert('SARposition',dbType=dbType) 762 763 if dbType=='postgres': 764 finished = [] 765 for key in params: 766 if key in finished: 767 continue 768 769 if key not in toPgFields and key not in fromPgFields: 770 if type(params[key])==Decimal: i.add(key,float(params[key])) 771 else: i.add(key,params[key]) 772 else: 773 if key in fromPgFields: 774 val = params[key] 775 # Had better be a WKT type like POINT(-88.1 30.321) 776 i.addPostGIS(key,val) 777 finished.append(key) 778 else: 779 # Need to construct the type. 780 pgName = toPgFields[key] 781 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 782 valStr=pgTypes[pgName]+'(' 783 vals = [] 784 for nonPgKey in fromPgFields[pgName]: 785 vals.append(str(params[nonPgKey])) 786 finished.append(nonPgKey) 787 valStr+=' '.join(vals)+')' 788 i.addPostGIS(pgName,valStr) 789 else: 790 for key in params: 791 if type(params[key])==Decimal: i.add(key,float(params[key])) 792 else: i.add(key,params[key]) 793 794 if None != extraParams: 795 for key in extraParams: 796 i.add(key,extraParams[key]) 797 798 return i

799 800 ###################################################################### 801 # LATEX SUPPORT 802 ###################################################################### 803

804 -def latexDefinitionTable(outfile=sys.stdout 805 ):

806 ''' 807 Return the LaTeX definition table for this message type 808 @param outfile: file like object to print to. 809 @type outfile: file obj 810 @return: LaTeX table string via the outfile 811 @rtype: str 812 813 ''' 814 o = outfile 815 816 o.write(''' 817 \\begin{table}%[htb] 818 \\centering 819 \\begin{tabular}{|l|c|l|} 820 \\hline 821 Parameter & Number of bits & Description 822 \\\\ \\hline\\hline 823 MessageID & 6 & AIS message number. Must be 9 \\\\ \hline 824 RepeatIndicator & 2 & Indicated how many times a message has been repeated \\\\ \hline 825 UserID & 30 & Unique ship identification number (MMSI) \\\\ \hline 826 Altitude & 12 & Altitude (GNSS) \\\\ \hline 827 SOG & 10 & Speed over ground \\\\ \hline 828 PositionAccuracy & 1 & Accuracy of positioning fixes \\\\ \hline 829 Position\_longitude & 28 & Location of the vessel East West location \\\\ \hline 830 Position\_latitude & 27 & Location of the vessel North South location \\\\ \hline 831 COG & 12 & Course over ground \\\\ \hline 832 TimeStamp & 6 & UTC second when the report was generated \\\\ \hline 833 Reserved & 8 & Reserved for regional applications. Should be set to zero. \\\\ \hline 834 DTE & 1 & Dtta terminal ready \\\\ \hline 835 Spare & 5 & Not used. Should be set to zero. \\\\ \hline 836 RAIM & 1 & Receiver autonomous integrity monitoring flag \\\\ \hline 837 state\_syncstate & 2 & Communications State - SOTDMA Sycronization state \\\\ \hline 838 state\_slottimeout & 3 & Communications State - SOTDMA Frames remaining until a new slot is selected \\\\ \hline 839 state\_slotoffset & 14 & Communications State - SOTDMA In what slot will the next transmission occur. BROKEN\\\\ \\hline \\hline 840 Total bits & 168 & Appears to take 1 slot \\\\ \\hline 841 \\end{tabular} 842 \\caption{AIS message number 9: Search and rescue position report} 843 \\label{tab:SARposition} 844 \\end{table} 845 ''')

846 847 ###################################################################### 848 # Text Definition 849 ###################################################################### 850

851 -def textDefinitionTable(outfile=sys.stdout 852 ,delim='\t' 853 ):

854 ''' 855 Return the text definition table for this message type 856 @param outfile: file like object to print to. 857 @type outfile: file obj 858 @return: text table string via the outfile 859 @rtype: str 860 861 ''' 862 o = outfile 863 o.write('''Parameter'''+delim+'Number of bits'''+delim+'''Description 864 MessageID'''+delim+'''6'''+delim+'''AIS message number. Must be 9 865 RepeatIndicator'''+delim+'''2'''+delim+'''Indicated how many times a message has been repeated 866 UserID'''+delim+'''30'''+delim+'''Unique ship identification number (MMSI) 867 Altitude'''+delim+'''12'''+delim+'''Altitude (GNSS) 868 SOG'''+delim+'''10'''+delim+'''Speed over ground 869 PositionAccuracy'''+delim+'''1'''+delim+'''Accuracy of positioning fixes 870 Position_longitude'''+delim+'''28'''+delim+'''Location of the vessel East West location 871 Position_latitude'''+delim+'''27'''+delim+'''Location of the vessel North South location 872 COG'''+delim+'''12'''+delim+'''Course over ground 873 TimeStamp'''+delim+'''6'''+delim+'''UTC second when the report was generated 874 Reserved'''+delim+'''8'''+delim+'''Reserved for regional applications. Should be set to zero. 875 DTE'''+delim+'''1'''+delim+'''Dtta terminal ready 876 Spare'''+delim+'''5'''+delim+'''Not used. Should be set to zero. 877 RAIM'''+delim+'''1'''+delim+'''Receiver autonomous integrity monitoring flag 878 state_syncstate'''+delim+'''2'''+delim+'''Communications State - SOTDMA Sycronization state 879 state_slottimeout'''+delim+'''3'''+delim+'''Communications State - SOTDMA Frames remaining until a new slot is selected 880 state_slotoffset'''+delim+'''14'''+delim+'''Communications State - SOTDMA In what slot will the next transmission occur. BROKEN 881 Total bits'''+delim+'''168'''+delim+'''Appears to take 1 slot''')

882 883 884 ###################################################################### 885 # UNIT TESTING 886 ###################################################################### 887 import unittest

888 -def testParams():

889 '''Return a params file base on the testvalue tags. 890 @rtype: dict 891 @return: params based on testvalue tags 892 ''' 893 params = {} 894 params['MessageID'] = 9 895 params['RepeatIndicator'] = 1 896 params['UserID'] = 1193046 897 params['Altitude'] = 1001 898 params['SOG'] = Decimal('101.9') 899 params['PositionAccuracy'] = 1 900 params['Position_longitude'] = Decimal('-122.16328055555556') 901 params['Position_latitude'] = Decimal('37.424458333333334') 902 params['COG'] = Decimal('34.5') 903 params['TimeStamp'] = 35 904 params['Reserved'] = 0 905 params['DTE'] = False 906 params['Spare'] = 0 907 params['RAIM'] = False 908 params['state_syncstate'] = 2 909 params['state_slottimeout'] = 0 910 params['state_slotoffset'] = 1221 911 912 return params

913

914 -class TestSARposition(unittest.TestCase):

915 '''Use testvalue tag text from each type to build test case the SARposition message'''

916 - def testEncodeDecode(self):

917 918 params = testParams() 919 bits = encode(params) 920 r = decode(bits) 921 922 # Check that each parameter came through ok. 923 self.failUnlessEqual(r['MessageID'],params['MessageID']) 924 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator']) 925 self.failUnlessEqual(r['UserID'],params['UserID']) 926 self.failUnlessEqual(r['Altitude'],params['Altitude']) 927 self.failUnlessAlmostEqual(r['SOG'],params['SOG'],1) 928 self.failUnlessEqual(r['PositionAccuracy'],params['PositionAccuracy']) 929 self.failUnlessAlmostEqual(r['Position_longitude'],params['Position_longitude'],5) 930 self.failUnlessAlmostEqual(r['Position_latitude'],params['Position_latitude'],5) 931 self.failUnlessAlmostEqual(r['COG'],params['COG'],1) 932 self.failUnlessEqual(r['TimeStamp'],params['TimeStamp']) 933 self.failUnlessEqual(r['Reserved'],params['Reserved']) 934 self.failUnlessEqual(r['DTE'],params['DTE']) 935 self.failUnlessEqual(r['Spare'],params['Spare']) 936 self.failUnlessEqual(r['RAIM'],params['RAIM']) 937 self.failUnlessEqual(r['state_syncstate'],params['state_syncstate']) 938 self.failUnlessEqual(r['state_slottimeout'],params['state_slottimeout']) 939 self.failUnlessEqual(r['state_slotoffset'],params['state_slotoffset'])

940

941 -def addMsgOptions(parser):

942 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 943 help='decode a "SARposition" AIS message') 944 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 945 help='encode a "SARposition" AIS message') 946 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 947 ,help='Field parameter value [default: %default]') 948 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 949 ,help='Field parameter value [default: %default]') 950 parser.add_option('--Altitude-field', dest='AltitudeField',default=4095,metavar='uint',type='int' 951 ,help='Field parameter value [default: %default]') 952 parser.add_option('--SOG-field', dest='SOGField',default=Decimal('102.3'),metavar='udecimal',type='string' 953 ,help='Field parameter value [default: %default]') 954 parser.add_option('--PositionAccuracy-field', dest='PositionAccuracyField',metavar='uint',type='int' 955 ,help='Field parameter value [default: %default]') 956 parser.add_option('--Position_longitude-field', dest='Position_longitudeField',default=Decimal('181'),metavar='decimal',type='string' 957 ,help='Field parameter value [default: %default]') 958 parser.add_option('--Position_latitude-field', dest='Position_latitudeField',default=Decimal('91'),metavar='decimal',type='string' 959 ,help='Field parameter value [default: %default]') 960 parser.add_option('--COG-field', dest='COGField',default=Decimal('360'),metavar='udecimal',type='string' 961 ,help='Field parameter value [default: %default]') 962 parser.add_option('--TimeStamp-field', dest='TimeStampField',default=60,metavar='uint',type='int' 963 ,help='Field parameter value [default: %default]') 964 parser.add_option('--DTE-field', dest='DTEField',metavar='bool',type='int' 965 ,help='Field parameter value [default: %default]') 966 parser.add_option('--RAIM-field', dest='RAIMField',metavar='bool',type='int' 967 ,help='Field parameter value [default: %default]') 968 parser.add_option('--state_syncstate-field', dest='state_syncstateField',metavar='uint',type='int' 969 ,help='Field parameter value [default: %default]') 970 parser.add_option('--state_slottimeout-field', dest='state_slottimeoutField',metavar='uint',type='int' 971 ,help='Field parameter value [default: %default]') 972 parser.add_option('--state_slotoffset-field', dest='state_slotoffsetField',metavar='uint',type='int' 973 ,help='Field parameter value [default: %default]')

974 975 ############################################################ 976 if __name__=='__main__': 977 978 from optparse import OptionParser 979 parser = OptionParser(usage="%prog [options]", 980 version="%prog "+__version__) 981 982 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 983 help='run the documentation tests') 984 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 985 help='run the unit tests') 986 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 987 help='Make the test output verbose') 988 989 # FIX: remove nmea from binary messages. No way to build the whole packet? 990 # FIX: or build the surrounding msg 8 for a broadcast? 991 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 992 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 993 ,default='nmeapayload' 994 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]') 995 996 997 outputChoices = ('std','html','csv','sql' , 'kml','kml-full') 998 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 999 ,default='std' 1000 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 1001 1002 parser.add_option('-o','--output',dest='outputFileName',default=None, 1003 help='Name of the python file to write [default: stdout]') 1004 1005 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append', 1006 choices=fieldList, 1007 help='Which fields to include in the output. Currently only for csv output [default: all]') 1008 1009 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true', 1010 help='Print the field name for csv') 1011 1012 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true', 1013 help='Print out an sql create command for the table.') 1014 1015 parser.add_option('--latex-table',dest='latexDefinitionTable',default=False,action='store_true', 1016 help='Print a LaTeX table of the type') 1017 1018 parser.add_option('--text-table',dest='textDefinitionTable',default=False,action='store_true', 1019 help='Print delimited table of the type (for Word table importing)') 1020 parser.add_option('--delimt-text-table',dest='delimTextDefinitionTable',default='\t' 1021 ,help='Delimiter for text table [default: \'%default\'](for Word table importing)') 1022 1023 1024 dbChoices = ('sqlite','postgres') 1025 parser.add_option('-D','--db-type',dest='dbType',default='postgres' 1026 ,choices=dbChoices,type='choice' 1027 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]') 1028 1029 addMsgOptions(parser) 1030 1031 (options,args) = parser.parse_args() 1032 success=True 1033 1034 if options.doctest: 1035 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 1036 sys.argv= [sys.argv[0]] 1037 if options.verbose: sys.argv.append('-v') 1038 import doctest 1039 numfail,numtests=doctest.testmod() 1040 if numfail==0: print 'ok' 1041 else: 1042 print 'FAILED' 1043 success=False 1044 1045 if not success: sys.exit('Something Failed') 1046 del success # Hide success from epydoc 1047 1048 if options.unittest: 1049 sys.argv = [sys.argv[0]] 1050 if options.verbose: sys.argv.append('-v') 1051 unittest.main() 1052 1053 outfile = sys.stdout 1054 if None!=options.outputFileName: 1055 outfile = file(options.outputFileName,'w') 1056 1057 1058 if options.doEncode: 1059 # First make sure all non required options are specified 1060 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField") 1061 if None==options.UserIDField: parser.error("missing value for UserIDField") 1062 if None==options.AltitudeField: parser.error("missing value for AltitudeField") 1063 if None==options.SOGField: parser.error("missing value for SOGField") 1064 if None==options.PositionAccuracyField: parser.error("missing value for PositionAccuracyField") 1065 if None==options.Position_longitudeField: parser.error("missing value for Position_longitudeField") 1066 if None==options.Position_latitudeField: parser.error("missing value for Position_latitudeField") 1067 if None==options.COGField: parser.error("missing value for COGField") 1068 if None==options.TimeStampField: parser.error("missing value for TimeStampField") 1069 if None==options.DTEField: parser.error("missing value for DTEField") 1070 if None==options.RAIMField: parser.error("missing value for RAIMField") 1071 if None==options.state_syncstateField: parser.error("missing value for state_syncstateField") 1072 if None==options.state_slottimeoutField: parser.error("missing value for state_slottimeoutField") 1073 if None==options.state_slotoffsetField: parser.error("missing value for state_slotoffsetField") 1074 msgDict={ 1075 'MessageID': '9', 1076 'RepeatIndicator': options.RepeatIndicatorField, 1077 'UserID': options.UserIDField, 1078 'Altitude': options.AltitudeField, 1079 'SOG': options.SOGField, 1080 'PositionAccuracy': options.PositionAccuracyField, 1081 'Position_longitude': options.Position_longitudeField, 1082 'Position_latitude': options.Position_latitudeField, 1083 'COG': options.COGField, 1084 'TimeStamp': options.TimeStampField, 1085 'Reserved': '0', 1086 'DTE': options.DTEField, 1087 'Spare': '0', 1088 'RAIM': options.RAIMField, 1089 'state_syncstate': options.state_syncstateField, 1090 'state_slottimeout': options.state_slottimeoutField, 1091 'state_slotoffset': options.state_slotoffsetField, 1092 } 1093 1094 bits = encode(msgDict) 1095 if 'binary'==options.ioType: print str(bits) 1096 elif 'nmeapayload'==options.ioType: 1097 # FIX: figure out if this might be necessary at compile time 1098 print "bitLen",len(bits) 1099 bitLen=len(bits) 1100 if bitLen%6!=0: 1101 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 1102 print "result:",binary.bitvectoais6(bits)[0] 1103 1104 1105 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 1106 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 1107 else: sys.exit('ERROR: unknown ioType. Help!') 1108 1109 1110 if options.sqlCreate: 1111 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType) 1112 1113 if options.latexDefinitionTable: 1114 latexDefinitionTable(outfile) 1115 1116 # For conversion to word tables 1117 if options.textDefinitionTable: 1118 textDefinitionTable(outfile,options.delimTextDefinitionTable) 1119 1120 if options.printCsvfieldList: 1121 # Make a csv separated list of fields that will be displayed for csv 1122 if None == options.fieldList: options.fieldList = fieldList 1123 import StringIO 1124 buf = StringIO.StringIO() 1125 for field in options.fieldList: 1126 buf.write(field+',') 1127 result = buf.getvalue() 1128 if result[-1] == ',': print result[:-1] 1129 else: print result 1130 1131 if options.doDecode: 1132 if len(args)==0: args = sys.stdin 1133 for msg in args: 1134 bv = None 1135 1136 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'): 1137 # Found nmea 1138 # FIX: do checksum 1139 bv = binary.ais6tobitvec(msg.split(',')[5]) 1140 else: # either binary or nmeapayload... expect mostly nmeapayloads 1141 # assumes that an all 0 and 1 string can not be a nmeapayload 1142 binaryMsg=True 1143 for c in msg: 1144 if c not in ('0','1'): 1145 binaryMsg=False 1146 break 1147 if binaryMsg: 1148 bv = BitVector(bitstring=msg) 1149 else: # nmeapayload 1150 bv = binary.ais6tobitvec(msg) 1151 1152 printFields(decode(bv) 1153 ,out=outfile 1154 ,format=options.outputType 1155 ,fieldList=options.fieldList 1156 ,dbType=options.dbType 1157 ) 1158

Source Code for Module ais.ais_msg_9