-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.js
458 lines (416 loc) · 14.2 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/* eslint-disable no-bitwise */
/*
MIT License
Copyright (c) 2020 Karl-Erik Gustafsson
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
const fetchNew = (...args) => import('node-fetch').then(({ default: fetch }) => fetch(...args));
const https = require('https');
const AisEncode = require('ggencoder').AisEncode;
const moment = require('moment');
const haversine = require('haversine-distance');
module.exports = function createPlugin(app) {
const plugin = {};
plugin.id = 'signalk-vessels-to-ais';
plugin.name = 'Other vessels data to AIS NMEA0183';
plugin.description = 'SignalK server plugin to convert other vessel data to NMEA0183 AIS format and forward it out to 3rd party applications';
let positionUpdate = null;
let distance;
let sendOwn;
let url;
let intervalRun;
const setStatus = app.setPluginStatus || app.setProviderStatus;
let useTag;
let eventName
const httpsAgent = new https.Agent({
rejectUnauthorized: false,
});
let getParam;
plugin.start = function (options) {
useTag = options.useTag;
eventName = options.eventName;
positionUpdate = options.position_update * 60;
distance = options.distance;
sendOwn = options.sendOwn;
const port = options.port || 3000;
const portSec = options.portSec || 3443;
url = `https://localhost:${portSec}/signalk/v1/api/vessels`;
getParam = { method: 'GET', agent: httpsAgent };
fetchNew(url, getParam)
.then((res) => {
console.log(`${plugin.id}: SSL enabled, using https`);
if (!res.ok) {
console.error(`${plugin.id}: SSL enabled, but error accessing server. Check 'Allow Readonly Access' and enable it.`);
setStatus("Error accessing server. Check 'Allow Readonly Access' and enable it");
}
})
.catch(() => {
url = `http://localhost:${port}/signalk/v1/api/vessels`;
getParam = { method: 'GET' };
fetchNew(url, getParam)
.then((res) => {
console.log(`${plugin.id}: SSL disabled, using http`);
if (!res.ok) {
console.error(`${plugin.id}: SSL disabled, but error accessing server. Check 'Allow Readonly Access' and enable it.`);
setStatus("Error accessing server. Check 'Allow Readonly Access' and enable it");
}
});
})
.finally(() => {
// eslint-disable-next-line no-use-before-define
intervalRun = setInterval(readData, (positionUpdate * 1000), getParam);
});
app.debug('Plugin started');
};
//----------------------------------------------------------------------------
// State Mapping
const stateMapping = {
motoring: 0,
'UnderWayUsingEngine': 0,
'under way using engine': 0,
'underway using engine': 0,
anchored: 1,
'AtAnchor': 1,
'at anchor': 1,
'not under command': 2,
'restricted manouverability': 3,
'constrained by draft': 4,
'constrained by her draught': 4,
moored: 5,
'Moored': 5,
aground: 6,
fishing: 7,
'engaged in fishing': 7,
sailing: 8,
'UnderWaySailing': 8,
'under way sailing': 8,
'underway sailing': 8,
'hazardous material high speed': 9,
'hazardous material wing in ground': 10,
'reserved for future use': 13,
'ais-sart': 14,
default: 15,
'UnDefined': 15,
'undefined': 15,
};
//----------------------------------------------------------------------------
// Rad to Deg
function radToDegrees(radians) {
const pi = Math.PI;
return ((radians * 180) / pi);
}
//----------------------------------------------------------------------------
// m/s to knots
function msToKnots(speed) {
return ((speed * 3.6) / 1.852);
}
//----------------------------------------------------------------------------
// nmea out
function aisOut(encMsg, aisTime) {
const enc = new AisEncode(encMsg);
const sentence = enc.nmea;
let taggString = '';
if (useTag) {
// eslint-disable-next-line no-use-before-define
taggString = createTagBlock(aisTime);
}
if (sentence && sentence.length > 0) {
app.debug(taggString + sentence);
app.emit(eventName, taggString + sentence);
}
}
const mHex = [
'0',
'1',
'2',
'3',
'4',
'5',
'6',
'7',
'8',
'9',
'A',
'B',
'C',
'D',
'E',
'F',
];
function toHexString(v) {
const msn = (v >> 4) & 0x0f;
const lsn = (v >> 0) & 0x0f;
return mHex[msn] + mHex[lsn];
}
function createTagBlock(aisTime) {
let tagBlock = '';
tagBlock += 's:SK0001,';
// tagBlock += 'c:' + aisTime + ','
tagBlock += `c:${Date.now(aisTime)},`;
tagBlock = tagBlock.slice(0, -1);
let tagBlockChecksum = 0;
for (let i = 0; i < tagBlock.length; i++) {
tagBlockChecksum ^= tagBlock.charCodeAt(i);
}
return `\\${tagBlock}*${toHexString(tagBlockChecksum)}\\`;
}
//----------------------------------------------------------------------------
// Read and parse AIS data
// eslint-disable-next-line no-shadow
function readData(getParam) {
let i, mmsi, aisTime, aisDelay, shipName, lat, lon, sog, cog, rot;
let navStat, hdg, dst, callSign, imo, id, type;
let draftCur, length, beam, ais, encMsg3, encMsg5, encMsg18, encMsg240, encMsg241, own;
const ownLat = app.getSelfPath('navigation.position.value.latitude');
const ownLon = app.getSelfPath('navigation.position.value.longitude');
if (typeof ownLat !== "undefined" && typeof ownLon !== "undefined") {
fetchNew(url, getParam)
.then((res) => res.json())
.then((json) => {
const jsonContent = JSON.parse(JSON.stringify(json));
const numberAIS = Object.keys(jsonContent).length;
for (i = 0; i < numberAIS; i++) {
const jsonKey = Object.keys(jsonContent)[i];
try {
aisTime = jsonContent[jsonKey].sensors.ais.class.timestamp;
} catch (error) {
if (i === 0) {
aisTime = jsonContent[jsonKey].navigation.position.timestamp;
} else {
aisTime = null;
}
}
aisDelay = (parseFloat((moment(new Date(Date.now()))
.diff(aisTime) / 1000).toFixed(3))) < positionUpdate;
try {
mmsi = jsonContent[jsonKey].mmsi;
} catch (error) { mmsi = null; }
try {
shipName = jsonContent[jsonKey].name;
} catch (error) { shipName = ''; }
try {
lat = jsonContent[jsonKey].navigation.position.value.latitude;
} catch (error) { lat = null; }
try {
lon = jsonContent[jsonKey].navigation.position.value.longitude;
} catch (error) { lon = null; }
try {
sog = msToKnots(jsonContent[jsonKey].navigation.speedOverGround.value);
} catch (error) { sog = null; }
try {
cog = radToDegrees(jsonContent[jsonKey].navigation.courseOverGroundTrue.value);
} catch (error) { cog = null; }
try {
rot = radToDegrees(jsonContent[jsonKey].navigation.rateOfTurn.value);
} catch (error) { rot = null; }
try {
navStat = stateMapping[jsonContent[jsonKey].navigation.state.value];
} catch (error) { navStat = ''; }
try {
hdg = radToDegrees(jsonContent[jsonKey].navigation.headingTrue.value);
} catch (error) { hdg = null; }
try {
dst = jsonContent[jsonKey].navigation.destination.commonName.value;
} catch (error) { dst = ''; }
try {
if (i === 0) {
callSign = jsonContent[jsonKey].communication.callsignVhf;
} else {
callSign = jsonContent[jsonKey].communication.value.callsignVhf;
}
} catch (error) { callSign = ''; }
try {
imo = (jsonContent[jsonKey].registrations.value.imo).substring(4, 20);
} catch (error) { imo = null; }
try {
id = jsonContent[jsonKey].design.aisShipType.value.id;
} catch (error) { id = null; }
try {
type = jsonContent[jsonKey].design.aisShipType.value.name;
} catch (error) { type = ''; }
try {
draftCur = (jsonContent[jsonKey].design.draft.value.current) / 10;
} catch (error) { draftCur = null; }
try {
length = jsonContent[jsonKey].design.length.value.overall;
} catch (error) { length = null; }
try {
beam = (jsonContent[jsonKey].design.beam.value) / 2;
} catch (error) { beam = null; }
try {
ais = jsonContent[jsonKey].sensors.ais.class.value;
} catch (error) { ais = null; }
if (shipName % 1 === 0) {
shipName = '';
}
if (dst % 1 === 0) {
dst = '';
}
if (callSign % 1 === 0) {
callSign = '';
}
if (type % 1 === 0) {
type = '';
}
if (i === 0) {
own = true;
if (sendOwn) {
ais = 'A';
} else {
ais = '';
}
} else {
own = false;
}
const a = { lat: ownLat, lon: ownLon };
const b = { lat, lon };
const dist = (haversine(a, b) / 1000).toFixed(2);
if (dist <= distance) {
encMsg3 = {
own,
aistype: 3, // class A position report
repeat: 0,
mmsi,
navstatus: navStat,
sog,
lon,
lat,
cog,
hdg,
rot,
};
encMsg5 = {
own,
aistype: 5, // class A static
repeat: 0,
mmsi,
imo,
cargo: id,
callsign: callSign,
shipname: shipName,
draught: draftCur,
destination: dst,
dimA: 0,
dimB: length,
dimC: beam,
dimD: beam,
};
encMsg18 = {
own,
aistype: 18, // class B position report
repeat: 0,
mmsi,
sog,
accuracy: 0,
lon,
lat,
cog,
hdg,
};
encMsg240 = {
own,
aistype: 24, // class B static
repeat: 0,
part: 0,
mmsi,
shipname: shipName,
};
encMsg241 = {
own,
aistype: 24, // class B static
repeat: 0,
part: 1,
mmsi,
cargo: id,
callsign: callSign,
dimA: 0,
dimB: length,
dimC: beam,
dimD: beam,
};
if (aisDelay && (ais === 'A' || ais === 'B')) {
// eslint-disable-next-line no-useless-concat
app.debug(`Distance range: ${distance}km, AIS target distance: ${dist}km` + `, Class ${ais} Vessel` + `, MMSI:${mmsi}`);
if (ais === 'A') {
app.debug(`class A, ${i}, time: ${aisTime}`);
aisOut(encMsg3, aisTime);
aisOut(encMsg5, aisTime);
}
if (ais === 'B') {
app.debug(`class B, ${i}, time: ${aisTime}`);
aisOut(encMsg18, aisTime);
aisOut(encMsg240, aisTime);
aisOut(encMsg241, aisTime);
}
app.debug('--------------------------------------------------------');
}
}
}
const dateobj = new Date(Date.now());
const date = dateobj.toISOString();
setStatus(`AIS NMEA message sent: ${date}`);
})
.catch((err) => console.error(err));
}
}
//----------------------------------------------------------------------------
plugin.stop = function stop() {
clearInterval(intervalRun);
app.debug('Stopped');
};
plugin.schema = {
type: 'object',
properties: {
position_update: {
type: 'number',
default: 1,
title: 'How often AIS data is sent to NMEA0183 out (in minutes). E.g. 0.5 = 30s, 1 = 1min',
},
port: {
type: 'number',
title: 'HTTP port',
default: 3000,
},
portSec: {
type: 'number',
title: 'HTTPS port',
default: 3443,
},
sendOwn: {
type: 'boolean',
title: 'Send own AIS data, VDO',
default: true,
},
useTag: {
type: 'boolean',
title: 'Add Tag-block',
default: false,
},
distance: {
type: 'integer',
default: 100,
title: 'AIS target within range [km]',
},
eventName: {
type: 'string',
default: 'nmea0183out',
title: 'Output event name',
},
},
};
return plugin;
};