ais.ais_msg

1 #!/usr/bin/env python 2 3 __version__ = '$Revision: 4791 $'.split()[1] 4 __date__ = '$Date: 2007-03-31 $'.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 'NavigationStatus', 54 'ROT', 55 'SOG', 56 'PositionAccuracy', 57 'Position_longitude', 58 'Position_latitude', 59 'COG', 60 'TrueHeading', 61 'TimeStamp', 62 'RegionalReserved', 63 'Spare', 64 'RAIM', 65 'state_syncstate', 66 'state_slottimeout', 67 'state_slotoffset', 68 ) 69 70 fieldListPostgres = ( 71 'MessageID', 72 'RepeatIndicator', 73 'UserID', 74 'NavigationStatus', 75 'ROT', 76 'SOG', 77 'PositionAccuracy', 78 'Position', # PostGIS data type 79 'COG', 80 'TrueHeading', 81 'TimeStamp', 82 'RegionalReserved', 83 'Spare', 84 'RAIM', 85 'state_syncstate', 86 'state_slottimeout', 87 'state_slotoffset', 88 ) 89 90 toPgFields = { 91 'Position_longitude':'Position', 92 'Position_latitude':'Position', 93 } 94 ''' 95 Go to the Postgis field names from the straight field name 96 ''' 97 98 fromPgFields = { 99 'Position':('Position_longitude','Position_latitude',), 100 } 101 ''' 102 Go from the Postgis field names to the straight field name 103 ''' 104 105 pgTypes = { 106 'Position':'POINT', 107 } 108 ''' 109 Lookup table for each postgis field name to get its type. 110 ''' 111

112 -def encode(params, validate=False):

113 '''Create a position binary message payload to pack into an AIS Msg position. 114 115 Fields in params: 116 - MessageID(uint): AIS message number. Must be 1 (field automatically set to "3") 117 - RepeatIndicator(uint): Indicated how many times a message has been repeated 118 - UserID(uint): Unique ship identification number (MMSI) 119 - NavigationStatus(uint): What is the vessel doing 120 - ROT(int): RateOfTurn 121 - SOG(udecimal): Speed over ground 122 - PositionAccuracy(uint): Accuracy of positioning fixes 123 - Position_longitude(decimal): Location of the vessel East West location 124 - Position_latitude(decimal): Location of the vessel North South location 125 - COG(udecimal): Course over ground 126 - TrueHeading(uint): True heading (relative to true North) 127 - TimeStamp(uint): UTC second when the report was generated 128 - RegionalReserved(uint): Reserved for definition by a regional authority. (field automatically set to "0") 129 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 130 - RAIM(bool): Receiver autonomous integrity monitoring flag 131 - state_syncstate(uint): Communications State - SOTDMA Sycronization state 132 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected 133 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN 134 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing 135 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 136 @rtype: BitVector 137 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8 138 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits. 139 ''' 140 141 bvList = [] 142 bvList.append(binary.setBitVectorSize(BitVector(intVal=3),6)) 143 if 'RepeatIndicator' in params: 144 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2)) 145 else: 146 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 147 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30)) 148 if 'NavigationStatus' in params: 149 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['NavigationStatus']),4)) 150 else: 151 bvList.append(binary.setBitVectorSize(BitVector(intVal=15),4)) 152 if 'ROT' in params: 153 bvList.append(binary.bvFromSignedInt(params['ROT'],8)) 154 else: 155 bvList.append(binary.bvFromSignedInt(-128,8)) 156 if 'SOG' in params: 157 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['SOG'])*Decimal('10')))),10)) 158 else: 159 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(1023)),10)) 160 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['PositionAccuracy']),1)) 161 if 'Position_longitude' in params: 162 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_longitude'])*Decimal('600000')),28)) 163 else: 164 bvList.append(binary.bvFromSignedInt(108600000,28)) 165 if 'Position_latitude' in params: 166 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_latitude'])*Decimal('600000')),27)) 167 else: 168 bvList.append(binary.bvFromSignedInt(54600000,27)) 169 if 'COG' in params: 170 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['COG'])*Decimal('10')))),12)) 171 else: 172 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(3600)),12)) 173 if 'TrueHeading' in params: 174 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['TrueHeading']),9)) 175 else: 176 bvList.append(binary.setBitVectorSize(BitVector(intVal=511),9)) 177 if 'TimeStamp' in params: 178 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['TimeStamp']),6)) 179 else: 180 bvList.append(binary.setBitVectorSize(BitVector(intVal=60),6)) 181 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4)) 182 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),1)) 183 if params["RAIM"]: bvList.append(TrueBV) 184 else: bvList.append(FalseBV) 185 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_syncstate']),2)) 186 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_slottimeout']),3)) 187 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_slotoffset']),14)) 188 189 return binary.joinBV(bvList)

190

191 -def decode(bv, validate=False):

192 '''Unpack a position message 193 194 Fields in params: 195 - MessageID(uint): AIS message number. Must be 1 (field automatically set to "3") 196 - RepeatIndicator(uint): Indicated how many times a message has been repeated 197 - UserID(uint): Unique ship identification number (MMSI) 198 - NavigationStatus(uint): What is the vessel doing 199 - ROT(int): RateOfTurn 200 - SOG(udecimal): Speed over ground 201 - PositionAccuracy(uint): Accuracy of positioning fixes 202 - Position_longitude(decimal): Location of the vessel East West location 203 - Position_latitude(decimal): Location of the vessel North South location 204 - COG(udecimal): Course over ground 205 - TrueHeading(uint): True heading (relative to true North) 206 - TimeStamp(uint): UTC second when the report was generated 207 - RegionalReserved(uint): Reserved for definition by a regional authority. (field automatically set to "0") 208 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 209 - RAIM(bool): Receiver autonomous integrity monitoring flag 210 - state_syncstate(uint): Communications State - SOTDMA Sycronization state 211 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected 212 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN 213 @type bv: BitVector 214 @param bv: Bits defining a message 215 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 216 @rtype: dict 217 @return: params 218 ''' 219 220 #Would be nice to check the bit count here.. 221 #if validate: 222 # assert (len(bv)==FIX: SOME NUMBER) 223 r = {} 224 r['MessageID']=3 225 r['RepeatIndicator']=int(bv[6:8]) 226 r['UserID']=int(bv[8:38]) 227 r['NavigationStatus']=int(bv[38:42]) 228 r['ROT']=binary.signedIntFromBV(bv[42:50]) 229 r['SOG']=Decimal(int(bv[50:60]))/Decimal('10') 230 r['PositionAccuracy']=int(bv[60:61]) 231 r['Position_longitude']=Decimal(binary.signedIntFromBV(bv[61:89]))/Decimal('600000') 232 r['Position_latitude']=Decimal(binary.signedIntFromBV(bv[89:116]))/Decimal('600000') 233 r['COG']=Decimal(int(bv[116:128]))/Decimal('10') 234 r['TrueHeading']=int(bv[128:137]) 235 r['TimeStamp']=int(bv[137:143]) 236 r['RegionalReserved']=0 237 r['Spare']=0 238 r['RAIM']=bool(int(bv[148:149])) 239 r['state_syncstate']=int(bv[149:151]) 240 r['state_slottimeout']=int(bv[151:154]) 241 r['state_slotoffset']=int(bv[154:168]) 242 return r

243

244 -def decodeMessageID(bv, validate=False):

245 return 3

246

247 -def decodeRepeatIndicator(bv, validate=False):

248 return int(bv[6:8])

249

250 -def decodeUserID(bv, validate=False):

251 return int(bv[8:38])

252

253 -def decodeNavigationStatus(bv, validate=False):

254 return int(bv[38:42])

255

256 -def decodeROT(bv, validate=False):

257 return binary.signedIntFromBV(bv[42:50])

258

259 -def decodeSOG(bv, validate=False):

260 return Decimal(int(bv[50:60]))/Decimal('10')

261

262 -def decodePositionAccuracy(bv, validate=False):

263 return int(bv[60:61])

264

265 -def decodePosition_longitude(bv, validate=False):

266 return Decimal(binary.signedIntFromBV(bv[61:89]))/Decimal('600000')

267

268 -def decodePosition_latitude(bv, validate=False):

269 return Decimal(binary.signedIntFromBV(bv[89:116]))/Decimal('600000')

270

271 -def decodeCOG(bv, validate=False):

272 return Decimal(int(bv[116:128]))/Decimal('10')

273

274 -def decodeTrueHeading(bv, validate=False):

275 return int(bv[128:137])

276

277 -def decodeTimeStamp(bv, validate=False):

278 return int(bv[137:143])

279

280 -def decodeRegionalReserved(bv, validate=False):

281 return 0

282

283 -def decodeSpare(bv, validate=False):

284 return 0

285

286 -def decodeRAIM(bv, validate=False):

287 return bool(int(bv[148:149]))

288

289 -def decodestate_syncstate(bv, validate=False):

290 return int(bv[149:151])

291

292 -def decodestate_slottimeout(bv, validate=False):

293 return int(bv[151:154])

294

295 -def decodestate_slotoffset(bv, validate=False):

296 return int(bv[154:168])

297 298

299 -def printHtml(params, out=sys.stdout):

300 out.write("<h3>position<h3>\n") 301 out.write("<table border=\"1\">\n") 302 out.write("<tr bgcolor=\"orange\">\n") 303 out.write("<th align=\"left\">Field Name</th>\n") 304 out.write("<th align=\"left\">Type</th>\n") 305 out.write("<th align=\"left\">Value</th>\n") 306 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 307 out.write("<th align=\"left\">Units</th>\n") 308 out.write("\n") 309 out.write("<tr>\n") 310 out.write("<td>MessageID</td>\n") 311 out.write("<td>uint</td>\n") 312 if 'MessageID' in params: 313 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 314 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 315 out.write("</tr>\n") 316 out.write("\n") 317 out.write("<tr>\n") 318 out.write("<td>RepeatIndicator</td>\n") 319 out.write("<td>uint</td>\n") 320 if 'RepeatIndicator' in params: 321 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n") 322 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut: 323 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>") 324 else: 325 out.write("<td><i>Missing LUT entry</i></td>") 326 out.write("</tr>\n") 327 out.write("\n") 328 out.write("<tr>\n") 329 out.write("<td>UserID</td>\n") 330 out.write("<td>uint</td>\n") 331 if 'UserID' in params: 332 out.write(" <td>"+str(params['UserID'])+"</td>\n") 333 out.write(" <td>"+str(params['UserID'])+"</td>\n") 334 out.write("</tr>\n") 335 out.write("\n") 336 out.write("<tr>\n") 337 out.write("<td>NavigationStatus</td>\n") 338 out.write("<td>uint</td>\n") 339 if 'NavigationStatus' in params: 340 out.write(" <td>"+str(params['NavigationStatus'])+"</td>\n") 341 if str(params['NavigationStatus']) in NavigationStatusDecodeLut: 342 out.write("<td>"+NavigationStatusDecodeLut[str(params['NavigationStatus'])]+"</td>") 343 else: 344 out.write("<td><i>Missing LUT entry</i></td>") 345 out.write("</tr>\n") 346 out.write("\n") 347 out.write("<tr>\n") 348 out.write("<td>ROT</td>\n") 349 out.write("<td>int</td>\n") 350 if 'ROT' in params: 351 out.write(" <td>"+str(params['ROT'])+"</td>\n") 352 out.write(" <td>"+str(params['ROT'])+"</td>\n") 353 out.write("<td>4.733*sqrt(val) degrees/min</td>\n") 354 out.write("</tr>\n") 355 out.write("\n") 356 out.write("<tr>\n") 357 out.write("<td>SOG</td>\n") 358 out.write("<td>udecimal</td>\n") 359 if 'SOG' in params: 360 out.write(" <td>"+str(params['SOG'])+"</td>\n") 361 if str(params['SOG']) in SOGDecodeLut: 362 out.write("<td>"+SOGDecodeLut[str(params['SOG'])]+"</td>") 363 else: 364 out.write("<td><i>Missing LUT entry</i></td>") 365 out.write("<td>knots</td>\n") 366 out.write("</tr>\n") 367 out.write("\n") 368 out.write("<tr>\n") 369 out.write("<td>PositionAccuracy</td>\n") 370 out.write("<td>uint</td>\n") 371 if 'PositionAccuracy' in params: 372 out.write(" <td>"+str(params['PositionAccuracy'])+"</td>\n") 373 if str(params['PositionAccuracy']) in PositionAccuracyDecodeLut: 374 out.write("<td>"+PositionAccuracyDecodeLut[str(params['PositionAccuracy'])]+"</td>") 375 else: 376 out.write("<td><i>Missing LUT entry</i></td>") 377 out.write("</tr>\n") 378 out.write("\n") 379 out.write("<tr>\n") 380 out.write("<td>Position_longitude</td>\n") 381 out.write("<td>decimal</td>\n") 382 if 'Position_longitude' in params: 383 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n") 384 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n") 385 out.write("<td>degrees</td>\n") 386 out.write("</tr>\n") 387 out.write("\n") 388 out.write("<tr>\n") 389 out.write("<td>Position_latitude</td>\n") 390 out.write("<td>decimal</td>\n") 391 if 'Position_latitude' in params: 392 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n") 393 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n") 394 out.write("<td>degrees</td>\n") 395 out.write("</tr>\n") 396 out.write("\n") 397 out.write("<tr>\n") 398 out.write("<td>COG</td>\n") 399 out.write("<td>udecimal</td>\n") 400 if 'COG' in params: 401 out.write(" <td>"+str(params['COG'])+"</td>\n") 402 out.write(" <td>"+str(params['COG'])+"</td>\n") 403 out.write("<td>degrees</td>\n") 404 out.write("</tr>\n") 405 out.write("\n") 406 out.write("<tr>\n") 407 out.write("<td>TrueHeading</td>\n") 408 out.write("<td>uint</td>\n") 409 if 'TrueHeading' in params: 410 out.write(" <td>"+str(params['TrueHeading'])+"</td>\n") 411 out.write(" <td>"+str(params['TrueHeading'])+"</td>\n") 412 out.write("<td>degrees</td>\n") 413 out.write("</tr>\n") 414 out.write("\n") 415 out.write("<tr>\n") 416 out.write("<td>TimeStamp</td>\n") 417 out.write("<td>uint</td>\n") 418 if 'TimeStamp' in params: 419 out.write(" <td>"+str(params['TimeStamp'])+"</td>\n") 420 if str(params['TimeStamp']) in TimeStampDecodeLut: 421 out.write("<td>"+TimeStampDecodeLut[str(params['TimeStamp'])]+"</td>") 422 else: 423 out.write("<td><i>Missing LUT entry</i></td>") 424 out.write("<td>seconds</td>\n") 425 out.write("</tr>\n") 426 out.write("\n") 427 out.write("<tr>\n") 428 out.write("<td>RegionalReserved</td>\n") 429 out.write("<td>uint</td>\n") 430 if 'RegionalReserved' in params: 431 out.write(" <td>"+str(params['RegionalReserved'])+"</td>\n") 432 out.write(" <td>"+str(params['RegionalReserved'])+"</td>\n") 433 out.write("</tr>\n") 434 out.write("\n") 435 out.write("<tr>\n") 436 out.write("<td>Spare</td>\n") 437 out.write("<td>uint</td>\n") 438 if 'Spare' in params: 439 out.write(" <td>"+str(params['Spare'])+"</td>\n") 440 out.write(" <td>"+str(params['Spare'])+"</td>\n") 441 out.write("</tr>\n") 442 out.write("\n") 443 out.write("<tr>\n") 444 out.write("<td>RAIM</td>\n") 445 out.write("<td>bool</td>\n") 446 if 'RAIM' in params: 447 out.write(" <td>"+str(params['RAIM'])+"</td>\n") 448 if str(params['RAIM']) in RAIMDecodeLut: 449 out.write("<td>"+RAIMDecodeLut[str(params['RAIM'])]+"</td>") 450 else: 451 out.write("<td><i>Missing LUT entry</i></td>") 452 out.write("</tr>\n") 453 out.write("\n") 454 out.write("<tr>\n") 455 out.write("<td>state_syncstate</td>\n") 456 out.write("<td>uint</td>\n") 457 if 'state_syncstate' in params: 458 out.write(" <td>"+str(params['state_syncstate'])+"</td>\n") 459 if str(params['state_syncstate']) in state_syncstateDecodeLut: 460 out.write("<td>"+state_syncstateDecodeLut[str(params['state_syncstate'])]+"</td>") 461 else: 462 out.write("<td><i>Missing LUT entry</i></td>") 463 out.write("</tr>\n") 464 out.write("\n") 465 out.write("<tr>\n") 466 out.write("<td>state_slottimeout</td>\n") 467 out.write("<td>uint</td>\n") 468 if 'state_slottimeout' in params: 469 out.write(" <td>"+str(params['state_slottimeout'])+"</td>\n") 470 if str(params['state_slottimeout']) in state_slottimeoutDecodeLut: 471 out.write("<td>"+state_slottimeoutDecodeLut[str(params['state_slottimeout'])]+"</td>") 472 else: 473 out.write("<td><i>Missing LUT entry</i></td>") 474 out.write("<td>frames</td>\n") 475 out.write("</tr>\n") 476 out.write("\n") 477 out.write("<tr>\n") 478 out.write("<td>state_slotoffset</td>\n") 479 out.write("<td>uint</td>\n") 480 if 'state_slotoffset' in params: 481 out.write(" <td>"+str(params['state_slotoffset'])+"</td>\n") 482 out.write(" <td>"+str(params['state_slotoffset'])+"</td>\n") 483 out.write("</tr>\n") 484 out.write("</table>\n")

485 486

487 -def printKml(params, out=sys.stdout):

488 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer''' 489 out.write("\ <Placemark>\n") 490 out.write("\t <name>"+str(params['UserID'])+"</name>\n") 491 out.write("\t\t<description>\n") 492 import StringIO 493 buf = StringIO.StringIO() 494 printHtml(params,buf) 495 import cgi 496 out.write(cgi.escape(buf.getvalue())) 497 out.write("\t\t</description>\n") 498 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n") 499 out.write("\t\t<Point>\n") 500 out.write("\t\t\t<coordinates>") 501 out.write(str(params['Position_longitude'])) 502 out.write(',') 503 out.write(str(params['Position_latitude'])) 504 out.write(",0</coordinates>\n") 505 out.write("\t\t</Point>\n") 506 out.write("\t</Placemark>\n")

507

508 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):

509 '''Print a position message to stdout. 510 511 Fields in params: 512 - MessageID(uint): AIS message number. Must be 1 (field automatically set to "3") 513 - RepeatIndicator(uint): Indicated how many times a message has been repeated 514 - UserID(uint): Unique ship identification number (MMSI) 515 - NavigationStatus(uint): What is the vessel doing 516 - ROT(int): RateOfTurn 517 - SOG(udecimal): Speed over ground 518 - PositionAccuracy(uint): Accuracy of positioning fixes 519 - Position_longitude(decimal): Location of the vessel East West location 520 - Position_latitude(decimal): Location of the vessel North South location 521 - COG(udecimal): Course over ground 522 - TrueHeading(uint): True heading (relative to true North) 523 - TimeStamp(uint): UTC second when the report was generated 524 - RegionalReserved(uint): Reserved for definition by a regional authority. (field automatically set to "0") 525 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 526 - RAIM(bool): Receiver autonomous integrity monitoring flag 527 - state_syncstate(uint): Communications State - SOTDMA Sycronization state 528 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected 529 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN 530 @param params: Dictionary of field names/values. 531 @param out: File like object to write to 532 @rtype: stdout 533 @return: text to out 534 ''' 535 536 if 'std'==format: 537 out.write("position:\n") 538 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n") 539 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n") 540 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n") 541 if 'NavigationStatus' in params: out.write(" NavigationStatus: "+str(params['NavigationStatus'])+"\n") 542 if 'ROT' in params: out.write(" ROT: "+str(params['ROT'])+"\n") 543 if 'SOG' in params: out.write(" SOG: "+str(params['SOG'])+"\n") 544 if 'PositionAccuracy' in params: out.write(" PositionAccuracy: "+str(params['PositionAccuracy'])+"\n") 545 if 'Position_longitude' in params: out.write(" Position_longitude: "+str(params['Position_longitude'])+"\n") 546 if 'Position_latitude' in params: out.write(" Position_latitude: "+str(params['Position_latitude'])+"\n") 547 if 'COG' in params: out.write(" COG: "+str(params['COG'])+"\n") 548 if 'TrueHeading' in params: out.write(" TrueHeading: "+str(params['TrueHeading'])+"\n") 549 if 'TimeStamp' in params: out.write(" TimeStamp: "+str(params['TimeStamp'])+"\n") 550 if 'RegionalReserved' in params: out.write(" RegionalReserved: "+str(params['RegionalReserved'])+"\n") 551 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n") 552 if 'RAIM' in params: out.write(" RAIM: "+str(params['RAIM'])+"\n") 553 if 'state_syncstate' in params: out.write(" state_syncstate: "+str(params['state_syncstate'])+"\n") 554 if 'state_slottimeout' in params: out.write(" state_slottimeout: "+str(params['state_slottimeout'])+"\n") 555 if 'state_slotoffset' in params: out.write(" state_slotoffset: "+str(params['state_slotoffset'])+"\n") 556 elif 'csv'==format: 557 if None == options.fieldList: 558 options.fieldList = fieldList 559 needComma = False; 560 for field in fieldList: 561 if needComma: out.write(',') 562 needComma = True 563 if field in params: 564 out.write(str(params[field])) 565 # else: leave it empty 566 out.write("\n") 567 elif 'html'==format: 568 printHtml(params,out) 569 elif 'sql'==format: 570 sqlInsertStr(params,out,dbType=dbType) 571 elif 'kml'==format: 572 printKml(params,out) 573 elif 'kml-full'==format: 574 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n") 575 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n") 576 out.write("<Document>\n") 577 out.write(" <name>position</name>\n") 578 printKml(params,out) 579 out.write("</Document>\n") 580 out.write("</kml>\n") 581 else: 582 print "ERROR: unknown format:",format 583 assert False 584 585 return # Nothing to return

586 587 RepeatIndicatorEncodeLut = { 588 'default':'0', 589 'do not repeat any more':'3', 590 } #RepeatIndicatorEncodeLut 591 592 RepeatIndicatorDecodeLut = { 593 '0':'default', 594 '3':'do not repeat any more', 595 } # RepeatIndicatorEncodeLut 596 597 NavigationStatusEncodeLut = { 598 'under way using engine':'0', 599 'at anchor':'1', 600 'not under command':'2', 601 'restricted maneuverability':'3', 602 'constrained by her draught':'4', 603 'moored':'5', 604 'aground':'6', 605 'engaged in fishing':'7', 606 'under way sailing':'8', 607 'reserved for future use (hazmat)':'9', 608 'reserved for future use':'10', 609 'reserved for future use':'11', 610 'reserved for future use':'12', 611 'reserved for future use':'13', 612 'reserved for future use':'14', 613 'not defined = default':'15', 614 } #NavigationStatusEncodeLut 615 616 NavigationStatusDecodeLut = { 617 '0':'under way using engine', 618 '1':'at anchor', 619 '2':'not under command', 620 '3':'restricted maneuverability', 621 '4':'constrained by her draught', 622 '5':'moored', 623 '6':'aground', 624 '7':'engaged in fishing', 625 '8':'under way sailing', 626 '9':'reserved for future use (hazmat)', 627 '10':'reserved for future use', 628 '11':'reserved for future use', 629 '12':'reserved for future use', 630 '13':'reserved for future use', 631 '14':'reserved for future use', 632 '15':'not defined = default', 633 } # NavigationStatusEncodeLut 634 635 SOGEncodeLut = { 636 '102.2 knots or higher':'102.2', 637 } #SOGEncodeLut 638 639 SOGDecodeLut = { 640 '102.2':'102.2 knots or higher', 641 } # SOGEncodeLut 642 643 PositionAccuracyEncodeLut = { 644 'low (greater than 10 m)':'0', 645 'high (less than 10 m)':'1', 646 } #PositionAccuracyEncodeLut 647 648 PositionAccuracyDecodeLut = { 649 '0':'low (greater than 10 m)', 650 '1':'high (less than 10 m)', 651 } # PositionAccuracyEncodeLut 652 653 TimeStampEncodeLut = { 654 'not available/default':'60', 655 'manual input':'61', 656 'dead reckoning':'62', 657 'inoperative':'63', 658 } #TimeStampEncodeLut 659 660 TimeStampDecodeLut = { 661 '60':'not available/default', 662 '61':'manual input', 663 '62':'dead reckoning', 664 '63':'inoperative', 665 } # TimeStampEncodeLut 666 667 RAIMEncodeLut = { 668 'not in use':'False', 669 'in use':'True', 670 } #RAIMEncodeLut 671 672 RAIMDecodeLut = { 673 'False':'not in use', 674 'True':'in use', 675 } # RAIMEncodeLut 676 677 state_syncstateEncodeLut = { 678 'UTC direct':'0', 679 'UTC indirect':'1', 680 'synchronized to a base station':'2', 681 'synchronized to another station':'3', 682 } #state_syncstateEncodeLut 683 684 state_syncstateDecodeLut = { 685 '0':'UTC direct', 686 '1':'UTC indirect', 687 '2':'synchronized to a base station', 688 '3':'synchronized to another station', 689 } # state_syncstateEncodeLut 690 691 state_slottimeoutEncodeLut = { 692 'Last frame in this slot':'0', 693 '1 frames left':'1', 694 '2 frames left':'2', 695 '3 frames left':'3', 696 '4 frames left':'4', 697 '5 frames left':'5', 698 '6 frames left':'6', 699 '7 frames left':'7', 700 } #state_slottimeoutEncodeLut 701 702 state_slottimeoutDecodeLut = { 703 '0':'Last frame in this slot', 704 '1':'1 frames left', 705 '2':'2 frames left', 706 '3':'3 frames left', 707 '4':'4 frames left', 708 '5':'5 frames left', 709 '6':'6 frames left', 710 '7':'7 frames left', 711 } # state_slottimeoutEncodeLut 712 713 ###################################################################### 714 # SQL SUPPORT 715 ###################################################################### 716

717 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 718 ,addCoastGuardFields=True 719 ,dbType='postgres' 720 ):

721 ''' 722 Return the SQL CREATE command for this message type 723 @param outfile: file like object to print to. 724 @param fields: which fields to put in the create. Defaults to all. 725 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 726 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 727 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 728 @type addCoastGuardFields: bool 729 @return: sql create string 730 @rtype: str 731 732 @see: sqlCreate 733 ''' 734 # FIX: should this sqlCreate be the same as in LaTeX (createFuncName) rather than hard coded? 735 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))

736

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

738 ''' 739 Return the sqlhelp object to create the table. 740 741 @param fields: which fields to put in the create. Defaults to all. 742 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 743 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 744 @type addCoastGuardFields: bool 745 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 746 @return: An object that can be used to generate a return 747 @rtype: sqlhelp.create 748 ''' 749 if None == fields: fields = fieldList 750 import sqlhelp 751 c = sqlhelp.create('position',dbType=dbType) 752 c.addPrimaryKey() 753 if 'MessageID' in fields: c.addInt ('MessageID') 754 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator') 755 if 'UserID' in fields: c.addInt ('UserID') 756 if 'NavigationStatus' in fields: c.addInt ('NavigationStatus') 757 if 'ROT' in fields: c.addInt ('ROT') 758 if 'SOG' in fields: c.addDecimal('SOG',4,1) 759 if 'PositionAccuracy' in fields: c.addInt ('PositionAccuracy') 760 if dbType != 'postgres': 761 if 'Position_longitude' in fields: c.addDecimal('Position_longitude',8,5) 762 if dbType != 'postgres': 763 if 'Position_latitude' in fields: c.addDecimal('Position_latitude',8,5) 764 if 'COG' in fields: c.addDecimal('COG',4,1) 765 if 'TrueHeading' in fields: c.addInt ('TrueHeading') 766 if 'TimeStamp' in fields: c.addInt ('TimeStamp') 767 if 'RegionalReserved' in fields: c.addInt ('RegionalReserved') 768 if 'Spare' in fields: c.addInt ('Spare') 769 if 'RAIM' in fields: c.addBool('RAIM') 770 if 'state_syncstate' in fields: c.addInt ('state_syncstate') 771 if 'state_slottimeout' in fields: c.addInt ('state_slottimeout') 772 if 'state_slotoffset' in fields: c.addInt ('state_slotoffset') 773 774 if addCoastGuardFields: 775 # c.addInt('cg_rssi') # Relative signal strength indicator 776 # c.addInt('cg_d') # dBm receive strength 777 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 778 # c.addInt('cg_S') # Slot received in 779 # c.addVarChar('cg_x',10) # Idonno 780 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 781 c.addInt('cg_sec') # UTC seconds since the epoch 782 783 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 784 785 if dbType == 'postgres': 786 c.addPostGIS('Position','POINT',2); 787 788 return c

789

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

791 ''' 792 Return the SQL INSERT command for this message type 793 @param params: dictionary of values keyed by field name 794 @param outfile: file like object to print to. 795 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 796 @return: sql create string 797 @rtype: str 798 799 @see: sqlCreate 800 ''' 801 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))

802 803

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

805 ''' 806 Give the SQL INSERT statement 807 @param params: dict keyed by field name of values 808 @param extraParams: any extra fields that you have created beyond the normal ais message fields 809 @rtype: sqlhelp.insert 810 @return: insert class instance 811 @todo: allow optional type checking of params? 812 @warning: this will take invalid keys happily and do what??? 813 ''' 814 import sqlhelp 815 i = sqlhelp.insert('position',dbType=dbType) 816 817 if dbType=='postgres': 818 finished = [] 819 for key in params: 820 if key in finished: 821 continue 822 823 if key not in toPgFields and key not in fromPgFields: 824 if type(params[key])==Decimal: i.add(key,float(params[key])) 825 else: i.add(key,params[key]) 826 else: 827 if key in fromPgFields: 828 val = params[key] 829 # Had better be a WKT type like POINT(-88.1 30.321) 830 i.addPostGIS(key,val) 831 finished.append(key) 832 else: 833 # Need to construct the type. 834 pgName = toPgFields[key] 835 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 836 valStr=pgTypes[pgName]+'(' 837 vals = [] 838 for nonPgKey in fromPgFields[pgName]: 839 vals.append(str(params[nonPgKey])) 840 finished.append(nonPgKey) 841 valStr+=' '.join(vals)+')' 842 i.addPostGIS(pgName,valStr) 843 else: 844 for key in params: 845 if type(params[key])==Decimal: i.add(key,float(params[key])) 846 else: i.add(key,params[key]) 847 848 if None != extraParams: 849 for key in extraParams: 850 i.add(key,extraParams[key]) 851 852 return i

853 854 ###################################################################### 855 # LATEX SUPPORT 856 ###################################################################### 857

858 -def latexDefinitionTable(outfile=sys.stdout 859 ):

860 ''' 861 Return the LaTeX definition table for this message type 862 @param outfile: file like object to print to. 863 @type outfile: file obj 864 @return: LaTeX table string via the outfile 865 @rtype: str 866 867 ''' 868 o = outfile 869 870 o.write(''' 871 \\begin{table}%[htb] 872 \\centering 873 \\begin{tabular}{|l|c|l|} 874 \\hline 875 Parameter & Number of bits & Description 876 \\\\ \\hline\\hline 877 MessageID & 6 & AIS message number. Must be 1 \\\\ \hline 878 RepeatIndicator & 2 & Indicated how many times a message has been repeated \\\\ \hline 879 UserID & 30 & Unique ship identification number (MMSI) \\\\ \hline 880 NavigationStatus & 4 & What is the vessel doing \\\\ \hline 881 ROT & 8 & Rate of turning. Positive right; negative left. BROKEN! \\\\ \hline 882 SOG & 10 & Speed over ground \\\\ \hline 883 PositionAccuracy & 1 & Accuracy of positioning fixes \\\\ \hline 884 Position\_longitude & 28 & Location of the vessel East West location \\\\ \hline 885 Position\_latitude & 27 & Location of the vessel North South location \\\\ \hline 886 COG & 12 & Course over ground \\\\ \hline 887 TrueHeading & 9 & True heading (relative to true North) \\\\ \hline 888 TimeStamp & 6 & UTC second when the report was generated \\\\ \hline 889 RegionalReserved & 4 & Reserved for definition by a regional authority. \\\\ \hline 890 Spare & 1 & Not used. Should be set to zero. \\\\ \hline 891 RAIM & 1 & Receiver autonomous integrity monitoring flag \\\\ \hline 892 state\_syncstate & 2 & Communications State - SOTDMA Sycronization state \\\\ \hline 893 state\_slottimeout & 3 & Communications State - SOTDMA Frames remaining until a new slot is selected \\\\ \hline 894 state\_slotoffset & 14 & Communications State - SOTDMA In what slot will the next transmission occur. BROKEN\\\\ \\hline \\hline 895 Total bits & 168 & Appears to take 1 slot \\\\ \\hline 896 \\end{tabular} 897 \\caption{AIS message number 3: Scheduled position report} 898 \\label{tab:position} 899 \\end{table} 900 ''')

901 902 903 ###################################################################### 904 # UNIT TESTING 905 ###################################################################### 906 import unittest

907 -def testParams():

908 '''Return a params file base on the testvalue tags. 909 @rtype: dict 910 @return: params based on testvalue tags 911 ''' 912 params = {} 913 params['MessageID'] = 3 914 params['RepeatIndicator'] = 1 915 params['UserID'] = 1193046 916 params['NavigationStatus'] = 3 917 params['ROT'] = -2 918 params['SOG'] = Decimal('101.9') 919 params['PositionAccuracy'] = 1 920 params['Position_longitude'] = Decimal('-122.16328055555556') 921 params['Position_latitude'] = Decimal('37.424458333333334') 922 params['COG'] = Decimal('34.5') 923 params['TrueHeading'] = 41 924 params['TimeStamp'] = 35 925 params['RegionalReserved'] = 0 926 params['Spare'] = 0 927 params['RAIM'] = False 928 params['state_syncstate'] = 2 929 params['state_slottimeout'] = 0 930 params['state_slotoffset'] = 1221 931 932 return params

933

934 -class Testposition(unittest.TestCase):

935 '''Use testvalue tag text from each type to build test case the position message'''

936 - def testEncodeDecode(self):

937 938 params = testParams() 939 bits = encode(params) 940 r = decode(bits) 941 942 # Check that each parameter came through ok. 943 self.failUnlessEqual(r['MessageID'],params['MessageID']) 944 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator']) 945 self.failUnlessEqual(r['UserID'],params['UserID']) 946 self.failUnlessEqual(r['NavigationStatus'],params['NavigationStatus']) 947 self.failUnlessEqual(r['ROT'],params['ROT']) 948 self.failUnlessAlmostEqual(r['SOG'],params['SOG'],1) 949 self.failUnlessEqual(r['PositionAccuracy'],params['PositionAccuracy']) 950 self.failUnlessAlmostEqual(r['Position_longitude'],params['Position_longitude'],5) 951 self.failUnlessAlmostEqual(r['Position_latitude'],params['Position_latitude'],5) 952 self.failUnlessAlmostEqual(r['COG'],params['COG'],1) 953 self.failUnlessEqual(r['TrueHeading'],params['TrueHeading']) 954 self.failUnlessEqual(r['TimeStamp'],params['TimeStamp']) 955 self.failUnlessEqual(r['RegionalReserved'],params['RegionalReserved']) 956 self.failUnlessEqual(r['Spare'],params['Spare']) 957 self.failUnlessEqual(r['RAIM'],params['RAIM']) 958 self.failUnlessEqual(r['state_syncstate'],params['state_syncstate']) 959 self.failUnlessEqual(r['state_slottimeout'],params['state_slottimeout']) 960 self.failUnlessEqual(r['state_slotoffset'],params['state_slotoffset'])

961

962 -def addMsgOptions(parser):

963 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 964 help='decode a "position" AIS message') 965 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 966 help='encode a "position" AIS message') 967 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 968 ,help='Field parameter value [default: %default]') 969 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 970 ,help='Field parameter value [default: %default]') 971 parser.add_option('--NavigationStatus-field', dest='NavigationStatusField',default=15,metavar='uint',type='int' 972 ,help='Field parameter value [default: %default]') 973 parser.add_option('--ROT-field', dest='ROTField',default=-128,metavar='int',type='int' 974 ,help='Field parameter value [default: %default]') 975 parser.add_option('--SOG-field', dest='SOGField',default=Decimal('102.3'),metavar='udecimal',type='string' 976 ,help='Field parameter value [default: %default]') 977 parser.add_option('--PositionAccuracy-field', dest='PositionAccuracyField',metavar='uint',type='int' 978 ,help='Field parameter value [default: %default]') 979 parser.add_option('--Position_longitude-field', dest='Position_longitudeField',default=Decimal('181'),metavar='decimal',type='string' 980 ,help='Field parameter value [default: %default]') 981 parser.add_option('--Position_latitude-field', dest='Position_latitudeField',default=Decimal('91'),metavar='decimal',type='string' 982 ,help='Field parameter value [default: %default]') 983 parser.add_option('--COG-field', dest='COGField',default=Decimal('360'),metavar='udecimal',type='string' 984 ,help='Field parameter value [default: %default]') 985 parser.add_option('--TrueHeading-field', dest='TrueHeadingField',default=511,metavar='uint',type='int' 986 ,help='Field parameter value [default: %default]') 987 parser.add_option('--TimeStamp-field', dest='TimeStampField',default=60,metavar='uint',type='int' 988 ,help='Field parameter value [default: %default]') 989 parser.add_option('--RAIM-field', dest='RAIMField',metavar='bool',type='int' 990 ,help='Field parameter value [default: %default]') 991 parser.add_option('--state_syncstate-field', dest='state_syncstateField',metavar='uint',type='int' 992 ,help='Field parameter value [default: %default]') 993 parser.add_option('--state_slottimeout-field', dest='state_slottimeoutField',metavar='uint',type='int' 994 ,help='Field parameter value [default: %default]') 995 parser.add_option('--state_slotoffset-field', dest='state_slotoffsetField',metavar='uint',type='int' 996 ,help='Field parameter value [default: %default]')

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

Source Code for Module ais.ais_msg_3