1
2
3 __version__ = '$Revision: 4791 $'.split()[1]
4 __date__ = '$Date: 2007-01-04 $'.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 "3")
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=3),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 "3")
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']=3
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 3
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
228 '''Print a position message to stdout.
229
230 Fields in params:
231 - MessageID(uint): AIS message number. Must be 1 (field automatically set to "3")
232 - RepeatIndicator(uint): Indicated how many times a message has been repeated
233 - UserID(uint): Unique ship identification number (MMSI)
234 - NavigationStatus(uint): What is the vessel doing
235 - ROT(int): RateOfTurn
236 - SOG(udecimal): Speed over ground
237 - PositionAccuracy(uint): Accuracy of positioning fixes
238 - Position_longitude(decimal): Location of the vessel East West location
239 - Position_latitude(decimal): Location of the vessel North South location
240 - COG(udecimal): Course over ground
241 - TrueHeading(uint): True heading (relative to true North)
242 - TimeStamp(uint): UTC second when the report was generated
243 - RegionalReserved(uint): Reserved for definition by a regional authority. (field automatically set to "0")
244 - Spare(uint): Reserved for definition by a regional authority. (field automatically set to "0")
245 - RAIM(bool): Receiver autonomous integrity monitoring flag
246 - syncstate(uint): Sycronization state
247 - slotoffset(uint): In what slot will the next transmission occur. BROKEN
248 @param params: Dictionary of field names/values.
249 @param out: File like object to write to
250 @rtype: stdout
251 @return: text to out
252 '''
253
254 if 'std'==format:
255 out.write("position:\n")
256 if 'MessageID' in params: out.write(" MessageID: "+str(params['MessageID'])+"\n")
257 if 'RepeatIndicator' in params: out.write(" RepeatIndicator: "+str(params['RepeatIndicator'])+"\n")
258 if 'UserID' in params: out.write(" UserID: "+str(params['UserID'])+"\n")
259 if 'NavigationStatus' in params: out.write(" NavigationStatus: "+str(params['NavigationStatus'])+"\n")
260 if 'ROT' in params: out.write(" ROT: "+str(params['ROT'])+"\n")
261 if 'SOG' in params: out.write(" SOG: "+str(params['SOG'])+"\n")
262 if 'PositionAccuracy' in params: out.write(" PositionAccuracy: "+str(params['PositionAccuracy'])+"\n")
263 if 'Position_longitude' in params: out.write(" Position_longitude: "+str(params['Position_longitude'])+"\n")
264 if 'Position_latitude' in params: out.write(" Position_latitude: "+str(params['Position_latitude'])+"\n")
265 if 'COG' in params: out.write(" COG: "+str(params['COG'])+"\n")
266 if 'TrueHeading' in params: out.write(" TrueHeading: "+str(params['TrueHeading'])+"\n")
267 if 'TimeStamp' in params: out.write(" TimeStamp: "+str(params['TimeStamp'])+"\n")
268 if 'RegionalReserved' in params: out.write(" RegionalReserved: "+str(params['RegionalReserved'])+"\n")
269 if 'Spare' in params: out.write(" Spare: "+str(params['Spare'])+"\n")
270 if 'RAIM' in params: out.write(" RAIM: "+str(params['RAIM'])+"\n")
271 if 'syncstate' in params: out.write(" syncstate: "+str(params['syncstate'])+"\n")
272 if 'slotoffset' in params: out.write(" slotoffset: "+str(params['slotoffset'])+"\n")
273 elif 'html'==format:
274 out.write("<h3>slotoffset<h3>\n")
275 out.write("<table border=\"1\">\n")
276 out.write("<tr bgcolor=\"orange\">\n")
277 out.write("<th align=\"left\">Field Name</th>\n")
278 out.write("<th align=\"left\">Type</th>\n")
279 out.write("<th align=\"left\">Value</th>\n")
280 out.write("<th align=\"left\">Value in Lookup Table</th>\n")
281 out.write("\n")
282 out.write("<tr>\n")
283 out.write("<td>MessageID</td>\n")
284 out.write("<td>uint</td>\n")
285 if 'MessageID' in params:
286 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
287 out.write(" <td>"+str(params['MessageID'])+"</td>\n")
288 out.write("</tr>\n")
289 out.write("\n")
290 out.write("<tr>\n")
291 out.write("<td>RepeatIndicator</td>\n")
292 out.write("<td>uint</td>\n")
293 if 'RepeatIndicator' in params:
294 out.write(" <td>"+str(params['RepeatIndicator'])+"</td>\n")
295 if str(params['RepeatIndicator']) in RepeatIndicatorDecodeLut:
296 out.write("<td>"+RepeatIndicatorDecodeLut[str(params['RepeatIndicator'])]+"</td>")
297 else:
298 out.write("<td><i>Missing LUT entry</i></td>")
299 out.write("</tr>\n")
300 out.write("\n")
301 out.write("<tr>\n")
302 out.write("<td>UserID</td>\n")
303 out.write("<td>uint</td>\n")
304 if 'UserID' in params:
305 out.write(" <td>"+str(params['UserID'])+"</td>\n")
306 out.write(" <td>"+str(params['UserID'])+"</td>\n")
307 out.write("</tr>\n")
308 out.write("\n")
309 out.write("<tr>\n")
310 out.write("<td>NavigationStatus</td>\n")
311 out.write("<td>uint</td>\n")
312 if 'NavigationStatus' in params:
313 out.write(" <td>"+str(params['NavigationStatus'])+"</td>\n")
314 if str(params['NavigationStatus']) in NavigationStatusDecodeLut:
315 out.write("<td>"+NavigationStatusDecodeLut[str(params['NavigationStatus'])]+"</td>")
316 else:
317 out.write("<td><i>Missing LUT entry</i></td>")
318 out.write("</tr>\n")
319 out.write("\n")
320 out.write("<tr>\n")
321 out.write("<td>ROT</td>\n")
322 out.write("<td>int</td>\n")
323 if 'ROT' in params:
324 out.write(" <td>"+str(params['ROT'])+"</td>\n")
325 out.write(" <td>"+str(params['ROT'])+"</td>\n")
326 out.write("</tr>\n")
327 out.write("\n")
328 out.write("<tr>\n")
329 out.write("<td>SOG</td>\n")
330 out.write("<td>udecimal</td>\n")
331 if 'SOG' in params:
332 out.write(" <td>"+str(params['SOG'])+"</td>\n")
333 if str(params['SOG']) in SOGDecodeLut:
334 out.write("<td>"+SOGDecodeLut[str(params['SOG'])]+"</td>")
335 else:
336 out.write("<td><i>Missing LUT entry</i></td>")
337 out.write("</tr>\n")
338 out.write("\n")
339 out.write("<tr>\n")
340 out.write("<td>PositionAccuracy</td>\n")
341 out.write("<td>uint</td>\n")
342 if 'PositionAccuracy' in params:
343 out.write(" <td>"+str(params['PositionAccuracy'])+"</td>\n")
344 if str(params['PositionAccuracy']) in PositionAccuracyDecodeLut:
345 out.write("<td>"+PositionAccuracyDecodeLut[str(params['PositionAccuracy'])]+"</td>")
346 else:
347 out.write("<td><i>Missing LUT entry</i></td>")
348 out.write("</tr>\n")
349 out.write("\n")
350 out.write("<tr>\n")
351 out.write("<td>Position_longitude</td>\n")
352 out.write("<td>decimal</td>\n")
353 if 'Position_longitude' in params:
354 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n")
355 out.write(" <td>"+str(params['Position_longitude'])+"</td>\n")
356 out.write("</tr>\n")
357 out.write("\n")
358 out.write("<tr>\n")
359 out.write("<td>Position_latitude</td>\n")
360 out.write("<td>decimal</td>\n")
361 if 'Position_latitude' in params:
362 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n")
363 out.write(" <td>"+str(params['Position_latitude'])+"</td>\n")
364 out.write("</tr>\n")
365 out.write("\n")
366 out.write("<tr>\n")
367 out.write("<td>COG</td>\n")
368 out.write("<td>udecimal</td>\n")
369 if 'COG' in params:
370 out.write(" <td>"+str(params['COG'])+"</td>\n")
371 out.write(" <td>"+str(params['COG'])+"</td>\n")
372 out.write("</tr>\n")
373 out.write("\n")
374 out.write("<tr>\n")
375 out.write("<td>TrueHeading</td>\n")
376 out.write("<td>uint</td>\n")
377 if 'TrueHeading' in params:
378 out.write(" <td>"+str(params['TrueHeading'])+"</td>\n")
379 out.write(" <td>"+str(params['TrueHeading'])+"</td>\n")
380 out.write("</tr>\n")
381 out.write("\n")
382 out.write("<tr>\n")
383 out.write("<td>TimeStamp</td>\n")
384 out.write("<td>uint</td>\n")
385 if 'TimeStamp' in params:
386 out.write(" <td>"+str(params['TimeStamp'])+"</td>\n")
387 if str(params['TimeStamp']) in TimeStampDecodeLut:
388 out.write("<td>"+TimeStampDecodeLut[str(params['TimeStamp'])]+"</td>")
389 else:
390 out.write("<td><i>Missing LUT entry</i></td>")
391 out.write("</tr>\n")
392 out.write("\n")
393 out.write("<tr>\n")
394 out.write("<td>RegionalReserved</td>\n")
395 out.write("<td>uint</td>\n")
396 if 'RegionalReserved' in params:
397 out.write(" <td>"+str(params['RegionalReserved'])+"</td>\n")
398 out.write(" <td>"+str(params['RegionalReserved'])+"</td>\n")
399 out.write("</tr>\n")
400 out.write("\n")
401 out.write("<tr>\n")
402 out.write("<td>Spare</td>\n")
403 out.write("<td>uint</td>\n")
404 if 'Spare' in params:
405 out.write(" <td>"+str(params['Spare'])+"</td>\n")
406 out.write(" <td>"+str(params['Spare'])+"</td>\n")
407 out.write("</tr>\n")
408 out.write("\n")
409 out.write("<tr>\n")
410 out.write("<td>RAIM</td>\n")
411 out.write("<td>bool</td>\n")
412 if 'RAIM' in params:
413 out.write(" <td>"+str(params['RAIM'])+"</td>\n")
414 if str(params['RAIM']) in RAIMDecodeLut:
415 out.write("<td>"+RAIMDecodeLut[str(params['RAIM'])]+"</td>")
416 else:
417 out.write("<td><i>Missing LUT entry</i></td>")
418 out.write("</tr>\n")
419 out.write("\n")
420 out.write("<tr>\n")
421 out.write("<td>syncstate</td>\n")
422 out.write("<td>uint</td>\n")
423 if 'syncstate' in params:
424 out.write(" <td>"+str(params['syncstate'])+"</td>\n")
425 if str(params['syncstate']) in syncstateDecodeLut:
426 out.write("<td>"+syncstateDecodeLut[str(params['syncstate'])]+"</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>slotoffset</td>\n")
433 out.write("<td>uint</td>\n")
434 if 'slotoffset' in params:
435 out.write(" <td>"+str(params['slotoffset'])+"</td>\n")
436 out.write(" <td>"+str(params['slotoffset'])+"</td>\n")
437 out.write("</tr>\n")
438 out.write("</table>\n")
439 else:
440 print "ERROR: unknown format:",format
441 assert False
442
443 return
444
445 RepeatIndicatorEncodeLut = {
446 'default':'0',
447 'do not repeat any more':'3',
448 }
449
450 RepeatIndicatorDecodeLut = {
451 '0':'default',
452 '3':'do not repeat any more',
453 }
454
455 NavigationStatusEncodeLut = {
456 'under way using engine':'0',
457 'at anchor':'1',
458 'not under command':'2',
459 'restricted maneuverability':'3',
460 'constrained by her draught':'4',
461 'moored':'5',
462 'aground':'6',
463 'engaged in fishing':'7',
464 'under way sailing':'8',
465 'reserved for future use (hazmat)':'9',
466 'reserved for future use':'10',
467 'reserved for future use':'11',
468 'reserved for future use':'12',
469 'reserved for future use':'13',
470 'reserved for future use':'14',
471 'not defined = default':'15',
472 }
473
474 NavigationStatusDecodeLut = {
475 '0':'under way using engine',
476 '1':'at anchor',
477 '2':'not under command',
478 '3':'restricted maneuverability',
479 '4':'constrained by her draught',
480 '5':'moored',
481 '6':'aground',
482 '7':'engaged in fishing',
483 '8':'under way sailing',
484 '9':'reserved for future use (hazmat)',
485 '10':'reserved for future use',
486 '11':'reserved for future use',
487 '12':'reserved for future use',
488 '13':'reserved for future use',
489 '14':'reserved for future use',
490 '15':'not defined = default',
491 }
492
493 SOGEncodeLut = {
494 '102.2 knots or higher':'102.2',
495 }
496
497 SOGDecodeLut = {
498 '102.2':'102.2 knots or higher',
499 }
500
501 PositionAccuracyEncodeLut = {
502 'low (greater than 10 m)':'0',
503 'high (greater than 10 m)':'1',
504 }
505
506 PositionAccuracyDecodeLut = {
507 '0':'low (greater than 10 m)',
508 '1':'high (greater than 10 m)',
509 }
510
511 TimeStampEncodeLut = {
512 'not available/default':'60',
513 'manual input':'61',
514 'dead reckoning':'62',
515 'inoperative':'63',
516 }
517
518 TimeStampDecodeLut = {
519 '60':'not available/default',
520 '61':'manual input',
521 '62':'dead reckoning',
522 '63':'inoperative',
523 }
524
525 RAIMEncodeLut = {
526 'not in use':'False',
527 'in use':'True',
528 }
529
530 RAIMDecodeLut = {
531 'False':'not in use',
532 'True':'in use',
533 }
534
535 syncstateEncodeLut = {
536 'UTC direct':'0',
537 'UTC indirect':'1',
538 'synchronized to a base station':'2',
539 'synchronized to another station':'3',
540 }
541
542 syncstateDecodeLut = {
543 '0':'UTC direct',
544 '1':'UTC indirect',
545 '2':'synchronized to a base station',
546 '3':'synchronized to another station',
547 }
548
549
550
551
552
553
554 import unittest
556 '''Return a params file base on the testvalue tags.
557 @rtype: dict
558 @return: params based on testvalue tags
559 '''
560 params = {}
561 params['MessageID'] = 3
562 params['RepeatIndicator'] = 1
563 params['UserID'] = 1193046
564 params['NavigationStatus'] = 3
565 params['ROT'] = -2
566 params['SOG'] = Decimal('101.9')
567 params['PositionAccuracy'] = 1
568 params['Position_longitude'] = Decimal('-122.16328055555556')
569 params['Position_latitude'] = Decimal('37.424458333333334')
570 params['COG'] = Decimal('34.5')
571 params['TrueHeading'] = 41
572 params['TimeStamp'] = 35
573 params['RegionalReserved'] = 0
574 params['Spare'] = 0
575 params['RAIM'] = False
576 params['syncstate'] = 2
577 params['slotoffset'] = 1221
578
579 return params
580
582 '''Use testvalue tag text from each type to build test case the position message'''
584
585 params = testParams()
586 bits = encode(params)
587 r = decode(bits)
588
589
590 self.failUnlessEqual(r['MessageID'],params['MessageID'])
591 self.failUnlessEqual(r['RepeatIndicator'],params['RepeatIndicator'])
592 self.failUnlessEqual(r['UserID'],params['UserID'])
593 self.failUnlessEqual(r['NavigationStatus'],params['NavigationStatus'])
594 self.failUnlessEqual(r['ROT'],params['ROT'])
595 self.failUnlessAlmostEqual(r['SOG'],params['SOG'],1)
596 self.failUnlessEqual(r['PositionAccuracy'],params['PositionAccuracy'])
597 self.failUnlessAlmostEqual(r['Position_longitude'],params['Position_longitude'],5)
598 self.failUnlessAlmostEqual(r['Position_latitude'],params['Position_latitude'],5)
599 self.failUnlessAlmostEqual(r['COG'],params['COG'],3)
600 self.failUnlessEqual(r['TrueHeading'],params['TrueHeading'])
601 self.failUnlessEqual(r['TimeStamp'],params['TimeStamp'])
602 self.failUnlessEqual(r['RegionalReserved'],params['RegionalReserved'])
603 self.failUnlessEqual(r['Spare'],params['Spare'])
604 self.failUnlessEqual(r['RAIM'],params['RAIM'])
605 self.failUnlessEqual(r['syncstate'],params['syncstate'])
606 self.failUnlessEqual(r['slotoffset'],params['slotoffset'])
607
609 parser.add_option('-d','--decode',dest='doDecode',default=False,action='store_true',
610 help='decode a "position" AIS message')
611 parser.add_option('-e','--encode',dest='doEncode',default=False,action='store_true',
612 help='encode a "position" AIS message')
613 parser.add_option('--RepeatIndicator-field', dest='RepeatIndicatorField',default=0,metavar='uint',type='int'
614 ,help='Field parameter value [default: %default]')
615 parser.add_option('--UserID-field', dest='UserIDField',metavar='uint',type='int'
616 ,help='Field parameter value [default: %default]')
617 parser.add_option('--NavigationStatus-field', dest='NavigationStatusField',default=15,metavar='uint',type='int'
618 ,help='Field parameter value [default: %default]')
619 parser.add_option('--ROT-field', dest='ROTField',default=-128,metavar='int',type='int'
620 ,help='Field parameter value [default: %default]')
621 parser.add_option('--SOG-field', dest='SOGField',default=Decimal('102.3'),metavar='udecimal',type='string'
622 ,help='Field parameter value [default: %default]')
623 parser.add_option('--PositionAccuracy-field', dest='PositionAccuracyField',metavar='uint',type='int'
624 ,help='Field parameter value [default: %default]')
625 parser.add_option('--Position_longitude-field', dest='Position_longitudeField',default=Decimal('181'),metavar='decimal',type='string'
626 ,help='Field parameter value [default: %default]')
627 parser.add_option('--Position_latitude-field', dest='Position_latitudeField',default=Decimal('91'),metavar='decimal',type='string'
628 ,help='Field parameter value [default: %default]')
629 parser.add_option('--COG-field', dest='COGField',default=Decimal('360'),metavar='udecimal',type='string'
630 ,help='Field parameter value [default: %default]')
631 parser.add_option('--TrueHeading-field', dest='TrueHeadingField',default=511,metavar='uint',type='int'
632 ,help='Field parameter value [default: %default]')
633 parser.add_option('--TimeStamp-field', dest='TimeStampField',default=60,metavar='uint',type='int'
634 ,help='Field parameter value [default: %default]')
635 parser.add_option('--RAIM-field', dest='RAIMField',metavar='bool',type='int'
636 ,help='Field parameter value [default: %default]')
637 parser.add_option('--syncstate-field', dest='syncstateField',metavar='uint',type='int'
638 ,help='Field parameter value [default: %default]')
639 parser.add_option('--slotoffset-field', dest='slotoffsetField',metavar='uint',type='int'
640 ,help='Field parameter value [default: %default]')
641
642
643 if __name__=='__main__':
644
645 from optparse import OptionParser
646 parser = OptionParser(usage="%prog [options]",
647 version="%prog "+__version__)
648
649 parser.add_option('--doc-test',dest='doctest',default=False,action='store_true',
650 help='run the documentation tests')
651 parser.add_option('--unit-test',dest='unittest',default=False,action='store_true',
652 help='run the unit tests')
653 parser.add_option('-v','--verbose',dest='verbose',default=False,action='store_true',
654 help='Make the test output verbose')
655
656
657
658 typeChoices = ('binary','nmeapayload','nmea')
659 parser.add_option('-t','--type',choices=typeChoices,type='choice',dest='ioType'
660 ,default='nmeapayload'
661 ,help='What kind of string to expect ('+', '.join(typeChoices)+') [default: %default]')
662
663 outputChoices = ('std','html','xml')
664 parser.add_option('-T','--output-type',choices=outputChoices,type='choice',dest='outputType'
665 ,default='std'
666 ,help='What kind of string to output ('+', '.join(outputChoices)+') [default: %default]')
667
668 parser.add_option('-o','--output',dest='outputFileName',default=None,
669 help='Name of the python file to write [default: stdout]')
670
671 addMsgOptions(parser)
672
673 (options,args) = parser.parse_args()
674 success=True
675
676 if options.doctest:
677 import os; print os.path.basename(sys.argv[0]), 'doctests ...',
678 sys.argv= [sys.argv[0]]
679 if options.verbose: sys.argv.append('-v')
680 import doctest
681 numfail,numtests=doctest.testmod()
682 if numfail==0: print 'ok'
683 else:
684 print 'FAILED'
685 success=False
686
687 if not success: sys.exit('Something Failed')
688 del success
689
690 if options.unittest:
691 sys.argv = [sys.argv[0]]
692 if options.verbose: sys.argv.append('-v')
693 unittest.main()
694
695 outfile = sys.stdout
696 if None!=options.outputFileName:
697 outfile = file(options.outputFileName,'w')
698
699
700 if options.doEncode:
701
702 if None==options.RepeatIndicatorField: parser.error("missing value for RepeatIndicatorField")
703 if None==options.UserIDField: parser.error("missing value for UserIDField")
704 if None==options.NavigationStatusField: parser.error("missing value for NavigationStatusField")
705 if None==options.ROTField: parser.error("missing value for ROTField")
706 if None==options.SOGField: parser.error("missing value for SOGField")
707 if None==options.PositionAccuracyField: parser.error("missing value for PositionAccuracyField")
708 if None==options.Position_longitudeField: parser.error("missing value for Position_longitudeField")
709 if None==options.Position_latitudeField: parser.error("missing value for Position_latitudeField")
710 if None==options.COGField: parser.error("missing value for COGField")
711 if None==options.TrueHeadingField: parser.error("missing value for TrueHeadingField")
712 if None==options.TimeStampField: parser.error("missing value for TimeStampField")
713 if None==options.RAIMField: parser.error("missing value for RAIMField")
714 if None==options.syncstateField: parser.error("missing value for syncstateField")
715 if None==options.slotoffsetField: parser.error("missing value for slotoffsetField")
716 msgDict={
717 'MessageID': '3',
718 'RepeatIndicator': options.RepeatIndicatorField,
719 'UserID': options.UserIDField,
720 'NavigationStatus': options.NavigationStatusField,
721 'ROT': options.ROTField,
722 'SOG': options.SOGField,
723 'PositionAccuracy': options.PositionAccuracyField,
724 'Position_longitude': options.Position_longitudeField,
725 'Position_latitude': options.Position_latitudeField,
726 'COG': options.COGField,
727 'TrueHeading': options.TrueHeadingField,
728 'TimeStamp': options.TimeStampField,
729 'RegionalReserved': '0',
730 'Spare': '0',
731 'RAIM': options.RAIMField,
732 'syncstate': options.syncstateField,
733 'slotoffset': options.slotoffsetField,
734 }
735
736 bits = encode(msgDict)
737 if 'binary'==options.ioType: print str(bits)
738 elif 'nmeapayload'==options.ioType:
739
740 print "bitLen",len(bits)
741 bitLen=len(bits)
742 if bitLen%6!=0:
743 bits = bits + BitVector(size=(6 - (bitLen%6)))
744 print "result:",binary.bitvectoais6(bits)[0]
745
746
747
748 elif 'nmea'==options.ioType: sys.exit("FIX: need to implement this capability")
749 else: sys.exit('ERROR: unknown ioType. Help!')
750
751 if options.doDecode:
752 for msg in args:
753 bv = None
754 if 'binary' == options.ioType: bv = BitVector(bitstring=msg)
755 elif 'nmeapayload'== options.ioType: bv = binary.ais6tobitvec(msg)
756 elif 'nmea' == options.ioType: bv = binary.ais6tobitvec(msg.split(',')[5])
757 else: sys.exit('ERROR: unknown ioType. Help!')
758
759 printFields(decode(bv),out=outfile,format=options.outputType)
760