1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-03-31 $'.split()[1]
5 __author__ = 'xmlbinmsg'
6
7 __doc__='''
8
9 Autogenerated python functions to serialize/deserialize binary messages.
10
11 Generated by: ./aisxmlbinmsg2py.py
12
13 Need to then wrap these functions with the outer AIS packet and then
14 convert the whole binary blob to a NMEA string. Those functions are
15 not currently provided in this file.
16
17 serialize: python to ais binary
18 deserialize: ais binary to python
19
20 The generated code uses translators.py, binary.py, and aisstring.py
21 which should be packaged with the resulting files.
22
23
24 @requires: U{epydoc<http://epydoc.sourceforge.net/>} > 3.0alpha3
25 @requires: U{BitVector<http://cheeseshop.python.org/pypi/BitVector>}
26
27 @author: '''+__author__+'''
28 @version: ''' + __version__ +'''
29 @var __date__: Date of last svn commit
30 @undocumented: __version__ __author__ __doc__ parser
31 @status: under development
32 @license: Generated code has no license
33 @todo: FIX: put in a description of the message here with fields and types.
34 '''
35
36 import sys
37 from decimal import Decimal
38 from BitVector import BitVector
39
40 import binary, aisstring
41
42
43 TrueBV = BitVector(bitstring="1")
44 "Why always rebuild the True bit? This should speed things up a bunch"
45 FalseBV = BitVector(bitstring="0")
46 "Why always rebuild the False bit? This should speed things up a bunch"
47
48
49 fieldList = (
50 'MessageID',
51 'RepeatIndicator',
52 'UserID',
53 'Altitude',
54 'SOG',
55 'PositionAccuracy',
56 'Position_longitude',
57 'Position_latitude',
58 'COG',
59 'TimeStamp',
60 'Reserved',
61 'DTE',
62 'Spare',
63 'RAIM',
64 'state_syncstate',
65 'state_slottimeout',
66 'state_slotoffset',
67 )
68
69 fieldListPostgres = (
70 'MessageID',
71 'RepeatIndicator',
72 'UserID',
73 'Altitude',
74 'SOG',
75 'PositionAccuracy',
76 'Position',
77 'COG',
78 'TimeStamp',
79 'Reserved',
80 'DTE',
81 'Spare',
82 'RAIM',
83 'state_syncstate',
84 'state_slottimeout',
85 'state_slotoffset',
86 )
87
88 toPgFields = {
89 'Position_longitude':'Position',
90 'Position_latitude':'Position',
91 }
92 '''
93 Go to the Postgis field names from the straight field name
94 '''
95
96 fromPgFields = {
97 'Position':('Position_longitude','Position_latitude',),
98 }
99 '''
100 Go from the Postgis field names to the straight field name
101 '''
102
103 pgTypes = {
104 'Position':'POINT',
105 }
106 '''
107 Lookup table for each postgis field name to get its type.
108 '''
109
110 -def encode(params, validate=False):
111 '''Create a SARposition binary message payload to pack into an AIS Msg SARposition.
112
113 Fields in params:
114 - MessageID(uint): AIS message number. Must be 9 (field automatically set to "9")
115 - RepeatIndicator(uint): Indicated how many times a message has been repeated
116 - UserID(uint): Unique ship identification number (MMSI)
117 - Altitude(uint): Altitude (GNSS)
118 - SOG(udecimal): Speed over ground
119 - PositionAccuracy(uint): Accuracy of positioning fixes
120 - Position_longitude(decimal): Location of the vessel East West location
121 - Position_latitude(decimal): Location of the vessel North South location
122 - COG(udecimal): Course over ground
123 - TimeStamp(uint): UTC second when the report was generated
124 - Reserved(uint): Reserved for regional applications. Should be set to zero. (field automatically set to "0")
125 - DTE(bool): Dtta terminal ready
126 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
127 - RAIM(bool): Receiver autonomous integrity monitoring flag
128 - state_syncstate(uint): Communications State - SOTDMA Sycronization state
129 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected
130 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN
131 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
132 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
133 @rtype: BitVector
134 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
135 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
136 '''
137
138 bvList = []
139 bvList.append(binary.setBitVectorSize(BitVector(intVal=9),6))
140 if 'RepeatIndicator' in params:
141 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2))
142 else:
143 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2))
144 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30))
145 if 'Altitude' in params:
146 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['Altitude']),12))
147 else:
148 bvList.append(binary.setBitVectorSize(BitVector(intVal=4095),12))
149 if 'SOG' in params:
150 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['SOG'])*Decimal('10')))),10))
151 else:
152 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(1023)),10))
153 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['PositionAccuracy']),1))
154 if 'Position_longitude' in params:
155 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_longitude'])*Decimal('600000')),28))
156 else:
157 bvList.append(binary.bvFromSignedInt(108600000,28))
158 if 'Position_latitude' in params:
159 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_latitude'])*Decimal('600000')),27))
160 else:
161 bvList.append(binary.bvFromSignedInt(54600000,27))
162 if 'COG' in params:
163 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['COG'])*Decimal('10')))),12))
164 else:
165 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(3600)),12))
166 if 'TimeStamp' in params:
167 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['TimeStamp']),6))
168 else:
169 bvList.append(binary.setBitVectorSize(BitVector(intVal=60),6))
170 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),8))
171 if params["DTE"]: bvList.append(TrueBV)
172 else: bvList.append(FalseBV)
173 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),5))
174 if params["RAIM"]: bvList.append(TrueBV)
175 else: bvList.append(FalseBV)
176 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_syncstate']),2))
177 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_slottimeout']),3))
178 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['state_slotoffset']),14))
179
180 return binary.joinBV(bvList)
181
182 -def decode(bv, validate=False):
183 '''Unpack a SARposition message
184
185 Fields in params:
186 - MessageID(uint): AIS message number. Must be 9 (field automatically set to "9")
187 - RepeatIndicator(uint): Indicated how many times a message has been repeated
188 - UserID(uint): Unique ship identification number (MMSI)
189 - Altitude(uint): Altitude (GNSS)
190 - SOG(udecimal): Speed over ground
191 - PositionAccuracy(uint): Accuracy of positioning fixes
192 - Position_longitude(decimal): Location of the vessel East West location
193 - Position_latitude(decimal): Location of the vessel North South location
194 - COG(udecimal): Course over ground
195 - TimeStamp(uint): UTC second when the report was generated
196 - Reserved(uint): Reserved for regional applications. Should be set to zero. (field automatically set to "0")
197 - DTE(bool): Dtta terminal ready
198 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
199 - RAIM(bool): Receiver autonomous integrity monitoring flag
200 - state_syncstate(uint): Communications State - SOTDMA Sycronization state
201 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected
202 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN
203 @type bv: BitVector
204 @param bv: Bits defining a message
205 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
206 @rtype: dict
207 @return: params
208 '''
209
210
211
212
213 r = {}
214 r['MessageID']=9
215 r['RepeatIndicator']=int(bv[6:8])
216 r['UserID']=int(bv[8:38])
217 r['Altitude']=int(bv[38:50])
218 r['SOG']=Decimal(int(bv[50:60]))/Decimal('10')
219 r['PositionAccuracy']=int(bv[60:61])
220 r['Position_longitude']=Decimal(binary.signedIntFromBV(bv[61:89]))/Decimal('600000')
221 r['Position_latitude']=Decimal(binary.signedIntFromBV(bv[89:116]))/Decimal('600000')
222 r['COG']=Decimal(int(bv[116:128]))/Decimal('10')
223 r['TimeStamp']=int(bv[128:134])
224 r['Reserved']=0
225 r['DTE']=bool(int(bv[142:143]))
226 r['Spare']=0
227 r['RAIM']=bool(int(bv[148:149]))
228 r['state_syncstate']=int(bv[149:151])
229 r['state_slottimeout']=int(bv[151:154])
230 r['state_slotoffset']=int(bv[154:168])
231 return r
232
235
238
241
243 return int(bv[38:50])
244
246 return Decimal(int(bv[50:60]))/Decimal('10')
247
249 return int(bv[60:61])
250
253
256
258 return Decimal(int(bv[116:128]))/Decimal('10')
259
261 return int(bv[128:134])
262
265
267 return bool(int(bv[142:143]))
268
271
273 return bool(int(bv[148:149]))
274
276 return int(bv[149:151])
277
279 return int(bv[151:154])
280
282 return int(bv[154:168])
283
284
286 out.write("<h3>SARposition<h3>\n")
287 out.write("<table border=\"1\">\n")
288 out.write("<tr bgcolor=\"orange\">\n")
289 out.write("<th align=\"left\">Field Name</th>\n")
290 out.write("<th align=\"left\">Type</th>\n")
291 out.write("<th align=\"left\">Value</th>\n")
292 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
293 out.write("<th align=\"left\">Units</th>\n")
294 out.write("\n")
295 out.write("<tr>\n")
296 out.write("<td>MessageID</td>\n")
297 out.write("<td>uint</td>\n")
298 if 'MessageID' in params:
299 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
300 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
301 out.write("</tr>\n")
302 out.write("\n")
303 out.write("<tr>\n")
304 out.write("<td>RepeatIndicator</td>\n")
305 out.write("<td>uint</td>\n")
306 if 'RepeatIndicator' in params:
307 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n")
308 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut:
309 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>")
310 else:
311 out.write("<td><i>Missing LUT entry</i></td>")
312 out.write("</tr>\n")
313 out.write("\n")
314 out.write("<tr>\n")
315 out.write("<td>UserID</td>\n")
316 out.write("<td>uint</td>\n")
317 if 'UserID' in params:
318 out.write(" <td>"+str(params['UserID'])+"</td>\n")
319 out.write(" <td>"+str(params['UserID'])+"</td>\n")
320 out.write("</tr>\n")
321 out.write("\n")
322 out.write("<tr>\n")
323 out.write("<td>Altitude</td>\n")
324 out.write("<td>uint</td>\n")
325 if 'Altitude' in params:
326 out.write(" <td>"+str(params['Altitude'])+"</td>\n")
327 if str(params['Altitude']) in AltitudeDecodeLut:
328 out.write("<td>"+AltitudeDecodeLut[str(params['Altitude'])]+"</td>")
329 else:
330 out.write("<td><i>Missing LUT entry</i></td>")
331 out.write("<td>meters</td>\n")
332 out.write("</tr>\n")
333 out.write("\n")
334 out.write("<tr>\n")
335 out.write("<td>SOG</td>\n")
336 out.write("<td>udecimal</td>\n")
337 if 'SOG' in params:
338 out.write(" <td>"+str(params['SOG'])+"</td>\n")
339 if str(params['SOG']) in SOGDecodeLut:
340 out.write("<td>"+SOGDecodeLut[str(params['SOG'])]+"</td>")
341 else:
342 out.write("<td><i>Missing LUT entry</i></td>")
343 out.write("<td>knots</td>\n")
344 out.write("</tr>\n")
345 out.write("\n")
346 out.write("<tr>\n")
347 out.write("<td>PositionAccuracy</td>\n")
348 out.write("<td>uint</td>\n")
349 if 'PositionAccuracy' in params:
350 out.write(" <td>"+str(params['PositionAccuracy'])+"</td>\n")
351 if str(params['PositionAccuracy']) in PositionAccuracyDecodeLut:
352 out.write("<td>"+PositionAccuracyDecodeLut[str(params['PositionAccuracy'])]+"</td>")
353 else:
354 out.write("<td><i>Missing LUT entry</i></td>")
355 out.write("</tr>\n")
356 out.write("\n")
357 out.write("<tr>\n")
358 out.write("<td>Position_longitude</td>\n")
359 out.write("<td>decimal</td>\n")
360 if 'Position_longitude' in params:
361 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n")
362 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n")
363 out.write("<td>degrees</td>\n")
364 out.write("</tr>\n")
365 out.write("\n")
366 out.write("<tr>\n")
367 out.write("<td>Position_latitude</td>\n")
368 out.write("<td>decimal</td>\n")
369 if 'Position_latitude' in params:
370 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n")
371 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n")
372 out.write("<td>degrees</td>\n")
373 out.write("</tr>\n")
374 out.write("\n")
375 out.write("<tr>\n")
376 out.write("<td>COG</td>\n")
377 out.write("<td>udecimal</td>\n")
378 if 'COG' in params:
379 out.write(" <td>"+str(params['COG'])+"</td>\n")
380 out.write(" <td>"+str(params['COG'])+"</td>\n")
381 out.write("<td>degrees</td>\n")
382 out.write("</tr>\n")
383 out.write("\n")
384 out.write("<tr>\n")
385 out.write("<td>TimeStamp</td>\n")
386 out.write("<td>uint</td>\n")
387 if 'TimeStamp' in params:
388 out.write(" <td>"+str(params['TimeStamp'])+"</td>\n")
389 if str(params['TimeStamp']) in TimeStampDecodeLut:
390 out.write("<td>"+TimeStampDecodeLut[str(params['TimeStamp'])]+"</td>")
391 else:
392 out.write("<td><i>Missing LUT entry</i></td>")
393 out.write("<td>seconds</td>\n")
394 out.write("</tr>\n")
395 out.write("\n")
396 out.write("<tr>\n")
397 out.write("<td>Reserved</td>\n")
398 out.write("<td>uint</td>\n")
399 if 'Reserved' in params:
400 out.write(" <td>"+str(params['Reserved'])+"</td>\n")
401 out.write(" <td>"+str(params['Reserved'])+"</td>\n")
402 out.write("</tr>\n")
403 out.write("\n")
404 out.write("<tr>\n")
405 out.write("<td>DTE</td>\n")
406 out.write("<td>bool</td>\n")
407 if 'DTE' in params:
408 out.write(" <td>"+str(params['DTE'])+"</td>\n")
409 out.write(" <td>"+str(params['DTE'])+"</td>\n")
410 out.write("</tr>\n")
411 out.write("\n")
412 out.write("<tr>\n")
413 out.write("<td>Spare</td>\n")
414 out.write("<td>uint</td>\n")
415 if 'Spare' in params:
416 out.write(" <td>"+str(params['Spare'])+"</td>\n")
417 out.write(" <td>"+str(params['Spare'])+"</td>\n")
418 out.write("</tr>\n")
419 out.write("\n")
420 out.write("<tr>\n")
421 out.write("<td>RAIM</td>\n")
422 out.write("<td>bool</td>\n")
423 if 'RAIM' in params:
424 out.write(" <td>"+str(params['RAIM'])+"</td>\n")
425 if str(params['RAIM']) in RAIMDecodeLut:
426 out.write("<td>"+RAIMDecodeLut[str(params['RAIM'])]+"</td>")
427 else:
428 out.write("<td><i>Missing LUT entry</i></td>")
429 out.write("</tr>\n")
430 out.write("\n")
431 out.write("<tr>\n")
432 out.write("<td>state_syncstate</td>\n")
433 out.write("<td>uint</td>\n")
434 if 'state_syncstate' in params:
435 out.write(" <td>"+str(params['state_syncstate'])+"</td>\n")
436 if str(params['state_syncstate']) in state_syncstateDecodeLut:
437 out.write("<td>"+state_syncstateDecodeLut[str(params['state_syncstate'])]+"</td>")
438 else:
439 out.write("<td><i>Missing LUT entry</i></td>")
440 out.write("</tr>\n")
441 out.write("\n")
442 out.write("<tr>\n")
443 out.write("<td>state_slottimeout</td>\n")
444 out.write("<td>uint</td>\n")
445 if 'state_slottimeout' in params:
446 out.write(" <td>"+str(params['state_slottimeout'])+"</td>\n")
447 if str(params['state_slottimeout']) in state_slottimeoutDecodeLut:
448 out.write("<td>"+state_slottimeoutDecodeLut[str(params['state_slottimeout'])]+"</td>")
449 else:
450 out.write("<td><i>Missing LUT entry</i></td>")
451 out.write("<td>frames</td>\n")
452 out.write("</tr>\n")
453 out.write("\n")
454 out.write("<tr>\n")
455 out.write("<td>state_slotoffset</td>\n")
456 out.write("<td>uint</td>\n")
457 if 'state_slotoffset' in params:
458 out.write(" <td>"+str(params['state_slotoffset'])+"</td>\n")
459 out.write(" <td>"+str(params['state_slotoffset'])+"</td>\n")
460 out.write("</tr>\n")
461 out.write("</table>\n")
462
463
465 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer'''
466 out.write("\ <Placemark>\n")
467 out.write("\t <name>"+str(params['UserID'])+"</name>\n")
468 out.write("\t\t<description>\n")
469 import StringIO
470 buf = StringIO.StringIO()
471 printHtml(params,buf)
472 import cgi
473 out.write(cgi.escape(buf.getvalue()))
474 out.write("\t\t</description>\n")
475 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n")
476 out.write("\t\t<Point>\n")
477 out.write("\t\t\t<coordinates>")
478 out.write(str(params['Position_longitude']))
479 out.write(',')
480 out.write(str(params['Position_latitude']))
481 out.write(",0</coordinates>\n")
482 out.write("\t\t</Point>\n")
483 out.write("\t</Placemark>\n")
484
485 -def printFields(params, out=sys.stdout, format='std', fieldList=None, dbType='postgres'):
486 '''Print a SARposition message to stdout.
487
488 Fields in params:
489 - MessageID(uint): AIS message number. Must be 9 (field automatically set to "9")
490 - RepeatIndicator(uint): Indicated how many times a message has been repeated
491 - UserID(uint): Unique ship identification number (MMSI)
492 - Altitude(uint): Altitude (GNSS)
493 - SOG(udecimal): Speed over ground
494 - PositionAccuracy(uint): Accuracy of positioning fixes
495 - Position_longitude(decimal): Location of the vessel East West location
496 - Position_latitude(decimal): Location of the vessel North South location
497 - COG(udecimal): Course over ground
498 - TimeStamp(uint): UTC second when the report was generated
499 - Reserved(uint): Reserved for regional applications. Should be set to zero. (field automatically set to "0")
500 - DTE(bool): Dtta terminal ready
501 - Spare(uint): Not used. Should be set to zero. (field automatically set to "0")
502 - RAIM(bool): Receiver autonomous integrity monitoring flag
503 - state_syncstate(uint): Communications State - SOTDMA Sycronization state
504 - state_slottimeout(uint): Communications State - SOTDMA Frames remaining until a new slot is selected
505 - state_slotoffset(uint): Communications State - SOTDMA In what slot will the next transmission occur. BROKEN
506 @param params: Dictionary of field names/values.
507 @param out: File like object to write to
508 @rtype: stdout
509 @return: text to out
510 '''
511
512 if 'std'==format:
513 out.write("SARposition:\n")
514 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n")
515 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n")
516 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n")
517 if 'Altitude' in params: out.write(" Altitude: "+str(params['Altitude'])+"\n")
518 if 'SOG' in params: out.write(" SOG: "+str(params['SOG'])+"\n")
519 if 'PositionAccuracy' in params: out.write(" PositionAccuracy: "+str(params['PositionAccuracy'])+"\n")
520 if 'Position_longitude' in params: out.write(" Position_longitude: "+str(params['Position_longitude'])+"\n")
521 if 'Position_latitude' in params: out.write(" Position_latitude: "+str(params['Position_latitude'])+"\n")
522 if 'COG' in params: out.write(" COG: "+str(params['COG'])+"\n")
523 if 'TimeStamp' in params: out.write(" TimeStamp: "+str(params['TimeStamp'])+"\n")
524 if 'Reserved' in params: out.write(" Reserved: "+str(params['Reserved'])+"\n")
525 if 'DTE' in params: out.write(" DTE: "+str(params['DTE'])+"\n")
526 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n")
527 if 'RAIM' in params: out.write(" RAIM: "+str(params['RAIM'])+"\n")
528 if 'state_syncstate' in params: out.write(" state_syncstate: "+str(params['state_syncstate'])+"\n")
529 if 'state_slottimeout' in params: out.write(" state_slottimeout: "+str(params['state_slottimeout'])+"\n")
530 if 'state_slotoffset' in params: out.write(" state_slotoffset: "+str(params['state_slotoffset'])+"\n")
531 elif 'csv'==format:
532 if None == options.fieldList:
533 options.fieldList = fieldList
534 needComma = False;
535 for field in fieldList:
536 if needComma: out.write(',')
537 needComma = True
538 if field in params:
539 out.write(str(params[field]))
540
541 out.write("\n")
542 elif 'html'==format:
543 printHtml(params,out)
544 elif 'sql'==format:
545 sqlInsertStr(params,out,dbType=dbType)
546 elif 'kml'==format:
547 printKml(params,out)
548 elif 'kml-full'==format:
549 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
550 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n")
551 out.write("<Document>\n")
552 out.write(" <name>SARposition</name>\n")
553 printKml(params,out)
554 out.write("</Document>\n")
555 out.write("</kml>\n")
556 else:
557 print "ERROR: unknown format:",format
558 assert False
559
560 return
561
562 RepeatIndicatorEncodeLut = {
563 'default':'0',
564 'do not repeat any more':'3',
565 }
566
567 RepeatIndicatorDecodeLut = {
568 '0':'default',
569 '3':'do not repeat any more',
570 }
571
572 AltitudeEncodeLut = {
573 '4095 or higher':'4095',
574 }
575
576 AltitudeDecodeLut = {
577 '4095':'4095 or higher',
578 }
579
580 SOGEncodeLut = {
581 '102.2 knots or higher':'102.2',
582 }
583
584 SOGDecodeLut = {
585 '102.2':'102.2 knots or higher',
586 }
587
588 PositionAccuracyEncodeLut = {
589 'low (greater than 10 m)':'0',
590 'high (less than 10 m)':'1',
591 }
592
593 PositionAccuracyDecodeLut = {
594 '0':'low (greater than 10 m)',
595 '1':'high (less than 10 m)',
596 }
597
598 TimeStampEncodeLut = {
599 'not available/default':'60',
600 'manual input':'61',
601 'dead reckoning':'62',
602 'inoperative':'63',
603 }
604
605 TimeStampDecodeLut = {
606 '60':'not available/default',
607 '61':'manual input',
608 '62':'dead reckoning',
609 '63':'inoperative',
610 }
611
612 RAIMEncodeLut = {
613 'not in use':'False',
614 'in use':'True',
615 }
616
617 RAIMDecodeLut = {
618 'False':'not in use',
619 'True':'in use',
620 }
621
622 state_syncstateEncodeLut = {
623 'UTC direct':'0',
624 'UTC indirect':'1',
625 'synchronized to a base station':'2',
626 'synchronized to another station':'3',
627 }
628
629 state_syncstateDecodeLut = {
630 '0':'UTC direct',
631 '1':'UTC indirect',
632 '2':'synchronized to a base station',
633 '3':'synchronized to another station',
634 }
635
636 state_slottimeoutEncodeLut = {
637 'Last frame in this slot':'0',
638 '1 frames left':'1',
639 '2 frames left':'2',
640 '3 frames left':'3',
641 '4 frames left':'4',
642 '5 frames left':'5',
643 '6 frames left':'6',
644 '7 frames left':'7',
645 }
646
647 state_slottimeoutDecodeLut = {
648 '0':'Last frame in this slot',
649 '1':'1 frames left',
650 '2':'2 frames left',
651 '3':'3 frames left',
652 '4':'4 frames left',
653 '5':'5 frames left',
654 '6':'6 frames left',
655 '7':'7 frames left',
656 }
657
658
659
660
661
662 -def sqlCreateStr(outfile=sys.stdout, fields=None, extraFields=None
663 ,addCoastGuardFields=True
664 ,dbType='postgres'
665 ):
666 '''
667 Return the SQL CREATE command for this message type
668 @param outfile: file like object to print to.
669 @param fields: which fields to put in the create. Defaults to all.
670 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
671 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
672 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
673 @type addCoastGuardFields: bool
674 @return: sql create string
675 @rtype: str
676
677 @see: sqlCreate
678 '''
679
680 outfile.write(str(sqlCreate(fields,extraFields,addCoastGuardFields,dbType=dbType)))
681
682 -def sqlCreate(fields=None, extraFields=None, addCoastGuardFields=True, dbType='postgres'):
683 '''
684 Return the sqlhelp object to create the table.
685
686 @param fields: which fields to put in the create. Defaults to all.
687 @param extraFields: A sequence of tuples containing (name,sql type) for additional fields
688 @param addCoastGuardFields: Add the extra fields that come after the NMEA check some from the USCG N-AIS format
689 @type addCoastGuardFields: bool
690 @param dbType: Which flavor of database we are using so that the create is tailored ('sqlite' or 'postgres')
691 @return: An object that can be used to generate a return
692 @rtype: sqlhelp.create
693 '''
694 if None == fields: fields = fieldList
695 import sqlhelp
696 c = sqlhelp.create('SARposition',dbType=dbType)
697 c.addPrimaryKey()
698 if 'MessageID' in fields: c.addInt ('MessageID')
699 if 'RepeatIndicator' in fields: c.addInt ('RepeatIndicator')
700 if 'UserID' in fields: c.addInt ('UserID')
701 if 'Altitude' in fields: c.addInt ('Altitude')
702 if 'SOG' in fields: c.addDecimal('SOG',4,1)
703 if 'PositionAccuracy' in fields: c.addInt ('PositionAccuracy')
704 if dbType != 'postgres':
705 if 'Position_longitude' in fields: c.addDecimal('Position_longitude',8,5)
706 if dbType != 'postgres':
707 if 'Position_latitude' in fields: c.addDecimal('Position_latitude',8,5)
708 if 'COG' in fields: c.addDecimal('COG',4,1)
709 if 'TimeStamp' in fields: c.addInt ('TimeStamp')
710 if 'Reserved' in fields: c.addInt ('Reserved')
711 if 'DTE' in fields: c.addBool('DTE')
712 if 'Spare' in fields: c.addInt ('Spare')
713 if 'RAIM' in fields: c.addBool('RAIM')
714 if 'state_syncstate' in fields: c.addInt ('state_syncstate')
715 if 'state_slottimeout' in fields: c.addInt ('state_slottimeout')
716 if 'state_slotoffset' in fields: c.addInt ('state_slotoffset')
717
718 if addCoastGuardFields:
719
720
721
722
723
724 c.addVarChar('cg_r',15)
725 c.addInt('cg_sec')
726
727 c.addTimestamp('cg_timestamp')
728
729 if dbType == 'postgres':
730 c.addPostGIS('Position','POINT',2);
731
732 return c
733
734 -def sqlInsertStr(params, outfile=sys.stdout, extraParams=None, dbType='postgres'):
735 '''
736 Return the SQL INSERT command for this message type
737 @param params: dictionary of values keyed by field name
738 @param outfile: file like object to print to.
739 @param extraParams: A sequence of tuples containing (name,sql type) for additional fields
740 @return: sql create string
741 @rtype: str
742
743 @see: sqlCreate
744 '''
745 outfile.write(str(sqlInsert(params,extraParams,dbType=dbType)))
746
747
748 -def sqlInsert(params,extraParams=None,dbType='postgres'):
749 '''
750 Give the SQL INSERT statement
751 @param params: dict keyed by field name of values
752 @param extraParams: any extra fields that you have created beyond the normal ais message fields
753 @rtype: sqlhelp.insert
754 @return: insert class instance
755 @todo: allow optional type checking of params?
756 @warning: this will take invalid keys happily and do what???
757 '''
758 import sqlhelp
759 i = sqlhelp.insert('SARposition',dbType=dbType)
760
761 if dbType=='postgres':
762 finished = []
763 for key in params:
764 if key in finished:
765 continue
766
767 if key not in toPgFields and key not in fromPgFields:
768 if type(params[key])==Decimal: i.add(key,float(params[key]))
769 else: i.add(key,params[key])
770 else:
771 if key in fromPgFields:
772 val = params[key]
773
774 i.addPostGIS(key,val)
775 finished.append(key)
776 else:
777
778 pgName = toPgFields[key]
779
780 valStr=pgTypes[pgName]+'('
781 vals = []
782 for nonPgKey in fromPgFields[pgName]:
783 vals.append(str(params[nonPgKey]))
784 finished.append(nonPgKey)
785 valStr+=' '.join(vals)+')'
786 i.addPostGIS(pgName,valStr)
787 else:
788 for key in params:
789 if type(params[key])==Decimal: i.add(key,float(params[key]))
790 else: i.add(key,params[key])
791
792 if None != extraParams:
793 for key in extraParams:
794 i.add(key,extraParams[key])
795
796 return i
797
798
799
800
801
804 '''
805 Return the LaTeX definition table for this message type
806 @param outfile: file like object to print to.
807 @type outfile: file obj
808 @return: LaTeX table string via the outfile
809 @rtype: str
810
811 '''
812 o = outfile
813
814 o.write('''
815 \\begin{table}%[htb]
816 \\centering
817 \\begin{tabular}{|l|c|l|}
818 \\hline
819 Parameter & Number of bits & Description
820 \\\\ \\hline\\hline
821 MessageID & 6 & AIS message number. Must be 9 \\\\ \hline
822 RepeatIndicator & 2 & Indicated how many times a message has been repeated \\\\ \hline
823 UserID & 30 & Unique ship identification number (MMSI) \\\\ \hline
824 Altitude & 12 & Altitude (GNSS) \\\\ \hline
825 SOG & 10 & Speed over ground \\\\ \hline
826 PositionAccuracy & 1 & Accuracy of positioning fixes \\\\ \hline
827 Position\_longitude & 28 & Location of the vessel East West location \\\\ \hline
828 Position\_latitude & 27 & Location of the vessel North South location \\\\ \hline
829 COG & 12 & Course over ground \\\\ \hline
830 TimeStamp & 6 & UTC second when the report was generated \\\\ \hline
831 Reserved & 8 & Reserved for regional applications. Should be set to zero. \\\\ \hline
832 DTE & 1 & Dtta terminal ready \\\\ \hline
833 Spare & 5 & Not used. Should be set to zero. \\\\ \hline
834 RAIM & 1 & Receiver autonomous integrity monitoring flag \\\\ \hline
835 state\_syncstate & 2 & Communications State - SOTDMA Sycronization state \\\\ \hline
836 state\_slottimeout & 3 & Communications State - SOTDMA Frames remaining until a new slot is selected \\\\ \hline
837 state\_slotoffset & 14 & Communications State - SOTDMA In what slot will the next transmission occur. BROKEN\\\\ \\hline \\hline
838 Total bits & 168 & Appears to take 1 slot \\\\ \\hline
839 \\end{tabular}
840 \\caption{AIS message number 9: Search and rescue position report}
841 \\label{tab:SARposition}
842 \\end{table}
843 ''')
844
845
846
847
848
849 import unittest
851 '''Return a params file base on the testvalue tags.
852 @rtype: dict
853 @return: params based on testvalue tags
854 '''
855 params = {}
856 params['MessageID'] = 9
857 params['RepeatIndicator'] = 1
858 params['UserID'] = 1193046
859 params['Altitude'] = 1001
860 params['SOG'] = Decimal('101.9')
861 params['PositionAccuracy'] = 1
862 params['Position_longitude'] = Decimal('-122.16328055555556')
863 params['Position_latitude'] = Decimal('37.424458333333334')
864 params['COG'] = Decimal('34.5')
865 params['TimeStamp'] = 35
866 params['Reserved'] = 0
867 params['DTE'] = False
868 params['Spare'] = 0
869 params['RAIM'] = False
870 params['state_syncstate'] = 2
871 params['state_slottimeout'] = 0
872 params['state_slotoffset'] = 1221
873
874 return params
875
877 '''Use testvalue tag text from each type to build test case the SARposition message'''
879
880 params = testParams()
881 bits = encode(params)
882 r = decode(bits)
883
884
885 self.failUnlessEqual(r['MessageID'],params['MessageID'])
886 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator'])
887 self.failUnlessEqual(r['UserID'],params['UserID'])
888 self.failUnlessEqual(r['Altitude'],params['Altitude'])
889 self.failUnlessAlmostEqual(r['SOG'],params['SOG'],1)
890 self.failUnlessEqual(r['PositionAccuracy'],params['PositionAccuracy'])
891 self.failUnlessAlmostEqual(r['Position_longitude'],params['Position_longitude'],5)
892 self.failUnlessAlmostEqual(r['Position_latitude'],params['Position_latitude'],5)
893 self.failUnlessAlmostEqual(r['COG'],params['COG'],1)
894 self.failUnlessEqual(r['TimeStamp'],params['TimeStamp'])
895 self.failUnlessEqual(r['Reserved'],params['Reserved'])
896 self.failUnlessEqual(r['DTE'],params['DTE'])
897 self.failUnlessEqual(r['Spare'],params['Spare'])
898 self.failUnlessEqual(r['RAIM'],params['RAIM'])
899 self.failUnlessEqual(r['state_syncstate'],params['state_syncstate'])
900 self.failUnlessEqual(r['state_slottimeout'],params['state_slottimeout'])
901 self.failUnlessEqual(r['state_slotoffset'],params['state_slotoffset'])
902
904 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
905 help='decode a "SARposition" AIS message')
906 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
907 help='encode a "SARposition" AIS message')
908 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int'
909 ,help='Field parameter value [default: %default]')
910 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int'
911 ,help='Field parameter value [default: %default]')
912 parser.add_option('--Altitude-field', dest='AltitudeField',default=4095,metavar='uint',type='int'
913 ,help='Field parameter value [default: %default]')
914 parser.add_option('--SOG-field', dest='SOGField',default=Decimal('102.3'),metavar='udecimal',type='string'
915 ,help='Field parameter value [default: %default]')
916 parser.add_option('--PositionAccuracy-field', dest='PositionAccuracyField',metavar='uint',type='int'
917 ,help='Field parameter value [default: %default]')
918 parser.add_option('--Position_longitude-field', dest='Position_longitudeField',default=Decimal('181'),metavar='decimal',type='string'
919 ,help='Field parameter value [default: %default]')
920 parser.add_option('--Position_latitude-field', dest='Position_latitudeField',default=Decimal('91'),metavar='decimal',type='string'
921 ,help='Field parameter value [default: %default]')
922 parser.add_option('--COG-field', dest='COGField',default=Decimal('360'),metavar='udecimal',type='string'
923 ,help='Field parameter value [default: %default]')
924 parser.add_option('--TimeStamp-field', dest='TimeStampField',default=60,metavar='uint',type='int'
925 ,help='Field parameter value [default: %default]')
926 parser.add_option('--DTE-field', dest='DTEField',metavar='bool',type='int'
927 ,help='Field parameter value [default: %default]')
928 parser.add_option('--RAIM-field', dest='RAIMField',metavar='bool',type='int'
929 ,help='Field parameter value [default: %default]')
930 parser.add_option('--state_syncstate-field', dest='state_syncstateField',metavar='uint',type='int'
931 ,help='Field parameter value [default: %default]')
932 parser.add_option('--state_slottimeout-field', dest='state_slottimeoutField',metavar='uint',type='int'
933 ,help='Field parameter value [default: %default]')
934 parser.add_option('--state_slotoffset-field', dest='state_slotoffsetField',metavar='uint',type='int'
935 ,help='Field parameter value [default: %default]')
936
937
938 if __name__=='__main__':
939
940 from optparse import OptionParser
941 parser = OptionParser(usage="%prog [options]",
942 version="%prog "+__version__)
943
944 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
945 help='run the documentation tests')
946 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
947 help='run the unit tests')
948 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
949 help='Make the test output verbose')
950
951
952
953 typeChoices = ('binary','nmeapayload','nmea')
954 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
955 ,default='nmeapayload'
956 ,help='What kind of string to write for encoding ('+', '.join(typeChoices)+') [default: %default]')
957
958
959 outputChoices = ('std','html','csv','sql' , 'kml','kml-full')
960 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
961 ,default='std'
962 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
963
964 parser.add_option('-o','--output',dest='outputFileName',default=None,
965 help='Name of the python file to write [default: stdout]')
966
967 parser.add_option('-f','--fields',dest='fieldList',default=None, action='append',
968 choices=fieldList,
969 help='Which fields to include in the output. Currently only for csv output [default: all]')
970
971 parser.add_option('-p','--print-csv-field-list',dest='printCsvfieldList',default=False,action='store_true',
972 help='Print the field name for csv')
973
974 parser.add_option('-c','--sql-create',dest='sqlCreate',default=False,action='store_true',
975 help='Print out an sql create command for the table.')
976
977 parser.add_option('--latex-table',dest='latexDefinitionTable',default=False,action='store_true',
978 help='Print a LaTeX table of the type')
979
980 dbChoices = ('sqlite','postgres')
981 parser.add_option('-D','--db-type',dest='dbType',default='postgres'
982 ,choices=dbChoices,type='choice'
983 ,help='What kind of database ('+', '.join(dbChoices)+') [default: %default]')
984
985 addMsgOptions(parser)
986
987 (options,args) = parser.parse_args()
988 success=True
989
990 if options.doctest:
991 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
992 sys.argv= [sys.argv[0]]
993 if options.verbose: sys.argv.append('-v')
994 import doctest
995 numfail,numtests=doctest.testmod()
996 if numfail==0: print 'ok'
997 else:
998 print 'FAILED'
999 success=False
1000
1001 if not success: sys.exit('Something Failed')
1002 del success
1003
1004 if options.unittest:
1005 sys.argv = [sys.argv[0]]
1006 if options.verbose: sys.argv.append('-v')
1007 unittest.main()
1008
1009 outfile = sys.stdout
1010 if None!=options.outputFileName:
1011 outfile = file(options.outputFileName,'w')
1012
1013
1014 if options.doEncode:
1015
1016 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField")
1017 if None==options.UserIDField: parser.error("missing value for UserIDField")
1018 if None==options.AltitudeField: parser.error("missing value for AltitudeField")
1019 if None==options.SOGField: parser.error("missing value for SOGField")
1020 if None==options.PositionAccuracyField: parser.error("missing value for PositionAccuracyField")
1021 if None==options.Position_longitudeField: parser.error("missing value for Position_longitudeField")
1022 if None==options.Position_latitudeField: parser.error("missing value for Position_latitudeField")
1023 if None==options.COGField: parser.error("missing value for COGField")
1024 if None==options.TimeStampField: parser.error("missing value for TimeStampField")
1025 if None==options.DTEField: parser.error("missing value for DTEField")
1026 if None==options.RAIMField: parser.error("missing value for RAIMField")
1027 if None==options.state_syncstateField: parser.error("missing value for state_syncstateField")
1028 if None==options.state_slottimeoutField: parser.error("missing value for state_slottimeoutField")
1029 if None==options.state_slotoffsetField: parser.error("missing value for state_slotoffsetField")
1030 msgDict={
1031 'MessageID': '9',
1032 'RepeatIndicator': options.RepeatIndicatorField,
1033 'UserID': options.UserIDField,
1034 'Altitude': options.AltitudeField,
1035 'SOG': options.SOGField,
1036 'PositionAccuracy': options.PositionAccuracyField,
1037 'Position_longitude': options.Position_longitudeField,
1038 'Position_latitude': options.Position_latitudeField,
1039 'COG': options.COGField,
1040 'TimeStamp': options.TimeStampField,
1041 'Reserved': '0',
1042 'DTE': options.DTEField,
1043 'Spare': '0',
1044 'RAIM': options.RAIMField,
1045 'state_syncstate': options.state_syncstateField,
1046 'state_slottimeout': options.state_slottimeoutField,
1047 'state_slotoffset': options.state_slotoffsetField,
1048 }
1049
1050 bits = encode(msgDict)
1051 if 'binary'==options.ioType: print str(bits)
1052 elif 'nmeapayload'==options.ioType:
1053
1054 print "bitLen",len(bits)
1055 bitLen=len(bits)
1056 if bitLen%6!=0:
1057 bits = bits + BitVector(size=(6 - (bitLen%6)))
1058 print "result:",binary.bitvectoais6(bits)[0]
1059
1060
1061
1062 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
1063 else: sys.exit('ERROR: unknown ioType. Help!')
1064
1065
1066 if options.sqlCreate:
1067 sqlCreateStr(outfile,options.fieldList,dbType=options.dbType)
1068
1069 if options.latexDefinitionTable:
1070 latexDefinitionTable(outfile)
1071
1072 if options.printCsvfieldList:
1073
1074 if None == options.fieldList: options.fieldList = fieldList
1075 import StringIO
1076 buf = StringIO.StringIO()
1077 for field in options.fieldList:
1078 buf.write(field+',')
1079 result = buf.getvalue()
1080 if result[-1] == ',': print result[:-1]
1081 else: print result
1082
1083 if options.doDecode:
1084 for msg in args:
1085 bv = None
1086
1087 if msg[0] in ('$','!') and msg[3:6] in ('VDM','VDO'):
1088
1089
1090 bv = binary.ais6tobitvec(msg.split(',')[5])
1091 else:
1092
1093 binaryMsg=True
1094 for c in msg:
1095 if c not in ('0','1'):
1096 binaryMsg=False
1097 break
1098 if binaryMsg:
1099 bv = BitVector(bitstring=msg)
1100 else:
1101 bv = binary.ais6tobitvec(msg)
1102
1103 printFields(decode(bv)
1104 ,out=outfile
1105 ,format=options.outputType
1106 ,fieldList=options.fieldList
1107 ,dbType=options.dbType
1108 )
1109