ais.ais_msg

1 #!/usr/bin/env python 2 3 __version__ = '$Revision: 4791 $'.split()[1] 4 __date__ = '$Date: 2008-01-09 $'.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 'Spare', 54 'offset1', 55 'numslots1', 56 'timeout1', 57 'increment1', 58 'offset2', 59 'numslots2', 60 'timeout2', 61 'increment2', 62 'offset3', 63 'numslots3', 64 'timeout3', 65 'increment3', 66 'offset4', 67 'numslots4', 68 'timeout4', 69 'increment4', 70 'variablespare', 71 ) 72 73 fieldListPostgres = ( 74 'MessageID', 75 'RepeatIndicator', 76 'UserID', 77 'Spare', 78 'offset1', 79 'numslots1', 80 'timeout1', 81 'increment1', 82 'offset2', 83 'numslots2', 84 'timeout2', 85 'increment2', 86 'offset3', 87 'numslots3', 88 'timeout3', 89 'increment3', 90 'offset4', 91 'numslots4', 92 'timeout4', 93 'increment4', 94 'variablespare', 95 ) 96 97 toPgFields = { 98 } 99 ''' 100 Go to the Postgis field names from the straight field name 101 ''' 102 103 fromPgFields = { 104 } 105 ''' 106 Go from the Postgis field names to the straight field name 107 ''' 108 109 pgTypes = { 110 } 111 ''' 112 Lookup table for each postgis field name to get its type. 113 ''' 114

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

116 '''Create a datalinkmng binary message payload to pack into an AIS Msg datalinkmng. 117 118 Fields in params: 119 - MessageID(uint): AIS message number. Must be 20 (field automatically set to "20") 120 - RepeatIndicator(uint): Indicated how many times a message has been repeated 121 - UserID(uint): Unique ship identification number (MMSI) 122 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 123 - offset1(uint): Reserved offset number 124 - numslots1(uint): Number of reserved consecutive slots 125 - timeout1(uint): Time-out value in minutes 126 - increment1(uint): Increment to repeast reservation of this block 127 - offset2(uint): Reserved offset number (optional) 128 - numslots2(uint): Number of reserved consecutive slots (optional) 129 - timeout2(uint): Time-out value in minutes (optional) 130 - increment2(uint): Increment to repeast reservation of this block (optional) 131 - offset3(uint): Reserved offset number (optional) 132 - numslots3(uint): Number of reserved consecutive slots (optional) 133 - timeout3(uint): Time-out value in minutes (optional) 134 - increment3(uint): Increment to repeast reservation of this block (optional) 135 - offset4(uint): Reserved offset number (optional) 136 - numslots4(uint): Number of reserved consecutive slots (optional) 137 - timeout4(uint): Time-out value in minutes (optional) 138 - increment4(uint): Increment to repeast reservation of this block (optional) 139 - variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0") 140 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing 141 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 142 @rtype: BitVector 143 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8 144 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits. 145 ''' 146 147 bvList = [] 148 bvList.append(binary.setBitVectorSize(BitVector(intVal=20),6)) 149 if 'RepeatIndicator' in params: 150 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2)) 151 else: 152 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 153 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30)) 154 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 155 if 'offset1' in params: 156 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset1']),12)) 157 else: 158 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12)) 159 if 'numslots1' in params: 160 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots1']),4)) 161 else: 162 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4)) 163 if 'timeout1' in params: 164 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout1']),3)) 165 else: 166 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3)) 167 if 'increment1' in params: 168 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment1']),11)) 169 else: 170 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11)) 171 if 'offset2' in params: 172 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset2']),12)) 173 else: 174 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12)) 175 if 'numslots2' in params: 176 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots2']),4)) 177 else: 178 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4)) 179 if 'timeout2' in params: 180 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout2']),3)) 181 else: 182 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3)) 183 if 'increment2' in params: 184 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment2']),11)) 185 else: 186 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11)) 187 if 'offset3' in params: 188 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset3']),12)) 189 else: 190 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12)) 191 if 'numslots3' in params: 192 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots3']),4)) 193 else: 194 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4)) 195 if 'timeout3' in params: 196 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout3']),3)) 197 else: 198 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3)) 199 if 'increment3' in params: 200 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment3']),11)) 201 else: 202 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11)) 203 if 'offset4' in params: 204 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['offset4']),12)) 205 else: 206 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),12)) 207 if 'numslots4' in params: 208 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['numslots4']),4)) 209 else: 210 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4)) 211 if 'timeout4' in params: 212 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['timeout4']),3)) 213 else: 214 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),3)) 215 if 'increment4' in params: 216 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['increment4']),11)) 217 else: 218 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),11)) 219 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),6)) 220 221 return binary.joinBV(bvList)

222

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

224 '''Unpack a datalinkmng message 225 226 Fields in params: 227 - MessageID(uint): AIS message number. Must be 20 (field automatically set to "20") 228 - RepeatIndicator(uint): Indicated how many times a message has been repeated 229 - UserID(uint): Unique ship identification number (MMSI) 230 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 231 - offset1(uint): Reserved offset number 232 - numslots1(uint): Number of reserved consecutive slots 233 - timeout1(uint): Time-out value in minutes 234 - increment1(uint): Increment to repeast reservation of this block 235 - offset2(uint): Reserved offset number (optional) 236 - numslots2(uint): Number of reserved consecutive slots (optional) 237 - timeout2(uint): Time-out value in minutes (optional) 238 - increment2(uint): Increment to repeast reservation of this block (optional) 239 - offset3(uint): Reserved offset number (optional) 240 - numslots3(uint): Number of reserved consecutive slots (optional) 241 - timeout3(uint): Time-out value in minutes (optional) 242 - increment3(uint): Increment to repeast reservation of this block (optional) 243 - offset4(uint): Reserved offset number (optional) 244 - numslots4(uint): Number of reserved consecutive slots (optional) 245 - timeout4(uint): Time-out value in minutes (optional) 246 - increment4(uint): Increment to repeast reservation of this block (optional) 247 - variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0") 248 @type bv: BitVector 249 @param bv: Bits defining a message 250 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 251 @rtype: dict 252 @return: params 253 ''' 254 255 #Would be nice to check the bit count here.. 256 #if validate: 257 # assert (len(bv)==FIX: SOME NUMBER) 258 r = {} 259 r['MessageID']=20 260 r['RepeatIndicator']=int(bv[6:8]) 261 r['UserID']=int(bv[8:38]) 262 r['Spare']=0 263 r['offset1']=int(bv[40:52]) 264 r['numslots1']=int(bv[52:56]) 265 r['timeout1']=int(bv[56:59]) 266 r['increment1']=int(bv[59:70]) 267 if len(bv)<=72: return r; # All fields below are optional 268 r['offset2']=int(bv[70:82]) 269 r['numslots2']=int(bv[82:86]) 270 r['timeout2']=int(bv[86:89]) 271 r['increment2']=int(bv[89:100]) 272 if len(bv)<=104: return r; # All fields below are optional 273 r['offset3']=int(bv[100:112]) 274 r['numslots3']=int(bv[112:116]) 275 r['timeout3']=int(bv[116:119]) 276 r['increment3']=int(bv[119:130]) 277 if len(bv)<=136: return r; # All fields below are optional 278 r['offset4']=int(bv[130:142]) 279 r['numslots4']=int(bv[142:146]) 280 r['timeout4']=int(bv[146:149]) 281 r['increment4']=int(bv[149:160]) 282 r['variablespare']=0 283 return r

284

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

286 return 20

287

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

289 return int(bv[6:8])

290

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

292 return int(bv[8:38])

293

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

295 return 0

296

297 -def decodeoffset1(bv, validate=False):

298 return int(bv[40:52])

299

300 -def decodenumslots1(bv, validate=False):

301 return int(bv[52:56])

302

303 -def decodetimeout1(bv, validate=False):

304 return int(bv[56:59])

305

306 -def decodeincrement1(bv, validate=False):

307 return int(bv[59:70])

308

309 -def decodeoffset2(bv, validate=False):

310 return int(bv[70:82])

311

312 -def decodenumslots2(bv, validate=False):

313 return int(bv[82:86])

314

315 -def decodetimeout2(bv, validate=False):

316 return int(bv[86:89])

317

318 -def decodeincrement2(bv, validate=False):

319 return int(bv[89:100])

320

321 -def decodeoffset3(bv, validate=False):

322 return int(bv[100:112])

323

324 -def decodenumslots3(bv, validate=False):

325 return int(bv[112:116])

326

327 -def decodetimeout3(bv, validate=False):

328 return int(bv[116:119])

329

330 -def decodeincrement3(bv, validate=False):

331 return int(bv[119:130])

332

333 -def decodeoffset4(bv, validate=False):

334 return int(bv[130:142])

335

336 -def decodenumslots4(bv, validate=False):

337 return int(bv[142:146])

338

339 -def decodetimeout4(bv, validate=False):

340 return int(bv[146:149])

341

342 -def decodeincrement4(bv, validate=False):

343 return int(bv[149:160])

344

345 -def decodevariablespare(bv, validate=False):

346 return 0

347 348

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

350 out.write("<h3>datalinkmng</h3>\n") 351 out.write("<table border=\"1\">\n") 352 out.write("<tr bgcolor=\"orange\">\n") 353 out.write("<th align=\"left\">Field Name</th>\n") 354 out.write("<th align=\"left\">Type</th>\n") 355 out.write("<th align=\"left\">Value</th>\n") 356 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 357 out.write("<th align=\"left\">Units</th>\n") 358 out.write("\n") 359 out.write("<tr>\n") 360 out.write("<td>MessageID</td>\n") 361 out.write("<td>uint</td>\n") 362 if 'MessageID' in params: 363 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 364 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 365 out.write("</tr>\n") 366 out.write("\n") 367 out.write("<tr>\n") 368 out.write("<td>RepeatIndicator</td>\n") 369 out.write("<td>uint</td>\n") 370 if 'RepeatIndicator' in params: 371 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n") 372 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut: 373 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>") 374 else: 375 out.write("<td><i>Missing LUT entry</i></td>") 376 out.write("</tr>\n") 377 out.write("\n") 378 out.write("<tr>\n") 379 out.write("<td>UserID</td>\n") 380 out.write("<td>uint</td>\n") 381 if 'UserID' in params: 382 out.write(" <td>"+str(params['UserID'])+"</td>\n") 383 out.write(" <td>"+str(params['UserID'])+"</td>\n") 384 out.write("</tr>\n") 385 out.write("\n") 386 out.write("<tr>\n") 387 out.write("<td>Spare</td>\n") 388 out.write("<td>uint</td>\n") 389 if 'Spare' in params: 390 out.write(" <td>"+str(params['Spare'])+"</td>\n") 391 out.write(" <td>"+str(params['Spare'])+"</td>\n") 392 out.write("</tr>\n") 393 out.write("\n") 394 out.write("<tr>\n") 395 out.write("<td>offset1</td>\n") 396 out.write("<td>uint</td>\n") 397 if 'offset1' in params: 398 out.write(" <td>"+str(params['offset1'])+"</td>\n") 399 out.write(" <td>"+str(params['offset1'])+"</td>\n") 400 out.write("</tr>\n") 401 out.write("\n") 402 out.write("<tr>\n") 403 out.write("<td>numslots1</td>\n") 404 out.write("<td>uint</td>\n") 405 if 'numslots1' in params: 406 out.write(" <td>"+str(params['numslots1'])+"</td>\n") 407 out.write(" <td>"+str(params['numslots1'])+"</td>\n") 408 out.write("</tr>\n") 409 out.write("\n") 410 out.write("<tr>\n") 411 out.write("<td>timeout1</td>\n") 412 out.write("<td>uint</td>\n") 413 if 'timeout1' in params: 414 out.write(" <td>"+str(params['timeout1'])+"</td>\n") 415 out.write(" <td>"+str(params['timeout1'])+"</td>\n") 416 out.write("<td>min</td>\n") 417 out.write("</tr>\n") 418 out.write("\n") 419 out.write("<tr>\n") 420 out.write("<td>increment1</td>\n") 421 out.write("<td>uint</td>\n") 422 if 'increment1' in params: 423 out.write(" <td>"+str(params['increment1'])+"</td>\n") 424 out.write(" <td>"+str(params['increment1'])+"</td>\n") 425 out.write("</tr>\n") 426 out.write("\n") 427 out.write("<tr>\n") 428 out.write("<td>offset2</td>\n") 429 out.write("<td>uint</td>\n") 430 if 'offset2' in params: 431 out.write(" <td>"+str(params['offset2'])+"</td>\n") 432 out.write(" <td>"+str(params['offset2'])+"</td>\n") 433 out.write("</tr>\n") 434 out.write("\n") 435 out.write("<tr>\n") 436 out.write("<td>numslots2</td>\n") 437 out.write("<td>uint</td>\n") 438 if 'numslots2' in params: 439 out.write(" <td>"+str(params['numslots2'])+"</td>\n") 440 out.write(" <td>"+str(params['numslots2'])+"</td>\n") 441 out.write("</tr>\n") 442 out.write("\n") 443 out.write("<tr>\n") 444 out.write("<td>timeout2</td>\n") 445 out.write("<td>uint</td>\n") 446 if 'timeout2' in params: 447 out.write(" <td>"+str(params['timeout2'])+"</td>\n") 448 out.write(" <td>"+str(params['timeout2'])+"</td>\n") 449 out.write("<td>min</td>\n") 450 out.write("</tr>\n") 451 out.write("\n") 452 out.write("<tr>\n") 453 out.write("<td>increment2</td>\n") 454 out.write("<td>uint</td>\n") 455 if 'increment2' in params: 456 out.write(" <td>"+str(params['increment2'])+"</td>\n") 457 out.write(" <td>"+str(params['increment2'])+"</td>\n") 458 out.write("</tr>\n") 459 out.write("\n") 460 out.write("<tr>\n") 461 out.write("<td>offset3</td>\n") 462 out.write("<td>uint</td>\n") 463 if 'offset3' in params: 464 out.write(" <td>"+str(params['offset3'])+"</td>\n") 465 out.write(" <td>"+str(params['offset3'])+"</td>\n") 466 out.write("</tr>\n") 467 out.write("\n") 468 out.write("<tr>\n") 469 out.write("<td>numslots3</td>\n") 470 out.write("<td>uint</td>\n") 471 if 'numslots3' in params: 472 out.write(" <td>"+str(params['numslots3'])+"</td>\n") 473 out.write(" <td>"+str(params['numslots3'])+"</td>\n") 474 out.write("</tr>\n") 475 out.write("\n") 476 out.write("<tr>\n") 477 out.write("<td>timeout3</td>\n") 478 out.write("<td>uint</td>\n") 479 if 'timeout3' in params: 480 out.write(" <td>"+str(params['timeout3'])+"</td>\n") 481 out.write(" <td>"+str(params['timeout3'])+"</td>\n") 482 out.write("<td>min</td>\n") 483 out.write("</tr>\n") 484 out.write("\n") 485 out.write("<tr>\n") 486 out.write("<td>increment3</td>\n") 487 out.write("<td>uint</td>\n") 488 if 'increment3' in params: 489 out.write(" <td>"+str(params['increment3'])+"</td>\n") 490 out.write(" <td>"+str(params['increment3'])+"</td>\n") 491 out.write("</tr>\n") 492 out.write("\n") 493 out.write("<tr>\n") 494 out.write("<td>offset4</td>\n") 495 out.write("<td>uint</td>\n") 496 if 'offset4' in params: 497 out.write(" <td>"+str(params['offset4'])+"</td>\n") 498 out.write(" <td>"+str(params['offset4'])+"</td>\n") 499 out.write("</tr>\n") 500 out.write("\n") 501 out.write("<tr>\n") 502 out.write("<td>numslots4</td>\n") 503 out.write("<td>uint</td>\n") 504 if 'numslots4' in params: 505 out.write(" <td>"+str(params['numslots4'])+"</td>\n") 506 out.write(" <td>"+str(params['numslots4'])+"</td>\n") 507 out.write("</tr>\n") 508 out.write("\n") 509 out.write("<tr>\n") 510 out.write("<td>timeout4</td>\n") 511 out.write("<td>uint</td>\n") 512 if 'timeout4' in params: 513 out.write(" <td>"+str(params['timeout4'])+"</td>\n") 514 out.write(" <td>"+str(params['timeout4'])+"</td>\n") 515 out.write("<td>min</td>\n") 516 out.write("</tr>\n") 517 out.write("\n") 518 out.write("<tr>\n") 519 out.write("<td>increment4</td>\n") 520 out.write("<td>uint</td>\n") 521 if 'increment4' in params: 522 out.write(" <td>"+str(params['increment4'])+"</td>\n") 523 out.write(" <td>"+str(params['increment4'])+"</td>\n") 524 out.write("</tr>\n") 525 out.write("\n") 526 out.write("<tr>\n") 527 out.write("<td>variablespare</td>\n") 528 out.write("<td>uint</td>\n") 529 if 'variablespare' in params: 530 out.write(" <td>"+str(params['variablespare'])+"</td>\n") 531 out.write(" <td>"+str(params['variablespare'])+"</td>\n") 532 out.write("</tr>\n") 533 out.write("</table>\n")

534

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

536 '''Print a datalinkmng message to stdout. 537 538 Fields in params: 539 - MessageID(uint): AIS message number. Must be 20 (field automatically set to "20") 540 - RepeatIndicator(uint): Indicated how many times a message has been repeated 541 - UserID(uint): Unique ship identification number (MMSI) 542 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0") 543 - offset1(uint): Reserved offset number 544 - numslots1(uint): Number of reserved consecutive slots 545 - timeout1(uint): Time-out value in minutes 546 - increment1(uint): Increment to repeast reservation of this block 547 - offset2(uint): Reserved offset number (optional) 548 - numslots2(uint): Number of reserved consecutive slots (optional) 549 - timeout2(uint): Time-out value in minutes (optional) 550 - increment2(uint): Increment to repeast reservation of this block (optional) 551 - offset3(uint): Reserved offset number (optional) 552 - numslots3(uint): Number of reserved consecutive slots (optional) 553 - timeout3(uint): Time-out value in minutes (optional) 554 - increment3(uint): Increment to repeast reservation of this block (optional) 555 - offset4(uint): Reserved offset number (optional) 556 - numslots4(uint): Number of reserved consecutive slots (optional) 557 - timeout4(uint): Time-out value in minutes (optional) 558 - increment4(uint): Increment to repeast reservation of this block (optional) 559 - variablespare(uint): This field is a serious pain. This padding makes the message byte aligned (field automatically set to "0") 560 @param params: Dictionary of field names/values. 561 @param out: File like object to write to 562 @rtype: stdout 563 @return: text to out 564 ''' 565 566 if 'std'==format: 567 out.write("datalinkmng:\n") 568 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n") 569 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n") 570 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n") 571 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n") 572 if 'offset1' in params: out.write(" offset1: "+str(params['offset1'])+"\n") 573 if 'numslots1' in params: out.write(" numslots1: "+str(params['numslots1'])+"\n") 574 if 'timeout1' in params: out.write(" timeout1: "+str(params['timeout1'])+"\n") 575 if 'increment1' in params: out.write(" increment1: "+str(params['increment1'])+"\n") 576 if 'offset2' in params: out.write(" offset2: "+str(params['offset2'])+"\n") 577 if 'numslots2' in params: out.write(" numslots2: "+str(params['numslots2'])+"\n") 578 if 'timeout2' in params: out.write(" timeout2: "+str(params['timeout2'])+"\n") 579 if 'increment2' in params: out.write(" increment2: "+str(params['increment2'])+"\n") 580 if 'offset3' in params: out.write(" offset3: "+str(params['offset3'])+"\n") 581 if 'numslots3' in params: out.write(" numslots3: "+str(params['numslots3'])+"\n") 582 if 'timeout3' in params: out.write(" timeout3: "+str(params['timeout3'])+"\n") 583 if 'increment3' in params: out.write(" increment3: "+str(params['increment3'])+"\n") 584 if 'offset4' in params: out.write(" offset4: "+str(params['offset4'])+"\n") 585 if 'numslots4' in params: out.write(" numslots4: "+str(params['numslots4'])+"\n") 586 if 'timeout4' in params: out.write(" timeout4: "+str(params['timeout4'])+"\n") 587 if 'increment4' in params: out.write(" increment4: "+str(params['increment4'])+"\n") 588 if 'variablespare' in params: out.write(" variablespare: "+str(params['variablespare'])+"\n") 589 elif 'csv'==format: 590 if None == options.fieldList: 591 options.fieldList = fieldList 592 needComma = False; 593 for field in fieldList: 594 if needComma: out.write(',') 595 needComma = True 596 if field in params: 597 out.write(str(params[field])) 598 # else: leave it empty 599 out.write("\n") 600 elif 'html'==format: 601 printHtml(params,out) 602 elif 'sql'==format: 603 sqlInsertStr(params,out,dbType=dbType) 604 else: 605 print "ERROR: unknown format:",format 606 assert False 607 608 return # Nothing to return

609 610 RepeatIndicatorEncodeLut = { 611 'default':'0', 612 'do not repeat any more':'3', 613 } #RepeatIndicatorEncodeLut 614 615 RepeatIndicatorDecodeLut = { 616 '0':'default', 617 '3':'do not repeat any more', 618 } # RepeatIndicatorEncodeLut 619 620 ###################################################################### 621 # SQL SUPPORT 622 ###################################################################### 623 624 dbTableName='datalinkmng' 625 'Database table name' 626

627 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 628 ,addCoastGuardFields=True 629 ,dbType='postgres' 630 ):

631 ''' 632 Return the SQL CREATE command for this message type 633 @param outfile: file like object to print to. 634 @param fields: which fields to put in the create. Defaults to all. 635 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 636 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 637 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 638 @type addCoastGuardFields: bool 639 @return: sql create string 640 @rtype: str 641 642 @see: sqlCreate 643 ''' 644 # FIX: should this sqlCreate be the same as in LaTeX (createFuncName) rather than hard coded? 645 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))

646

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

648 ''' 649 Return the sqlhelp object to create the table. 650 651 @param fields: which fields to put in the create. Defaults to all. 652 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 653 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 654 @type addCoastGuardFields: bool 655 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 656 @return: An object that can be used to generate a return 657 @rtype: sqlhelp.create 658 ''' 659 if None == fields: fields = fieldList 660 import sqlhelp 661 c = sqlhelp.create('datalinkmng',dbType=dbType) 662 c.addPrimaryKey() 663 if 'MessageID' in fields: c.addInt ('MessageID') 664 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator') 665 if 'UserID' in fields: c.addInt ('UserID') 666 if 'Spare' in fields: c.addInt ('Spare') 667 if 'offset1' in fields: c.addInt ('offset1') 668 if 'numslots1' in fields: c.addInt ('numslots1') 669 if 'timeout1' in fields: c.addInt ('timeout1') 670 if 'increment1' in fields: c.addInt ('increment1') 671 if 'offset2' in fields: c.addInt ('offset2') 672 if 'numslots2' in fields: c.addInt ('numslots2') 673 if 'timeout2' in fields: c.addInt ('timeout2') 674 if 'increment2' in fields: c.addInt ('increment2') 675 if 'offset3' in fields: c.addInt ('offset3') 676 if 'numslots3' in fields: c.addInt ('numslots3') 677 if 'timeout3' in fields: c.addInt ('timeout3') 678 if 'increment3' in fields: c.addInt ('increment3') 679 if 'offset4' in fields: c.addInt ('offset4') 680 if 'numslots4' in fields: c.addInt ('numslots4') 681 if 'timeout4' in fields: c.addInt ('timeout4') 682 if 'increment4' in fields: c.addInt ('increment4') 683 if 'variablespare' in fields: c.addInt ('variablespare') 684 685 if addCoastGuardFields: 686 # c.addInt('cg_rssi') # Relative signal strength indicator 687 # c.addInt('cg_d') # dBm receive strength 688 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 689 # c.addInt('cg_S') # Slot received in 690 # c.addVarChar('cg_x',10) # Idonno 691 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 692 c.addInt('cg_sec') # UTC seconds since the epoch 693 694 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 695 696 return c

697

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

699 ''' 700 Return the SQL INSERT command for this message type 701 @param params: dictionary of values keyed by field name 702 @param outfile: file like object to print to. 703 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 704 @return: sql create string 705 @rtype: str 706 707 @see: sqlCreate 708 ''' 709 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))

710 711

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

713 ''' 714 Give the SQL INSERT statement 715 @param params: dict keyed by field name of values 716 @param extraParams: any extra fields that you have created beyond the normal ais message fields 717 @rtype: sqlhelp.insert 718 @return: insert class instance 719 @todo: allow optional type checking of params? 720 @warning: this will take invalid keys happily and do what??? 721 ''' 722 import sqlhelp 723 i = sqlhelp.insert('datalinkmng',dbType=dbType) 724 725 if dbType=='postgres': 726 finished = [] 727 for key in params: 728 if key in finished: 729 continue 730 731 if key not in toPgFields and key not in fromPgFields: 732 if type(params[key])==Decimal: i.add(key,float(params[key])) 733 else: i.add(key,params[key]) 734 else: 735 if key in fromPgFields: 736 val = params[key] 737 # Had better be a WKT type like POINT(-88.1 30.321) 738 i.addPostGIS(key,val) 739 finished.append(key) 740 else: 741 # Need to construct the type. 742 pgName = toPgFields[key] 743 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 744 valStr=pgTypes[pgName]+'(' 745 vals = [] 746 for nonPgKey in fromPgFields[pgName]: 747 vals.append(str(params[nonPgKey])) 748 finished.append(nonPgKey) 749 valStr+=' '.join(vals)+')' 750 i.addPostGIS(pgName,valStr) 751 else: 752 for key in params: 753 if type(params[key])==Decimal: i.add(key,float(params[key])) 754 else: i.add(key,params[key]) 755 756 if None != extraParams: 757 for key in extraParams: 758 i.add(key,extraParams[key]) 759 760 return i

761 762 ###################################################################### 763 # LATEX SUPPORT 764 ###################################################################### 765

766 -def latexDefinitionTable(outfile=sys.stdout 767 ):

768 ''' 769 Return the LaTeX definition table for this message type 770 @param outfile: file like object to print to. 771 @type outfile: file obj 772 @return: LaTeX table string via the outfile 773 @rtype: str 774 775 ''' 776 o = outfile 777 778 o.write(''' 779 \\begin{table}%[htb] 780 \\centering 781 \\begin{tabular}{|l|c|l|} 782 \\hline 783 Parameter & Number of bits & Description 784 \\\\ \\hline\\hline 785 MessageID & 6 & AIS message number. Must be 20 \\\\ \hline 786 RepeatIndicator & 2 & Indicated how many times a message has been repeated \\\\ \hline 787 UserID & 30 & Unique ship identification number (MMSI) \\\\ \hline 788 Spare & 2 & Not used. Should be set to zero. \\\\ \hline 789 offset1 & 12 & Reserved offset number \\\\ \hline 790 numslots1 & 4 & Number of reserved consecutive slots \\\\ \hline 791 timeout1 & 3 & Time-out value in minutes \\\\ \hline 792 increment1 & 11 & Increment to repeast reservation of this block \\\\ \hline 793 offset2 & 12 & Reserved offset number (optional) \\\\ \hline 794 numslots2 & 4 & Number of reserved consecutive slots (optional) \\\\ \hline 795 timeout2 & 3 & Time-out value in minutes (optional) \\\\ \hline 796 increment2 & 11 & Increment to repeast reservation of this block (optional) \\\\ \hline 797 offset3 & 12 & Reserved offset number (optional) \\\\ \hline 798 numslots3 & 4 & Number of reserved consecutive slots (optional) \\\\ \hline 799 timeout3 & 3 & Time-out value in minutes (optional) \\\\ \hline 800 increment3 & 11 & Increment to repeast reservation of this block (optional) \\\\ \hline 801 offset4 & 12 & Reserved offset number (optional) \\\\ \hline 802 numslots4 & 4 & Number of reserved consecutive slots (optional) \\\\ \hline 803 timeout4 & 3 & Time-out value in minutes (optional) \\\\ \hline 804 increment4 & 11 & Increment to repeast reservation of this block (optional) \\\\ \hline 805 variablespare & 6 & This field is a serious pain. This padding makes the message byte aligned\\\\ \\hline \\hline 806 Total bits & 166 & Appears to take 1 slot with 2 pad bits to fill the last slot \\\\ \\hline 807 \\end{tabular} 808 \\caption{AIS message number 20: Data Link Management - D. This message uses an optional tag that should not be reused. The spare at the end is used to byte align the message. } 809 \\label{tab:datalinkmng} 810 \\end{table} 811 ''')

812 813 ###################################################################### 814 # Text Definition 815 ###################################################################### 816

817 -def textDefinitionTable(outfile=sys.stdout 818 ,delim='\t' 819 ):

820 ''' 821 Return the text definition table for this message type 822 @param outfile: file like object to print to. 823 @type outfile: file obj 824 @return: text table string via the outfile 825 @rtype: str 826 827 ''' 828 o = outfile 829 o.write('''Parameter'''+delim+'Number of bits'''+delim+'''Description 830 MessageID'''+delim+'''6'''+delim+'''AIS message number. Must be 20 831 RepeatIndicator'''+delim+'''2'''+delim+'''Indicated how many times a message has been repeated 832 UserID'''+delim+'''30'''+delim+'''Unique ship identification number (MMSI) 833 Spare'''+delim+'''2'''+delim+'''Not used. Should be set to zero. 834 offset1'''+delim+'''12'''+delim+'''Reserved offset number 835 numslots1'''+delim+'''4'''+delim+'''Number of reserved consecutive slots 836 timeout1'''+delim+'''3'''+delim+'''Time-out value in minutes 837 increment1'''+delim+'''11'''+delim+'''Increment to repeast reservation of this block 838 offset2'''+delim+'''12'''+delim+'''Reserved offset number (optional) 839 numslots2'''+delim+'''4'''+delim+'''Number of reserved consecutive slots (optional) 840 timeout2'''+delim+'''3'''+delim+'''Time-out value in minutes (optional) 841 increment2'''+delim+'''11'''+delim+'''Increment to repeast reservation of this block (optional) 842 offset3'''+delim+'''12'''+delim+'''Reserved offset number (optional) 843 numslots3'''+delim+'''4'''+delim+'''Number of reserved consecutive slots (optional) 844 timeout3'''+delim+'''3'''+delim+'''Time-out value in minutes (optional) 845 increment3'''+delim+'''11'''+delim+'''Increment to repeast reservation of this block (optional) 846 offset4'''+delim+'''12'''+delim+'''Reserved offset number (optional) 847 numslots4'''+delim+'''4'''+delim+'''Number of reserved consecutive slots (optional) 848 timeout4'''+delim+'''3'''+delim+'''Time-out value in minutes (optional) 849 increment4'''+delim+'''11'''+delim+'''Increment to repeast reservation of this block (optional) 850 variablespare'''+delim+'''6'''+delim+'''This field is a serious pain. This padding makes the message byte aligned 851 Total bits'''+delim+'''166'''+delim+'''Appears to take 1 slot with 2 pad bits to fill the last slot''')

852 853 854 ###################################################################### 855 # UNIT TESTING 856 ###################################################################### 857 import unittest

858 -def testParams():

859 '''Return a params file base on the testvalue tags. 860 @rtype: dict 861 @return: params based on testvalue tags 862 ''' 863 params = {} 864 params['MessageID'] = 20 865 params['RepeatIndicator'] = 1 866 params['UserID'] = 1193046 867 params['Spare'] = 0 868 params['offset1'] = 10 869 params['numslots1'] = 1 870 params['timeout1'] = 1 871 params['increment1'] = 14 872 params['offset2'] = 20 873 params['numslots2'] = 2 874 params['timeout2'] = 2 875 params['increment2'] = 24 876 params['offset3'] = 30 877 params['numslots3'] = 3 878 params['timeout3'] = 3 879 params['increment3'] = 34 880 params['offset4'] = 40 881 params['numslots4'] = 4 882 params['timeout4'] = 4 883 params['increment4'] = 44 884 params['variablespare'] = 0 885 886 return params

887

888 -class Testdatalinkmng(unittest.TestCase):

889 '''Use testvalue tag text from each type to build test case the datalinkmng message'''

890 - def testEncodeDecode(self):

891 892 params = testParams() 893 bits = encode(params) 894 r = decode(bits) 895 896 # Check that each parameter came through ok. 897 self.failUnlessEqual(r['MessageID'],params['MessageID']) 898 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator']) 899 self.failUnlessEqual(r['UserID'],params['UserID']) 900 self.failUnlessEqual(r['Spare'],params['Spare']) 901 self.failUnlessEqual(r['offset1'],params['offset1']) 902 self.failUnlessEqual(r['numslots1'],params['numslots1']) 903 self.failUnlessEqual(r['timeout1'],params['timeout1']) 904 self.failUnlessEqual(r['increment1'],params['increment1']) 905 self.failUnlessEqual(r['offset2'],params['offset2']) 906 self.failUnlessEqual(r['numslots2'],params['numslots2']) 907 self.failUnlessEqual(r['timeout2'],params['timeout2']) 908 self.failUnlessEqual(r['increment2'],params['increment2']) 909 self.failUnlessEqual(r['offset3'],params['offset3']) 910 self.failUnlessEqual(r['numslots3'],params['numslots3']) 911 self.failUnlessEqual(r['timeout3'],params['timeout3']) 912 self.failUnlessEqual(r['increment3'],params['increment3']) 913 self.failUnlessEqual(r['offset4'],params['offset4']) 914 self.failUnlessEqual(r['numslots4'],params['numslots4']) 915 self.failUnlessEqual(r['timeout4'],params['timeout4']) 916 self.failUnlessEqual(r['increment4'],params['increment4']) 917 self.failUnlessEqual(r['variablespare'],params['variablespare'])

918

919 -def addMsgOptions(parser):

920 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 921 help='decode a "datalinkmng" AIS message') 922 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 923 help='encode a "datalinkmng" AIS message') 924 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 925 ,help='Field parameter value [default: %default]') 926 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 927 ,help='Field parameter value [default: %default]') 928 parser.add_option('--offset1-field', dest='offset1Field',default=0,metavar='uint',type='int' 929 ,help='Field parameter value [default: %default]') 930 parser.add_option('--numslots1-field', dest='numslots1Field',default=0,metavar='uint',type='int' 931 ,help='Field parameter value [default: %default]') 932 parser.add_option('--timeout1-field', dest='timeout1Field',default=0,metavar='uint',type='int' 933 ,help='Field parameter value [default: %default]') 934 parser.add_option('--increment1-field', dest='increment1Field',default=0,metavar='uint',type='int' 935 ,help='Field parameter value [default: %default]') 936 parser.add_option('--offset2-field', dest='offset2Field',default=0,metavar='uint',type='int' 937 ,help='Field parameter value [default: %default]') 938 parser.add_option('--numslots2-field', dest='numslots2Field',default=0,metavar='uint',type='int' 939 ,help='Field parameter value [default: %default]') 940 parser.add_option('--timeout2-field', dest='timeout2Field',default=0,metavar='uint',type='int' 941 ,help='Field parameter value [default: %default]') 942 parser.add_option('--increment2-field', dest='increment2Field',default=0,metavar='uint',type='int' 943 ,help='Field parameter value [default: %default]') 944 parser.add_option('--offset3-field', dest='offset3Field',default=0,metavar='uint',type='int' 945 ,help='Field parameter value [default: %default]') 946 parser.add_option('--numslots3-field', dest='numslots3Field',default=0,metavar='uint',type='int' 947 ,help='Field parameter value [default: %default]') 948 parser.add_option('--timeout3-field', dest='timeout3Field',default=0,metavar='uint',type='int' 949 ,help='Field parameter value [default: %default]') 950 parser.add_option('--increment3-field', dest='increment3Field',default=0,metavar='uint',type='int' 951 ,help='Field parameter value [default: %default]') 952 parser.add_option('--offset4-field', dest='offset4Field',default=0,metavar='uint',type='int' 953 ,help='Field parameter value [default: %default]') 954 parser.add_option('--numslots4-field', dest='numslots4Field',default=0,metavar='uint',type='int' 955 ,help='Field parameter value [default: %default]') 956 parser.add_option('--timeout4-field', dest='timeout4Field',default=0,metavar='uint',type='int' 957 ,help='Field parameter value [default: %default]') 958 parser.add_option('--increment4-field', dest='increment4Field',default=0,metavar='uint',type='int' 959 ,help='Field parameter value [default: %default]')

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

Source Code for Module ais.ais_msg_20