ais.ris.waterlevel

1 #!/usr/bin/env python 2 3 __version__ = '$Revision: 4791 $'.split()[1] 4 __date__ = '$Date: 2008-01-11 $'.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 'dac', 55 'fid', 56 'country', 57 'id1_id', 58 'id1_sign', 59 'id1_waterlevel', 60 'id1_i_have_no_idea', 61 'id2_id', 62 'id2_sign', 63 'id2_waterlevel', 64 'id2_i_have_no_idea', 65 'id3_id', 66 'id3_sign', 67 'id3_waterlevel', 68 'id3_i_have_no_idea', 69 'id4_id', 70 'id4_sign', 71 'id4_waterlevel', 72 'id4_i_have_no_idea', 73 ) 74 75 fieldListPostgres = ( 76 'MessageID', 77 'RepeatIndicator', 78 'UserID', 79 'Spare', 80 'dac', 81 'fid', 82 'country', 83 'id1_id', 84 'id1_sign', 85 'id1_waterlevel', 86 'id1_i_have_no_idea', 87 'id2_id', 88 'id2_sign', 89 'id2_waterlevel', 90 'id2_i_have_no_idea', 91 'id3_id', 92 'id3_sign', 93 'id3_waterlevel', 94 'id3_i_have_no_idea', 95 'id4_id', 96 'id4_sign', 97 'id4_waterlevel', 98 'id4_i_have_no_idea', 99 ) 100 101 toPgFields = { 102 } 103 ''' 104 Go to the Postgis field names from the straight field name 105 ''' 106 107 fromPgFields = { 108 } 109 ''' 110 Go from the Postgis field names to the straight field name 111 ''' 112 113 pgTypes = { 114 } 115 ''' 116 Lookup table for each postgis field name to get its type. 117 ''' 118

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

120 '''Create a ris_waterlevel binary message payload to pack into an AIS Msg ris_waterlevel. 121 122 Fields in params: 123 - MessageID(uint): AIS message number. Must be 8 (field automatically set to "8") 124 - RepeatIndicator(uint): Indicated how many times a message has been repeated 125 - UserID(uint): Unique ship identification number (MMSI) 126 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0") 127 - dac(uint): Designated Area Code (field automatically set to "000") 128 - fid(uint): Functional Identifier (field automatically set to "1") 129 - country(aisstr6): UN country code using 2*6-Bit ASCII characters according to ERI specification 130 - id1_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 131 - id1_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 132 - id1_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 133 - id1_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 134 - id2_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 135 - id2_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 136 - id2_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 137 - id2_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 138 - id3_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 139 - id3_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 140 - id3_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 141 - id3_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 142 - id4_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 143 - id4_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 144 - id4_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 145 - id4_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 146 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing 147 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 148 @rtype: BitVector 149 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8 150 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits. 151 ''' 152 153 bvList = [] 154 bvList.append(binary.setBitVectorSize(BitVector(intVal=8),6)) 155 if 'RepeatIndicator' in params: 156 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2)) 157 else: 158 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 159 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30)) 160 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 161 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),10)) 162 bvList.append(binary.setBitVectorSize(BitVector(intVal=1),6)) 163 bvList.append(aisstring.encode(params['country'],12)) 164 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id1_id']),11)) 165 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id1_sign']),1)) 166 bvList.append(binary.bvFromSignedInt(int(Decimal(params['id1_waterlevel'])*Decimal('100')),11)) 167 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 168 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id2_id']),11)) 169 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id2_sign']),1)) 170 bvList.append(binary.bvFromSignedInt(int(Decimal(params['id2_waterlevel'])*Decimal('100')),11)) 171 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 172 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id3_id']),11)) 173 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id3_sign']),1)) 174 bvList.append(binary.bvFromSignedInt(int(Decimal(params['id3_waterlevel'])*Decimal('100')),11)) 175 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 176 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id4_id']),11)) 177 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['id4_sign']),1)) 178 bvList.append(binary.bvFromSignedInt(int(Decimal(params['id4_waterlevel'])*Decimal('100')),11)) 179 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2)) 180 181 return binary.joinBV(bvList)

182

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

184 '''Unpack a ris_waterlevel message 185 186 Fields in params: 187 - MessageID(uint): AIS message number. Must be 8 (field automatically set to "8") 188 - RepeatIndicator(uint): Indicated how many times a message has been repeated 189 - UserID(uint): Unique ship identification number (MMSI) 190 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0") 191 - dac(uint): Designated Area Code (field automatically set to "000") 192 - fid(uint): Functional Identifier (field automatically set to "1") 193 - country(aisstr6): UN country code using 2*6-Bit ASCII characters according to ERI specification 194 - id1_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 195 - id1_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 196 - id1_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 197 - id1_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 198 - id2_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 199 - id2_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 200 - id2_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 201 - id2_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 202 - id3_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 203 - id3_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 204 - id3_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 205 - id3_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 206 - id4_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 207 - id4_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 208 - id4_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 209 - id4_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 210 @type bv: BitVector 211 @param bv: Bits defining a message 212 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 213 @rtype: dict 214 @return: params 215 ''' 216 217 #Would be nice to check the bit count here.. 218 #if validate: 219 # assert (len(bv)==FIX: SOME NUMBER) 220 r = {} 221 r['MessageID']=8 222 r['RepeatIndicator']=int(bv[6:8]) 223 r['UserID']=int(bv[8:38]) 224 r['Spare']=0 225 r['dac']=000 226 r['fid']=1 227 r['country']=aisstring.decode(bv[56:68]) 228 r['id1_id']=int(bv[68:79]) 229 r['id1_sign']=int(bv[79:80]) 230 r['id1_waterlevel']=Decimal(binary.signedIntFromBV(bv[80:91]))/Decimal('100') 231 r['id1_i_have_no_idea']=0 232 r['id2_id']=int(bv[93:104]) 233 r['id2_sign']=int(bv[104:105]) 234 r['id2_waterlevel']=Decimal(binary.signedIntFromBV(bv[105:116]))/Decimal('100') 235 r['id2_i_have_no_idea']=0 236 r['id3_id']=int(bv[118:129]) 237 r['id3_sign']=int(bv[129:130]) 238 r['id3_waterlevel']=Decimal(binary.signedIntFromBV(bv[130:141]))/Decimal('100') 239 r['id3_i_have_no_idea']=0 240 r['id4_id']=int(bv[143:154]) 241 r['id4_sign']=int(bv[154:155]) 242 r['id4_waterlevel']=Decimal(binary.signedIntFromBV(bv[155:166]))/Decimal('100') 243 r['id4_i_have_no_idea']=0 244 return r

245

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

247 return 8

248

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

250 return int(bv[6:8])

251

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

253 return int(bv[8:38])

254

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

256 return 0

257

258 -def decodedac(bv, validate=False):

259 return 000

260

261 -def decodefid(bv, validate=False):

262 return 1

263

264 -def decodecountry(bv, validate=False):

265 return aisstring.decode(bv[56:68])

266

267 -def decodeid1_id(bv, validate=False):

268 return int(bv[68:79])

269

270 -def decodeid1_sign(bv, validate=False):

271 return int(bv[79:80])

272

273 -def decodeid1_waterlevel(bv, validate=False):

274 return Decimal(binary.signedIntFromBV(bv[80:91]))/Decimal('100')

275

276 -def decodeid1_i_have_no_idea(bv, validate=False):

277 return 0

278

279 -def decodeid2_id(bv, validate=False):

280 return int(bv[93:104])

281

282 -def decodeid2_sign(bv, validate=False):

283 return int(bv[104:105])

284

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

286 return Decimal(binary.signedIntFromBV(bv[105:116]))/Decimal('100')

287

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

289 return 0

290

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

292 return int(bv[118:129])

293

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

295 return int(bv[129:130])

296

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

298 return Decimal(binary.signedIntFromBV(bv[130:141]))/Decimal('100')

299

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

301 return 0

302

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

304 return int(bv[143:154])

305

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

307 return int(bv[154:155])

308

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

310 return Decimal(binary.signedIntFromBV(bv[155:166]))/Decimal('100')

311

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

313 return 0

314 315

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

317 out.write("<h3>ris_waterlevel</h3>\n") 318 out.write("<table border=\"1\">\n") 319 out.write("<tr bgcolor=\"orange\">\n") 320 out.write("<th align=\"left\">Field Name</th>\n") 321 out.write("<th align=\"left\">Type</th>\n") 322 out.write("<th align=\"left\">Value</th>\n") 323 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 324 out.write("<th align=\"left\">Units</th>\n") 325 out.write("\n") 326 out.write("<tr>\n") 327 out.write("<td>MessageID</td>\n") 328 out.write("<td>uint</td>\n") 329 if 'MessageID' in params: 330 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 331 out.write(" <td>"+str(params['MessageID'])+"</td>\n") 332 out.write("</tr>\n") 333 out.write("\n") 334 out.write("<tr>\n") 335 out.write("<td>RepeatIndicator</td>\n") 336 out.write("<td>uint</td>\n") 337 if 'RepeatIndicator' in params: 338 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n") 339 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut: 340 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>") 341 else: 342 out.write("<td><i>Missing LUT entry</i></td>") 343 out.write("</tr>\n") 344 out.write("\n") 345 out.write("<tr>\n") 346 out.write("<td>UserID</td>\n") 347 out.write("<td>uint</td>\n") 348 if 'UserID' in params: 349 out.write(" <td>"+str(params['UserID'])+"</td>\n") 350 out.write(" <td>"+str(params['UserID'])+"</td>\n") 351 out.write("</tr>\n") 352 out.write("\n") 353 out.write("<tr>\n") 354 out.write("<td>Spare</td>\n") 355 out.write("<td>uint</td>\n") 356 if 'Spare' in params: 357 out.write(" <td>"+str(params['Spare'])+"</td>\n") 358 out.write(" <td>"+str(params['Spare'])+"</td>\n") 359 out.write("</tr>\n") 360 out.write("\n") 361 out.write("<tr>\n") 362 out.write("<td>dac</td>\n") 363 out.write("<td>uint</td>\n") 364 if 'dac' in params: 365 out.write(" <td>"+str(params['dac'])+"</td>\n") 366 out.write(" <td>"+str(params['dac'])+"</td>\n") 367 out.write("</tr>\n") 368 out.write("\n") 369 out.write("<tr>\n") 370 out.write("<td>fid</td>\n") 371 out.write("<td>uint</td>\n") 372 if 'fid' in params: 373 out.write(" <td>"+str(params['fid'])+"</td>\n") 374 out.write(" <td>"+str(params['fid'])+"</td>\n") 375 out.write("</tr>\n") 376 out.write("\n") 377 out.write("<tr>\n") 378 out.write("<td>country</td>\n") 379 out.write("<td>aisstr6</td>\n") 380 if 'country' in params: 381 out.write(" <td>"+str(params['country'])+"</td>\n") 382 out.write(" <td>"+str(params['country'])+"</td>\n") 383 out.write("</tr>\n") 384 out.write("\n") 385 out.write("<tr>\n") 386 out.write("<td>id1_id</td>\n") 387 out.write("<td>uint</td>\n") 388 if 'id1_id' in params: 389 out.write(" <td>"+str(params['id1_id'])+"</td>\n") 390 out.write(" <td>"+str(params['id1_id'])+"</td>\n") 391 out.write("</tr>\n") 392 out.write("\n") 393 out.write("<tr>\n") 394 out.write("<td>id1_sign</td>\n") 395 out.write("<td>uint</td>\n") 396 if 'id1_sign' in params: 397 out.write(" <td>"+str(params['id1_sign'])+"</td>\n") 398 if str(params['id1_sign']) in id1_signDecodeLut: 399 out.write("<td>"+id1_signDecodeLut[str(params['id1_sign'])]+"</td>") 400 else: 401 out.write("<td><i>Missing LUT entry</i></td>") 402 out.write("</tr>\n") 403 out.write("\n") 404 out.write("<tr>\n") 405 out.write("<td>id1_waterlevel</td>\n") 406 out.write("<td>decimal</td>\n") 407 if 'id1_waterlevel' in params: 408 out.write(" <td>"+str(params['id1_waterlevel'])+"</td>\n") 409 out.write(" <td>"+str(params['id1_waterlevel'])+"</td>\n") 410 out.write("<td>m</td>\n") 411 out.write("</tr>\n") 412 out.write("\n") 413 out.write("<tr>\n") 414 out.write("<td>id1_i_have_no_idea</td>\n") 415 out.write("<td>uint</td>\n") 416 if 'id1_i_have_no_idea' in params: 417 out.write(" <td>"+str(params['id1_i_have_no_idea'])+"</td>\n") 418 out.write(" <td>"+str(params['id1_i_have_no_idea'])+"</td>\n") 419 out.write("</tr>\n") 420 out.write("\n") 421 out.write("<tr>\n") 422 out.write("<td>id2_id</td>\n") 423 out.write("<td>uint</td>\n") 424 if 'id2_id' in params: 425 out.write(" <td>"+str(params['id2_id'])+"</td>\n") 426 out.write(" <td>"+str(params['id2_id'])+"</td>\n") 427 out.write("</tr>\n") 428 out.write("\n") 429 out.write("<tr>\n") 430 out.write("<td>id2_sign</td>\n") 431 out.write("<td>uint</td>\n") 432 if 'id2_sign' in params: 433 out.write(" <td>"+str(params['id2_sign'])+"</td>\n") 434 if str(params['id2_sign']) in id2_signDecodeLut: 435 out.write("<td>"+id2_signDecodeLut[str(params['id2_sign'])]+"</td>") 436 else: 437 out.write("<td><i>Missing LUT entry</i></td>") 438 out.write("</tr>\n") 439 out.write("\n") 440 out.write("<tr>\n") 441 out.write("<td>id2_waterlevel</td>\n") 442 out.write("<td>decimal</td>\n") 443 if 'id2_waterlevel' in params: 444 out.write(" <td>"+str(params['id2_waterlevel'])+"</td>\n") 445 out.write(" <td>"+str(params['id2_waterlevel'])+"</td>\n") 446 out.write("<td>m</td>\n") 447 out.write("</tr>\n") 448 out.write("\n") 449 out.write("<tr>\n") 450 out.write("<td>id2_i_have_no_idea</td>\n") 451 out.write("<td>uint</td>\n") 452 if 'id2_i_have_no_idea' in params: 453 out.write(" <td>"+str(params['id2_i_have_no_idea'])+"</td>\n") 454 out.write(" <td>"+str(params['id2_i_have_no_idea'])+"</td>\n") 455 out.write("</tr>\n") 456 out.write("\n") 457 out.write("<tr>\n") 458 out.write("<td>id3_id</td>\n") 459 out.write("<td>uint</td>\n") 460 if 'id3_id' in params: 461 out.write(" <td>"+str(params['id3_id'])+"</td>\n") 462 out.write(" <td>"+str(params['id3_id'])+"</td>\n") 463 out.write("</tr>\n") 464 out.write("\n") 465 out.write("<tr>\n") 466 out.write("<td>id3_sign</td>\n") 467 out.write("<td>uint</td>\n") 468 if 'id3_sign' in params: 469 out.write(" <td>"+str(params['id3_sign'])+"</td>\n") 470 if str(params['id3_sign']) in id3_signDecodeLut: 471 out.write("<td>"+id3_signDecodeLut[str(params['id3_sign'])]+"</td>") 472 else: 473 out.write("<td><i>Missing LUT entry</i></td>") 474 out.write("</tr>\n") 475 out.write("\n") 476 out.write("<tr>\n") 477 out.write("<td>id3_waterlevel</td>\n") 478 out.write("<td>decimal</td>\n") 479 if 'id3_waterlevel' in params: 480 out.write(" <td>"+str(params['id3_waterlevel'])+"</td>\n") 481 out.write(" <td>"+str(params['id3_waterlevel'])+"</td>\n") 482 out.write("<td>m</td>\n") 483 out.write("</tr>\n") 484 out.write("\n") 485 out.write("<tr>\n") 486 out.write("<td>id3_i_have_no_idea</td>\n") 487 out.write("<td>uint</td>\n") 488 if 'id3_i_have_no_idea' in params: 489 out.write(" <td>"+str(params['id3_i_have_no_idea'])+"</td>\n") 490 out.write(" <td>"+str(params['id3_i_have_no_idea'])+"</td>\n") 491 out.write("</tr>\n") 492 out.write("\n") 493 out.write("<tr>\n") 494 out.write("<td>id4_id</td>\n") 495 out.write("<td>uint</td>\n") 496 if 'id4_id' in params: 497 out.write(" <td>"+str(params['id4_id'])+"</td>\n") 498 out.write(" <td>"+str(params['id4_id'])+"</td>\n") 499 out.write("</tr>\n") 500 out.write("\n") 501 out.write("<tr>\n") 502 out.write("<td>id4_sign</td>\n") 503 out.write("<td>uint</td>\n") 504 if 'id4_sign' in params: 505 out.write(" <td>"+str(params['id4_sign'])+"</td>\n") 506 if str(params['id4_sign']) in id4_signDecodeLut: 507 out.write("<td>"+id4_signDecodeLut[str(params['id4_sign'])]+"</td>") 508 else: 509 out.write("<td><i>Missing LUT entry</i></td>") 510 out.write("</tr>\n") 511 out.write("\n") 512 out.write("<tr>\n") 513 out.write("<td>id4_waterlevel</td>\n") 514 out.write("<td>decimal</td>\n") 515 if 'id4_waterlevel' in params: 516 out.write(" <td>"+str(params['id4_waterlevel'])+"</td>\n") 517 out.write(" <td>"+str(params['id4_waterlevel'])+"</td>\n") 518 out.write("<td>m</td>\n") 519 out.write("</tr>\n") 520 out.write("\n") 521 out.write("<tr>\n") 522 out.write("<td>id4_i_have_no_idea</td>\n") 523 out.write("<td>uint</td>\n") 524 if 'id4_i_have_no_idea' in params: 525 out.write(" <td>"+str(params['id4_i_have_no_idea'])+"</td>\n") 526 out.write(" <td>"+str(params['id4_i_have_no_idea'])+"</td>\n") 527 out.write("</tr>\n") 528 out.write("</table>\n")

529

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

531 '''Print a ris_waterlevel message to stdout. 532 533 Fields in params: 534 - MessageID(uint): AIS message number. Must be 8 (field automatically set to "8") 535 - RepeatIndicator(uint): Indicated how many times a message has been repeated 536 - UserID(uint): Unique ship identification number (MMSI) 537 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0") 538 - dac(uint): Designated Area Code (field automatically set to "000") 539 - fid(uint): Functional Identifier (field automatically set to "1") 540 - country(aisstr6): UN country code using 2*6-Bit ASCII characters according to ERI specification 541 - id1_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 542 - id1_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 543 - id1_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 544 - id1_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 545 - id2_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 546 - id2_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 547 - id2_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 548 - id2_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 549 - id3_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 550 - id3_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 551 - id3_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 552 - id3_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 553 - id4_id(uint): One tide gauge measurement. Station ID defined by ERI for each country 554 - id4_sign(uint): One tide gauge measurement. sign of the number in the waterlevel 555 - id4_waterlevel(decimal): One tide gauge measurement. Water level at the sensor 556 - id4_i_have_no_idea(uint): One tide gauge measurement. What are these bits for? They do not seem to be specified (field automatically set to "0") 557 @param params: Dictionary of field names/values. 558 @param out: File like object to write to 559 @rtype: stdout 560 @return: text to out 561 ''' 562 563 if 'std'==format: 564 out.write("ris_waterlevel:\n") 565 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n") 566 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n") 567 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n") 568 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n") 569 if 'dac' in params: out.write(" dac: "+str(params['dac'])+"\n") 570 if 'fid' in params: out.write(" fid: "+str(params['fid'])+"\n") 571 if 'country' in params: out.write(" country: "+str(params['country'])+"\n") 572 if 'id1_id' in params: out.write(" id1_id: "+str(params['id1_id'])+"\n") 573 if 'id1_sign' in params: out.write(" id1_sign: "+str(params['id1_sign'])+"\n") 574 if 'id1_waterlevel' in params: out.write(" id1_waterlevel: "+str(params['id1_waterlevel'])+"\n") 575 if 'id1_i_have_no_idea' in params: out.write(" id1_i_have_no_idea: "+str(params['id1_i_have_no_idea'])+"\n") 576 if 'id2_id' in params: out.write(" id2_id: "+str(params['id2_id'])+"\n") 577 if 'id2_sign' in params: out.write(" id2_sign: "+str(params['id2_sign'])+"\n") 578 if 'id2_waterlevel' in params: out.write(" id2_waterlevel: "+str(params['id2_waterlevel'])+"\n") 579 if 'id2_i_have_no_idea' in params: out.write(" id2_i_have_no_idea: "+str(params['id2_i_have_no_idea'])+"\n") 580 if 'id3_id' in params: out.write(" id3_id: "+str(params['id3_id'])+"\n") 581 if 'id3_sign' in params: out.write(" id3_sign: "+str(params['id3_sign'])+"\n") 582 if 'id3_waterlevel' in params: out.write(" id3_waterlevel: "+str(params['id3_waterlevel'])+"\n") 583 if 'id3_i_have_no_idea' in params: out.write(" id3_i_have_no_idea: "+str(params['id3_i_have_no_idea'])+"\n") 584 if 'id4_id' in params: out.write(" id4_id: "+str(params['id4_id'])+"\n") 585 if 'id4_sign' in params: out.write(" id4_sign: "+str(params['id4_sign'])+"\n") 586 if 'id4_waterlevel' in params: out.write(" id4_waterlevel: "+str(params['id4_waterlevel'])+"\n") 587 if 'id4_i_have_no_idea' in params: out.write(" id4_i_have_no_idea: "+str(params['id4_i_have_no_idea'])+"\n") 588 elif 'csv'==format: 589 if None == options.fieldList: 590 options.fieldList = fieldList 591 needComma = False; 592 for field in fieldList: 593 if needComma: out.write(',') 594 needComma = True 595 if field in params: 596 out.write(str(params[field])) 597 # else: leave it empty 598 out.write("\n") 599 elif 'html'==format: 600 printHtml(params,out) 601 elif 'sql'==format: 602 sqlInsertStr(params,out,dbType=dbType) 603 else: 604 print "ERROR: unknown format:",format 605 assert False 606 607 return # Nothing to return

608 609 RepeatIndicatorEncodeLut = { 610 'default':'0', 611 'do not repeat any more':'3', 612 } #RepeatIndicatorEncodeLut 613 614 RepeatIndicatorDecodeLut = { 615 '0':'default', 616 '3':'do not repeat any more', 617 } # RepeatIndicatorEncodeLut 618 619 id1_signEncodeLut = { 620 '-1':'0', 621 '1':'1', 622 } #id1_signEncodeLut 623 624 id1_signDecodeLut = { 625 '0':'-1', 626 '1':'1', 627 } # id1_signEncodeLut 628 629 id2_signEncodeLut = { 630 '-1':'0', 631 '1':'1', 632 } #id2_signEncodeLut 633 634 id2_signDecodeLut = { 635 '0':'-1', 636 '1':'1', 637 } # id2_signEncodeLut 638 639 id3_signEncodeLut = { 640 '-1':'0', 641 '1':'1', 642 } #id3_signEncodeLut 643 644 id3_signDecodeLut = { 645 '0':'-1', 646 '1':'1', 647 } # id3_signEncodeLut 648 649 id4_signEncodeLut = { 650 '-1':'0', 651 '1':'1', 652 } #id4_signEncodeLut 653 654 id4_signDecodeLut = { 655 '0':'-1', 656 '1':'1', 657 } # id4_signEncodeLut 658 659 ###################################################################### 660 # SQL SUPPORT 661 ###################################################################### 662 663 dbTableName='ris_waterlevel' 664 'Database table name' 665

666 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 667 ,addCoastGuardFields=True 668 ,dbType='postgres' 669 ):

670 ''' 671 Return the SQL CREATE command for this message type 672 @param outfile: file like object to print to. 673 @param fields: which fields to put in the create. Defaults to all. 674 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 675 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 676 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 677 @type addCoastGuardFields: bool 678 @return: sql create string 679 @rtype: str 680 681 @see: sqlCreate 682 ''' 683 # FIX: should this sqlCreate be the same as in LaTeX (createFuncName) rather than hard coded? 684 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))

685

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

687 ''' 688 Return the sqlhelp object to create the table. 689 690 @param fields: which fields to put in the create. Defaults to all. 691 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 692 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 693 @type addCoastGuardFields: bool 694 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 695 @return: An object that can be used to generate a return 696 @rtype: sqlhelp.create 697 ''' 698 if None == fields: fields = fieldList 699 import sqlhelp 700 c = sqlhelp.create('ris_waterlevel',dbType=dbType) 701 c.addPrimaryKey() 702 if 'MessageID' in fields: c.addInt ('MessageID') 703 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator') 704 if 'UserID' in fields: c.addInt ('UserID') 705 if 'Spare' in fields: c.addInt ('Spare') 706 if 'dac' in fields: c.addInt ('dac') 707 if 'fid' in fields: c.addInt ('fid') 708 if 'country' in fields: c.addVarChar('country',2) 709 if 'id1_id' in fields: c.addInt ('id1_id') 710 if 'id1_sign' in fields: c.addInt ('id1_sign') 711 if 'id1_waterlevel' in fields: c.addDecimal('id1_waterlevel',4,2) 712 if 'id1_i_have_no_idea' in fields: c.addInt ('id1_i_have_no_idea') 713 if 'id2_id' in fields: c.addInt ('id2_id') 714 if 'id2_sign' in fields: c.addInt ('id2_sign') 715 if 'id2_waterlevel' in fields: c.addDecimal('id2_waterlevel',4,2) 716 if 'id2_i_have_no_idea' in fields: c.addInt ('id2_i_have_no_idea') 717 if 'id3_id' in fields: c.addInt ('id3_id') 718 if 'id3_sign' in fields: c.addInt ('id3_sign') 719 if 'id3_waterlevel' in fields: c.addDecimal('id3_waterlevel',4,2) 720 if 'id3_i_have_no_idea' in fields: c.addInt ('id3_i_have_no_idea') 721 if 'id4_id' in fields: c.addInt ('id4_id') 722 if 'id4_sign' in fields: c.addInt ('id4_sign') 723 if 'id4_waterlevel' in fields: c.addDecimal('id4_waterlevel',4,2) 724 if 'id4_i_have_no_idea' in fields: c.addInt ('id4_i_have_no_idea') 725 726 if addCoastGuardFields: 727 # c.addInt('cg_rssi') # Relative signal strength indicator 728 # c.addInt('cg_d') # dBm receive strength 729 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 730 # c.addInt('cg_S') # Slot received in 731 # c.addVarChar('cg_x',10) # Idonno 732 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 733 c.addInt('cg_sec') # UTC seconds since the epoch 734 735 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 736 737 return c

738

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

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

751 752

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

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

802 803 ###################################################################### 804 # LATEX SUPPORT 805 ###################################################################### 806

807 -def latexDefinitionTable(outfile=sys.stdout 808 ):

809 ''' 810 Return the LaTeX definition table for this message type 811 @param outfile: file like object to print to. 812 @type outfile: file obj 813 @return: LaTeX table string via the outfile 814 @rtype: str 815 816 ''' 817 o = outfile 818 819 o.write(''' 820 \\begin{table}%[htb] 821 \\centering 822 \\begin{tabular}{|l|c|l|} 823 \\hline 824 Parameter & Number of bits & Description 825 \\\\ \\hline\\hline 826 MessageID & 6 & AIS message number. Must be 8 \\\\ \hline 827 RepeatIndicator & 2 & Indicated how many times a message has been repeated \\\\ \hline 828 UserID & 30 & Unique ship identification number (MMSI) \\\\ \hline 829 Spare & 2 & Reserved for definition by a regional authority. \\\\ \hline 830 dac & 10 & Designated Area Code \\\\ \hline 831 fid & 6 & Functional Identifier \\\\ \hline 832 country & 12 & UN country code using 2*6-Bit ASCII characters according to ERI specification \\\\ \hline 833 id1\_id & 11 & One tide gauge measurement. Station ID defined by ERI for each country \\\\ \hline 834 id1\_sign & 1 & One tide gauge measurement. sign of the number in the waterlevel \\\\ \hline 835 id1\_waterlevel & 11 & One tide gauge measurement. Water level at the sensor \\\\ \hline 836 id1\_i\_have\_no\_idea & 2 & One tide gauge measurement. What are these bits for? They do not seem to be specified \\\\ \hline 837 id2\_id & 11 & One tide gauge measurement. Station ID defined by ERI for each country \\\\ \hline 838 id2\_sign & 1 & One tide gauge measurement. sign of the number in the waterlevel \\\\ \hline 839 id2\_waterlevel & 11 & One tide gauge measurement. Water level at the sensor \\\\ \hline 840 id2\_i\_have\_no\_idea & 2 & One tide gauge measurement. What are these bits for? They do not seem to be specified \\\\ \hline 841 id3\_id & 11 & One tide gauge measurement. Station ID defined by ERI for each country \\\\ \hline 842 id3\_sign & 1 & One tide gauge measurement. sign of the number in the waterlevel \\\\ \hline 843 id3\_waterlevel & 11 & One tide gauge measurement. Water level at the sensor \\\\ \hline 844 id3\_i\_have\_no\_idea & 2 & One tide gauge measurement. What are these bits for? They do not seem to be specified \\\\ \hline 845 id4\_id & 11 & One tide gauge measurement. Station ID defined by ERI for each country \\\\ \hline 846 id4\_sign & 1 & One tide gauge measurement. sign of the number in the waterlevel \\\\ \hline 847 id4\_waterlevel & 11 & One tide gauge measurement. Water level at the sensor \\\\ \hline 848 id4\_i\_have\_no\_idea & 2 & One tide gauge measurement. What are these bits for? They do not seem to be specified\\\\ \\hline \\hline 849 Total bits & 168 & Appears to take 1 slot \\\\ \\hline 850 \\end{tabular} 851 \\caption{AIS message number 8: RIS ECE\\TRANS\\SC.3\\2006\\10 Table 2.15: Water level report} 852 \\label{tab:ris_waterlevel} 853 \\end{table} 854 ''')

855 856 ###################################################################### 857 # Text Definition 858 ###################################################################### 859

860 -def textDefinitionTable(outfile=sys.stdout 861 ,delim='\t' 862 ):

863 ''' 864 Return the text definition table for this message type 865 @param outfile: file like object to print to. 866 @type outfile: file obj 867 @return: text table string via the outfile 868 @rtype: str 869 870 ''' 871 o = outfile 872 o.write('''Parameter'''+delim+'Number of bits'''+delim+'''Description 873 MessageID'''+delim+'''6'''+delim+'''AIS message number. Must be 8 874 RepeatIndicator'''+delim+'''2'''+delim+'''Indicated how many times a message has been repeated 875 UserID'''+delim+'''30'''+delim+'''Unique ship identification number (MMSI) 876 Spare'''+delim+'''2'''+delim+'''Reserved for definition by a regional authority. 877 dac'''+delim+'''10'''+delim+'''Designated Area Code 878 fid'''+delim+'''6'''+delim+'''Functional Identifier 879 country'''+delim+'''12'''+delim+'''UN country code using 2*6-Bit ASCII characters according to ERI specification 880 id1_id'''+delim+'''11'''+delim+'''One tide gauge measurement. Station ID defined by ERI for each country 881 id1_sign'''+delim+'''1'''+delim+'''One tide gauge measurement. sign of the number in the waterlevel 882 id1_waterlevel'''+delim+'''11'''+delim+'''One tide gauge measurement. Water level at the sensor 883 id1_i_have_no_idea'''+delim+'''2'''+delim+'''One tide gauge measurement. What are these bits for? They do not seem to be specified 884 id2_id'''+delim+'''11'''+delim+'''One tide gauge measurement. Station ID defined by ERI for each country 885 id2_sign'''+delim+'''1'''+delim+'''One tide gauge measurement. sign of the number in the waterlevel 886 id2_waterlevel'''+delim+'''11'''+delim+'''One tide gauge measurement. Water level at the sensor 887 id2_i_have_no_idea'''+delim+'''2'''+delim+'''One tide gauge measurement. What are these bits for? They do not seem to be specified 888 id3_id'''+delim+'''11'''+delim+'''One tide gauge measurement. Station ID defined by ERI for each country 889 id3_sign'''+delim+'''1'''+delim+'''One tide gauge measurement. sign of the number in the waterlevel 890 id3_waterlevel'''+delim+'''11'''+delim+'''One tide gauge measurement. Water level at the sensor 891 id3_i_have_no_idea'''+delim+'''2'''+delim+'''One tide gauge measurement. What are these bits for? They do not seem to be specified 892 id4_id'''+delim+'''11'''+delim+'''One tide gauge measurement. Station ID defined by ERI for each country 893 id4_sign'''+delim+'''1'''+delim+'''One tide gauge measurement. sign of the number in the waterlevel 894 id4_waterlevel'''+delim+'''11'''+delim+'''One tide gauge measurement. Water level at the sensor 895 id4_i_have_no_idea'''+delim+'''2'''+delim+'''One tide gauge measurement. What are these bits for? They do not seem to be specified 896 Total bits'''+delim+'''168'''+delim+'''Appears to take 1 slot''')

897 898 899 ###################################################################### 900 # UNIT TESTING 901 ###################################################################### 902 import unittest

903 -def testParams():

904 '''Return a params file base on the testvalue tags. 905 @rtype: dict 906 @return: params based on testvalue tags 907 ''' 908 params = {} 909 params['MessageID'] = 8 910 params['RepeatIndicator'] = 1 911 params['UserID'] = 1193046 912 params['Spare'] = 0 913 params['dac'] = 000 914 params['fid'] = 1 915 params['country'] = 'ZZ' 916 params['id1_id'] = 4 917 params['id1_sign'] = 0 918 params['id1_waterlevel'] = Decimal('3.21') 919 params['id1_i_have_no_idea'] = 0 920 params['id2_id'] = 4 921 params['id2_sign'] = 0 922 params['id2_waterlevel'] = Decimal('3.21') 923 params['id2_i_have_no_idea'] = 0 924 params['id3_id'] = 4 925 params['id3_sign'] = 0 926 params['id3_waterlevel'] = Decimal('3.21') 927 params['id3_i_have_no_idea'] = 0 928 params['id4_id'] = 4 929 params['id4_sign'] = 0 930 params['id4_waterlevel'] = Decimal('3.21') 931 params['id4_i_have_no_idea'] = 0 932 933 return params

934

935 -class Testris_waterlevel(unittest.TestCase):

936 '''Use testvalue tag text from each type to build test case the ris_waterlevel message'''

937 - def testEncodeDecode(self):

938 939 params = testParams() 940 bits = encode(params) 941 r = decode(bits) 942 943 # Check that each parameter came through ok. 944 self.failUnlessEqual(r['MessageID'],params['MessageID']) 945 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator']) 946 self.failUnlessEqual(r['UserID'],params['UserID']) 947 self.failUnlessEqual(r['Spare'],params['Spare']) 948 self.failUnlessEqual(r['dac'],params['dac']) 949 self.failUnlessEqual(r['fid'],params['fid']) 950 self.failUnlessEqual(r['country'],params['country']) 951 self.failUnlessEqual(r['id1_id'],params['id1_id']) 952 self.failUnlessEqual(r['id1_sign'],params['id1_sign']) 953 self.failUnlessAlmostEqual(r['id1_waterlevel'],params['id1_waterlevel'],2) 954 self.failUnlessEqual(r['id1_i_have_no_idea'],params['id1_i_have_no_idea']) 955 self.failUnlessEqual(r['id2_id'],params['id2_id']) 956 self.failUnlessEqual(r['id2_sign'],params['id2_sign']) 957 self.failUnlessAlmostEqual(r['id2_waterlevel'],params['id2_waterlevel'],2) 958 self.failUnlessEqual(r['id2_i_have_no_idea'],params['id2_i_have_no_idea']) 959 self.failUnlessEqual(r['id3_id'],params['id3_id']) 960 self.failUnlessEqual(r['id3_sign'],params['id3_sign']) 961 self.failUnlessAlmostEqual(r['id3_waterlevel'],params['id3_waterlevel'],2) 962 self.failUnlessEqual(r['id3_i_have_no_idea'],params['id3_i_have_no_idea']) 963 self.failUnlessEqual(r['id4_id'],params['id4_id']) 964 self.failUnlessEqual(r['id4_sign'],params['id4_sign']) 965 self.failUnlessAlmostEqual(r['id4_waterlevel'],params['id4_waterlevel'],2) 966 self.failUnlessEqual(r['id4_i_have_no_idea'],params['id4_i_have_no_idea'])

967

968 -def addMsgOptions(parser):

969 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 970 help='decode a "ris_waterlevel" AIS message') 971 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 972 help='encode a "ris_waterlevel" AIS message') 973 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int' 974 ,help='Field parameter value [default: %default]') 975 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int' 976 ,help='Field parameter value [default: %default]') 977 parser.add_option('--country-field', dest='countryField',metavar='aisstr6',type='string' 978 ,help='Field parameter value [default: %default]') 979 parser.add_option('--id1_id-field', dest='id1_idField',metavar='uint',type='int' 980 ,help='Field parameter value [default: %default]') 981 parser.add_option('--id1_sign-field', dest='id1_signField',metavar='uint',type='int' 982 ,help='Field parameter value [default: %default]') 983 parser.add_option('--id1_waterlevel-field', dest='id1_waterlevelField',metavar='decimal',type='string' 984 ,help='Field parameter value [default: %default]') 985 parser.add_option('--id2_id-field', dest='id2_idField',metavar='uint',type='int' 986 ,help='Field parameter value [default: %default]') 987 parser.add_option('--id2_sign-field', dest='id2_signField',metavar='uint',type='int' 988 ,help='Field parameter value [default: %default]') 989 parser.add_option('--id2_waterlevel-field', dest='id2_waterlevelField',metavar='decimal',type='string' 990 ,help='Field parameter value [default: %default]') 991 parser.add_option('--id3_id-field', dest='id3_idField',metavar='uint',type='int' 992 ,help='Field parameter value [default: %default]') 993 parser.add_option('--id3_sign-field', dest='id3_signField',metavar='uint',type='int' 994 ,help='Field parameter value [default: %default]') 995 parser.add_option('--id3_waterlevel-field', dest='id3_waterlevelField',metavar='decimal',type='string' 996 ,help='Field parameter value [default: %default]') 997 parser.add_option('--id4_id-field', dest='id4_idField',metavar='uint',type='int' 998 ,help='Field parameter value [default: %default]') 999 parser.add_option('--id4_sign-field', dest='id4_signField',metavar='uint',type='int' 1000 ,help='Field parameter value [default: %default]') 1001 parser.add_option('--id4_waterlevel-field', dest='id4_waterlevelField',metavar='decimal',type='string' 1002 ,help='Field parameter value [default: %default]')

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

Source Code for Module ais.ris.waterlevel