1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-01-18 $'.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 '''
34
35 import sys
36 from decimal import Decimal
37 from BitVector import BitVector
38
39 import binary, aisstring
40
41
42 TrueBV = BitVector(bitstring="1")
43 "Why always rebuild the True bit? This should speed things up a bunch"
44 FalseBV = BitVector(bitstring="0")
45 "Why always rebuild the False bit? This should speed things up a bunch"
46
47
48 -def encode(params, validate=False):
49 '''Create a position binary message payload to pack into an AIS Msg position.
50
51 Fields in params:
52 - MessageID(uint): AIS message number. Must be 1 (field automatically set to "1")
53 - RepeatIndicator(uint): Indicated how many times a message has been repeated
54 - UserID(uint): Unique ship identification number (MMSI)
55 - NavigationStatus(uint): What is the vessel doing
56 - ROT(int): RateOfTurn
57 - SOG(udecimal): Speed over ground
58 - PositionAccuracy(uint): Accuracy of positioning fixes
59 - Position_longitude(decimal): Location of the vessel East West location
60 - Position_latitude(decimal): Location of the vessel North South location
61 - COG(udecimal): Course over ground
62 - TrueHeading(uint): True heading (relative to true North)
63 - TimeStamp(uint): UTC second when the report was generated
64 - RegionalReserved(uint): Reserved for definition by a regional authority. (field automatically set to "0")
65 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
66 - RAIM(bool): Receiver autonomous integrity monitoring flag
67 - syncstate(uint): Sycronization state
68 - slotoffset(uint): In what slot will the next transmission occur. BROKEN
69 @param params: Dictionary of field names/values. Throws a ValueError exception if required is missing
70 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
71 @rtype: BitVector
72 @return: encoded binary message (for binary messages, this needs to be wrapped in a msg 8
73 @note: The returned bits may not be 6 bit aligned. It is up to you to pad out the bits.
74 '''
75
76 bvList = []
77 bvList.append(binary.setBitVectorSize(BitVector(intVal=1),6))
78 if 'RepeatIndicator' in params:
79 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['RepeatIndicator']),2))
80 else:
81 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),2))
82 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['UserID']),30))
83 if 'NavigationStatus' in params:
84 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['NavigationStatus']),4))
85 else:
86 bvList.append(binary.setBitVectorSize(BitVector(intVal=15),4))
87 if 'ROT' in params:
88 bvList.append(binary.bvFromSignedInt(params['ROT'],8))
89 else:
90 bvList.append(binary.bvFromSignedInt(-128,8))
91 if 'SOG' in params:
92 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['SOG'])*Decimal('10')))),10))
93 else:
94 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(1023)),10))
95 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['PositionAccuracy']),1))
96 if 'Position_longitude' in params:
97 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_longitude'])*Decimal('600000')),28))
98 else:
99 bvList.append(binary.bvFromSignedInt(108600000,28))
100 if 'Position_latitude' in params:
101 bvList.append(binary.bvFromSignedInt(int(Decimal(params['Position_latitude'])*Decimal('600000')),27))
102 else:
103 bvList.append(binary.bvFromSignedInt(54600000,27))
104 if 'COG' in params:
105 bvList.append(binary.setBitVectorSize(BitVector(intVal=int((Decimal(params['COG'])*Decimal('10')))),12))
106 else:
107 bvList.append(binary.setBitVectorSize(BitVector(intVal=int(3600)),12))
108 if 'TrueHeading' in params:
109 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['TrueHeading']),9))
110 else:
111 bvList.append(binary.setBitVectorSize(BitVector(intVal=511),9))
112 if 'TimeStamp' in params:
113 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['TimeStamp']),6))
114 else:
115 bvList.append(binary.setBitVectorSize(BitVector(intVal=60),6))
116 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),4))
117 bvList.append(binary.setBitVectorSize(BitVector(intVal=0),1))
118 if params["RAIM"]: bvList.append(TrueBV)
119 else: bvList.append(FalseBV)
120 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['syncstate']),2))
121 bvList.append(binary.setBitVectorSize(BitVector(intVal=params['slotoffset']),14))
122
123 return binary.joinBV(bvList)
124
125 -def decode(bv, validate=False):
126 '''Unpack a position message
127
128 Fields in params:
129 - MessageID(uint): AIS message number. Must be 1 (field automatically set to "1")
130 - RepeatIndicator(uint): Indicated how many times a message has been repeated
131 - UserID(uint): Unique ship identification number (MMSI)
132 - NavigationStatus(uint): What is the vessel doing
133 - ROT(int): RateOfTurn
134 - SOG(udecimal): Speed over ground
135 - PositionAccuracy(uint): Accuracy of positioning fixes
136 - Position_longitude(decimal): Location of the vessel East West location
137 - Position_latitude(decimal): Location of the vessel North South location
138 - COG(udecimal): Course over ground
139 - TrueHeading(uint): True heading (relative to true North)
140 - TimeStamp(uint): UTC second when the report was generated
141 - RegionalReserved(uint): Reserved for definition by a regional authority. (field automatically set to "0")
142 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
143 - RAIM(bool): Receiver autonomous integrity monitoring flag
144 - syncstate(uint): Sycronization state
145 - slotoffset(uint): In what slot will the next transmission occur. BROKEN
146 @type bv: BitVector
147 @param bv: Bits defining a message
148 @param validate: Set to true to cause checking to occur. Runs slower. FIX: not implemented.
149 @rtype: dict
150 @return: params
151 '''
152
153
154
155
156 r = {}
157 r['MessageID']=1
158 r['RepeatIndicator']=int(bv[6:8])
159 r['UserID']=int(bv[8:38])
160 r['NavigationStatus']=int(bv[38:42])
161 r['ROT']=binary.signedIntFromBV(bv[42:50])
162 r['SOG']=Decimal(int(bv[50:60]))/Decimal('10')
163 r['PositionAccuracy']=int(bv[60:61])
164 r['Position_longitude']=Decimal(binary.signedIntFromBV(bv[61:89]))/Decimal('600000')
165 r['Position_latitude']=Decimal(binary.signedIntFromBV(bv[89:116]))/Decimal('600000')
166 r['COG']=Decimal(int(bv[116:128]))/Decimal('10')
167 r['TrueHeading']=int(bv[128:137])
168 r['TimeStamp']=int(bv[137:143])
169 r['RegionalReserved']=0
170 r['Spare']=0
171 r['RAIM']=bool(int(bv[148:149]))
172 r['syncstate']=int(bv[149:151])
173 r['slotoffset']=int(bv[151:165])
174 return r
175
177 return 1
178
181
184
186 return int(bv[38:42])
187
190
192 return Decimal(int(bv[50:60]))/Decimal('10')
193
195 return int(bv[60:61])
196
199
202
204 return Decimal(int(bv[116:128]))/Decimal('10')
205
207 return int(bv[128:137])
208
210 return int(bv[137:143])
211
213 return 0
214
216 return 0
217
219 return bool(int(bv[148:149]))
220
222 return int(bv[149:151])
223
225 return int(bv[151:165])
226
227
229 out.write("<h3>position<h3>\n")
230 out.write("<table border=\"1\">\n")
231 out.write("<tr bgcolor=\"orange\">\n")
232 out.write("<th align=\"left\">Field Name</th>\n")
233 out.write("<th align=\"left\">Type</th>\n")
234 out.write("<th align=\"left\">Value</th>\n")
235 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
236 out.write("<th align=\"left\">Units</th>\n")
237 out.write("\n")
238 out.write("<tr>\n")
239 out.write("<td>MessageID</td>\n")
240 out.write("<td>uint</td>\n")
241 if 'MessageID' in params:
242 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
243 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
244 out.write("</tr>\n")
245 out.write("\n")
246 out.write("<tr>\n")
247 out.write("<td>RepeatIndicator</td>\n")
248 out.write("<td>uint</td>\n")
249 if 'RepeatIndicator' in params:
250 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n")
251 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut:
252 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>")
253 else:
254 out.write("<td><i>Missing LUT entry</i></td>")
255 out.write("</tr>\n")
256 out.write("\n")
257 out.write("<tr>\n")
258 out.write("<td>UserID</td>\n")
259 out.write("<td>uint</td>\n")
260 if 'UserID' in params:
261 out.write(" <td>"+str(params['UserID'])+"</td>\n")
262 out.write(" <td>"+str(params['UserID'])+"</td>\n")
263 out.write("</tr>\n")
264 out.write("\n")
265 out.write("<tr>\n")
266 out.write("<td>NavigationStatus</td>\n")
267 out.write("<td>uint</td>\n")
268 if 'NavigationStatus' in params:
269 out.write(" <td>"+str(params['NavigationStatus'])+"</td>\n")
270 if str(params['NavigationStatus']) in NavigationStatusDecodeLut:
271 out.write("<td>"+NavigationStatusDecodeLut[str(params['NavigationStatus'])]+"</td>")
272 else:
273 out.write("<td><i>Missing LUT entry</i></td>")
274 out.write("</tr>\n")
275 out.write("\n")
276 out.write("<tr>\n")
277 out.write("<td>ROT</td>\n")
278 out.write("<td>int</td>\n")
279 if 'ROT' in params:
280 out.write(" <td>"+str(params['ROT'])+"</td>\n")
281 out.write(" <td>"+str(params['ROT'])+"</td>\n")
282 out.write("<td>4.733*sqrt(val) degrees/min</td>\n")
283 out.write("</tr>\n")
284 out.write("\n")
285 out.write("<tr>\n")
286 out.write("<td>SOG</td>\n")
287 out.write("<td>udecimal</td>\n")
288 if 'SOG' in params:
289 out.write(" <td>"+str(params['SOG'])+"</td>\n")
290 if str(params['SOG']) in SOGDecodeLut:
291 out.write("<td>"+SOGDecodeLut[str(params['SOG'])]+"</td>")
292 else:
293 out.write("<td><i>Missing LUT entry</i></td>")
294 out.write("<td>knots</td>\n")
295 out.write("</tr>\n")
296 out.write("\n")
297 out.write("<tr>\n")
298 out.write("<td>PositionAccuracy</td>\n")
299 out.write("<td>uint</td>\n")
300 if 'PositionAccuracy' in params:
301 out.write(" <td>"+str(params['PositionAccuracy'])+"</td>\n")
302 if str(params['PositionAccuracy']) in PositionAccuracyDecodeLut:
303 out.write("<td>"+PositionAccuracyDecodeLut[str(params['PositionAccuracy'])]+"</td>")
304 else:
305 out.write("<td><i>Missing LUT entry</i></td>")
306 out.write("</tr>\n")
307 out.write("\n")
308 out.write("<tr>\n")
309 out.write("<td>Position_longitude</td>\n")
310 out.write("<td>decimal</td>\n")
311 if 'Position_longitude' in params:
312 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n")
313 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n")
314 out.write("<td>degrees</td>\n")
315 out.write("</tr>\n")
316 out.write("\n")
317 out.write("<tr>\n")
318 out.write("<td>Position_latitude</td>\n")
319 out.write("<td>decimal</td>\n")
320 if 'Position_latitude' in params:
321 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n")
322 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n")
323 out.write("<td>degrees</td>\n")
324 out.write("</tr>\n")
325 out.write("\n")
326 out.write("<tr>\n")
327 out.write("<td>COG</td>\n")
328 out.write("<td>udecimal</td>\n")
329 if 'COG' in params:
330 out.write(" <td>"+str(params['COG'])+"</td>\n")
331 out.write(" <td>"+str(params['COG'])+"</td>\n")
332 out.write("<td>degrees</td>\n")
333 out.write("</tr>\n")
334 out.write("\n")
335 out.write("<tr>\n")
336 out.write("<td>TrueHeading</td>\n")
337 out.write("<td>uint</td>\n")
338 if 'TrueHeading' in params:
339 out.write(" <td>"+str(params['TrueHeading'])+"</td>\n")
340 out.write(" <td>"+str(params['TrueHeading'])+"</td>\n")
341 out.write("<td>degrees</td>\n")
342 out.write("</tr>\n")
343 out.write("\n")
344 out.write("<tr>\n")
345 out.write("<td>TimeStamp</td>\n")
346 out.write("<td>uint</td>\n")
347 if 'TimeStamp' in params:
348 out.write(" <td>"+str(params['TimeStamp'])+"</td>\n")
349 if str(params['TimeStamp']) in TimeStampDecodeLut:
350 out.write("<td>"+TimeStampDecodeLut[str(params['TimeStamp'])]+"</td>")
351 else:
352 out.write("<td><i>Missing LUT entry</i></td>")
353 out.write("<td>seconds</td>\n")
354 out.write("</tr>\n")
355 out.write("\n")
356 out.write("<tr>\n")
357 out.write("<td>RegionalReserved</td>\n")
358 out.write("<td>uint</td>\n")
359 if 'RegionalReserved' in params:
360 out.write(" <td>"+str(params['RegionalReserved'])+"</td>\n")
361 out.write(" <td>"+str(params['RegionalReserved'])+"</td>\n")
362 out.write("</tr>\n")
363 out.write("\n")
364 out.write("<tr>\n")
365 out.write("<td>Spare</td>\n")
366 out.write("<td>uint</td>\n")
367 if 'Spare' in params:
368 out.write(" <td>"+str(params['Spare'])+"</td>\n")
369 out.write(" <td>"+str(params['Spare'])+"</td>\n")
370 out.write("</tr>\n")
371 out.write("\n")
372 out.write("<tr>\n")
373 out.write("<td>RAIM</td>\n")
374 out.write("<td>bool</td>\n")
375 if 'RAIM' in params:
376 out.write(" <td>"+str(params['RAIM'])+"</td>\n")
377 if str(params['RAIM']) in RAIMDecodeLut:
378 out.write("<td>"+RAIMDecodeLut[str(params['RAIM'])]+"</td>")
379 else:
380 out.write("<td><i>Missing LUT entry</i></td>")
381 out.write("</tr>\n")
382 out.write("\n")
383 out.write("<tr>\n")
384 out.write("<td>syncstate</td>\n")
385 out.write("<td>uint</td>\n")
386 if 'syncstate' in params:
387 out.write(" <td>"+str(params['syncstate'])+"</td>\n")
388 if str(params['syncstate']) in syncstateDecodeLut:
389 out.write("<td>"+syncstateDecodeLut[str(params['syncstate'])]+"</td>")
390 else:
391 out.write("<td><i>Missing LUT entry</i></td>")
392 out.write("</tr>\n")
393 out.write("\n")
394 out.write("<tr>\n")
395 out.write("<td>slotoffset</td>\n")
396 out.write("<td>uint</td>\n")
397 if 'slotoffset' in params:
398 out.write(" <td>"+str(params['slotoffset'])+"</td>\n")
399 out.write(" <td>"+str(params['slotoffset'])+"</td>\n")
400 out.write("</tr>\n")
401 out.write("</table>\n")
402
404 '''KML (Keyhole Markup Language) for Google Earth, but without the header/footer'''
405 out.write("\ <Placemark>\n")
406 out.write("\t <name>"+str(params['UserID'])+"</name>\n")
407 out.write("\t\t<description>\n")
408 import StringIO
409 buf = StringIO.StringIO()
410 printHtml(params,buf)
411 import cgi
412 out.write(cgi.escape(buf.getvalue()))
413 out.write("\t\t</description>\n")
414 out.write("\t\t<styleUrl>#m_ylw-pushpin_copy0</styleUrl>\n")
415 out.write("\t\t<Point>\n")
416 out.write("\t\t\t<coordinates>")
417 out.write(str(params['Position_longitude']))
418 out.write(',')
419 out.write(str(params['Position_latitude']))
420 out.write(",0</coordinates>\n")
421 out.write("\t\t</Point>\n")
422 out.write("\t</Placemark>\n")
423
425 '''Print a slotoffset message to stdout.
426
427 Fields in params:
428 - MessageID(uint): AIS message number. Must be 1 (field automatically set to "1")
429 - RepeatIndicator(uint): Indicated how many times a message has been repeated
430 - UserID(uint): Unique ship identification number (MMSI)
431 - NavigationStatus(uint): What is the vessel doing
432 - ROT(int): RateOfTurn
433 - SOG(udecimal): Speed over ground
434 - PositionAccuracy(uint): Accuracy of positioning fixes
435 - Position_longitude(decimal): Location of the vessel East West location
436 - Position_latitude(decimal): Location of the vessel North South location
437 - COG(udecimal): Course over ground
438 - TrueHeading(uint): True heading (relative to true North)
439 - TimeStamp(uint): UTC second when the report was generated
440 - RegionalReserved(uint): Reserved for definition by a regional authority. (field automatically set to "0")
441 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
442 - RAIM(bool): Receiver autonomous integrity monitoring flag
443 - syncstate(uint): Sycronization state
444 - slotoffset(uint): In what slot will the next transmission occur. BROKEN
445 @param params: Dictionary of field names/values.
446 @param out: File like object to write to
447 @rtype: stdout
448 @return: text to out
449 '''
450
451 if 'std'==format:
452 out.write("slotoffset:\n")
453 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n")
454 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n")
455 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n")
456 if 'NavigationStatus' in params: out.write(" NavigationStatus: "+str(params['NavigationStatus'])+"\n")
457 if 'ROT' in params: out.write(" ROT: "+str(params['ROT'])+"\n")
458 if 'SOG' in params: out.write(" SOG: "+str(params['SOG'])+"\n")
459 if 'PositionAccuracy' in params: out.write(" PositionAccuracy: "+str(params['PositionAccuracy'])+"\n")
460 if 'Position_longitude' in params: out.write(" Position_longitude: "+str(params['Position_longitude'])+"\n")
461 if 'Position_latitude' in params: out.write(" Position_latitude: "+str(params['Position_latitude'])+"\n")
462 if 'COG' in params: out.write(" COG: "+str(params['COG'])+"\n")
463 if 'TrueHeading' in params: out.write(" TrueHeading: "+str(params['TrueHeading'])+"\n")
464 if 'TimeStamp' in params: out.write(" TimeStamp: "+str(params['TimeStamp'])+"\n")
465 if 'RegionalReserved' in params: out.write(" RegionalReserved: "+str(params['RegionalReserved'])+"\n")
466 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n")
467 if 'RAIM' in params: out.write(" RAIM: "+str(params['RAIM'])+"\n")
468 if 'syncstate' in params: out.write(" syncstate: "+str(params['syncstate'])+"\n")
469 if 'slotoffset' in params: out.write(" slotoffset: "+str(params['slotoffset'])+"\n")
470 elif 'html'==format:
471 printHtml(params,out)
472 elif 'kml'==format:
473 printKml(params,out)
474 elif 'kml-full'==format:
475 out.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
476 out.write("<kml xmlns=\"http://earth.google.com/kml/2.1\">\n")
477 out.write("<Document>\n")
478 out.write(" <name>Position</name>\n")
479 printKml(params,out)
480 out.write("</Document>\n")
481 out.write("</kml>\n")
482 else:
483 print "ERROR: unknown format:",format
484 assert False
485
486 return
487
488 RepeatIndicatorEncodeLut = {
489 'default':'0',
490 'do not repeat any more':'3',
491 }
492
493 RepeatIndicatorDecodeLut = {
494 '0':'default',
495 '3':'do not repeat any more',
496 }
497
498 NavigationStatusEncodeLut = {
499 'under way using engine':'0',
500 'at anchor':'1',
501 'not under command':'2',
502 'restricted maneuverability':'3',
503 'constrained by her draught':'4',
504 'moored':'5',
505 'aground':'6',
506 'engaged in fishing':'7',
507 'under way sailing':'8',
508 'reserved for future use (hazmat)':'9',
509 'reserved for future use':'10',
510 'reserved for future use':'11',
511 'reserved for future use':'12',
512 'reserved for future use':'13',
513 'reserved for future use':'14',
514 'not defined = default':'15',
515 }
516
517 NavigationStatusDecodeLut = {
518 '0':'under way using engine',
519 '1':'at anchor',
520 '2':'not under command',
521 '3':'restricted maneuverability',
522 '4':'constrained by her draught',
523 '5':'moored',
524 '6':'aground',
525 '7':'engaged in fishing',
526 '8':'under way sailing',
527 '9':'reserved for future use (hazmat)',
528 '10':'reserved for future use',
529 '11':'reserved for future use',
530 '12':'reserved for future use',
531 '13':'reserved for future use',
532 '14':'reserved for future use',
533 '15':'not defined = default',
534 }
535
536 SOGEncodeLut = {
537 '102.2 knots or higher':'102.2',
538 }
539
540 SOGDecodeLut = {
541 '102.2':'102.2 knots or higher',
542 }
543
544 PositionAccuracyEncodeLut = {
545 'low (greater than 10 m)':'0',
546 'high (less than 10 m)':'1',
547 }
548
549 PositionAccuracyDecodeLut = {
550 '0':'low (greater than 10 m)',
551 '1':'high (less than 10 m)',
552 }
553
554 TimeStampEncodeLut = {
555 'not available/default':'60',
556 'manual input':'61',
557 'dead reckoning':'62',
558 'inoperative':'63',
559 }
560
561 TimeStampDecodeLut = {
562 '60':'not available/default',
563 '61':'manual input',
564 '62':'dead reckoning',
565 '63':'inoperative',
566 }
567
568 RAIMEncodeLut = {
569 'not in use':'False',
570 'in use':'True',
571 }
572
573 RAIMDecodeLut = {
574 'False':'not in use',
575 'True':'in use',
576 }
577
578 syncstateEncodeLut = {
579 'UTC direct':'0',
580 'UTC indirect':'1',
581 'synchronized to a base station':'2',
582 'synchronized to another station':'3',
583 }
584
585 syncstateDecodeLut = {
586 '0':'UTC direct',
587 '1':'UTC indirect',
588 '2':'synchronized to a base station',
589 '3':'synchronized to another station',
590 }
591
592
593
594
595
596
597 import unittest
599 '''Return a params file base on the testvalue tags.
600 @rtype: dict
601 @return: params based on testvalue tags
602 '''
603 params = {}
604 params['MessageID'] = 1
605 params['RepeatIndicator'] = 1
606 params['UserID'] = 1193046
607 params['NavigationStatus'] = 3
608 params['ROT'] = -2
609 params['SOG'] = Decimal('101.9')
610 params['PositionAccuracy'] = 1
611 params['Position_longitude'] = Decimal('-122.16328055555556')
612 params['Position_latitude'] = Decimal('37.424458333333334')
613 params['COG'] = Decimal('34.5')
614 params['TrueHeading'] = 41
615 params['TimeStamp'] = 35
616 params['RegionalReserved'] = 0
617 params['Spare'] = 0
618 params['RAIM'] = False
619 params['syncstate'] = 2
620 params['slotoffset'] = 1221
621
622 return params
623
625 '''Use testvalue tag text from each type to build test case the position message'''
627
628 params = testParams()
629 bits = encode(params)
630 r = decode(bits)
631
632
633 self.failUnlessEqual(r['MessageID'],params['MessageID'])
634 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator'])
635 self.failUnlessEqual(r['UserID'],params['UserID'])
636 self.failUnlessEqual(r['NavigationStatus'],params['NavigationStatus'])
637 self.failUnlessEqual(r['ROT'],params['ROT'])
638 self.failUnlessAlmostEqual(r['SOG'],params['SOG'],1)
639 self.failUnlessEqual(r['PositionAccuracy'],params['PositionAccuracy'])
640 self.failUnlessAlmostEqual(r['Position_longitude'],params['Position_longitude'],5)
641 self.failUnlessAlmostEqual(r['Position_latitude'],params['Position_latitude'],5)
642 self.failUnlessAlmostEqual(r['COG'],params['COG'],3)
643 self.failUnlessEqual(r['TrueHeading'],params['TrueHeading'])
644 self.failUnlessEqual(r['TimeStamp'],params['TimeStamp'])
645 self.failUnlessEqual(r['RegionalReserved'],params['RegionalReserved'])
646 self.failUnlessEqual(r['Spare'],params['Spare'])
647 self.failUnlessEqual(r['RAIM'],params['RAIM'])
648 self.failUnlessEqual(r['syncstate'],params['syncstate'])
649 self.failUnlessEqual(r['slotoffset'],params['slotoffset'])
650
652 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
653 help='decode a "position" AIS message')
654 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
655 help='encode a "position" AIS message')
656 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int'
657 ,help='Field parameter value [default: %default]')
658 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int'
659 ,help='Field parameter value [default: %default]')
660 parser.add_option('--NavigationStatus-field', dest='NavigationStatusField',default=15,metavar='uint',type='int'
661 ,help='Field parameter value [default: %default]')
662 parser.add_option('--ROT-field', dest='ROTField',default=-128,metavar='int',type='int'
663 ,help='Field parameter value [default: %default]')
664 parser.add_option('--SOG-field', dest='SOGField',default=Decimal('102.3'),metavar='udecimal',type='string'
665 ,help='Field parameter value [default: %default]')
666 parser.add_option('--PositionAccuracy-field', dest='PositionAccuracyField',metavar='uint',type='int'
667 ,help='Field parameter value [default: %default]')
668 parser.add_option('--Position_longitude-field', dest='Position_longitudeField',default=Decimal('181'),metavar='decimal',type='string'
669 ,help='Field parameter value [default: %default]')
670 parser.add_option('--Position_latitude-field', dest='Position_latitudeField',default=Decimal('91'),metavar='decimal',type='string'
671 ,help='Field parameter value [default: %default]')
672 parser.add_option('--COG-field', dest='COGField',default=Decimal('360'),metavar='udecimal',type='string'
673 ,help='Field parameter value [default: %default]')
674 parser.add_option('--TrueHeading-field', dest='TrueHeadingField',default=511,metavar='uint',type='int'
675 ,help='Field parameter value [default: %default]')
676 parser.add_option('--TimeStamp-field', dest='TimeStampField',default=60,metavar='uint',type='int'
677 ,help='Field parameter value [default: %default]')
678 parser.add_option('--RAIM-field', dest='RAIMField',metavar='bool',type='int'
679 ,help='Field parameter value [default: %default]')
680 parser.add_option('--syncstate-field', dest='syncstateField',metavar='uint',type='int'
681 ,help='Field parameter value [default: %default]')
682 parser.add_option('--slotoffset-field', dest='slotoffsetField',metavar='uint',type='int'
683 ,help='Field parameter value [default: %default]')
684
685
686 if __name__=='__main__':
687
688 from optparse import OptionParser
689 parser = OptionParser(usage="%prog [options]",
690 version="%prog "+__version__)
691
692 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
693 help='run the documentation tests')
694 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
695 help='run the unit tests')
696 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
697 help='Make the test output verbose')
698
699
700
701 typeChoices = ('binary','nmeapayload','nmea')
702 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
703 ,default='nmeapayload'
704 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]')
705
706
707 outputChoices = ('std','html','xml' , 'kml','kml-full')
708 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
709 ,default='std'
710 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
711
712 parser.add_option('-o','--output',dest='outputFileName',default=None,
713 help='Name of the python file to write [default: stdout]')
714
715 addMsgOptions(parser)
716
717 (options,args) = parser.parse_args()
718 success=True
719
720 if options.doctest:
721 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
722 sys.argv= [sys.argv[0]]
723 if options.verbose: sys.argv.append('-v')
724 import doctest
725 numfail,numtests=doctest.testmod()
726 if numfail==0: print 'ok'
727 else:
728 print 'FAILED'
729 success=False
730
731 if not success: sys.exit('Something Failed')
732 del success
733
734 if options.unittest:
735 sys.argv = [sys.argv[0]]
736 if options.verbose: sys.argv.append('-v')
737 unittest.main()
738
739 outfile = sys.stdout
740 if None!=options.outputFileName:
741 outfile = file(options.outputFileName,'w')
742
743
744 if options.doEncode:
745
746 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField")
747 if None==options.UserIDField: parser.error("missing value for UserIDField")
748 if None==options.NavigationStatusField: parser.error("missing value for NavigationStatusField")
749 if None==options.ROTField: parser.error("missing value for ROTField")
750 if None==options.SOGField: parser.error("missing value for SOGField")
751 if None==options.PositionAccuracyField: parser.error("missing value for PositionAccuracyField")
752 if None==options.Position_longitudeField: parser.error("missing value for Position_longitudeField")
753 if None==options.Position_latitudeField: parser.error("missing value for Position_latitudeField")
754 if None==options.COGField: parser.error("missing value for COGField")
755 if None==options.TrueHeadingField: parser.error("missing value for TrueHeadingField")
756 if None==options.TimeStampField: parser.error("missing value for TimeStampField")
757 if None==options.RAIMField: parser.error("missing value for RAIMField")
758 if None==options.syncstateField: parser.error("missing value for syncstateField")
759 if None==options.slotoffsetField: parser.error("missing value for slotoffsetField")
760 msgDict={
761 'MessageID': '1',
762 'RepeatIndicator': options.RepeatIndicatorField,
763 'UserID': options.UserIDField,
764 'NavigationStatus': options.NavigationStatusField,
765 'ROT': options.ROTField,
766 'SOG': options.SOGField,
767 'PositionAccuracy': options.PositionAccuracyField,
768 'Position_longitude': options.Position_longitudeField,
769 'Position_latitude': options.Position_latitudeField,
770 'COG': options.COGField,
771 'TrueHeading': options.TrueHeadingField,
772 'TimeStamp': options.TimeStampField,
773 'RegionalReserved': '0',
774 'Spare': '0',
775 'RAIM': options.RAIMField,
776 'syncstate': options.syncstateField,
777 'slotoffset': options.slotoffsetField,
778 }
779
780 bits = encode(msgDict)
781 if 'binary'==options.ioType: print str(bits)
782 elif 'nmeapayload'==options.ioType:
783
784 print "bitLen",len(bits)
785 bitLen=len(bits)
786 if bitLen%6!=0:
787 bits = bits + BitVector(size=(6 - (bitLen%6)))
788 print "result:",binary.bitvectoais6(bits)[0]
789
790
791
792 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
793 else: sys.exit('ERROR: unknown ioType. Help!')
794
795 if options.doDecode:
796 for msg in args:
797 bv = None
798 if 'binary' == options.ioType: bv = BitVector(bitstring=msg)
799 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg)
800 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5])
801 else: sys.exit('ERROR: unknown ioType. Help!')
802
803 printFields(decode(bv),out=outfile,format=options.outputType)
804