signalk-to-noforeignland 0.1.22 → 0.1.24

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.
package/CHANGELOG.md ADDED
@@ -0,0 +1,29 @@
1
+ 0.1.24
2
+ * CHANGE: testInternet only uses ipv4 now, some users don't have ipv6 configured properly and where unable to reach the API, when testInternet returned false
3
+ * NEW: PluginStatus on SK dashboard now shows last savePoint and last API transfer, so a user has more feedback what the app is doing without enabling the debug log and crawling though it.
4
+ * CHANGE: Renamed CHANGELOG to CHANGELOG.md
5
+ * CHANGE: CHANGELOG ORDER - newest on top.
6
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
7
+
8
+ 0.1.23
9
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
10
+
11
+ 0.1.23-beta.1
12
+ * Renamed branch to follow the release versions.
13
+ * CLEANUP - More debug info for the SK dashboard using this.app.setPluginError
14
+ * CLEANUP - Removed CreateGPX, was only used for removed Email transmission of the track
15
+
16
+ 0.1.22-beta.2
17
+
18
+ * CLEANUP and move to Object Oriented Javascript
19
+
20
+ 0.1.22-beta.1
21
+
22
+ * CONFIG: Attempt sending location while moving - Default changed from false to true
23
+ * CONFIG: Ping added for 24h ping if boat is not moved. - Default: true
24
+ * Package.json - Nodemailer dependency removed
25
+ * Marked for removal - Depricated "sendEmailData" function.
26
+ * REMOVED - sendEmail.js
27
+ * CLEANUP - Renamed emaiCron to apiCron
28
+ * NEW: 24h api ping, when enabled, even if boat didn't move.
29
+
package/README.md CHANGED
@@ -1,6 +1,12 @@
1
1
  # SignalK To NFL
2
2
  Effortlessly log your boat's movement to **noforeignland.com**
3
3
 
4
+ ## Testing Notes
5
+ - This version includes experimental features
6
+ - Report issues on GitHub
7
+ - Not recommended for production use
8
+
9
+
4
10
  ## Features
5
11
  * Automatically log your position to NFL
6
12
  * Send detailed tracks to log your entire trip and not just your final position
package/index.js CHANGED
@@ -1,4 +1,3 @@
1
-
2
1
  const { EOL } = require('os');
3
2
  const internetTestAddress = 'google.com';
4
3
  const internetTestTimeout = 1000;
@@ -8,480 +7,486 @@ const CronJob = require('cron').CronJob;
8
7
  const readline = require('readline');
9
8
  const fetch = require('node-fetch');
10
9
  const isReachable = require('is-reachable');
11
- const sendEmail = require('./sendEmail');
12
- const createGPX = require('./createGPX');
10
+
13
11
  const apiUrl = 'https://www.noforeignland.com/home/api/v1/boat/tracking/track';
14
12
  const pluginApiKey = '0ede6cb6-5213-45f5-8ab4-b4836b236f97';
15
- // const msToKn = 1.944;
16
-
17
-
18
- module.exports = function (app) {
19
- var plugin = {};
20
- plugin.id = 'signalk-to-noforeignland';
21
- plugin.name = 'SignalK to Noforeignland';
22
- plugin.description = 'SignalK track logger to noforeignland.com';
23
-
24
- plugin.schema = {
25
- "title": plugin.name,
26
- "description": "Some parameters need for use",
27
- "type": "object",
28
- "required": ["emailCron", "boatApiKey"],
29
- "properties": {
30
- "trackFrequency": {
31
- "type": "integer",
32
- "title": "Position tracking frequency in seconds.",
33
- "description": "To keep file sizes small we only log positions once in a while (unless you set this value to 0)",
34
- "default": 60
35
- },
36
- "minMove": {
37
- "type": "number",
38
- "title": "Minimum boat move to log in meters",
39
- "description": "To keep file sizes small we only log positions if a move larger than this size is noted (if set to 0 will log every move)",
40
- "default": 50
41
- },
42
- "minSpeed": {
43
- "type": "number",
44
- "title": "Minimum boat speed to log in knots",
45
- "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)",
46
- "default": 1.5
47
- },
48
- "emailCron": {
49
- "type": "string",
50
- "title": "Send attempt CRON",
51
- "description": "We send the tracking data to NFL once in a while, you can set the schedule with this setting. CRON format: https://crontab.guru/",
52
- "default": '*/10 * * * *',
53
- },
54
- 'boatApiKey': {
55
- "type": "string",
56
- "title": "Boat API key",
57
- "description": "Boat API key from noforeignland.com. Can be found in Account > Settings > Boat tracking > API Key. *required only in API method is set*",
58
- },
59
- "internetTestTimeout": {
60
- "type": "number",
61
- "title": "Timeout for testing internet connection in ms",
62
- "description": "Set this number higher for slower computers and internet connections",
63
- "default": 2000,
64
- },
65
- "sendWhileMoving": {
66
- "type": "boolean",
67
- "title": "Attempt sending location while moving",
68
- "description": "Should the plugin attempt to send tracking data to NFL while detecting the vessel is moving or only when stopped?",
69
- "default": false
70
- },
71
- "filterSource": {
72
- "type": "string",
73
- "title": "Position source device",
74
- "description": "Set this value to the name of a source if you want to only use the position given by that source.",
75
- },
76
- "trackDir": {
77
- "type": "string",
78
- "title": "Directory to cache tracks.",
79
- "description": "Path in server filesystem, absolute or from plugin directory. optional param (only used to keep file cache).",
80
- },
81
- "keepFiles": {
82
- "type": "boolean",
83
- "title": "Should keep track files on disk?",
84
- "description": "If you have a lot of hard drive space you can keep the track files for logging purposes.",
85
- "default": false
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
+ }
86
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);
87
124
  }
88
- };
89
125
 
90
- var unsubscribes = [];
91
- var unsubscribesControl = [];
92
- var routeSaveName = 'nfl-track.jsonl';
93
- let lastPosition;
94
- let upSince;
95
- let cron;
96
- const creator = 'signalk-track-logger';
97
- const defaultTracksDir = 'track';
98
- // const maxAllowedSpeed = 100;
99
-
100
- plugin.start = function (options, restartPlugin) {
101
- if (!options.trackDir) options.trackDir = defaultTracksDir;
102
- if (!path.isAbsolute(options.trackDir)) options.trackDir = path.join(__dirname, options.trackDir);
103
- //app.debug('options.trackDir=',options.trackDir);
104
- if (!createDir(options.trackDir)) {
105
- plugin.stop();
126
+ if (!this.createDir(this.options.trackDir)) {
127
+ this.stop();
106
128
  return;
107
129
  }
108
130
 
109
- app.debug('track logger started, now logging to', options.trackDir);
110
- app.setPluginStatus(`Started`);
111
-
112
- doLogging();
113
-
114
- function doLogging() {
115
- let shouldDoLog = true
116
- //subscribe for position
117
- app.subscriptionmanager.subscribe({
118
- "context": "vessels.self",
119
- "subscribe": [
120
- {
121
- "path": "navigation.position",
122
- "format": "delta",
123
- "policy": "instant",
124
- "minPeriod": options.trackFrequency ? options.trackFrequency * 1000 : 0,
125
- }
126
- ]
127
- },
128
- unsubscribes,
129
- subscriptionError => {
130
- app.debug('Error subscription to data:' + subscriptionError);
131
- app.setPluginError('Error subscription to data:' + subscriptionError.message);
132
- },
133
- doOnValue
134
- );
135
-
136
- //subscribe for speed
137
- if (options.minSpeed) {
138
- app.subscriptionmanager.subscribe({
139
- "context": "vessels.self",
140
- "subscribe": [
141
- {
142
- "path": "navigation.speedOverGround",
143
- "format": "delta",
144
- "policy": "instant",
145
- }
146
- ]
147
- },
148
- unsubscribes,
149
- subscriptionError => {
150
- app.debug('Error subscription to data:' + subscriptionError);
151
- app.setPluginError('Error subscription to data:' + subscriptionError.message);
152
- },
153
- delta => {
154
- // app.debug('got speed delta', delta);
155
- delta.updates.forEach(update => {
156
- // app.debug(`update:`, update);
157
- if (options.filterSource && update.$source !== options.filterSource) {
158
- return;
159
- }
160
- update.values.forEach(value => {
161
- // value.value is sog in m/s so 'sog*2' is in knots
162
- if (!shouldDoLog && options.minSpeed < value.value * 2) {
163
- app.debug('setting shouldDoLog to true');
164
- shouldDoLog = true;
165
- }
166
- })
167
- })
168
- }
169
- );
170
- }
171
-
172
- async function doOnValue(delta) {
131
+ this.app.debug('track logger started, now logging to', this.options.trackDir);
132
+ this.app.setPluginStatus(`Started`);
133
+ this.upSince = new Date().getTime();
173
134
 
174
- for (update of delta.updates) {
175
- // app.debug(`update:`, update);
176
- if (options.filterSource && update.$source !== options.filterSource) {
177
- return;
178
- }
179
- let timestamp = update.timestamp;
180
- for (value of update.values) {
181
-
182
-
183
- if (
184
- Math.abs(value.value.latitude) <= 0.01 &&
185
- Math.abs(value.value.longitude) <= 0.01
186
- ) {
187
- // Coordinates are within ±0.1 of (0,0)
188
- return;
189
- }
190
-
191
- // app.debug(`value:`, value);
192
-
193
- if (!shouldDoLog) {
194
- return;
195
- }
196
- if (!isValidLatitude(value.value.latitude) || !isValidLongitude(value.value.longitude)) {
197
- return;
198
- }
199
-
200
-
201
- if (lastPosition) {
202
- if (new Date(lastPosition.timestamp).getTime() > new Date(timestamp).getTime()) {
203
- app.debug('got error in timestamp:', timestamp, 'is earlier than previous:', lastPosition.timestamp);
204
- // SK sometimes messes up timestamps, when that happens we throw the update
205
- return;
206
- }
207
- const distance = equirectangularDistance(lastPosition.pos, value.value)
208
- if (options.minMove && distance < options.minMove) {
209
- return;
210
- }
211
- // if (calculatedSpeed(distance, (timestamp - lastPosition.timestamp) / 1000) > maxAllowedSpeed) {
212
- // app.debug('got error position', value.value, 'ignoring...');
213
- // return;
214
- // }
215
- }
216
- lastPosition = { pos: value.value, timestamp, currentTime: new Date().getTime() };
217
-
218
- await savePoint(lastPosition);
219
- if (options.minSpeed) {
220
- app.debug('setting shouldDoLog to false');
221
- shouldDoLog = false;
222
- }
223
- };
224
- };
225
- }
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 * * * *`;
226
140
  }
227
141
 
228
- async function savePoint(point) {
229
- //{pos: {latitude, longitude}, timestamp}
230
- // Date.parse(timestamp)
231
- const obj = {
232
- lat: point.pos.latitude,
233
- lon: point.pos.longitude,
234
- t: point.timestamp,
235
- }
236
- app.debug(`save data point:`, obj);
237
- await fs.appendFile(path.join(options.trackDir, routeSaveName), JSON.stringify(obj) + EOL);
238
- }
142
+ this.app.debug('Setting CRON to ', this.options.apiCron);
239
143
 
240
- function isValidLatitude(obj) {
241
- return isDefinedNumber(obj) && obj > -90 && obj < 90
242
- }
144
+ // subscribe and logging
145
+ this.doLogging();
243
146
 
244
- function isValidLongitude(obj) {
245
- return isDefinedNumber(obj) && obj > -180 && obj < 180
246
- }
147
+ // start cron job
148
+ this.cron = new CronJob(this.options.apiCron, this.interval.bind(this));
149
+ this.cron.start();
150
+ }
247
151
 
248
- function isDefinedNumber(obj) {
249
- return (obj !== undefined && obj !== null && typeof obj === 'number');
152
+ stop() {
153
+ this.app.debug('plugin stopped');
154
+ if (this.cron) {
155
+ this.cron.stop();
156
+ this.cron = undefined;
250
157
  }
251
-
252
- // function calculatedSpeed(distance, timeSecs) {
253
- // // m/s to knots ~= speedinms * 1.944
254
- // return (distance / timeSecs) * msToKn
255
- // }
256
-
257
- function equirectangularDistance(from, to) {
258
- // https://www.movable-type.co.uk/scripts/latlong.html
259
- // from,to: {longitude: xx, latitude: xx}
260
- const rad = Math.PI / 180;
261
- const φ1 = from.latitude * rad;
262
- const φ2 = to.latitude * rad;
263
- const Δλ = (to.longitude - from.longitude) * rad;
264
- const R = 6371e3;
265
- const x = Δλ * Math.cos((φ1 + φ2) / 2);
266
- const y = (φ2 - φ1);
267
- const d = Math.sqrt(x * x + y * y) * R;
268
- return d;
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
+ });
269
208
  }
209
+ }
270
210
 
271
- function createDir(dir) {
272
- let res = true;
273
- if (fs.existsSync(dir)) {
274
- try {
275
- fs.accessSync(dir, fs.constants.R_OK | fs.constants.W_OK);
276
- }
277
- catch (error) {
278
- app.debug('[createDir]', error.message);
279
- app.setPluginError(`No rights to directory ${dir}`);
280
- res = false;
281
- }
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;
282
222
  }
283
- else {
284
- try {
285
- fs.mkdirSync(dir, { recursive: true });
286
- }
287
- catch (error) {
288
- switch (error.code) {
289
- case 'EACCES': // Permission denied
290
- case 'EPERM': // Operation not permitted
291
- app.debug(`False to create ${dir} by Permission denied`);
292
- app.setPluginError(`False to create ${dir} by Permission denied`);
293
- res = false;
294
- break;
295
- case 'ETIMEDOUT': // Operation timed out
296
- app.debug(`False to create ${dir} by Operation timed out`);
297
- app.setPluginError(`False to create ${dir} by Operation timed out`);
298
- res = false;
299
- break;
300
- }
301
- }
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;
302
228
  }
303
- return res;
304
- } // end function createDir
305
229
 
306
- async function interval() {
307
- if ((checkBoatMoving()) && await checkTrack() && await testInternet()) {
308
- await sendData();
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
+ }
309
238
  }
310
- }
311
239
 
312
- function checkBoatMoving() {
313
- if (options.sendWhileMoving || !options.trackFrequency) {
314
- return true;
315
- }
316
- const time = lastPosition ? lastPosition.currentTime : upSince;
317
-
318
- const secsSinceLastPoint = (new Date().getTime() - time)/1000
319
- if (secsSinceLastPoint > (options.trackFrequency * 2)) {
320
- app.debug('Boat stopped moving, last move at least', secsSinceLastPoint,'seconds ago');
321
- return true;
322
- } else {
323
- app.debug('Boat is still moving, last move', secsSinceLastPoint,'seconds ago');
324
- return false;
240
+ // Wenn wir nicht loggen sollen UND es kein 24h-Force ist, dann raus
241
+ if (!force24hSave && !getShouldDoLog()) {
242
+ return;
325
243
  }
326
- }
327
244
 
328
- async function testInternet() {
329
- app.debug('testing internet connection');
330
- const check = await isReachable(internetTestAddress, { timeout: options.internetTestTimeout || internetTestTimeout });
331
- app.debug('internet connection = ', check);
332
- return check;
333
- }
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
+ }
334
260
 
335
- async function checkTrack() {
336
- const trackFile = path.join(options.trackDir, routeSaveName);
337
- app.debug('checking the track', trackFile, 'if should send');
338
- const exists = await fs.pathExists(trackFile);
339
- const size = exists ? (await fs.lstat(trackFile)).size : 0;
340
- app.debug(`'${trackFile}'.size=${size} ${trackFile}'.exists=${exists}`);
341
- return size > 0;
342
- }
261
+ // Punkt speichern
262
+ this.lastPosition = { pos: value.value, timestamp, currentTime: new Date().getTime() };
263
+ await this.savePoint(this.lastPosition);
343
264
 
344
- async function sendData() {
345
- if (options.boatApiKey) {
346
- sendApiData();
347
- } else {
348
- sendEmailData();
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);
349
269
  }
350
270
  }
271
+ }}
351
272
 
352
- async function sendApiData() {
353
- app.debug('sending the data');
354
- const trackData = await createTrack(path.join(options.trackDir, routeSaveName));
355
- if (!trackData) {
356
- app.debug('Recorded track did not contain any valid track points, aborting sending.');
357
- return;
358
- }
359
- app.debug('created track data with timestamp:', new Date(trackData.timestamp));
360
-
361
- const params = new URLSearchParams();
362
- params.append('timestamp', trackData.timestamp);
363
- params.append('track', JSON.stringify(trackData.track));
364
- params.append('boatApiKey', options.boatApiKey);
365
273
 
366
- const headers = {
367
- 'X-NFL-API-Key': pluginApiKey
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;
368
320
  }
369
-
370
- app.debug('sending track to API');
321
+ } else {
371
322
  try {
372
- const response = await fetch(apiUrl, { method: 'POST', body: params, headers: new fetch.Headers(headers) });
373
- if (response.ok) {
374
- const responseBody = await response.json();
375
- if (responseBody.status === 'ok') {
376
- app.debug('Track successfully sent to API');
377
- if (options.keepFiles) {
378
- const filename = new Date().toJSON().slice(0, 19).replace(/:/g, '') + '-nfl-track.jsonl';
379
- app.debug('moving and keeping track file: ', filename);
380
- await fs.move(path.join(options.trackDir, routeSaveName), path.join(options.trackDir, filename));
381
- } else {
382
- app.debug('Deleting track file');
383
- await fs.remove(path.join(options.trackDir, routeSaveName));
384
- }
385
- } else {
386
- app.debug('Could not send track to API, returned response json:', responseBody);
387
- }
388
- } else {
389
- app.debug('Could not send track to API, returned response code:', response.status, response.statusText);
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;
390
341
  }
391
- } catch (err) {
392
- app.debug('Could not send track to API due to error:', err);
393
342
  }
394
343
  }
344
+ return res;
345
+ }
395
346
 
396
- async function createTrack(inputPath) {
397
- const fileStream = fs.createReadStream(inputPath);
398
-
399
- const rl = readline.createInterface({
400
- input: fileStream,
401
- crlfDelay: Infinity
402
- });
403
- const track = []
404
- let lastTimestamp;
405
- for await (const line of rl) {
406
- if (line) {
407
- try {
408
- const point = JSON.parse(line);
409
-
410
- const timestamp = new Date(point.t).getTime();
411
- if (!isNaN(timestamp) && isValidLatitude(point.lat) && isValidLongitude(point.lon)) {
412
- track.push([timestamp, point.lat, point.lon]);
413
- lastTimestamp = timestamp;
414
- }
415
-
416
- } catch (error) {
417
- app.debug('could not parse line from track file:', line);
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));
418
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.`);
419
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.`);
420
455
  }
421
- if (track.length > 0) {
422
- return { timestamp: new Date(lastTimestamp).getTime(), track };
423
- }
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.`);
424
459
  }
425
-
426
- async function sendEmailData() {
427
- app.debug('sending the data');
428
- const gpxFiles = await createGPX({ input: path.join(options.trackDir, routeSaveName), outputDir: options.trackDir, creator });
429
- app.debug('created GPX files', gpxFiles);
430
- try {
431
- for (let file of gpxFiles) {
432
- app.debug('sending', file);
433
- try {
434
- !await sendEmail({
435
- emailService: options.emailService,
436
- user: options.emailUser,
437
- password: options.emailPassword,
438
- from: options.emailFrom,
439
- to: options.emailTo,
440
- trackFile: file
441
- })
442
- } catch (err) {
443
- app.debug('Sending email failed:', err);
444
- return;
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;
445
475
  }
446
- }
447
- } finally {
448
- for (let file of gpxFiles) {
449
- app.debug('deleting', file);
450
- await fs.rm(file);
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.`);
451
479
  }
452
480
  }
453
- await fs.rm(path.join(options.trackDir, routeSaveName));
454
481
  }
455
- //every 10 minute but staggered to the second so we don't all send at once.
456
- if (!options.emailCron || options.emailCron === '*/10 * * * *') {
457
- const startMinute = Math.floor(Math.random() * 10); // Random minute within the 10-minute range
458
- const startSecond = Math.floor(Math.random() * 60); // Random second within the minute
459
- options.emailCron = `${startSecond} ${startMinute}/10 * * * *`; // Every 10 minutes, starting at a random minute and second within each 10-minute block
460
- }
461
-
462
- upSince = new Date().getTime();
463
-
464
- app.debug('Setting CRON to ', options.emailCron);
465
- cron = new CronJob(
466
- options.emailCron,
467
- interval
468
- );
469
- cron.start();
470
- }; // end plugin.start
471
-
472
- plugin.stop = function () {
473
- app.debug('plugin stopped');
474
- if (cron) {
475
- cron.stop();
476
- cron = undefined;
482
+ if (track.length > 0) {
483
+ return { timestamp: new Date(lastTimestamp).getTime(), track };
477
484
  }
478
- unsubscribesControl.forEach(f => f());
479
- unsubscribesControl = [];
480
- unsubscribes.forEach(f => f());
481
- unsubscribes = [];
482
- app.setPluginStatus('Plugin stopped');
483
- }; // end plugin.stop
485
+ return null;
486
+ }
487
+ }
484
488
 
485
-
486
- return plugin;
489
+ module.exports = function (app) {
490
+ const instance = new SignalkToNoforeignland(app);
491
+ return instance.getPluginObject();
487
492
  };
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "signalk-to-noforeignland",
3
- "version": "0.1.22",
3
+ "version": "0.1.24",
4
4
  "description": "SignalK track logger to noforeignland.com ",
5
5
  "main": "index.js",
6
6
  "keywords": [
7
7
  "signalk-node-server-plugin",
8
8
  "signalk-category-utility"
9
9
  ],
10
- "author": "Ian Miller",
10
+ "author": "Dirk Wahrheit",
11
11
  "homepage": "https://github.com/noforeignland/nfl-signalk",
12
12
  "bugs": {
13
13
  "url": "https://github.com/noforeignland/nfl-signalk/issues"
@@ -23,7 +23,6 @@
23
23
  "cron": "^2.1.0",
24
24
  "fs-extra": "^10.1.0",
25
25
  "is-reachable": "^5.2.1",
26
- "node-fetch": "^2.6.7",
27
- "nodemailer": "^6.8.0"
26
+ "node-fetch": "^2.6.7"
28
27
  }
29
28
  }
package/createGPX.js DELETED
@@ -1,48 +0,0 @@
1
- const fs = require('fs-extra');
2
- const path = require('path');
3
- const readline = require('readline');
4
-
5
- async function createGPX(options) {
6
- await writeHeader(options);
7
- const fileStream = fs.createReadStream(options.input);
8
-
9
- const rl = readline.createInterface({
10
- input: fileStream,
11
- crlfDelay: Infinity
12
- });
13
-
14
- for await (const line of rl) {
15
- if (line){
16
- const point = JSON.parse(line);
17
- let trkpt = ' <trkpt ';
18
- trkpt += `lat="${point.lat}" lon="${point.lon}">\n`;
19
- trkpt += ` <time>${point.t}</time>\n`;
20
- trkpt += ' </trkpt>\n';
21
- fs.appendFileSync(path.join(options.outputDir, 'track.gpx'), trkpt);
22
- }
23
- }
24
- await writeFooter(options);
25
- return [path.join(options.outputDir, 'track.gpx')];
26
- }
27
-
28
- async function writeHeader(options) {
29
- const header = `<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
30
- <gpx version="1.1" creator="${options.creator}"
31
- xmlns="http://www.topografix.com/GPX/1/1"
32
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
33
- xmlns:gpxx="http://www8.garmin.com/xmlschemas/GpxExtensions/v3"
34
- xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd https://www8.garmin.com/xmlschemas/GpxExtensions/v3 https://www8.garmin.com/xmlschemas/GpxExtensions/v3/GpxExtensionsv3.xsd"
35
- >
36
- <metadata/>
37
- <trk>
38
- <trkseg>
39
- `;
40
- fs.writeFileSync(path.join(options.outputDir, 'track.gpx'), header);
41
- }
42
-
43
- async function writeFooter(options) {
44
- const footer = ' </trkseg>\n </trk>\n</gpx>';
45
- fs.appendFileSync(path.join(options.outputDir, 'track.gpx'), footer);
46
- }
47
-
48
- module.exports = createGPX;
package/sendEmail.js DELETED
@@ -1,24 +0,0 @@
1
- const nodemailer = require('nodemailer');
2
-
3
- async function sendEmail(options) {
4
- const mail = nodemailer.createTransport({
5
- service: options.emailService,
6
- auth: {
7
- user: options.user,
8
- pass: options.password,
9
- }
10
- });
11
- var mailOptions = {
12
- from: options.from,
13
- to: options.to,
14
- subject: `GPX ${(new Date()).toISOString()}`,
15
- text: 'Generated by SignalK Tracker',
16
- attachments: [{ // file on disk as an attachment
17
- filename: 'track.gpx',
18
- path: options.trackFile // stream this file
19
- }],
20
- };
21
- await mail.sendMail(mailOptions);
22
- }
23
-
24
- module.exports = sendEmail;