signalk-to-noforeignland 0.1.24 → 0.1.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +55 -29
  2. package/README.md +26 -23
  3. package/index.js +638 -492
  4. package/package.json +28 -28
package/index.js CHANGED
@@ -1,492 +1,638 @@
1
- const { EOL } = require('os');
2
- const internetTestAddress = 'google.com';
3
- const internetTestTimeout = 1000;
4
- const fs = require('fs-extra');
5
- const path = require('path');
6
- const CronJob = require('cron').CronJob;
7
- const readline = require('readline');
8
- const fetch = require('node-fetch');
9
- const isReachable = require('is-reachable');
10
-
11
- const apiUrl = 'https://www.noforeignland.com/home/api/v1/boat/tracking/track';
12
- const pluginApiKey = '0ede6cb6-5213-45f5-8ab4-b4836b236f97';
13
- const defaultTracksDir = 'track';
14
- const routeSaveName = 'nfl-track.jsonl';
15
-
16
- class SignalkToNoforeignland {
17
- constructor(app) {
18
- this.app = app;
19
- this.pluginId = 'signalk-to-noforeignland';
20
- this.pluginName = 'SignalK to Noforeland';
21
- this.creator = 'signalk-track-logger';
22
-
23
- // runtime state
24
- this.unsubscribes = [];
25
- this.unsubscribesControl = [];
26
- this.lastPosition = null;
27
- this.upSince = null;
28
- this.cron = null;
29
- this.options = {};
30
- this.lastSuccessfulTransfer = null;
31
- }
32
-
33
- getSchema() {
34
- return {
35
- title: this.pluginName,
36
- description: 'Some parameters need for use',
37
- type: 'object',
38
- required: ['apiCron', 'boatApiKey'],
39
- properties: {
40
- trackFrequency: {
41
- type: 'integer',
42
- title: 'Position tracking frequency in seconds.',
43
- description: 'To keep file sizes small we only log positions once in a while (unless you set this value to 0)',
44
- default: 60
45
- },
46
- minMove: {
47
- type: 'number',
48
- title: 'Minimum boat move to log in meters',
49
- description: 'To keep file sizes small we only log positions if a move larger than this size (if set to 0 will log every move)',
50
- default: 50
51
- },
52
- minSpeed: {
53
- type: 'number',
54
- title: 'Minimum boat speed to log in knots',
55
- description: 'To keep file sizes small we only log positions if boat speed goes above this value to minimize recording position on anchor or mooring (if set to 0 will log every move)',
56
- default: 1.5
57
- },
58
- apiCron: {
59
- type: 'string',
60
- title: 'Send attempt CRON',
61
- description: 'We send the tracking data to NFL once in a while, you can set the schedule with this setting.\nCRON format: https://crontab.guru/',
62
- default: '*/10 * * * *'
63
- },
64
- boatApiKey: {
65
- type: 'string',
66
- title: 'Boat API key',
67
- description: 'Boat API key from noforeignland.com. Can be found in Account > Settings > Boat tracking > API Key.\n*required only in API method is set*'
68
- },
69
- internetTestTimeout: {
70
- type: 'number',
71
- title: 'Timeout for testing internet connection in ms',
72
- description: 'Set this number higher for slower computers and internet connections',
73
- default: 2000
74
- },
75
- sendWhileMoving: {
76
- type: 'boolean',
77
- title: 'Attempt sending location while moving',
78
- description: 'Should the plugin attempt to send tracking data to NFL while detecting the vessel is moving or only when stopped?',
79
- default: true
80
- },
81
- filterSource: {
82
- type: 'string',
83
- title: 'Position source device',
84
- description: 'Set this value to the name of a source if you want to only use the position given by that source.'
85
- },
86
- trackDir: {
87
- type: 'string',
88
- title: 'Directory to cache tracks.',
89
- description: 'Path in server filesystem, absolute or from plugin directory.\noptional param (only used to keep file cache).'
90
- },
91
- keepFiles: {
92
- type: 'boolean',
93
- title: 'Should keep track files on disk?',
94
- description: 'If you have a lot of hard drive space you can keep the track files for logging purposes.',
95
- default: false
96
- },
97
- ping_api_every_24h: {
98
- type: 'boolean',
99
- title: 'Should I force a send every 24 hours',
100
- description: 'Keeps your boat active on NFL in your current location even if you do not move',
101
- default: true
102
- }
103
- }
104
- };
105
- }
106
-
107
- getPluginObject() {
108
- return {
109
- id: this.pluginId,
110
- name: this.pluginName,
111
- description: 'SignalK track logger to noforeignland.com',
112
- schema: this.getSchema(),
113
- start: this.start.bind(this),
114
- stop: this.stop.bind(this)
115
- };
116
- }
117
-
118
- async start(options = {}, restartPlugin) {
119
- // normalize options
120
- this.options = Object.assign({}, options);
121
- if (!this.options.trackDir) this.options.trackDir = defaultTracksDir;
122
- if (!path.isAbsolute(this.options.trackDir)) {
123
- this.options.trackDir = path.join(__dirname, this.options.trackDir);
124
- }
125
-
126
- if (!this.createDir(this.options.trackDir)) {
127
- this.stop();
128
- return;
129
- }
130
-
131
- this.app.debug('track logger started, now logging to', this.options.trackDir);
132
- this.app.setPluginStatus(`Started`);
133
- this.upSince = new Date().getTime();
134
-
135
- // adjust default CRON if unchanged
136
- if (!this.options.apiCron || this.options.apiCron === '*/10 * * * *') {
137
- const startMinute = Math.floor(Math.random() * 10);
138
- const startSecond = Math.floor(Math.random() * 60);
139
- this.options.apiCron = `${startSecond} ${startMinute}/10 * * * *`;
140
- }
141
-
142
- this.app.debug('Setting CRON to ', this.options.apiCron);
143
-
144
- // subscribe and logging
145
- this.doLogging();
146
-
147
- // start cron job
148
- this.cron = new CronJob(this.options.apiCron, this.interval.bind(this));
149
- this.cron.start();
150
- }
151
-
152
- stop() {
153
- this.app.debug('plugin stopped');
154
- if (this.cron) {
155
- this.cron.stop();
156
- this.cron = undefined;
157
- }
158
- this.unsubscribesControl.forEach(f => f());
159
- this.unsubscribesControl = [];
160
- this.unsubscribes.forEach(f => f());
161
- this.unsubscribes = [];
162
- this.app.setPluginStatus('Plugin stopped');
163
- }
164
-
165
- doLogging() {
166
- // subscribe for position
167
- let shouldDoLog = true;
168
-
169
- this.app.subscriptionmanager.subscribe({
170
- context: 'vessels.self',
171
- subscribe: [{
172
- path: 'navigation.position',
173
- format: 'delta',
174
- policy: 'instant',
175
- minPeriod: this.options.trackFrequency ? this.options.trackFrequency * 1000 : 0
176
- }]
177
- }, this.unsubscribes, (subscriptionError) => {
178
- this.app.debug('Error subscription to data:' + subscriptionError);
179
- this.app.setPluginError('Error subscription to data:' + subscriptionError.message);
180
- }, this.doOnValue.bind(this, () => shouldDoLog, newShould => { shouldDoLog = newShould; }));
181
-
182
- // subscribe for speed
183
- if (this.options.minSpeed) {
184
- this.app.subscriptionmanager.subscribe({
185
- context: 'vessels.self',
186
- subscribe: [{
187
- path: 'navigation.speedOverGround',
188
- format: 'delta',
189
- policy: 'instant'
190
- }]
191
- }, this.unsubscribes, (subscriptionError) => {
192
- this.app.debug('Error subscription to data:' + subscriptionError);
193
- this.app.setPluginError('Error subscription to data:' + subscriptionError.message);
194
- }, (delta) => {
195
- delta.updates.forEach(update => {
196
- if (this.options.filterSource && update.$source !== this.options.filterSource) {
197
- return;
198
- }
199
- update.values.forEach(value => {
200
- const speedInKnots = value.value * 1.94384;
201
- if (!shouldDoLog && this.options.minSpeed < speedInKnots) {
202
- this.app.debug('setting shouldDoLog to true, speed:', speedInKnots.toFixed(2), 'knots');
203
- shouldDoLog = true;
204
- }
205
- });
206
- });
207
- });
208
- }
209
- }
210
-
211
- async doOnValue(getShouldDoLog, setShouldDoLog, delta) {
212
- for (const update of delta.updates) {
213
- if (this.options.filterSource && update.$source !== this.options.filterSource) {
214
- return;
215
- }
216
- const timestamp = update.timestamp;
217
- for (const value of update.values) {
218
- // Validierung: GPS nahe (0,0)
219
- if (Math.abs(value.value.latitude) <= 0.01 && Math.abs(value.value.longitude) <= 0.01) {
220
- this.app.debug('GPS coordinates near (0,0), ignoring point to avoid invalid data logging.');
221
- return;
222
- }
223
-
224
- // Validate for valid lat/lon
225
- if (!this.isValidLatitude(value.value.latitude) || !this.isValidLongitude(value.value.longitude)) {
226
- this.app.debug('got invalid position, ignoring...', value.value);
227
- return;
228
- }
229
-
230
- // 24h-Ping Check: Setze Flag, aber breche NICHT ab
231
- let force24hSave = false;
232
- if (this.options.ping_api_every_24h && this.lastPosition) {
233
- const timeSinceLastPoint = (new Date().getTime() - this.lastPosition.currentTime);
234
- if (timeSinceLastPoint >= 24 * 60 * 60 * 1000) {
235
- this.app.debug('24h since last point, forcing save of point to keep boat active on NFL');
236
- force24hSave = true;
237
- }
238
- }
239
-
240
- // Wenn wir nicht loggen sollen UND es kein 24h-Force ist, dann raus
241
- if (!force24hSave && !getShouldDoLog()) {
242
- return;
243
- }
244
-
245
- // Wenn wir eine letzte Position haben, prüfe Timestamp und Distanz
246
- if (this.lastPosition && !force24hSave) {
247
- // Timestamp-Validierung
248
- if (new Date(this.lastPosition.timestamp).getTime() > new Date(timestamp).getTime()) {
249
- this.app.debug('got error in timestamp:', timestamp, 'is earlier than previous:', this.lastPosition.timestamp);
250
- return;
251
- }
252
-
253
- // Distance-Check (nur wenn NICHT 24h-Force)
254
- const distance = this.equirectangularDistance(this.lastPosition.pos, value.value);
255
- if (this.options.minMove && distance < this.options.minMove) {
256
- this.app.debug('Distance', distance.toFixed(2), 'm is less than minMove', this.options.minMove, 'm - skipping');
257
- return;
258
- }
259
- }
260
-
261
- // Punkt speichern
262
- this.lastPosition = { pos: value.value, timestamp, currentTime: new Date().getTime() };
263
- await this.savePoint(this.lastPosition);
264
-
265
- // shouldDoLog zurücksetzen wenn minSpeed aktiv ist
266
- if (this.options.minSpeed) {
267
- this.app.debug('options.minSpeed - setting shouldDoLog to false');
268
- setShouldDoLog(false);
269
- }
270
- }
271
- }}
272
-
273
-
274
- async savePoint(point) {
275
- const obj = {
276
- lat: point.pos.latitude,
277
- lon: point.pos.longitude,
278
- t: point.timestamp
279
- };
280
- this.app.debug(`save data point:`, obj);
281
- await fs.appendFile(path.join(this.options.trackDir, routeSaveName), JSON.stringify(obj) + EOL);
282
-
283
- // Inform user about last saved point
284
- const lastSaveTime = new Date().toLocaleString();
285
- const lastTransferTime = this.lastSuccessfulTransfer ? this.lastSuccessfulTransfer.toLocaleString() : 'Never';
286
- this.app.setPluginStatus(`Last save: ${lastSaveTime} | Last transfer: ${lastTransferTime}`);
287
- }
288
-
289
- isValidLatitude(obj) {
290
- return this.isDefinedNumber(obj) && obj > -90 && obj < 90;
291
- }
292
- isValidLongitude(obj) {
293
- return this.isDefinedNumber(obj) && obj > -180 && obj < 180;
294
- }
295
- isDefinedNumber(obj) {
296
- return (obj !== undefined && obj !== null && typeof obj === 'number');
297
- }
298
-
299
- equirectangularDistance(from, to) {
300
- const rad = Math.PI / 180;
301
- const φ1 = from.latitude * rad;
302
- const φ2 = to.latitude * rad;
303
- const Δλ = (to.longitude - from.longitude) * rad;
304
- const R = 6371e3;
305
- const x = Δλ * Math.cos((φ1 + φ2) / 2);
306
- const y = (φ2 - φ1);
307
- const d = Math.sqrt(x * x + y * y) * R;
308
- return d;
309
- }
310
-
311
- createDir(dir) {
312
- let res = true;
313
- if (fs.existsSync(dir)) {
314
- try {
315
- fs.accessSync(dir, fs.constants.R_OK | fs.constants.W_OK);
316
- } catch (error) {
317
- this.app.debug('[createDir]', error.message);
318
- this.app.setPluginError(`No rights to directory ${dir}`);
319
- res = false;
320
- }
321
- } else {
322
- try {
323
- fs.mkdirSync(dir, { recursive: true });
324
- } catch (error) {
325
- switch (error.code) {
326
- case 'EACCES':
327
- case 'EPERM':
328
- this.app.debug(`False to create ${dir} by Permission denied`);
329
- this.app.setPluginError(`False to create ${dir} by Permission denied`);
330
- res = false;
331
- break;
332
- case 'ETIMEDOUT':
333
- this.app.debug(`False to create ${dir} by Operation timed out`);
334
- this.app.setPluginError(`False to create ${dir} by Operation timed out`);
335
- res = false;
336
- break;
337
- default:
338
- this.app.debug(`Error creating directory ${dir}: ${error.message}`);
339
- this.app.setPluginError(`Error creating directory ${dir}: ${error.message}`);
340
- res = false;
341
- }
342
- }
343
- }
344
- return res;
345
- }
346
-
347
- // periodic interval called by cron
348
- async interval() {
349
- if ((this.checkBoatMoving()) && await this.checkTrack() && await this.testInternet()) {
350
- await this.sendData();
351
- }
352
- }
353
-
354
- checkBoatMoving() {
355
- if (!this.options.trackFrequency) {
356
- return true; // Kein Tracking immer senden
357
- }
358
- const time = this.lastPosition ? this.lastPosition.currentTime : this.upSince;
359
- const secsSinceLastPoint = (new Date().getTime() - time) / 1000;
360
- const isMoving = secsSinceLastPoint <= (this.options.trackFrequency * 2);
361
- if (isMoving) {
362
- this.app.debug('Boat is still moving, last move', secsSinceLastPoint, 'seconds ago');
363
- return this.options.sendWhileMoving; // Nur senden wenn gewünscht
364
- } else {
365
- this.app.debug('Boat stopped moving, last move at least', secsSinceLastPoint, 'seconds ago');
366
- return true; // Immer senden wenn gestoppt
367
- }
368
- }
369
-
370
- async testInternet() {
371
- const dns = require('dns').promises;
372
-
373
- this.app.debug('testing internet connection');
374
-
375
- try {
376
- // Force IPv4 DNS lookup with timeout
377
- const timeoutMs = this.options.internetTestTimeout || internetTestTimeout;
378
- const addresses = await Promise.race([
379
- dns.resolve4(internetTestAddress),
380
- new Promise((_, reject) =>
381
- setTimeout(() => reject(new Error('DNS timeout')), timeoutMs)
382
- )
383
- ]);
384
-
385
- if (addresses && addresses.length > 0) {
386
- this.app.debug('internet connection = true, resolved IPv4:', addresses[0]);
387
- return true;
388
- } else {
389
- this.app.debug('internet connection = false, no IPv4 addresses found');
390
- return false;
391
- }
392
- } catch (err) {
393
- this.app.debug('internet connection = false, error:', err.message);
394
- return false;
395
- }
396
- }
397
-
398
- async checkTrack() {
399
- const trackFile = path.join(this.options.trackDir, routeSaveName);
400
- this.app.debug('checking the track', trackFile, 'if should send');
401
- const exists = await fs.pathExists(trackFile);
402
- const size = exists ? (await fs.lstat(trackFile)).size : 0;
403
- this.app.debug(`'${trackFile}'.size=${size} ${trackFile}'.exists=${exists}`);
404
- return size > 0;
405
- }
406
-
407
- async sendData() {
408
- if (this.options.boatApiKey) {
409
- await this.sendApiData();
410
- } else {
411
- this.app.debug('Failed to send track - no boat API key set in plugin settings.');
412
- this.app.setPluginError(`Failed to send track - no boat API key set in plugin settings.`);
413
- }
414
- }
415
-
416
- async sendApiData() {
417
- this.app.debug('sending the data');
418
- const trackData = await this.createTrack(path.join(this.options.trackDir, routeSaveName));
419
- if (!trackData) {
420
- this.app.debug('Recorded track did not contain any valid track points, aborting sending.');
421
- this.app.setPluginError(`Failed to send track - Recorded track did not contain any valid track points, aborting sending.`);
422
- return;
423
- }
424
- this.app.debug('created track data with timestamp:', new Date(trackData.timestamp));
425
- const params = new URLSearchParams();
426
- params.append('timestamp', trackData.timestamp);
427
- params.append('track', JSON.stringify(trackData.track));
428
- params.append('boatApiKey', this.options.boatApiKey);
429
- const headers = { 'X-NFL-API-Key': pluginApiKey };
430
- this.app.debug('sending track to API');
431
-
432
- try {
433
- const response = await fetch(apiUrl, { method: 'POST', body: params, headers: new fetch.Headers(headers) });
434
- if (response.ok) {
435
- const responseBody = await response.json();
436
- if (responseBody.status === 'ok') {
437
- this.lastSuccessfulTransfer = new Date();
438
- this.app.debug('Track successfully sent to API');
439
- this.app.setPluginStatus(`Started - last Track sent successfully at ${new Date().toLocaleString()}`);
440
- if (this.options.keepFiles) {
441
- const filename = new Date().toJSON().slice(0, 19).replace(/:/g, '') + '-nfl-track.jsonl';
442
- this.app.debug('moving and keeping track file: ', filename);
443
- await fs.move(path.join(this.options.trackDir, routeSaveName), path.join(this.options.trackDir, filename));
444
- } else {
445
- this.app.debug('Deleting track file');
446
- await fs.remove(path.join(this.options.trackDir, routeSaveName));
447
- }
448
- } else {
449
- this.app.debug('Could not send track to API, returned response json:', responseBody);
450
- this.app.setPluginError(`Failed to send track - check logs for details.`);
451
- }
452
- } else {
453
- this.app.debug('Could not send track to API, returned response code:', response.status, response.statusText);
454
- this.app.setPluginError(`Failed to send track - check logs for details.`);
455
- }
456
- } catch (err) {
457
- this.app.debug('Could not send track to API due to error:', err);
458
- this.app.setPluginError(`Failed to send track - check logs for details.`);
459
- }
460
- }
461
-
462
- async createTrack(inputPath) {
463
- const fileStream = fs.createReadStream(inputPath);
464
- const rl = readline.createInterface({ input: fileStream, crlfDelay: Infinity });
465
- const track = [];
466
- let lastTimestamp;
467
- for await (const line of rl) {
468
- if (line) {
469
- try {
470
- const point = JSON.parse(line);
471
- const timestamp = new Date(point.t).getTime();
472
- if (!isNaN(timestamp) && this.isValidLatitude(point.lat) && this.isValidLongitude(point.lon)) {
473
- track.push([timestamp, point.lat, point.lon]);
474
- lastTimestamp = timestamp;
475
- }
476
- } catch (error) {
477
- this.app.debug('could not parse line from track file:', line);
478
- this.app.setPluginError(`Failed could not parse line from track file - check logs for details.`);
479
- }
480
- }
481
- }
482
- if (track.length > 0) {
483
- return { timestamp: new Date(lastTimestamp).getTime(), track };
484
- }
485
- return null;
486
- }
487
- }
488
-
489
- module.exports = function (app) {
490
- const instance = new SignalkToNoforeignland(app);
491
- return instance.getPluginObject();
492
- };
1
+ const { EOL } = require('os');
2
+ const internetTestAddress = 'google.com';
3
+ const internetTestTimeout = 1000;
4
+ const fs = require('fs-extra');
5
+ const path = require('path');
6
+ const CronJob = require('cron').CronJob;
7
+ const readline = require('readline');
8
+ const fetch = require('node-fetch');
9
+ const isReachable = require('is-reachable');
10
+
11
+ const apiUrl = 'https://www.noforeignland.com/home/api/v1/boat/tracking/track';
12
+ const pluginApiKey = '0ede6cb6-5213-45f5-8ab4-b4836b236f97';
13
+ const defaultTracksDir = 'track';
14
+ const routeSaveName = 'nfl-track.jsonl';
15
+
16
+ class SignalkToNoforeignland {
17
+ constructor(app) {
18
+ this.app = app;
19
+ this.pluginId = 'signalk-to-noforeignland';
20
+ this.pluginName = 'Signal K to Noforeignland';
21
+ this.creator = 'signalk-track-logger';
22
+
23
+ // runtime state
24
+ this.unsubscribes = [];
25
+ this.unsubscribesControl = [];
26
+ this.lastPosition = null;
27
+ this.upSince = null;
28
+ this.cron = null;
29
+ this.options = {};
30
+ this.lastSuccessfulTransfer = null;
31
+ }
32
+
33
+ getSchema() {
34
+ return {
35
+ title: this.pluginName,
36
+ description: 'Some parameters need for use',
37
+ type: 'object',
38
+ required: ['boatApiKey', 'apiCron'],
39
+ properties: {
40
+ // Mandatory Settings Group
41
+ mandatory: {
42
+ type: 'object',
43
+ title: 'Mandatory Settings',
44
+ properties: {
45
+ boatApiKey: {
46
+ type: 'string',
47
+ title: 'Boat API Key',
48
+ description: 'Boat API Key from noforeignland.com. Can be found in Account > Settings > Boat tracking > API Key.'
49
+ }
50
+ }
51
+ },
52
+
53
+ // Advanced Settings Group
54
+ advanced: {
55
+ type: 'object',
56
+ title: 'Advanced Settings',
57
+ properties: {
58
+ minMove: {
59
+ type: 'number',
60
+ title: 'Minimum boat move to log in meters',
61
+ description: 'To keep file sizes small we only log positions if a move larger than this size (if set to 0 will log every move)',
62
+ default: 80
63
+ },
64
+ minSpeed: {
65
+ type: 'number',
66
+ title: 'Minimum boat speed to log in knots',
67
+ description: 'To keep file sizes small we only log positions if boat speed goes above this value to minimize recording position on anchor or mooring (if set to 0 will log every move)',
68
+ default: 1.5
69
+ },
70
+ sendWhileMoving: {
71
+ type: 'boolean',
72
+ title: 'Attempt sending location while moving',
73
+ description: 'Should the plugin attempt to send tracking data to NFL while detecting the vessel is moving or only when stopped?',
74
+ default: true
75
+ },
76
+ ping_api_every_24h: {
77
+ type: 'boolean',
78
+ title: 'Force a send every 24 hours',
79
+ description: 'Keeps your boat active on NFL in your current location even if you do not move',
80
+ default: true
81
+ }
82
+ }
83
+ },
84
+
85
+ // Expert Settings Group
86
+ expert: {
87
+ type: 'object',
88
+ title: 'Expert Settings',
89
+ properties: {
90
+ filterSource: {
91
+ type: 'string',
92
+ title: 'Position source device',
93
+ description: 'EMPTY DEFAULT IS FINE - Set this value to the name of a source if you want to only use the position given by that source.'
94
+ },
95
+ trackDir: {
96
+ type: 'string',
97
+ title: 'Directory to cache tracks',
98
+ description: 'EMPTY DEFAULT IS FINE - Path in server filesystem, absolute or from plugin directory.\noptional param (only used to keep file cache).'
99
+ },
100
+ keepFiles: {
101
+ type: 'boolean',
102
+ title: 'Keep track files on disk',
103
+ description: 'If you have a lot of hard drive space you can keep the track files for logging purposes.',
104
+ default: false
105
+ },
106
+ trackFrequency: {
107
+ type: 'integer',
108
+ title: 'Position tracking frequency in seconds',
109
+ description: 'To keep file sizes small we only log positions once in a while (unless you set this value to 0)',
110
+ default: 60
111
+ },
112
+ apiCron: {
113
+ type: 'string',
114
+ title: 'Send attempt CRON',
115
+ description: 'We send the tracking data to NFL once in a while, you can set the schedule with this setting.\nCRON format: https://crontab.guru/',
116
+ default: '*/10 * * * *'
117
+ },
118
+ internetTestTimeout: {
119
+ type: 'number',
120
+ title: 'Timeout for testing internet connection in ms',
121
+ description: 'Set this number higher for slower computers and internet connections',
122
+ default: 2000
123
+ },
124
+ apiTimeout: {
125
+ type: 'integer',
126
+ title: 'API request timeout in seconds',
127
+ description: 'Timeout for sending data to NFL API. Increase for slow connections.',
128
+ default: 30,
129
+ minimum: 10,
130
+ maximum: 180
131
+ }
132
+ }
133
+ }
134
+ }
135
+ };
136
+ }
137
+
138
+ getPluginObject() {
139
+ return {
140
+ id: this.pluginId,
141
+ name: this.pluginName,
142
+ description: 'SignalK track logger to noforeignland.com',
143
+ schema: this.getSchema(),
144
+ start: this.start.bind(this),
145
+ stop: this.stop.bind(this)
146
+ };
147
+ }
148
+
149
+ async start(options = {}, restartPlugin) {
150
+
151
+ // Backward compatibility: migrate old flat structure to new nested structure
152
+ let needsSave = false;
153
+ if (options.boatApiKey && !options.mandatory) {
154
+ // Old config detected, migrate to new structure
155
+ this.app.debug('Migrating old configuration to new grouped structure');
156
+ needsSave = true;
157
+
158
+ options = {
159
+ mandatory: {
160
+ boatApiKey: options.boatApiKey
161
+ },
162
+ advanced: {
163
+ minMove: options.minMove !== undefined ? options.minMove : 50,
164
+ minSpeed: options.minSpeed !== undefined ? options.minSpeed : 1.5,
165
+ sendWhileMoving: options.sendWhileMoving !== undefined ? options.sendWhileMoving : true,
166
+ ping_api_every_24h: options.ping_api_every_24h !== undefined ? options.ping_api_every_24h : true
167
+ },
168
+ expert: {
169
+ filterSource: options.filterSource,
170
+ trackDir: options.trackDir,
171
+ keepFiles: options.keepFiles !== undefined ? options.keepFiles : false,
172
+ trackFrequency: options.trackFrequency !== undefined ? options.trackFrequency : 60,
173
+ internetTestTimeout: options.internetTestTimeout !== undefined ? options.internetTestTimeout : 2000,
174
+ apiCron: options.apiCron || '*/10 * * * *',
175
+ apiTimeout: options.apiTimeout !== undefined ? options.apiTimeout : 30
176
+ }
177
+ };
178
+
179
+ // Save the migrated configuration
180
+ try {
181
+ this.app.debug('Saving migrated configuration...');
182
+ await this.app.savePluginOptions(options, () => {
183
+ this.app.debug('Configuration successfully migrated and saved');
184
+ });
185
+ } catch (err) {
186
+ this.app.debug('Failed to save migrated configuration:', err.message);
187
+ // Continue anyway - the migration will work in memory
188
+ }
189
+ }
190
+
191
+ // Flatten the nested structure for easier access and apply defaults
192
+ this.options = {
193
+ // Mandatory defaults
194
+ boatApiKey: options.mandatory?.boatApiKey,
195
+
196
+ // Advanced defaults
197
+ minMove: options.advanced?.minMove !== undefined ? options.advanced.minMove : 80,
198
+ minSpeed: options.advanced?.minSpeed !== undefined ? options.advanced.minSpeed : 1.5,
199
+ sendWhileMoving: options.advanced?.sendWhileMoving !== undefined ? options.advanced.sendWhileMoving : true,
200
+ ping_api_every_24h: options.advanced?.ping_api_every_24h !== undefined ? options.advanced.ping_api_every_24h : true,
201
+
202
+ // Expert defaults
203
+ filterSource: options.expert?.filterSource,
204
+ trackDir: options.expert?.trackDir || defaultTracksDir,
205
+ keepFiles: options.expert?.keepFiles !== undefined ? options.expert.keepFiles : false,
206
+ trackFrequency: options.expert?.trackFrequency !== undefined ? options.expert.trackFrequency : 60,
207
+ internetTestTimeout: options.expert?.internetTestTimeout !== undefined ? options.expert.internetTestTimeout : 2000,
208
+ apiCron: options.expert?.apiCron || '*/10 * * * *',
209
+ apiTimeout: options.expert?.apiTimeout !== undefined ? options.expert.apiTimeout : 30
210
+ };
211
+
212
+ // Validate that boatApiKey is set
213
+ if (!this.options.boatApiKey || this.options.boatApiKey.trim() === '') {
214
+ const errorMsg = 'No boat API key configured. Please set your API key in plugin settings (Mandatory Settings > Boat API key). You can find your API key at noforeignland.com under Account > Settings > Boat tracking > API Key.';
215
+ this.app.debug(errorMsg);
216
+ this.app.setPluginError(errorMsg);
217
+ this.stop();
218
+ return;
219
+ }
220
+
221
+ if (!path.isAbsolute(this.options.trackDir)) {
222
+ this.options.trackDir = path.join(__dirname, this.options.trackDir);
223
+ }
224
+
225
+ if (!this.createDir(this.options.trackDir)) {
226
+ this.stop();
227
+ return;
228
+ }
229
+
230
+ this.app.debug('track logger started, now logging to', this.options.trackDir);
231
+ this.app.setPluginStatus(`Started${needsSave ? ' (config migrated)' : ''}`);
232
+ this.upSince = new Date().getTime();
233
+
234
+ // adjust default CRON if unchanged
235
+ if (!this.options.apiCron || this.options.apiCron === '*/10 * * * *') {
236
+ const startMinute = Math.floor(Math.random() * 10);
237
+ const startSecond = Math.floor(Math.random() * 60);
238
+ this.options.apiCron = `${startSecond} ${startMinute}/10 * * * *`;
239
+ }
240
+
241
+ this.app.debug('Setting CRON to ', this.options.apiCron);
242
+ this.app.debug('trackFrequency is set to', this.options.trackFrequency, 'seconds');
243
+
244
+ // subscribe and logging
245
+ this.doLogging();
246
+
247
+ // start cron job
248
+ this.cron = new CronJob(this.options.apiCron, this.interval.bind(this));
249
+ this.cron.start();
250
+ }
251
+
252
+ stop() {
253
+ this.app.debug('plugin stopped');
254
+ if (this.cron) {
255
+ this.cron.stop();
256
+ this.cron = undefined;
257
+ }
258
+ this.unsubscribesControl.forEach(f => f());
259
+ this.unsubscribesControl = [];
260
+ this.unsubscribes.forEach(f => f());
261
+ this.unsubscribes = [];
262
+ this.app.setPluginStatus('Plugin stopped');
263
+ }
264
+
265
+ doLogging() {
266
+ // subscribe for position
267
+ let shouldDoLog = true;
268
+
269
+ this.app.subscriptionmanager.subscribe({
270
+ context: 'vessels.self',
271
+ subscribe: [{
272
+ path: 'navigation.position',
273
+ format: 'delta',
274
+ policy: 'instant',
275
+ minPeriod: this.options.trackFrequency ? this.options.trackFrequency * 1000 : 0
276
+ }]
277
+ }, this.unsubscribes, (subscriptionError) => {
278
+ this.app.debug('Error subscription to data:' + subscriptionError);
279
+ this.app.setPluginError('Error subscription to data:' + subscriptionError.message);
280
+ }, this.doOnValue.bind(this, () => shouldDoLog, newShould => { shouldDoLog = newShould; }));
281
+
282
+ // subscribe for speed
283
+ if (this.options.minSpeed) {
284
+ this.app.subscriptionmanager.subscribe({
285
+ context: 'vessels.self',
286
+ subscribe: [{
287
+ path: 'navigation.speedOverGround',
288
+ format: 'delta',
289
+ policy: 'instant'
290
+ }]
291
+ }, this.unsubscribes, (subscriptionError) => {
292
+ this.app.debug('Error subscription to data:' + subscriptionError);
293
+ this.app.setPluginError('Error subscription to data:' + subscriptionError.message);
294
+ }, (delta) => {
295
+ delta.updates.forEach(update => {
296
+ if (this.options.filterSource && update.$source !== this.options.filterSource) {
297
+ return;
298
+ }
299
+ update.values.forEach(value => {
300
+ const speedInKnots = value.value * 1.94384;
301
+ if (!shouldDoLog && this.options.minSpeed < speedInKnots) {
302
+ this.app.debug('setting shouldDoLog to true, speed:', speedInKnots.toFixed(2), 'knots');
303
+ shouldDoLog = true;
304
+ }
305
+ });
306
+ });
307
+ });
308
+ }
309
+ }
310
+
311
+ async doOnValue(getShouldDoLog, setShouldDoLog, delta) {
312
+ for (const update of delta.updates) {
313
+ if (this.options.filterSource && update.$source !== this.options.filterSource) {
314
+ return;
315
+ }
316
+ const timestamp = update.timestamp;
317
+ for (const value of update.values) {
318
+ // Validierung: GPS nahe (0,0)
319
+ if (Math.abs(value.value.latitude) <= 0.01 && Math.abs(value.value.longitude) <= 0.01) {
320
+ this.app.debug('GPS coordinates near (0,0), ignoring point to avoid invalid data logging.');
321
+ return;
322
+ }
323
+
324
+ // Validate for valid lat/lon
325
+ if (!this.isValidLatitude(value.value.latitude) || !this.isValidLongitude(value.value.longitude)) {
326
+ this.app.debug('got invalid position, ignoring...', value.value);
327
+ return;
328
+ }
329
+
330
+ // 24h-Ping Check: Setze Flag, aber breche NICHT ab
331
+ let force24hSave = false;
332
+ if (this.options.ping_api_every_24h && this.lastPosition) {
333
+ const timeSinceLastPoint = (new Date().getTime() - this.lastPosition.currentTime);
334
+ if (timeSinceLastPoint >= 24 * 60 * 60 * 1000) {
335
+ this.app.debug('24h since last point, forcing save of point to keep boat active on NFL');
336
+ force24hSave = true;
337
+ }
338
+ }
339
+
340
+ // Wenn wir nicht loggen sollen UND es kein 24h-Force ist, dann raus
341
+ if (!force24hSave && !getShouldDoLog()) {
342
+ return;
343
+ }
344
+
345
+ // Wenn wir eine letzte Position haben, prüfe Timestamp und Distanz
346
+ if (this.lastPosition && !force24hSave) {
347
+ // Timestamp-Validierung
348
+ if (new Date(this.lastPosition.timestamp).getTime() > new Date(timestamp).getTime()) {
349
+ this.app.debug('got error in timestamp:', timestamp, 'is earlier than previous:', this.lastPosition.timestamp);
350
+ return;
351
+ }
352
+
353
+ // Distance-Check (nur wenn NICHT 24h-Force)
354
+ const distance = this.equirectangularDistance(this.lastPosition.pos, value.value);
355
+ if (this.options.minMove && distance < this.options.minMove) {
356
+ this.app.debug('Distance', distance.toFixed(2), 'm is less than minMove', this.options.minMove, 'm - skipping');
357
+ return;
358
+ }
359
+ }
360
+
361
+ // Punkt speichern
362
+ this.lastPosition = { pos: value.value, timestamp, currentTime: new Date().getTime() };
363
+ await this.savePoint(this.lastPosition);
364
+
365
+ // shouldDoLog zurücksetzen wenn minSpeed aktiv ist
366
+ if (this.options.minSpeed) {
367
+ this.app.debug('options.minSpeed - setting shouldDoLog to false');
368
+ setShouldDoLog(false);
369
+ }
370
+ }
371
+ }}
372
+
373
+
374
+ async savePoint(point) {
375
+ const obj = {
376
+ lat: point.pos.latitude,
377
+ lon: point.pos.longitude,
378
+ t: point.timestamp
379
+ };
380
+ this.app.debug(`save data point:`, obj);
381
+ await fs.appendFile(path.join(this.options.trackDir, routeSaveName), JSON.stringify(obj) + EOL);
382
+
383
+ const lastSaveTime = new Date().toISOString();
384
+ const lastTransferTime = this.lastSuccessfulTransfer ? this.lastSuccessfulTransfer.toISOString() : 'None since start';
385
+ this.app.setPluginStatus(`Last save: ${lastSaveTime} | Last transfer: ${lastTransferTime}`);
386
+ }
387
+
388
+ isValidLatitude(obj) {
389
+ return this.isDefinedNumber(obj) && obj > -90 && obj < 90;
390
+ }
391
+ isValidLongitude(obj) {
392
+ return this.isDefinedNumber(obj) && obj > -180 && obj < 180;
393
+ }
394
+ isDefinedNumber(obj) {
395
+ return (obj !== undefined && obj !== null && typeof obj === 'number');
396
+ }
397
+
398
+ equirectangularDistance(from, to) {
399
+ const rad = Math.PI / 180;
400
+ const φ1 = from.latitude * rad;
401
+ const φ2 = to.latitude * rad;
402
+ const Δλ = (to.longitude - from.longitude) * rad;
403
+ const R = 6371e3;
404
+ const x = Δλ * Math.cos((φ1 + φ2) / 2);
405
+ const y = (φ2 - φ1);
406
+ const d = Math.sqrt(x * x + y * y) * R;
407
+ return d;
408
+ }
409
+
410
+ createDir(dir) {
411
+ let res = true;
412
+ if (fs.existsSync(dir)) {
413
+ try {
414
+ fs.accessSync(dir, fs.constants.R_OK | fs.constants.W_OK);
415
+ } catch (error) {
416
+ this.app.debug('[createDir]', error.message);
417
+ this.app.setPluginError(`No rights to directory ${dir}`);
418
+ res = false;
419
+ }
420
+ } else {
421
+ try {
422
+ fs.mkdirSync(dir, { recursive: true });
423
+ } catch (error) {
424
+ switch (error.code) {
425
+ case 'EACCES':
426
+ case 'EPERM':
427
+ this.app.debug(`False to create ${dir} by Permission denied`);
428
+ this.app.setPluginError(`False to create ${dir} by Permission denied`);
429
+ res = false;
430
+ break;
431
+ case 'ETIMEDOUT':
432
+ this.app.debug(`False to create ${dir} by Operation timed out`);
433
+ this.app.setPluginError(`False to create ${dir} by Operation timed out`);
434
+ res = false;
435
+ break;
436
+ default:
437
+ this.app.debug(`Error creating directory ${dir}: ${error.message}`);
438
+ this.app.setPluginError(`Error creating directory ${dir}: ${error.message}`);
439
+ res = false;
440
+ }
441
+ }
442
+ }
443
+ return res;
444
+ }
445
+
446
+ // periodic interval called by cron
447
+ async interval() {
448
+ if ((this.checkBoatMoving()) && await this.checkTrack() && await this.testInternet()) {
449
+ await this.sendData();
450
+ }
451
+ }
452
+
453
+ checkBoatMoving() {
454
+ if (!this.options.trackFrequency) {
455
+ return true; // Kein Tracking → immer senden
456
+ }
457
+ const time = this.lastPosition ? this.lastPosition.currentTime : this.upSince;
458
+ const secsSinceLastPoint = (new Date().getTime() - time) / 1000;
459
+ const isMoving = secsSinceLastPoint <= (this.options.trackFrequency * 2);
460
+ if (isMoving) {
461
+ this.app.debug('Boat is still moving, last move', secsSinceLastPoint, 'seconds ago');
462
+ return this.options.sendWhileMoving; // Nur senden wenn gewünscht
463
+ } else {
464
+ this.app.debug('Boat stopped moving, last move at least', secsSinceLastPoint, 'seconds ago');
465
+ return true; // Immer senden wenn gestoppt
466
+ }
467
+ }
468
+
469
+ async testInternet() {
470
+ const dns = require('dns').promises;
471
+
472
+ this.app.debug('testing internet connection');
473
+
474
+ const timeoutMs = this.options.internetTestTimeout || 2000;
475
+
476
+ // Prüfe mehrere öffentliche DNS-Server
477
+ const dnsServers = [
478
+ { name: 'Google DNS', ip: '8.8.8.8' },
479
+ { name: 'Cloudflare DNS', ip: '1.1.1.1' }
480
+ ];
481
+
482
+ for (const server of dnsServers) {
483
+ try {
484
+ // Versuche, den DNS-Server direkt zu erreichen
485
+ // Wir machen einen reverse lookup auf die IP selbst
486
+ const result = await Promise.race([
487
+ dns.reverse(server.ip),
488
+ new Promise((_, reject) =>
489
+ setTimeout(() => reject(new Error('DNS timeout')), timeoutMs)
490
+ )
491
+ ]);
492
+
493
+ this.app.debug(`internet connection = true, ${server.name} (${server.ip}) is reachable`);
494
+ return true;
495
+ } catch (err) {
496
+ this.app.debug(`${server.name} (${server.ip}) not reachable:`, err.message);
497
+ // Weiter zum nächsten Server
498
+ }
499
+ }
500
+
501
+ this.app.debug('internet connection = false, no public DNS servers reachable');
502
+ return false;
503
+ }
504
+
505
+ async checkTrack() {
506
+ const trackFile = path.join(this.options.trackDir, routeSaveName);
507
+ this.app.debug('checking the track', trackFile, 'if should send');
508
+ const exists = await fs.pathExists(trackFile);
509
+ const size = exists ? (await fs.lstat(trackFile)).size : 0;
510
+ this.app.debug(`'${trackFile}'.size=${size} ${trackFile}'.exists=${exists}`);
511
+ return size > 0;
512
+ }
513
+
514
+ async sendData() {
515
+ if (this.options.boatApiKey) {
516
+ await this.sendApiData();
517
+ } else {
518
+ this.app.debug('Failed to send track - no boat API key set in plugin settings.');
519
+ this.app.setPluginError(`Failed to send track - no boat API key set in plugin settings.`);
520
+ }
521
+ }
522
+
523
+ async sendApiData() {
524
+ this.app.debug('sending the data');
525
+ const trackData = await this.createTrack(path.join(this.options.trackDir, routeSaveName));
526
+ if (!trackData) {
527
+ this.app.debug('Recorded track did not contain any valid track points, aborting sending.');
528
+ this.app.setPluginError(`Failed to send track - Recorded track did not contain any valid track points, aborting sending.`);
529
+ return;
530
+ }
531
+ this.app.debug('created track data with timestamp:', new Date(trackData.timestamp));
532
+ const params = new URLSearchParams();
533
+ params.append('timestamp', trackData.timestamp);
534
+ params.append('track', JSON.stringify(trackData.track));
535
+ params.append('boatApiKey', this.options.boatApiKey);
536
+ const headers = { 'X-NFL-API-Key': pluginApiKey };
537
+ this.app.debug('sending track to API');
538
+
539
+ // Retry-Logik mit exponentiell steigendem Timeout
540
+ const maxRetries = 3;
541
+ const baseTimeout = (this.options.apiTimeout || 30) * 1000; // Konfigurierbarer Basis-Timeout in ms
542
+
543
+ for (let attempt = 1; attempt <= maxRetries; attempt++) {
544
+ try {
545
+ const currentTimeout = baseTimeout * attempt; // 30s, 60s, 90s
546
+ this.app.debug(`Attempt ${attempt}/${maxRetries} with ${currentTimeout}ms timeout`);
547
+
548
+ // AbortController für Timeout
549
+ const controller = new AbortController();
550
+ const timeoutId = setTimeout(() => controller.abort(), currentTimeout);
551
+
552
+ const response = await fetch(apiUrl, {
553
+ method: 'POST',
554
+ body: params,
555
+ headers: new fetch.Headers(headers),
556
+ signal: controller.signal
557
+ });
558
+
559
+ clearTimeout(timeoutId);
560
+
561
+ if (response.ok) {
562
+ const responseBody = await response.json();
563
+ if (responseBody.status === 'ok') {
564
+ this.lastSuccessfulTransfer = new Date();
565
+ this.app.debug('Track successfully sent to API');
566
+ this.app.setPluginStatus(`Started - last Track sent successfully at ${new Date().toISOString()}`);
567
+ if (this.options.keepFiles) {
568
+ const filename = new Date().toJSON().slice(0, 19).replace(/:/g, '') + '-nfl-track.jsonl';
569
+ this.app.debug('moving and keeping track file: ', filename);
570
+ await fs.move(path.join(this.options.trackDir, routeSaveName), path.join(this.options.trackDir, filename));
571
+ } else {
572
+ this.app.debug('Deleting track file');
573
+ await fs.remove(path.join(this.options.trackDir, routeSaveName));
574
+ }
575
+ return; // Erfolg - beende Funktion
576
+ } else {
577
+ this.app.debug('Could not send track to API, returned response json:', responseBody);
578
+ // Bei API-Fehler nicht erneut versuchen
579
+ this.app.setPluginError(`Failed to send track - API returned error.`);
580
+ return;
581
+ }
582
+ } else {
583
+ this.app.debug('Could not send track to API, returned response code:', response.status, response.statusText);
584
+ // Bei 4xx Fehler nicht erneut versuchen
585
+ if (response.status >= 400 && response.status < 500) {
586
+ this.app.setPluginError(`Failed to send track - HTTP ${response.status}.`);
587
+ return;
588
+ }
589
+ // Bei 5xx Fehler retry
590
+ throw new Error(`HTTP ${response.status}`);
591
+ }
592
+ } catch (err) {
593
+ this.app.debug(`Attempt ${attempt} failed:`, err.message);
594
+
595
+ // Bei letztem Versuch Fehler setzen
596
+ if (attempt === maxRetries) {
597
+ this.app.debug('Could not send track to API after', maxRetries, 'attempts:', err);
598
+ this.app.setPluginError(`Failed to send track after ${maxRetries} attempts - check logs for details.`);
599
+ } else {
600
+ // Kurze Pause vor nächstem Versuch
601
+ const waitTime = 2000 * attempt; // 2s, 4s
602
+ this.app.debug(`Waiting ${waitTime}ms before retry...`);
603
+ await new Promise(resolve => setTimeout(resolve, waitTime));
604
+ }
605
+ }
606
+ }
607
+ }
608
+ async createTrack(inputPath) {
609
+ const fileStream = fs.createReadStream(inputPath);
610
+ const rl = readline.createInterface({ input: fileStream, crlfDelay: Infinity });
611
+ const track = [];
612
+ let lastTimestamp;
613
+ for await (const line of rl) {
614
+ if (line) {
615
+ try {
616
+ const point = JSON.parse(line);
617
+ const timestamp = new Date(point.t).getTime();
618
+ if (!isNaN(timestamp) && this.isValidLatitude(point.lat) && this.isValidLongitude(point.lon)) {
619
+ track.push([timestamp, point.lat, point.lon]);
620
+ lastTimestamp = timestamp;
621
+ }
622
+ } catch (error) {
623
+ this.app.debug('could not parse line from track file:', line);
624
+ this.app.setPluginError(`Failed could not parse line from track file - check logs for details.`);
625
+ }
626
+ }
627
+ }
628
+ if (track.length > 0) {
629
+ return { timestamp: new Date(lastTimestamp).getTime(), track };
630
+ }
631
+ return null;
632
+ }
633
+ }
634
+
635
+ module.exports = function (app) {
636
+ const instance = new SignalkToNoforeignland(app);
637
+ return instance.getPluginObject();
638
+ };