ohos_aisparser_5175:基于 OpenHarmony 的船舶自动识别系统数据解析库项目

 aisparser鸿蒙化适配,提供AIS数据解析能力。

Branch5Tags0
FilesLast commitLast update
10 months ago
9 months ago
10 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago

aisparser

Introduction

aisparser is a third-party library designed for the OpenHarmony system to parse Automatic Identification System (AIS) data. It provides comprehensive AIS message parsing capabilities, extracting information such as vessel position, speed, heading, and more through radio signal transmissions.

Installation Tutorial

ohpm install @ohos/aisparser

For OpenHarmony ohpm environment configuration and more information, please refer to How to Install OpenHarmony ohpm Packages.

Import Modules

import { AisParser } from '@ohos/aisparser';

Example:

  let result = Aisparser.convSign(0x200, 0x3FF);
  console.info('result = ' + result) 
  // Output result: result = -1

Example:

  let result = Aisparser.ais2Ascii(0x10);
  console.info('result = ' + str) 
  // Output result: str = p

Example:

  import { SixbitResult, TimeResult } from '@ohos/aisparser';

  let result = Aisparser.ais2Ascii(0x10);
  let sixbitResult = new SixbitResult()
  sixbitResult.bitsData = '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
  sixbitResult.pointer = 0;
  sixbitResult.remainder = 0;
  sixbitResult.remainderBits = 0;
  let datetime = new TimeResult()
  let result = Aisparser.getTimetag(sixbitResult, datetime);
  console.info('result = ' + result) 
  // Output result: result = 0
  console.info('datetime.hours = ' + datetime.hours) 
  // Output result: datetime.hours = 4
  console.info('datetime.day = ' + datetime.day) 
  // Output result: datetime.day = 0
  console.info('datetime.month = ' + datetime.month) 
  // Output result: datetime.month = 0
  console.info('datetime.minutes = ' + datetime.minutes) 
  // Output result: datetime.minutes = 8

Example:

import { SixbitResult, TimeResult } from '@ohos/aisparser';

  let aisState = new AisState();
  let aisMsg24 = new Aismsg24();
  let testStr = '!AIVDM,1,1,,A,H69NbPU@0000000000000050@450,0*7C';
  let ret = Aisparser.assembleVdm(aisState, testStr);
  console.info('ret = ' + ret) 
  // Output result: ret = 0
  let sixbitState = aisState.sixState;
  let messageId = Aisparser.get6Bit(sixbitState, 6);
  console.info('messageId = ' + messageId) 
  // Output result: result = 24

  aisState.sixState = sixbitState;
  console.info('aisState.msgid = ' + aisState.msgid) 
  // Output result: aisState.msgid = 0
  console.info('aisState.sequence = ' + aisState.sequence) 
  // Output result: aisState.sequence = 0
  console.info('aisState.num = ' + aisState.num) 
  // Output result: aisState.num = 0
  console.info('aisState.channel = ' + aisState.channel) 
  // Output result: aisState.channel = 65
  let sixState = aisState.sixState;
  console.info('sixState.bitsData = ' + sixState.bitsData) 
  // Output result: sixState.bitsData = 'H69NbPU@0000000000000050@450'
  console.info('sixState.pointer = ' + sixState.pointer) 
  // Output result: sixState.pointer = 2
  console.info('sixState.remainder = ' + sixState.remainder) 
  // Output result: sixState.remainder = 6
  console.info('sixState.remainderBits = ' + sixState.remainderBits) 
  // Output result: sixState.remainderBits = 6

  let parseResult = Aisparser.parseAis24(aisState, aisMsg24);
  console.info('parseResult' + parseResult) 
  // Output result: parseResult = 0
  console.info('aisMsg24.partNumber = ' + aisMsg24.partNumber) 
  // Output result: aisMsg24.partNumber = 1
  console.info('aisMsg24.name = ' + aisMsg24.name) 
  // Output result: aisMsg24.name = ''
  console.info('aisMsg24.shipType = ' + aisMsg24.shipType)
  // Output result: aisMsg24.shipType = 80
  console.info('aisMsg24.vendorId = ' + aisMsg24.vendorId) 
  // Output result: aisMsg24.vendorId = '@@@@@@@'
  console.info('aisMsg24.callsign = ' + aisMsg24.callsign) 
  // Output result: aisMsg24.callsign = '@@@@@@@'
  console.info('aisMsg24.dimBow = ' + aisMsg24.dimBow) 
  // Output result: aisMsg24.dimBow = 40
  console.info('aisMsg24.dimStern = ' + aisMsg24.dimStern) 
  // Output result: aisMsg24.dimStern = 16
  console.info('aisMsg24.dimPort = ' + aisMsg24.dimPort) 
  // Output result: aisMsg24.dimPort = 4
  console.info('aisMsg24.dimStarboard = ' + aisMsg24.dimStarboard) 
  // Output result: aisMsg24.dimStarboard = 5
  console.info('aisMsg24.spare = ' + aisMsg24.spare) 
  // Output result: aisMsg24.spare = 0
  console.info('aisMsg24.flags = ' + aisMsg24.flags) 
  // Output result: aisMsg24.flags = 2
  console.info('aisMsg24.repeat = ' + aisMsg24.repeat) 
  // Output result: aisMsg24.repeat = 0
  console.info('aisMsg24.userid = ' + aisMsg24.userid) 
  // Output result: aisMsg24.userid = 412592770

Interface Description

PositionDdd

Location information.

Parameters

Name Type ReadOnly Description
latitude number Yes Latitude in 1/10000 minute.
longitude number Yes Longitude in 1/10000 minute.

PositionDmm

Location information.

Parameters

Name Type ReadOnly Description
latDegrees number Yes The degree part of latitude.
latMinutes number Yes The division of latitude (with decimals).
lonDegrees number Yes The degree part of longitude.
lonMinutes number Yes The division of longitude (with decimals).

ConvertedPosition

Convert location information.

Parameters

Name Type ReadOnly Description
latitude number Yes Latitude in 1/10000 minute.
longitude number Yes Longitude in 1/10000 minute.

TimeResult

Estimated time of arrival, route, and IMO UTC time stamp.

Parameters

Name Type Mandatory Description
month number Yes month.
day number Yes day.
hours number Yes UTC hours.
minutes number Yes UTC minutes.

constructor

constructor()

A constructor used to create a TimeResult object.

SixbitResult

Used for processing 6-bit ASCII data in AIS messages.

Parameters

Name Type Mandatory Description
bitsData string Yes original 6-bit ASCII data string.
pointer number Yes pointer to the current character in bits.
remainder number Yes remaining bits.
remainderBits number Yes number of remaining bits.

constructor

constructor()

A constructor used to create a SixbitResult object.

AisState

AisState: Message parser status.

Parameters

Name Type Mandatory Description
msgid number Yes Message ID 0-31.
sequence number Yes VDM message sequence number.
total number Yes Total # of parts for the message.
num number Yes Number of the last part stored.
channel number Yes AIS Channel character.
sixState SixbitResult Yes sixbit parser state.

constructor

constructor()

A constructor used to create a AisState object.

Sotdma

Used for representing communication status information.

Parameters

Name Type Mandatory Description
syncState number Yes Synchronization state.
slotTimeout number Yes Slot timeout.
subMessage number Yes Sub-message.

constructor

constructor()

A constructor used to create a Sotdma object.

Itdma

Used for representing communication status information.

Parameters

Name Type Mandatory Description
syncState number Yes Synchronization state.
slotInc number Yes Slot increment.
numSlots number Yes Number of slots.
keepFlag number Yes Keep flag.

constructor

constructor()

A constructor used to create a Itdma object.

Aismsg1

SOTDMA position report.

Parameters

Name Type Mandatory Description
msgid number Yes Message ID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
navStatus number Yes Navigational Status.
rot number Yes Rate of Turn.
sog number Yes Speed Over Ground.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
cog number Yes Course over Ground.
aismsgTemp number Yes True heading.
utcSec number Yes UTC Seconds.
regional number Yes Regional bits.
spare number Yes Spare.
raim number Yes RAIM RAIM flag.
syncState number Yes SOTDMA sync state.
slotTimeout number Yes SOTDMA Slot Timeout.
subMessage number Yes SOTDMA sub-message.

constructor

constructor()

A constructor used to create a Aismsg1 object.

Aismsg2

SOTDMA position report.

Parameters

Name Type Mandatory Description
msgid number Yes Message ID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
navStatus number Yes Navigational Status.
rot number Yes Rate of Turn.
sog number Yes Speed Over ground.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
cog number Yes Course over Ground.
aismsgTemp number Yes True Heading.
utcSec number Yes UTC Seconds.
regional number Yes Regional bits.
spare number Yes Spare.
raim number Yes RAIM RAIM flag.
syncState number Yes SOTDMA sync state.
slotTimeout number Yes SOTDMA Slot Timeout.
subMessage number Yes SOTDMA sub-message.

constructor

constructor()

A constructor used to create a Aismsg2 object.

Aismsg3

Position Report with ITDMA.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
navStatus number Yes Navigational Status.
rot number Yes Rate of Turn.
sog number Yes Speed Over Ground.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
cog number Yes Course over Ground.
aismsgTemp number Yes True Heading.
utcSec number Yes UTC Seconds.
regional number Yes Regional bits.
spare number Yes Spare.
raim number Yes RAIM Flag.
syncState number Yes ITDMA sync state.
slotIncrement number Yes ITDMA Slot Increment.
numSlots number Yes ITDMA Number of Slots.
keep number Yes ITDMA Keep Flag.

constructor

constructor()

A constructor used to create a Aismsg3 object.

Aismsg4

Base Station Report.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
utcYear number Yes UTC Year.
utcMonth number Yes UTC Month.
utcDay number Yes UTC Day.
utcHour number Yes UTC Hour.
utcMinute number Yes UTC Minute.
utcSecond number Yes UTC Second.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
cog number Yes Course over Ground.
aismsgTemp number Yes True Heading.
utcSec number Yes UTC Seconds.
regional number Yes Regional bits.
spare number Yes Spare.
raim number Yes RAIM Flag.
syncState number Yes SOTDMA sync state.
slotTimeout number Yes SOTDMA Slot Timeout.
subMessage number Yes SOTDMA sub-message.

constructor

constructor()

A constructor used to create a Aismsg4 object.

Aismsg5

Ship static data and navigation-related data.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
version number Yes AIS Version.
imo bigint Yes IMO Number.
callsign string Yes Callsign.
name string Yes Ship Name.
shipType number Yes Type of Ship and Cargo.
dimBow number Yes GPS Ant. Distance from Bow.
dimStern number Yes GPS Ant. Distance from stern.
dimPort number Yes GPS Ant. Distance from port.
dimStarboard number Yes GPS Ant. Distance from starboard.
posType number Yes Type of position fixing device.
eta bigint Yes Estimated Time of Arrival MMDDHHMM.
draught number Yes Maximum present static draught.
dest string Yes Ship Destination.
dte number Yes DTE flag.
spare number Yes Spare.

constructor

constructor()

A constructor used to create a Aismsg5 object.

Aismsg6

Processed binary message.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
sequence number Yes Sequence number.
destination bigint Yes Destination MMSI.
retransmit string Yes Retransmit.
spare string Yes Spare.
appid number Yes Application ID.
data number Yes Data payload.

constructor

constructor()

A constructor used to create a Aismsg6 object.

Aismsg7

Ship static data and navigation-related data.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spare number Yes Spare.
destidOne bigint Yes Destination MMSI 1.
sequenceOne number Yes Sequence number 1.
destidTwo bigint Yes Destination MMSI 2.
sequenceTwo number Yes Sequence number 2.
destidThree bigint Yes Destination MMSI 3.
sequenceThree number Yes Sequence number 3.
destidFour bigint Yes Destination MMSI 4.
sequenceFour number Yes Sequence number 4.
numAcks number Yes Number of acks.

constructor

constructor()

A constructor used to create a Aismsg7 object.

Aismsg8

Binary broadcast messages used for transmitting custom application data.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spare number Yes Spare.
appid bigint Yes Application ID.
data SixbitResult Yes Data payload.

constructor

constructor()

A constructor used to create a Aismsg8 object.

Aismsg9

Standard search and rescue aircraft position report.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
altitude number Yes Altitude.
sog number Yes Speed Over Ground.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
cog number Yes Course Over Ground.
utcSec number Yes UTC Seconds.
regional number Yes Regional bits.
dte number Yes DTE flag.
spare number Yes Spare.
assigned number Yes Assigned mode flag.
raim number Yes RAIM flag.
commState number Yes Comm State Flag.
sotdma Sotdma Yes SOTDMA Comm State.
itdma Itdma Yes ITDMA Comm State.

constructor

constructor()

A constructor used to create a Aismsg9 object.

Aismsg10

UTC and date inquiry message, used to request specific ships to send UTC and date information.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spareOne number Yes Spare.
destination bigint Yes Destination MMSI.
spareTwo number Yes Spare.

constructor

constructor()

A constructor used to create a Aismsg10 object.

Aismsg11

The UTC and date response message provides precise UTC time and location information.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
utcYear number Yes UTC Year.
utcMonth number Yes UTC Month.
utcDay number Yes UTC Day.
utcHour number Yes UTC Hour.
utcMinute number Yes UTC Minute.
utcSecond number Yes UTC Second.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
posType number Yes Type of position fixing device.
spare number Yes Spare.
raim number Yes RAIM flag.
syncState number Yes SOTDMA Sync State.
slotTimeout number Yes SOTDMA Slot Timeout.
subMessage number Yes SOTDMA Sub-Message.

constructor

constructor()

A constructor used to create a Aismsg11 object.

Aismsg12

Addressing security-related messages for exchanging security-related information between two specific ships.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
sequence number Yes Sequence.
destination bigint Yes Destination MMSI.
retransmit number Yes Retransmit.
spare bigint Yes Spare.
message string Yes Message in ASCII.

constructor

constructor()

A constructor used to create a Aismsg12 object.

Aismsg13

Safety-related confirmation message.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spare number Yes Spare.
destidOne bigint Yes Destination MMSI 1.
sequenceOne number Yes Sequence Number 1.
destidTwo bigint Yes Destination MMSI 2.
sequenceTwo number Yes Sequence Number 2.
destidThree bigint Yes Destination MMSI 3.
sequenceThree number Yes Sequence Number 3.
destidFour bigint Yes Destination MMSI 4.
sequenceFour number Yes Sequence Number 4.
numAcks number Yes Number of acks.

constructor

constructor()

A constructor used to create a Aismsg13 object.

Aismsg14

AIS Message 14 - Safety related Broadcast Message.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spare number Yes Spare.
message string Yes Message in ASCII.

constructor

constructor()

A constructor used to create a Aismsg14 object.

Aismsg15

Inquire about request messages. This message is used for ships to send inquiry requests to other ships, requesting them to send specific AIS messages.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spareOne number Yes Spare.
destidOne bigint Yes Destination MMSI 1.
msgidOneOne number Yes MessageID 1.1.
offsetOneOne bigint Yes Slot Offset 1.1.
spareTwo number Yes Spare.
msgidOneTwo number Yes MessageID 1.2.
offsetOneTwo number Yes Slot Offset 1.2.
spareThree number Yes Spare.
destidTwo bigint Yes Destination MMSI 2.
msgidTwoOne number Yes MessageID 2.1.
offsetTwoOne number Yes Slot Offset 2.1.
spareFour number Yes Spare.
numReqs number Yes Number of interrogation requests.

constructor

constructor()

A constructor used to create a Aismsg15 object.

Aismsg16

The designated mode command allocated by the base station to the mobile station is used to allocate time slots and increments.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spareOne number Yes Spare.
destidA bigint Yes Destination MMSI A.
offsetA number Yes Slot Offset A.
incrementA number Yes Increment A.
destidB bigint Yes Destination MMSI B.
offsetB number Yes Slot Offset B.
incrementB number Yes Increment B.
spareTwo number Yes Spare.
numCmds number Yes Number of commands received.

constructor

constructor()

A constructor used to create a Aismsg16 object.

Aismsg17

GNSS binary broadcast messages, used for transmitting differential GNSS correction data.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spareOne number Yes Spare.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
spareTwo number Yes Spare.
msgType number Yes Mesage Type from M.823.
stationId number Yes Station ID from M.823.
zCount number Yes Z Count.
seqNum number Yes Sequence Number.
numWords number Yes Number of Data Words.
health Sotdma Yes Reference Station Health from M.823.
data SixbitResult Yes Data payload.

constructor

constructor()

A constructor used to create a Aismsg17 object.

Aismsg18

AIS Message 18 - Standard Class B CS Position Report From IEC 62287. This differs slightly from the original message, some of the regional bits were changed to flags.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
regionalOne number Yes Regional Bits.
sog number Yes Speed Over Ground.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
cog number Yes Course Over Ground.
aismsgTemp number Yes True Heading.
utcSec number Yes UTC Seconds.
regionalTwo number Yes Regional Bits.
unitFlag number Yes Class B CS Flag.
displayFlag number Yes Integrated msg14 Display Flag.
dscFlag number Yes DSC Capability Flag.
bandFlag number Yes Marine Band Operation Flag.
msgTwoTwoFlag number Yes Msg22 Frequency Management Flag.
modeFlag number Yes Autonomous Mode Flag.
raim number Yes RAIM Flag.
commState number Yes Comm State Flag.
sotdma Sotdma Yes SOTDMA Comm State.
itdma Itdma Yes ITDMA Comm State.

constructor

constructor()

A constructor used to create a Aismsg18 object.

Aismsg19

The extended equipment location report for Class B ships contains more ship information.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
regionalOne number Yes Regional Bits.
sog number Yes Speed Over Ground.
posAcc number Yes Position Accuracy.
longitude number Yes Longitude in 1/10000 minute.
latitude number Yes Latitude in 1/10000 minute.
cog number Yes Course Over Ground.
aismsgTemp number Yes True Heading.
utcSec number Yes UTC Seconds.
regionalTwo number Yes Regional Bits.
name string Yes Ship Name in ASCII.
shipType number Yes Type of Ship and Cargo.
dimBow number Yes GPS Ant. Distance from Bow.
dimStern number Yes GPS Ant. Distance from Stern.
dimPort number Yes GPS Ant. Distance from Port.
dimStarboard number Yes GPS Ant. Distance from Starboard.
posType number Yes Type of Position Fixing Device.
raim number Yes RAIM Flag.
dte number Yes DTE Flag.
spare number Yes Spare.

constructor

constructor()

A constructor used to create a Aismsg19 object.

Aismsg20

Data link management messages are used to manage the allocation of data link time slots.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spareOne number Yes Spare.
offsetOne number Yes Slot Offset 1.
slotsOne number Yes Number of Slots 1.
timeoutOne number Yes Timeout 1.
incrementOne number Yes Slot Increment 1.
offsetTwo number Yes Slot Offset 2.
slotsTwo number Yes Number of Slots 2.
timeoutTwo number Yes Timeout in Minutes 2.
incrementTwo number Yes Slot Increment 2.
offsetThree number Yes Slot Offset 3.
slotsThree number Yes Number of Slots 3.
timeoutThree number Yes Timeout in Minutes 3.
incrementThree number Yes Slot Increment 3.
offsetFour number Yes Slot Offset 4.
slotsFour number Yes Number of Slots 4.
timeoutFour number Yes Timeout in Minutes 4.
incrementFour number Yes Slot Increment 4.
spareTwo number Yes Spare.
numCmds number Yes Number of Commands Received.

constructor

constructor()

A constructor used to create a Aismsg20 object.

Aismsg21

Navigational aid report, containing detailed information about navigational aids.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
atonType number Yes Type of AtoN.
name string Yes Name of AtoN in ASCII.
posAcc number Yes Position Accuracy.
longitude bigint Yes Longitude in 1/10000 minutes.
latitude bigint Yes Latitude in 1/10000 minutes.
dimBow number Yes GPS Ant. Distance from Bow.
dimStern number Yes GPS Ant. Distance from Stern.
dimPort number Yes GPS Ant. Distance from Port.
dimStarboard number Yes GPS Ant. Distance from Starboard.
posType number Yes Type of Position Fixing Device.
utcSec number Yes UTC Seconds.
offPosition number Yes Off Position Flag.
regional number Yes Regional Bits.
raim number Yes RAIM Flag.
aismsgTemp number Yes Virtual/Pseudo AtoN Flag.
assigned number Yes Assigned Mode Flag.
spareOne number Yes Spare.
nameExt string Yes Extended Name in ASCII.
spareTwo number Yes Spare.

constructor

constructor()

A constructor used to create a Aismsg21 object.

Aismsg22

Channel management message, used for managing AIS channel allocation. If the message is targeted at a geographical area, its two corners are defined by the NE and SW locations; If it is an allocation message, the target MMSI will be stored in addressedOne and addressedTwo.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spareOne number Yes Spare.
channelA number Yes M.1084 Channel A Frequency.
channelB number Yes M.1084 Channel B Frequency.
txrxMode number Yes TX/RX Mode.
power number Yes Power Level.
neLongitude number Yes Longitude in 1/1000 minutes.
neLatitude number Yes Latitude in 1/1000 minutes.
addressedOne bigint Yes Destination MMSI 1.
swLongitude number Yes Longitude in 1/1000 minutes.
swLatitude number Yes Latitude in 1/1000 minutes.
addressedTwo bigint Yes Destination MMSI 2.
addressed number Yes Addressed Flag.
bwA number Yes Channel A Bandwidth.
bwB number Yes Channel B Bandwidth.
tzSize number Yes Transition Zone Size.
spareTwo bigint Yes Spare.

constructor

constructor()

A constructor used to create a Aismsg22 object.

Aismsg23

Allocation command, used to allocate a geographical area. The geographical area is defined by two corner points, which are stored in the NE and SW positions respectively.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
spareOne number Yes Spare.
neLongitude number Yes Longitude in 1/1000 minutes.
neLatitude number Yes Latitude in 1/1000 minutes.
swLongitude number Yes Longitude in 1/1000 minutes.
swLatitude number Yes Latitude in 1/1000 minutes.
stationType number Yes Station Type.
shipType number Yes Type of Ship and Cargo.
spareTwo bigint Yes Spare.
txrxMode number Yes TX/RX Mode.
reportInterval number Yes Reporting Interval from IEC 62287 Table 17.
quietTime number Yes Quiet Time in Minutes.
spareThree number Yes Spare.

constructor

constructor()

A constructor used to create a Aismsg23 object.

Aismsg24

The static data report for Category B ships is divided into two parts: 24A and 24B. Section 24A includes the name of the ship; Section 24B includes information such as the ship's dimensions and call sign.

Parameters

Name Type Mandatory Description
msgid number Yes MessageID.
repeat number Yes Repeated.
userid bigint Yes UserID / MMSI.
partNumber number Yes Part Number.
name string Yes Ship Name in ASCII.
shipType number Yes Type of Ship and Cargo.
vendorId string Yes Vendor ID in ASCII.
callsign string Yes Callsign in ASCII.
dimBow number Yes GPS Ant. Distance from Bow.
dimStern number Yes GPS Ant. Distance from Stern.
dimPort number Yes GPS Ant. Distance from Port.
dimStarboard number Yes GPS Ant. Distance from Starboard.
spare number Yes Spare.
flags number Yes A/B section receiving flag.

constructor

constructor()

A constructor used to create a Aismsg24 object.

AisParser.getTimetag

getTimetag: (state: object, datetime: object): number;

Obtain the timestamp.

Parameter:

Parameter Name Type Mandatory Description
state object Yes SixbitResult message parser object.
datetime object Yes TimeResult object.

Return value

Type Description
number Analyze and obtain the status of the timestamp.
0 if there was no error.
1 if there was an error.
2 if there are < 20 bits to parse.

AisParser.convSign

convSign: (signBit: number, value: number): number;

Convert flag information.

Parameter:

Parameter Name Type Mandatory Description
signBit number Yes sign bit.
value number Yes pointer to value.

Return value

Type Description
number Analyze the status of conversion flag information.

AisParser.ais2Ascii

ais2Ascii: (value: number): string;

Convert location information.

Parameter:

Parameter Name Type Mandatory Description
value number Yes The 6-digit value that needs to be converted.

Return value

Type Description
string corresponding ASCII value.

AisParser.pos2Ddd

pos2Ddd: (latitude: number, longitude: number): PositionDdd

Convert the position of 1/10000 minute to signed decimal (DD.DDDDDD) coordinate format.

Parameter:

Parameter Name Type Mandatory Description
latitude number Yes signed latitude in 1/10000 minute format.
longitude number Yes signed longitude in 1/10000 minute format.

Return value

Type Description
PositionDdd returns an object with latitude and longitude in signed decimal (DD.DDDDDD) format.

AisParser.get6Bit

export const get6Bit: (state: object, numbits: number): bigint

Extracts a specified number of bits from a 6-bit ASCII encoded data stream.

Parameter:

Parameter Name Type Mandatory Description
state object Yes pointer to a SixbitResult object.
numbits number Yes number of bits to extract, ranging from 0 to 32 bits.

Return value:

Type Description
bigint returns an object with containing extracted bit data from a 6-bit ASCII encoded stream.

AisParser.pos2Dmm

pos2Dmm: (latitude: number, longitude: number): PositionDmm;

Convert 1/10000 minute position to signed DD MM.MMMM format.

Parameter:

Parameter Name Type Mandatory Description
latitude number Yes signed latitude in 1/10000 minute format.
longitude number Yes signed longitude in 1/10000 minute format.

Return value

Type Description
PositionDmm returns an object with latitude and longitude in signed DD MM.MMMM format.

AisParser.convPos

convPos: (latitude: number, longitude: number): ConvertedPosition;

Convert unsigned 1/10000 minute position to signed.

Parameter:

Parameter Name Type Mandatory Description
latitude number Yes pointer to an unsigned latitude.
longitude number Yes pointer to an unsigned longitude.

Return value

Type Description
ConvertedPosition returns an object with latitude and longitude in signed DD MM.MMMM format.

AisParser.assembleVdm

assembleVdm: (state: object, str: string): number;

Reassemble and extract the 6-digit data from the AIVDM/AIVDO statements.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
str string Yes NMEA string.

Return value

Type Description
number Analyze the status of the NMEA string.
0 Complete packet.
1 Incomplete packet.
2 NMEA 0183 checksum failed.
3 Not an AIS message.
4 Error with nmea_next_field.
5 Out of sequence packet.

AisParser.parseAis1

parseAis1: (state: object, result: object): number;

Parse the AIS message into the Aismsg1 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg1 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis2

parseAis2: (state: object, result: object): number;

Parse the AIS message into the Aismsg2 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg2 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis3

parseAis3: (state: object, result: object): number;

Parse the AIS message into the Aismsg3 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg3 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis4

parseAis4: (state: object, result: object): number;

Parse the AIS message into the Aismsg4 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg4 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis5

parseAis5: (state: object, result: object): number;

Parse the AIS message into the Aismsg5 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg5 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis6

parseAis6: (state: object, result: object): number;

Parse the AIS message into the Aismsg6 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg6 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis7

parseAis7: (state: object, result: object): number;

Parse the AIS message into the Aismsg7 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg7 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis8

parseAis8: (state: object, result: object): number;

Parse the AIS message into the Aismsg8 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg8 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis9

parseAis9: (state: object, result: object): number;

Parse the AIS message into the Aismsg9 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg9 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis10

parseAis10: (state: object, result: object): number;

Parse the AIS message into the Aismsg10 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg10 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis11

parseAis11: (state: object, result: object): number;

Parse the AIS message into the Aismsg11 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg11 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis12

parseAis12: (state: object, result: object): number;

Parse the AIS message into the Aismsg12 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg12 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis13

parseAis13: (state: object, result: object): number;

Parse the AIS message into the Aismsg13 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg13 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis14

parseAis14: (state: object, result: object): number;

Parse the AIS message into the Aismsg14 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg14 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis15

parseAis15: (state: object, result: object): number;

Parse the AIS message into the Aismsg15 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg15 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis16

parseAis16: (state: object, result: object): number;

Parse the AIS message into the Aismsg16 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg16 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis17

parseAis17: (state: object, result: object): number;

Parse the AIS message into the Aismsg17 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg17 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis18

parseAis18: (state: object, result: object): number;

Parse the AIS message into the Aismsg18 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg18 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis19

parseAis19: (state: object, result: object): number;

Parse the AIS message into the Aismsg19 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg19 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis20

parseAis20: (state: object, result: object): number;

Parse the AIS message into the Aismsg20 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg20 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis21

parseAis21: (state: object, result: object): number;

Parse the AIS message into the Aismsg21 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg21 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis22

parseAis22: (state: object, result: object): number;

Parse the AIS message into the Aismsg22 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg22 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis23

parseAis23: (state: object, result: object): number;

Parse the AIS message into the Aismsg23 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg23 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

AisParser.parseAis24

parseAis24: (state: object, result: object): number;

Parse the AIS message into the Aismsg24 structure.

Parameter:

Parameter Name Type Mandatory Description
state object Yes AisState message parser object.
result object Yes Aismsg24 object.

Return value

Type Description
number The status during parsing AIS messages.
0 if no errors.
1 if there is an error.
2 if there is a packet length error.

Constraints and limitations

The following version has passed verification:

  • DevEco Studio: NEXT Release(6.0.1.251), SDK: API12 (5.0.0.71)
  • DevEco Studio: NEXT Developer Beta(6.0.1), SDK: API21 (5.0.0.25)
|---- ohos_aisparser
|     |---- entry  # Example code folder
|     |---- aisparser  # Library folder
|         |---- src
|             |---- main
|                  |---- cpp
|                        |---- types\liblibrary
|                              |---- index.d.ts   # External interface
|         |---- index.ets
|     |---- README.md  # Installation and usage methods
|     |---- README_zh.md  # Installation and usage methods                    

Contribute code

If you find any problems while using the project, please submit Issue to us. Of course, we also welcome you to submit PR .

Open source license

This project follows the aisparser Runtimes License.

Introduction

aisparser鸿蒙化适配,提供AIS数据解析能力。

Customize your domain