ais.sls.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 'time_month', 51 'time_day', 52 'time_hour', 53 'time_min', 54 'stationid', 55 'pos_longitude', 56 'pos_latitude', 57 'type', 58 'waterlevel', 59 'datum', 60 'reserved', 61 ) 62 63 fieldListPostgres = ( 64 'time_month', 65 'time_day', 66 'time_hour', 67 'time_min', 68 'stationid', 69 'pos', # PostGIS data type 70 'type', 71 'waterlevel', 72 'datum', 73 'reserved', 74 ) 75 76 toPgFields = { 77 'pos_longitude':'pos', 78 'pos_latitude':'pos', 79 } 80 ''' 81 Go to the Postgis field names from the straight field name 82 ''' 83 84 fromPgFields = { 85 'pos':('pos_longitude','pos_latitude',), 86 } 87 ''' 88 Go from the Postgis field names to the straight field name 89 ''' 90 91 pgTypes = { 92 'pos':'POINT', 93 } 94 ''' 95 Lookup table for each postgis field name to get its type. 96 ''' 97

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

99 '''Create a sls_waterlevel binary message payload to pack into an AIS Msg sls_waterlevel. 100 101 Fields in params: 102 - time_month(uint): Time tag of measurement month 1..12 103 - time_day(uint): Time tag of measurement day of the month 1..31 104 - time_hour(uint): Time tag of measurement UTC hours 0..23 105 - time_min(uint): Time tag of measurement minutes 106 - stationid(aisstr6): Character identifier of the station. Usually a number. 107 - pos_longitude(decimal): Location of measurement East West location 108 - pos_latitude(decimal): Location of measurement North South location 109 - type(uint): How to interpret the water level 110 - waterlevel(int): Water level in centimeters 111 - datum(uint): What reference datum applies to the value 112 - reserved(uint): Reserved bits for future use (field automatically set to "0") 113 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing 114 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 115 @rtype: BitVector 116 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8 117 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits. 118 ''' 119 120 bvList = [] 121 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_month']),4)) 122 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_day']),5)) 123 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_hour']),5)) 124 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['time_min']),6)) 125 if 'stationid' in params: 126 bvList.append(aisstring.encode(params['stationid'],42)) 127 else: 128 bvList.append(aisstring.encode('@@@@@@@',42)) 129 if 'pos_longitude' in params: 130 bvList.append(binary.bvFromSignedInt(int(Decimal(params['pos_longitude'])*Decimal('60000')),25)) 131 else: 132 bvList.append(binary.bvFromSignedInt(10860000,25)) 133 if 'pos_latitude' in params: 134 bvList.append(binary.bvFromSignedInt(int(Decimal(params['pos_latitude'])*Decimal('60000')),24)) 135 else: 136 bvList.append(binary.bvFromSignedInt(5460000,24)) 137 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['type']),1)) 138 if 'waterlevel' in params: 139 bvList.append(binary.bvFromSignedInt(params['waterlevel'],16)) 140 else: 141 bvList.append(binary.bvFromSignedInt(-32768,16)) 142 if 'datum' in params: 143 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['datum']),2)) 144 else: 145 bvList.append(binary.setBitVectorSize(BitVector(intVal=31),2)) 146 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),14)) 147 148 return binary.joinBV(bvList)

149

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

151 '''Unpack a sls_waterlevel message 152 153 Fields in params: 154 - time_month(uint): Time tag of measurement month 1..12 155 - time_day(uint): Time tag of measurement day of the month 1..31 156 - time_hour(uint): Time tag of measurement UTC hours 0..23 157 - time_min(uint): Time tag of measurement minutes 158 - stationid(aisstr6): Character identifier of the station. Usually a number. 159 - pos_longitude(decimal): Location of measurement East West location 160 - pos_latitude(decimal): Location of measurement North South location 161 - type(uint): How to interpret the water level 162 - waterlevel(int): Water level in centimeters 163 - datum(uint): What reference datum applies to the value 164 - reserved(uint): Reserved bits for future use (field automatically set to "0") 165 @type bv: BitVector 166 @param bv: Bits defining a message 167 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented. 168 @rtype: dict 169 @return: params 170 ''' 171 172 #Would be nice to check the bit count here.. 173 #if validate: 174 # assert (len(bv)==FIX: SOME NUMBER) 175 r = {} 176 r['time_month']=int(bv[0:4]) 177 r['time_day']=int(bv[4:9]) 178 r['time_hour']=int(bv[9:14]) 179 r['time_min']=int(bv[14:20]) 180 r['stationid']=aisstring.decode(bv[20:62]) 181 r['pos_longitude']=Decimal(binary.signedIntFromBV(bv[62:87]))/Decimal('60000') 182 r['pos_latitude']=Decimal(binary.signedIntFromBV(bv[87:111]))/Decimal('60000') 183 r['type']=int(bv[111:112]) 184 r['waterlevel']=binary.signedIntFromBV(bv[112:128]) 185 r['datum']=int(bv[128:130]) 186 r['reserved']=0 187 return r

188

189 -def decodetime_month(bv, validate=False):

190 return int(bv[0:4])

191

192 -def decodetime_day(bv, validate=False):

193 return int(bv[4:9])

194

195 -def decodetime_hour(bv, validate=False):

196 return int(bv[9:14])

197

198 -def decodetime_min(bv, validate=False):

199 return int(bv[14:20])

200

201 -def decodestationid(bv, validate=False):

202 return aisstring.decode(bv[20:62])

203

204 -def decodepos_longitude(bv, validate=False):

205 return Decimal(binary.signedIntFromBV(bv[62:87]))/Decimal('60000')

206

207 -def decodepos_latitude(bv, validate=False):

208 return Decimal(binary.signedIntFromBV(bv[87:111]))/Decimal('60000')

209

210 -def decodetype(bv, validate=False):

211 return int(bv[111:112])

212

213 -def decodewaterlevel(bv, validate=False):

214 return binary.signedIntFromBV(bv[112:128])

215

216 -def decodedatum(bv, validate=False):

217 return int(bv[128:130])

218

219 -def decodereserved(bv, validate=False):

220 return 0

221 222

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

224 out.write("<h3>sls_waterlevel</h3>\n") 225 out.write("<table border=\"1\">\n") 226 out.write("<tr bgcolor=\"orange\">\n") 227 out.write("<th align=\"left\">Field Name</th>\n") 228 out.write("<th align=\"left\">Type</th>\n") 229 out.write("<th align=\"left\">Value</th>\n") 230 out.write("<th align=\"left\">Value in Lookup Table</th>\n") 231 out.write("<th align=\"left\">Units</th>\n") 232 out.write("\n") 233 out.write("<tr>\n") 234 out.write("<td>time_month</td>\n") 235 out.write("<td>uint</td>\n") 236 if 'time_month' in params: 237 out.write(" <td>"+str(params['time_month'])+"</td>\n") 238 out.write(" <td>"+str(params['time_month'])+"</td>\n") 239 out.write("</tr>\n") 240 out.write("\n") 241 out.write("<tr>\n") 242 out.write("<td>time_day</td>\n") 243 out.write("<td>uint</td>\n") 244 if 'time_day' in params: 245 out.write(" <td>"+str(params['time_day'])+"</td>\n") 246 out.write(" <td>"+str(params['time_day'])+"</td>\n") 247 out.write("</tr>\n") 248 out.write("\n") 249 out.write("<tr>\n") 250 out.write("<td>time_hour</td>\n") 251 out.write("<td>uint</td>\n") 252 if 'time_hour' in params: 253 out.write(" <td>"+str(params['time_hour'])+"</td>\n") 254 out.write(" <td>"+str(params['time_hour'])+"</td>\n") 255 out.write("</tr>\n") 256 out.write("\n") 257 out.write("<tr>\n") 258 out.write("<td>time_min</td>\n") 259 out.write("<td>uint</td>\n") 260 if 'time_min' in params: 261 out.write(" <td>"+str(params['time_min'])+"</td>\n") 262 out.write(" <td>"+str(params['time_min'])+"</td>\n") 263 out.write("</tr>\n") 264 out.write("\n") 265 out.write("<tr>\n") 266 out.write("<td>stationid</td>\n") 267 out.write("<td>aisstr6</td>\n") 268 if 'stationid' in params: 269 out.write(" <td>"+str(params['stationid'])+"</td>\n") 270 out.write(" <td>"+str(params['stationid'])+"</td>\n") 271 out.write("</tr>\n") 272 out.write("\n") 273 out.write("<tr>\n") 274 out.write("<td>pos_longitude</td>\n") 275 out.write("<td>decimal</td>\n") 276 if 'pos_longitude' in params: 277 out.write(" <td>"+str(params['pos_longitude'])+"</td>\n") 278 out.write(" <td>"+str(params['pos_longitude'])+"</td>\n") 279 out.write("<td>degrees</td>\n") 280 out.write("</tr>\n") 281 out.write("\n") 282 out.write("<tr>\n") 283 out.write("<td>pos_latitude</td>\n") 284 out.write("<td>decimal</td>\n") 285 if 'pos_latitude' in params: 286 out.write(" <td>"+str(params['pos_latitude'])+"</td>\n") 287 out.write(" <td>"+str(params['pos_latitude'])+"</td>\n") 288 out.write("<td>degrees</td>\n") 289 out.write("</tr>\n") 290 out.write("\n") 291 out.write("<tr>\n") 292 out.write("<td>type</td>\n") 293 out.write("<td>uint</td>\n") 294 if 'type' in params: 295 out.write(" <td>"+str(params['type'])+"</td>\n") 296 if str(params['type']) in typeDecodeLut: 297 out.write("<td>"+typeDecodeLut[str(params['type'])]+"</td>") 298 else: 299 out.write("<td><i>Missing LUT entry</i></td>") 300 out.write("</tr>\n") 301 out.write("\n") 302 out.write("<tr>\n") 303 out.write("<td>waterlevel</td>\n") 304 out.write("<td>int</td>\n") 305 if 'waterlevel' in params: 306 out.write(" <td>"+str(params['waterlevel'])+"</td>\n") 307 out.write(" <td>"+str(params['waterlevel'])+"</td>\n") 308 out.write("<td>cm</td>\n") 309 out.write("</tr>\n") 310 out.write("\n") 311 out.write("<tr>\n") 312 out.write("<td>datum</td>\n") 313 out.write("<td>uint</td>\n") 314 if 'datum' in params: 315 out.write(" <td>"+str(params['datum'])+"</td>\n") 316 if str(params['datum']) in datumDecodeLut: 317 out.write("<td>"+datumDecodeLut[str(params['datum'])]+"</td>") 318 else: 319 out.write("<td><i>Missing LUT entry</i></td>") 320 out.write("</tr>\n") 321 out.write("\n") 322 out.write("<tr>\n") 323 out.write("<td>reserved</td>\n") 324 out.write("<td>uint</td>\n") 325 if 'reserved' in params: 326 out.write(" <td>"+str(params['reserved'])+"</td>\n") 327 out.write(" <td>"+str(params['reserved'])+"</td>\n") 328 out.write("</tr>\n") 329 out.write("</table>\n")

330 331

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

333 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer''' 334 out.write("\ <Placemark>\n") 335 out.write("\t <name>"+str(params['stationid'])+"</name>\n") 336 out.write("\t\t<description>\n") 337 import StringIO 338 buf = StringIO.StringIO() 339 printHtml(params,buf) 340 import cgi 341 out.write(cgi.escape(buf.getvalue())) 342 out.write("\t\t</description>\n") 343 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n") 344 out.write("\t\t<Point>\n") 345 out.write("\t\t\t<coordinates>") 346 out.write(str(params['pos_longitude'])) 347 out.write(',') 348 out.write(str(params['pos_latitude'])) 349 out.write(",0</coordinates>\n") 350 out.write("\t\t</Point>\n") 351 out.write("\t</Placemark>\n")

352

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

354 '''Print a sls_waterlevel message to stdout. 355 356 Fields in params: 357 - time_month(uint): Time tag of measurement month 1..12 358 - time_day(uint): Time tag of measurement day of the month 1..31 359 - time_hour(uint): Time tag of measurement UTC hours 0..23 360 - time_min(uint): Time tag of measurement minutes 361 - stationid(aisstr6): Character identifier of the station. Usually a number. 362 - pos_longitude(decimal): Location of measurement East West location 363 - pos_latitude(decimal): Location of measurement North South location 364 - type(uint): How to interpret the water level 365 - waterlevel(int): Water level in centimeters 366 - datum(uint): What reference datum applies to the value 367 - reserved(uint): Reserved bits for future use (field automatically set to "0") 368 @param params: Dictionary of field names/values. 369 @param out: File like object to write to 370 @rtype: stdout 371 @return: text to out 372 ''' 373 374 if 'std'==format: 375 out.write("sls_waterlevel:\n") 376 if 'time_month' in params: out.write(" time_month: "+str(params['time_month'])+"\n") 377 if 'time_day' in params: out.write(" time_day: "+str(params['time_day'])+"\n") 378 if 'time_hour' in params: out.write(" time_hour: "+str(params['time_hour'])+"\n") 379 if 'time_min' in params: out.write(" time_min: "+str(params['time_min'])+"\n") 380 if 'stationid' in params: out.write(" stationid: "+str(params['stationid'])+"\n") 381 if 'pos_longitude' in params: out.write(" pos_longitude: "+str(params['pos_longitude'])+"\n") 382 if 'pos_latitude' in params: out.write(" pos_latitude: "+str(params['pos_latitude'])+"\n") 383 if 'type' in params: out.write(" type: "+str(params['type'])+"\n") 384 if 'waterlevel' in params: out.write(" waterlevel: "+str(params['waterlevel'])+"\n") 385 if 'datum' in params: out.write(" datum: "+str(params['datum'])+"\n") 386 if 'reserved' in params: out.write(" reserved: "+str(params['reserved'])+"\n") 387 elif 'csv'==format: 388 if None == options.fieldList: 389 options.fieldList = fieldList 390 needComma = False; 391 for field in fieldList: 392 if needComma: out.write(',') 393 needComma = True 394 if field in params: 395 out.write(str(params[field])) 396 # else: leave it empty 397 out.write("\n") 398 elif 'html'==format: 399 printHtml(params,out) 400 elif 'sql'==format: 401 sqlInsertStr(params,out,dbType=dbType) 402 elif 'kml'==format: 403 printKml(params,out) 404 elif 'kml-full'==format: 405 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n") 406 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n") 407 out.write("<Document>\n") 408 out.write(" <name>sls_waterlevel</name>\n") 409 printKml(params,out) 410 out.write("</Document>\n") 411 out.write("</kml>\n") 412 else: 413 print "ERROR: unknown format:",format 414 assert False 415 416 return # Nothing to return

417 418 typeEncodeLut = { 419 'Relative to datum':'0', 420 'Water depth':'1', 421 } #typeEncodeLut 422 423 typeDecodeLut = { 424 '0':'Relative to datum', 425 '1':'Water depth', 426 } # typeEncodeLut 427 428 datumEncodeLut = { 429 'MLLW':'0', 430 'IGLD-85':'1', 431 'Reserved':'2', 432 'Reserved':'3', 433 } #datumEncodeLut 434 435 datumDecodeLut = { 436 '0':'MLLW', 437 '1':'IGLD-85', 438 '2':'Reserved', 439 '3':'Reserved', 440 } # datumEncodeLut 441 442 ###################################################################### 443 # SQL SUPPORT 444 ###################################################################### 445 446 dbTableName='sls_waterlevel' 447 'Database table name' 448

449 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None 450 ,addCoastGuardFields=True 451 ,dbType='postgres' 452 ):

453 ''' 454 Return the SQL CREATE command for this message type 455 @param outfile: file like object to print to. 456 @param fields: which fields to put in the create. Defaults to all. 457 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 458 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 459 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 460 @type addCoastGuardFields: bool 461 @return: sql create string 462 @rtype: str 463 464 @see: sqlCreate 465 ''' 466 # FIX: should this sqlCreate be the same as in LaTeX (createFuncName) rather than hard coded? 467 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))

468

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

470 ''' 471 Return the sqlhelp object to create the table. 472 473 @param fields: which fields to put in the create. Defaults to all. 474 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields 475 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format 476 @type addCoastGuardFields: bool 477 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres') 478 @return: An object that can be used to generate a return 479 @rtype: sqlhelp.create 480 ''' 481 if None == fields: fields = fieldList 482 import sqlhelp 483 c = sqlhelp.create('sls_waterlevel',dbType=dbType) 484 c.addPrimaryKey() 485 if 'time_month' in fields: c.addInt ('time_month') 486 if 'time_day' in fields: c.addInt ('time_day') 487 if 'time_hour' in fields: c.addInt ('time_hour') 488 if 'time_min' in fields: c.addInt ('time_min') 489 if 'stationid' in fields: c.addVarChar('stationid',7) 490 if dbType != 'postgres': 491 if 'pos_longitude' in fields: c.addDecimal('pos_longitude',7,4) 492 if dbType != 'postgres': 493 if 'pos_latitude' in fields: c.addDecimal('pos_latitude',7,4) 494 if 'type' in fields: c.addInt ('type') 495 if 'waterlevel' in fields: c.addInt ('waterlevel') 496 if 'datum' in fields: c.addInt ('datum') 497 if 'reserved' in fields: c.addInt ('reserved') 498 499 if addCoastGuardFields: 500 # c.addInt('cg_rssi') # Relative signal strength indicator 501 # c.addInt('cg_d') # dBm receive strength 502 # c.addInt('cg_T') # Receive timestamp from the AIS equipment 503 # c.addInt('cg_S') # Slot received in 504 # c.addVarChar('cg_x',10) # Idonno 505 c.addVarChar('cg_r',15) # Receiver station ID - should usually be an MMSI, but sometimes is a string 506 c.addInt('cg_sec') # UTC seconds since the epoch 507 508 c.addTimestamp('cg_timestamp') # UTC decoded cg_sec - not actually in the data stream 509 510 if dbType == 'postgres': 511 #--- EPSG 4326 : WGS 84 512 #INSERT INTO "spatial_ref_sys" ("srid","auth_name","auth_srid","srtext","proj4text") VALUES (4326,'EPSG',4326,'GEOGCS["WGS 84",DATUM["WGS_1984",SPHEROID["WGS 84",6378137,298.257223563,AUTHORITY["EPSG","7030"]],TOWGS84[0,0,0,0,0,0,0],AUTHORITY["EPSG","6326"]],PRIMEM["Greenwich",0,AUTHORITY["EPSG","8901"]],UNIT["degree",0.01745329251994328,AUTHORITY["EPSG","9122"]],AUTHORITY["EPSG","4326"]]','+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs '); 513 c.addPostGIS('pos','POINT',2,SRID=4326); 514 515 return c

516

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

518 ''' 519 Return the SQL INSERT command for this message type 520 @param params: dictionary of values keyed by field name 521 @param outfile: file like object to print to. 522 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields 523 @return: sql create string 524 @rtype: str 525 526 @see: sqlCreate 527 ''' 528 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))

529 530

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

532 ''' 533 Give the SQL INSERT statement 534 @param params: dict keyed by field name of values 535 @param extraParams: any extra fields that you have created beyond the normal ais message fields 536 @rtype: sqlhelp.insert 537 @return: insert class instance 538 @todo: allow optional type checking of params? 539 @warning: this will take invalid keys happily and do what??? 540 ''' 541 import sqlhelp 542 i = sqlhelp.insert('sls_waterlevel',dbType=dbType) 543 544 if dbType=='postgres': 545 finished = [] 546 for key in params: 547 if key in finished: 548 continue 549 550 if key not in toPgFields and key not in fromPgFields: 551 if type(params[key])==Decimal: i.add(key,float(params[key])) 552 else: i.add(key,params[key]) 553 else: 554 if key in fromPgFields: 555 val = params[key] 556 # Had better be a WKT type like POINT(-88.1 30.321) 557 i.addPostGIS(key,val) 558 finished.append(key) 559 else: 560 # Need to construct the type. 561 pgName = toPgFields[key] 562 #valStr='GeomFromText(\''+pgTypes[pgName]+'(' 563 valStr=pgTypes[pgName]+'(' 564 vals = [] 565 for nonPgKey in fromPgFields[pgName]: 566 vals.append(str(params[nonPgKey])) 567 finished.append(nonPgKey) 568 valStr+=' '.join(vals)+')' 569 i.addPostGIS(pgName,valStr) 570 else: 571 for key in params: 572 if type(params[key])==Decimal: i.add(key,float(params[key])) 573 else: i.add(key,params[key]) 574 575 if None != extraParams: 576 for key in extraParams: 577 i.add(key,extraParams[key]) 578 579 return i

580 581 ###################################################################### 582 # LATEX SUPPORT 583 ###################################################################### 584

585 -def latexDefinitionTable(outfile=sys.stdout 586 ):

587 ''' 588 Return the LaTeX definition table for this message type 589 @param outfile: file like object to print to. 590 @type outfile: file obj 591 @return: LaTeX table string via the outfile 592 @rtype: str 593 594 ''' 595 o = outfile 596 597 o.write(''' 598 \\begin{table}%[htb] 599 \\centering 600 \\begin{tabular}{|l|c|l|} 601 \\hline 602 Parameter & Number of bits & Description 603 \\\\ \\hline\\hline 604 time\_month & 4 & Time tag of measurement month 1..12 \\\\ \hline 605 time\_day & 5 & Time tag of measurement day of the month 1..31 \\\\ \hline 606 time\_hour & 5 & Time tag of measurement UTC hours 0..23 \\\\ \hline 607 time\_min & 6 & Time tag of measurement minutes \\\\ \hline 608 stationid & 42 & Character identifier of the station. Usually a number. \\\\ \hline 609 pos\_longitude & 25 & Location of measurement East West location \\\\ \hline 610 pos\_latitude & 24 & Location of measurement North South location \\\\ \hline 611 type & 1 & How to interpret the water level \\\\ \hline 612 waterlevel & 16 & Water level in centimeters \\\\ \hline 613 datum & 2 & What reference datum applies to the value \\\\ \hline 614 reserved & 14 & Reserved bits for future use\\\\ \\hline \\hline 615 Total bits & 144 & Appears to take 1 slot with 24 pad bits to fill the last slot \\\\ \\hline 616 \\end{tabular} 617 \\caption{AIS message number 8: St Lawrance Seaway water level message} 618 \\label{tab:sls_waterlevel} 619 \\end{table} 620 ''')

621 622 ###################################################################### 623 # Text Definition 624 ###################################################################### 625

626 -def textDefinitionTable(outfile=sys.stdout 627 ,delim='\t' 628 ):

629 ''' 630 Return the text definition table for this message type 631 @param outfile: file like object to print to. 632 @type outfile: file obj 633 @return: text table string via the outfile 634 @rtype: str 635 636 ''' 637 o = outfile 638 o.write('''Parameter'''+delim+'Number of bits'''+delim+'''Description 639 time_month'''+delim+'''4'''+delim+'''Time tag of measurement month 1..12 640 time_day'''+delim+'''5'''+delim+'''Time tag of measurement day of the month 1..31 641 time_hour'''+delim+'''5'''+delim+'''Time tag of measurement UTC hours 0..23 642 time_min'''+delim+'''6'''+delim+'''Time tag of measurement minutes 643 stationid'''+delim+'''42'''+delim+'''Character identifier of the station. Usually a number. 644 pos_longitude'''+delim+'''25'''+delim+'''Location of measurement East West location 645 pos_latitude'''+delim+'''24'''+delim+'''Location of measurement North South location 646 type'''+delim+'''1'''+delim+'''How to interpret the water level 647 waterlevel'''+delim+'''16'''+delim+'''Water level in centimeters 648 datum'''+delim+'''2'''+delim+'''What reference datum applies to the value 649 reserved'''+delim+'''14'''+delim+'''Reserved bits for future use 650 Total bits'''+delim+'''144'''+delim+'''Appears to take 1 slot with 24 pad bits to fill the last slot''')

651 652 653 ###################################################################### 654 # UNIT TESTING 655 ###################################################################### 656 import unittest

657 -def testParams():

658 '''Return a params file base on the testvalue tags. 659 @rtype: dict 660 @return: params based on testvalue tags 661 ''' 662 params = {} 663 params['time_month'] = 2 664 params['time_day'] = 28 665 params['time_hour'] = 23 666 params['time_min'] = 45 667 params['stationid'] = 'A234567' 668 params['pos_longitude'] = Decimal('-122.16328') 669 params['pos_latitude'] = Decimal('37.42446') 670 params['type'] = 0 671 params['waterlevel'] = -97 672 params['datum'] = 0 673 params['reserved'] = 0 674 675 return params

676

677 -class Testsls_waterlevel(unittest.TestCase):

678 '''Use testvalue tag text from each type to build test case the sls_waterlevel message'''

679 - def testEncodeDecode(self):

680 681 params = testParams() 682 bits = encode(params) 683 r = decode(bits) 684 685 # Check that each parameter came through ok. 686 self.failUnlessEqual(r['time_month'],params['time_month']) 687 self.failUnlessEqual(r['time_day'],params['time_day']) 688 self.failUnlessEqual(r['time_hour'],params['time_hour']) 689 self.failUnlessEqual(r['time_min'],params['time_min']) 690 self.failUnlessEqual(r['stationid'],params['stationid']) 691 self.failUnlessAlmostEqual(r['pos_longitude'],params['pos_longitude'],4) 692 self.failUnlessAlmostEqual(r['pos_latitude'],params['pos_latitude'],4) 693 self.failUnlessEqual(r['type'],params['type']) 694 self.failUnlessEqual(r['waterlevel'],params['waterlevel']) 695 self.failUnlessEqual(r['datum'],params['datum']) 696 self.failUnlessEqual(r['reserved'],params['reserved'])

697

698 -def addMsgOptions(parser):

699 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true', 700 help='decode a "sls_waterlevel" AIS message') 701 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true', 702 help='encode a "sls_waterlevel" AIS message') 703 parser.add_option('--time_month-field', dest='time_monthField',metavar='uint',type='int' 704 ,help='Field parameter value [default: %default]') 705 parser.add_option('--time_day-field', dest='time_dayField',metavar='uint',type='int' 706 ,help='Field parameter value [default: %default]') 707 parser.add_option('--time_hour-field', dest='time_hourField',metavar='uint',type='int' 708 ,help='Field parameter value [default: %default]') 709 parser.add_option('--time_min-field', dest='time_minField',metavar='uint',type='int' 710 ,help='Field parameter value [default: %default]') 711 parser.add_option('--stationid-field', dest='stationidField',default='@@@@@@@',metavar='aisstr6',type='string' 712 ,help='Field parameter value [default: %default]') 713 parser.add_option('--pos_longitude-field', dest='pos_longitudeField',default=Decimal('181'),metavar='decimal',type='string' 714 ,help='Field parameter value [default: %default]') 715 parser.add_option('--pos_latitude-field', dest='pos_latitudeField',default=Decimal('91'),metavar='decimal',type='string' 716 ,help='Field parameter value [default: %default]') 717 parser.add_option('--type-field', dest='typeField',metavar='uint',type='int' 718 ,help='Field parameter value [default: %default]') 719 parser.add_option('--waterlevel-field', dest='waterlevelField',default=-32768,metavar='int',type='int' 720 ,help='Field parameter value [default: %default]') 721 parser.add_option('--datum-field', dest='datumField',default=31,metavar='uint',type='int' 722 ,help='Field parameter value [default: %default]')

723 724 ############################################################ 725 if __name__=='__main__': 726 727 from optparse import OptionParser 728 parser = OptionParser(usage="%prog [options]", 729 version="%prog "+__version__) 730 731 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true', 732 help='run the documentation tests') 733 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true', 734 help='run the unit tests') 735 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true', 736 help='Make the test output verbose') 737 738 # FIX: remove nmea from binary messages. No way to build the whole packet? 739 # FIX: or build the surrounding msg 8 for a broadcast? 740 typeChoices = ('binary','nmeapayload','nmea') # FIX: what about a USCG type message? 741 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType' 742 ,default='nmeapayload' 743 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]') 744 745 746 outputChoices = ('std','html','csv','sql' , 'kml','kml-full') 747 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType' 748 ,default='std' 749 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]') 750 751 parser.add_option('-o','--output',dest='outputFileName',default=None, 752 help='Name of the python file to write [default: stdout]') 753 754 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append', 755 choices=fieldList, 756 help='Which fields to include in the output. Currently only for csv output [default: all]') 757 758 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true', 759 help='Print the field name for csv') 760 761 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true', 762 help='Print out an sql create command for the table.') 763 764 parser.add_option('--latex-table',dest='latexDefinitionTable',default=False,action='store_true', 765 help='Print a LaTeX table of the type') 766 767 parser.add_option('--text-table',dest='textDefinitionTable',default=False,action='store_true', 768 help='Print delimited table of the type (for Word table importing)') 769 parser.add_option('--delimt-text-table',dest='delimTextDefinitionTable',default='\t' 770 ,help='Delimiter for text table [default: \'%default\'](for Word table importing)') 771 772 773 dbChoices = ('sqlite','postgres') 774 parser.add_option('-D','--db-type',dest='dbType',default='postgres' 775 ,choices=dbChoices,type='choice' 776 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]') 777 778 addMsgOptions(parser) 779 780 (options,args) = parser.parse_args() 781 success=True 782 783 if options.doctest: 784 import os; print os.path.basename(sys.argv[0]), 'doctests ...', 785 sys.argv= [sys.argv[0]] 786 if options.verbose: sys.argv.append('-v') 787 import doctest 788 numfail,numtests=doctest.testmod() 789 if numfail==0: print 'ok' 790 else: 791 print 'FAILED' 792 success=False 793 794 if not success: sys.exit('Something Failed') 795 del success # Hide success from epydoc 796 797 if options.unittest: 798 sys.argv = [sys.argv[0]] 799 if options.verbose: sys.argv.append('-v') 800 unittest.main() 801 802 outfile = sys.stdout 803 if None!=options.outputFileName: 804 outfile = file(options.outputFileName,'w') 805 806 807 if options.doEncode: 808 # First make sure all non required options are specified 809 if None==options.time_monthField: parser.error("missing value for time_monthField") 810 if None==options.time_dayField: parser.error("missing value for time_dayField") 811 if None==options.time_hourField: parser.error("missing value for time_hourField") 812 if None==options.time_minField: parser.error("missing value for time_minField") 813 if None==options.stationidField: parser.error("missing value for stationidField") 814 if None==options.pos_longitudeField: parser.error("missing value for pos_longitudeField") 815 if None==options.pos_latitudeField: parser.error("missing value for pos_latitudeField") 816 if None==options.typeField: parser.error("missing value for typeField") 817 if None==options.waterlevelField: parser.error("missing value for waterlevelField") 818 if None==options.datumField: parser.error("missing value for datumField") 819 msgDict={ 820 'time_month': options.time_monthField, 821 'time_day': options.time_dayField, 822 'time_hour': options.time_hourField, 823 'time_min': options.time_minField, 824 'stationid': options.stationidField, 825 'pos_longitude': options.pos_longitudeField, 826 'pos_latitude': options.pos_latitudeField, 827 'type': options.typeField, 828 'waterlevel': options.waterlevelField, 829 'datum': options.datumField, 830 'reserved': '0', 831 } 832 833 bits = encode(msgDict) 834 if 'binary'==options.ioType: print str(bits) 835 elif 'nmeapayload'==options.ioType: 836 # FIX: figure out if this might be necessary at compile time 837 print "bitLen",len(bits) 838 bitLen=len(bits) 839 if bitLen%6!=0: 840 bits = bits + BitVector(size=(6 - (bitLen%6))) # Pad out to multiple of 6 841 print "result:",binary.bitvectoais6(bits)[0] 842 843 844 # FIX: Do not emit this option for the binary message payloads. Does not make sense. 845 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability") 846 else: sys.exit('ERROR: unknown ioType. Help!') 847 848 849 if options.sqlCreate: 850 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType) 851 852 if options.latexDefinitionTable: 853 latexDefinitionTable(outfile) 854 855 # For conversion to word tables 856 if options.textDefinitionTable: 857 textDefinitionTable(outfile,options.delimTextDefinitionTable) 858 859 if options.printCsvfieldList: 860 # Make a csv separated list of fields that will be displayed for csv 861 if None == options.fieldList: options.fieldList = fieldList 862 import StringIO 863 buf = StringIO.StringIO() 864 for field in options.fieldList: 865 buf.write(field+',') 866 result = buf.getvalue() 867 if result[-1] == ',': print result[:-1] 868 else: print result 869 870 if options.doDecode: 871 if len(args)==0: args = sys.stdin 872 for msg in args: 873 bv = None 874 875 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'): 876 # Found nmea 877 # FIX: do checksum 878 bv = binary.ais6tobitvec(msg.split(',')[5]) 879 else: # either binary or nmeapayload... expect mostly nmeapayloads 880 # assumes that an all 0 and 1 string can not be a nmeapayload 881 binaryMsg=True 882 for c in msg: 883 if c not in ('0','1'): 884 binaryMsg=False 885 break 886 if binaryMsg: 887 bv = BitVector(bitstring=msg) 888 else: # nmeapayload 889 bv = binary.ais6tobitvec(msg) 890 891 printFields(decode(bv) 892 ,out=outfile 893 ,format=options.outputType 894 ,fieldList=options.fieldList 895 ,dbType=options.dbType 896 ) 897

Source Code for Module ais.sls.waterlevel