GitXplorerGitXplorer
d

ais-protocol-decoding

public
27 stars
13 forks
1 issues

Commits

List of commits on branch master.
Verified
c9150e24612ae0aaf7b4259d49413cd830542368

Bump minimatch from 3.0.4 to 3.1.2 (#17)

ddependabot[bot] committed 2 years ago
Verified
0e23a73755cd890ed0f49a1af550331421f97fbb

Bump minimist from 1.2.5 to 1.2.6 (#15)

ddependabot[bot] committed 2 years ago
Verified
d5f56a28a470b78bb909b0021ba17e60bf0edbb1

Bump path-parse from 1.0.6 to 1.0.7 (#13)

ddependabot[bot] committed 3 years ago
Unverified
3b198d6a9536216277b12a9d10674cca238d63a9

update 3.0.8

ddoron2402 committed 5 years ago
Unverified
252699903cc399dcff8e23921c03be9d11d5f105

update v3.0.1

ddoron2402 committed 5 years ago
Unverified
43b8e3ae6aafbfd35af8331b68519b5a484214b7

latest

ddoron2402 committed 5 years ago

README

The README file for this repository.

AIS Decoder

The automatic identification system (AIS) is an automatic Tracking system used on ships and by vessel traffic services (VTS). When satellites are used to detect AIS signatures, the term Satellite-AIS (S-AIS) is used. AIS information supplements marine radar, which continues to be the primary method of collision avoidance for water transport.

Build Status

Ideal Node Version : 8.16.2

Tests : run npm test

AIS MESSAGES

  1. Position[0] format: !AIVDM, identifies this as an AIVDM packet (AIS format).
  2. Position[1] message_count: Messages counter (number of messages), sometimes the ais messages will be split over several messages.
  3. Position[2] message_id:
  4. Position[3] sequence_id: Sequential message, the current message number
  5. Position[4] channel: vhf channel A/B
  6. Position[5] payload: the ais data itself
  7. Position[6] size: number of bits required to fill the data

<format>,<message count>,<message id>,<sequence id>,<channel A/B>,<data>,<fill bits>

Important notes:

  • Ais payload is represented in a 6bits encoded string

API

  • constructor(AIS_Messages, safeMode)
    • AIS_Messages: Array of ais messages.
    • safeMode: set to false by default. when true the module will never throw an error (silent mode).
  • getResults() - return a collection of the parse messages
  • private decode(input: Array<any>, session: any): void - decode the raw ais messages
  • private validateRawMessage(input: string): boolean - validate if the raw messages

Command Line:

  • node dist/bin/parse <ais message> for example: node ./dist/bin/parse "!AIVDM,1,1,,A,13u?etPv2;0n:dDPwUM1U1Cb069D,0*24"

Running example:

  • npm run example

Example:

// new Decoder(Array<AIS_Messages>, safeMode<Boolean>)
import { Decoder } from '../lib/index';
const aisMessages:Array<string> = [
  '!AIVDM,1,1,,A,400TcdiuiT7VDR>3nIfr6>i00000,0*78',
  '!AIVDM,2,1,0,A,58wt8Ui`g??r21`7S=:22058<v05Htp000000015>8OA;0sk,0*7B',
  '!AIVDM,2,2,0,A,eQ8823mDm3kP00000000000,2*5D',
  '!AIVDM,2,1,0,A,58wt8Ui`g??r21`7S=:22058<v05Htp000000015>8OA;0sk,0*7B ',
  '!AIVDM,2,2,0,A,eQ8823mDm3kP00000000000,2*5D',
];
const safeMode = false;
const aisDecoder_ex2 = new Decoder(aisMessages, safeMode);

// results will hold a collection of the parsed ais messages
const results = aisDecoder_ex2.getResults();

References:

Bugs & PR's

  • If you find any bug please feel free to open an issue. PR are always welcome.