@noforeignland/signalk-to-noforeignland 1.1.0 → 1.2.0-beta.2

package/doc/beta_install_cerbo.md

@@ -1,127 +0,0 @@
-How-to install the latest beta or dev tree (unstable) on your device?
-
-This guide assumes you have a default install with default folders.
-This is written for a Victron Cerbo GX jump to the section you need want to go to.
-It is recommended to enable the Debug Log for this plugin in Server -> Plugin Config before updating.
-
-
-# Pre-requirements
-On the Cerbo GUI enable SSH access and set a afmin password
-Windows User: Download putty (for ssh) and Winscp (for secure fie copy)
-
-## On GUI v1:
-1. Click "Menu" (bottom right)
-2. Settings > General
-3. Set root password
-4. Enable "SSH on LAN"
-
-## On GUI v2:
-1. Settings -> General
-2. Set root password
-3. Enable "SSH on LAN"
-
-
-# Backup old data
-
-## BEST + SLOW: Full signalk copy to local computer 
-1. Connect your Cerbo with WinSCP
-2. Copy the folder "/data/conf/signalk" to your local PC
-
-## Alternative Cerbo has a SD Card connected:
-1.  ssh to the Cerbo
-```
-df -h
-   # showns for me that /dev/mmcblk0p1 has 29GB free and is mounted to /run/media/mmcblk0p1
-   # This is a SD card that is manually inserted. 
-
-mount 
-   # confirms this for me with output:
-   # /dev/mmcblk0p1 on /run/media/mmcblk0p1 type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=iso8859-1,shortname=mixed,errors=remount-ro)
-
-cp -r /data/conf/signalk /run/media/mmcblk0p1/signalk-backup
-   # copies the files for you, it will take some time, as the CPU and IO are not the fastest
-
-ls –la  /run/media/mmcblk0p1/signalk-backup
-   # Verify that folder and files exist.
-```
-
-
-# npmjs beta on Cerbo
-
-## Install latest beta
-1. SSH to the Cerbo:
-```
-cd /data/conf/signalk
-
-npm i @noforeignland/signalk-to-noforeignland@beta
-
-# reset owner properly, else package belongs to root
-chown -R signalk:signalk /data/conf/signalk/*
-
-```
-
-2. Restart Server & Check logs
-```
- svc -t /service/signalk-server
-```
-
-
-## Install specific beta version f.e. 1.0.1-beta.5
-1. SSH to the Cerbo:
-```
-cd /data/conf/signalk
-
-# Here use the beta version you want to install
-npm i @noforeignland/signalk-to-noforeignland@1.0.1-beta.5
-
-# reset owner properly, else package belongs to root
-chown -R signalk:signalk /data/conf/signalk/*
-
-```
-2. Restart Server & Check logs
-```
- svc -t /service/signalk-server
-```
-
-
-# dev tree (unstable) install - NOT RECOMMENDED
-
-1. Backup as above 
-
-2. Get new files from repo (main for latest)
-
-```
-cd ~
-mkdir dev
-cd dev
-wget  https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
-unzip main.zip
-cd nfl-signalk-main/
-npm pack
-
-cd /data/conf/signalk
-npm install ~/dev/nfl-signalk-main/<your_npm_pack.tgz>
-
-# reset owner properly, else package belongs to root
-chown -R signalk:signalk /data/conf/signalk/*
-
-```
-
-3. Restart Server & Check logs
-```
-svc -t /service/signalk-server
-```
-
-# Manual Fixes
-
-## WARNING: found multiple copies of plugin with id signalk-to-noforeignland at /data/conf/signalk/node_modules/ and /data/conf/signalk/node_modules/
-
-```
-cd /data/conf/signalk && npm uninstall signalk-to-noforeignland signalk-to-nfl
-```
-
-and than
-
-```
-svc -t /service/signalk-server
-```

package/doc/beta_install_rpi.md

@@ -1,64 +0,0 @@
-How-to install the latest beta or dev tree (unstable) on your device?
-
-This guide assumes you have a default install with default folders.
-This is written for a RPI, jump to the section you need want to go to.
-It is recommended to enable the Debug Log for this plugin in Server -> Plugin Config before updating.
-
-
-# Backup old data
-```
-cp -a ~/.signalk ~/signalk-backup
-```
-
-# npmjs beta on RPI
-
-## Install latest beta
-```
-cd ~.signalk
-
-npm i @noforeignland/signalk-to-noforeignland@beta
-
-sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
-```
-
-## Install a specific beta
-```
-cd ~.signalk
-
-# Here use the beta version you want to install
-npm i @noforeignland/signalk-to-noforeignland@1.0.1-beta.5
-
-sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
-```
-
---------------------------
-
-# dev tree (unstable) - NOT RECOMMENDED
-1. Backup old data
-
-```
-cd ~
-cp -a .signalk/ signalk-backup
-```
-
-2.  Get new files from repo (main for latest)
-
-```
-cd ~
-mkdir dev
-cd dev
-wget  https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
-unzip main.zip
-cd nfl-signalk-main/
-npm pack
-
-cd ~/.signalk
-npm install ~/dev/nfl-signalk-main/<your_npm_pack.tgz>
-```
-
-3.  Restart Server & Check logs
-
-```
-sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
-```
-

package/index.js

@@ -1,295 +0,0 @@
-const CronJob = require('cron').CronJob;
-
-// Import all modules
-const ConfigManager = require('./lib/ConfigManager');
-const PluginCleanup = require('./lib/PluginCleanup');
-const TrackMigration = require('./lib/TrackMigration');
-const TrackLogger = require('./lib/TrackLogger');
-const TrackSender = require('./lib/TrackSender');
-const HealthMonitor = require('./lib/HealthMonitor');
-const DataPathEmitter = require('./lib/DataPathEmitter');
-const DirectoryUtils = require('./lib/DirectoryUtils');
-
-class SignalkToNoforeignland {
-  constructor(app) {
-    this.app = app;
-    this.pluginId = 'signalk-to-noforeignland';
-    this.pluginName = 'Signal K to Noforeignland';
-
-    // Runtime state
-    this.options = {};
-    this.upSince = null;
-    this.cron = null;
-    this.lastSuccessfulTransfer = null;
-    
-    // Module instances
-    this.configManager = new ConfigManager(app);
-    this.pluginCleanup = new PluginCleanup(app);
-    this.dataPathEmitter = new DataPathEmitter(app, this.pluginId);
-    this.trackLogger = null;
-    this.trackSender = null;
-    this.healthMonitor = null;
-    this.trackMigration = null;
-  }
-
-  /**
-   * Get plugin schema
-   */
-  getSchema() {
-    return ConfigManager.getSchema(this.pluginName);
-  }
-
-  /**
-   * Get plugin object for SignalK
-   */
-  getPluginObject() {
-    return {
-      id: this.pluginId,
-      name: this.pluginName,
-      description: 'SignalK track logger to noforeignland.com',
-      schema: this.getSchema(),
-      start: this.start.bind(this),
-      stop: this.stop.bind(this)
-    };
-  }
-
-  /**
-   * Start the plugin
-   */
-  async start(options = {}, restartPlugin) {
-    try {
-      // 1. Migrate old config structure if needed
-      const { options: migratedOptions, migrated } = await this.configManager.migrateOldConfig(options);
-      options = migratedOptions;
-      
-      // 2. Flatten config and apply defaults
-      this.options = this.configManager.flattenConfig(options);
-      
-      // 3. Validate API key
-      try {
-        this.configManager.validateApiKey(this.options);
-      } catch (err) {
-        this.app.debug(err.message);
-        this.setPluginError(err.message);
-        this.stop();
-        return;
-      }
-      
-      // 4. Resolve track directory path
-      const dataDirPath = this.app.getDataDirPath();
-      this.options.trackDir = this.configManager.resolveTrackDir(this.options, dataDirPath);
-      
-      // 5. Create track directory
-      try {
-        DirectoryUtils.createDir(this.options.trackDir, this.app);
-      } catch (err) {
-        this.setPluginError(err.message);
-        this.stop();
-        return;
-      }
-      
-      // 6. Cleanup old plugin versions (with callback handling)
-      this.pluginCleanup.cleanup()
-        .then((result) => {
-          if (result === 'all_removed') {
-            this.app.debug('Old plugins successfully cleaned up');
-            // Update status if plugin started successfully
-            if (this.options.boatApiKey) {
-              this.setPluginStatus('Started (old plugins cleaned up)');
-            }
-          }
-        })
-        .catch(err => {
-          this.app.debug('Error in cleanupOldPlugin:', err.message);
-        });
-      
-      // 7. Migrate old track files
-      this.trackMigration = new TrackMigration(this.app, this.options.trackDir);
-      await this.trackMigration.migrate();
-      
-      // 8. Initialize modules
-      this.trackLogger = new TrackLogger(this.app, this.options, this.options.trackDir);
-      this.trackSender = new TrackSender(this.app, this.options, this.options.trackDir);
-      this.healthMonitor = new HealthMonitor(this.app, this.options);
-      
-      // 9. Update startup time and randomize CRON
-      this.upSince = new Date().getTime();
-      this.options = this.configManager.randomizeCron(this.options);
-      
-      this.app.debug('Setting CRON to', this.options.apiCron);
-      this.app.debug('trackFrequency is set to', this.options.trackFrequency, 'seconds');
-      this.app.debug('track logger started, now logging to', this.options.trackDir);
-      
-      // 10. Start logging
-      this.trackLogger.startLogging((lastPosition) => {
-        this.handleSavePoint(lastPosition);
-      });
-      
-      // 11. Start CRON job for sending data
-      this.cron = new CronJob(this.options.apiCron, this.interval.bind(this));
-      this.cron.start();
-      
-      // 12. Start health monitoring
-      this.healthMonitor.start(
-        () => this.trackLogger.getLastPositionReceived(),
-        () => this.trackLogger.getAutoSelectedSource(),
-        (errorMsg) => this.setPluginError(errorMsg),
-        () => this.handleHealthy()
-      );
-      
-      // 13. Set plugin status
-      this.setPluginStatus(`Started${migrated ? ' (config migrated)' : ''}`);
-      
-    } catch (err) {
-      this.app.debug('Error during plugin start:', err.message);
-      this.setPluginError(`Failed to start: ${err.message}`);
-      this.stop();
-    }
-  }
-
-  /**
-   * Handle savepoint event
-   */
-  handleSavePoint(lastPosition) {
-    const now = new Date();
-    this.dataPathEmitter.emitSavepoint();
-    
-    // Update plugin status
-    const activeSource = this.options.filterSource || this.trackLogger.getAutoSelectedSource() || '';
-    const sourcePrefix = activeSource ? `${activeSource} | ` : '';
-    const saveTime = now.toISOString();
-    const transferTime = this.lastSuccessfulTransfer 
-      ? this.lastSuccessfulTransfer.toISOString() 
-      : 'None since start';
-    
-    this.setPluginStatus(`Save: ${saveTime} | Transfer: ${transferTime} | ${sourcePrefix}`);
-  }
-
-  /**
-   * Handle healthy status from health monitor
-   */
-  handleHealthy() {
-    // Clear error if position health is OK
-    if (this.dataPathEmitter.getError()) {
-      const lastPosition = this.trackLogger.getLastPosition();
-      const activeSource = this.options.filterSource || this.trackLogger.getAutoSelectedSource() || '';
-      const sourcePrefix = activeSource ? `${activeSource} | ` : '';
-      const saveTime = lastPosition 
-        ? new Date(lastPosition.currentTime).toISOString() 
-        : 'None since start';
-      const transferTime = this.lastSuccessfulTransfer 
-        ? this.lastSuccessfulTransfer.toISOString() 
-        : 'None since start';
-      
-      this.setPluginStatus(`Save: ${saveTime} | Transfer: ${transferTime} | ${sourcePrefix}`);
-    }
-  }
-
-  /**
-   * CRON interval - check and send data
-   */
-  async interval() {
-    try {
-      // Check if boat is moving
-      const lastPosition = this.trackLogger.getLastPosition();
-      const boatMoving = this.trackSender.isBoatMoving(lastPosition, this.upSince);
-      if (!boatMoving) {
-        return;
-      }
-      
-      // Check if we have track data
-      const hasTrack = await this.trackSender.hasTrackData();
-      if (!hasTrack) {
-        return;
-      }
-
-      // Send track data (has built-in retry logic)
-      const success = await this.trackSender.sendTrack();
-      
-      if (success) {
-        this.lastSuccessfulTransfer = new Date();
-        this.dataPathEmitter.emitApiTransfer(this.lastSuccessfulTransfer);
-        
-        // Update status
-        const activeSource = this.options.filterSource || this.trackLogger.getAutoSelectedSource() || '';
-        const sourcePrefix = activeSource ? `${activeSource} | ` : '';
-        const saveTime = lastPosition 
-          ? new Date(lastPosition.currentTime).toISOString() 
-          : 'None since start';
-        const transferTime = this.lastSuccessfulTransfer.toISOString();
-        
-        this.setPluginStatus(`Save: ${saveTime} | Transfer: ${transferTime} | ${sourcePrefix}`);
-      }
-      
-    } catch (err) {
-      this.app.debug('Error during send interval:', err.message);
-      this.setPluginError(`Failed to send track - ${err.message}`);
-    }
-  }
-
-  /**
-   * Stop the plugin
-   */
-  stop() {
-    this.app.debug('plugin stopped');
-    
-    // Stop CRON job
-    if (this.cron) {
-      this.cron.stop();
-      this.cron = undefined;
-    }
-    
-    // Stop track logger
-    if (this.trackLogger) {
-      this.trackLogger.stop();
-    }
-    
-    // Stop health monitor
-    if (this.healthMonitor) {
-      this.healthMonitor.stop();
-    }
-    
-    this.app.setPluginStatus('Plugin stopped');
-  }
-
-  /**
-   * Set plugin status and update data paths
-   */
-  setPluginStatus(status) {
-    this.dataPathEmitter.clearError();
-    this.app.setPluginStatus(status);
-    
-    const lastPosition = this.trackLogger ? this.trackLogger.getLastPosition() : null;
-    const autoSelectedSource = this.trackLogger ? this.trackLogger.getAutoSelectedSource() : null;
-    
-    this.dataPathEmitter.updateStatusPaths(
-      this.options,
-      lastPosition,
-      this.lastSuccessfulTransfer,
-      autoSelectedSource
-    );
-  }
-
-  /**
-   * Set plugin error and update data paths
-   */
-  setPluginError(error) {
-    this.dataPathEmitter.setError(error);
-    this.app.setPluginError(error);
-    
-    const lastPosition = this.trackLogger ? this.trackLogger.getLastPosition() : null;
-    const autoSelectedSource = this.trackLogger ? this.trackLogger.getAutoSelectedSource() : null;
-    
-    this.dataPathEmitter.updateStatusPaths(
-      this.options,
-      lastPosition,
-      this.lastSuccessfulTransfer,
-      autoSelectedSource
-    );
-  }
-}
-
-module.exports = function (app) {
-  const instance = new SignalkToNoforeignland(app);
-  return instance.getPluginObject();
-};

package/lib/ConfigManager.js

@@ -1,216 +0,0 @@
-const path = require('path');
-
-const defaultTracksDir = 'nfl-track';
-
-class ConfigManager {
-  constructor(app) {
-    this.app = app;
-  }
-
-  /**
-   * Migrate old flat config structure to new grouped structure
-   */
-  async migrateOldConfig(options) {
-    if (options.boatApiKey && !options.mandatory) {
-      this.app.debug('Migrating old configuration to new grouped structure');
-      
-      const migratedOptions = {
-        mandatory: {
-          boatApiKey: options.boatApiKey
-        },
-        advanced: {
-          minMove: options.minMove !== undefined ? options.minMove : 50,
-          minSpeed: options.minSpeed !== undefined ? options.minSpeed : 1.5,
-          sendWhileMoving: options.sendWhileMoving !== undefined ? options.sendWhileMoving : true,
-          ping_api_every_24h: options.ping_api_every_24h !== undefined ? options.ping_api_every_24h : true
-        },
-        expert: {
-          filterSource: options.filterSource,
-          trackDir: options.trackDir,
-          keepFiles: options.keepFiles !== undefined ? options.keepFiles : false,
-          trackFrequency: options.trackFrequency !== undefined ? options.trackFrequency : 60,
-          internetTestTimeout: options.internetTestTimeout !== undefined ? options.internetTestTimeout : 2000,
-          apiCron: options.apiCron || '*/10 * * * *',
-          apiTimeout: options.apiTimeout !== undefined ? options.apiTimeout : 30
-        }
-      };
-      
-      try {
-        this.app.debug('Saving migrated configuration...');
-        await this.app.savePluginOptions(migratedOptions, () => {
-          this.app.debug('Configuration successfully migrated and saved');
-        });
-        return { options: migratedOptions, migrated: true };
-      } catch (err) {
-        this.app.debug('Failed to save migrated configuration:', err.message);
-        return { options: migratedOptions, migrated: true };
-      }
-    }
-    
-    return { options, migrated: false };
-  }
-
-  /**
-   * Flatten nested config structure and apply defaults
-   */
-  flattenConfig(options) {
-    return {
-      boatApiKey: options.mandatory?.boatApiKey,
-      minMove: options.advanced?.minMove !== undefined ? options.advanced.minMove : 80,
-      minSpeed: options.advanced?.minSpeed !== undefined ? options.advanced.minSpeed : 1.5,
-      sendWhileMoving: options.advanced?.sendWhileMoving !== undefined ? options.advanced.sendWhileMoving : true,
-      ping_api_every_24h: options.advanced?.ping_api_every_24h !== undefined ? options.advanced.ping_api_every_24h : true,
-      filterSource: options.expert?.filterSource,
-      trackDir: options.expert?.trackDir || defaultTracksDir,
-      keepFiles: options.expert?.keepFiles !== undefined ? options.expert.keepFiles : false,
-      trackFrequency: options.expert?.trackFrequency !== undefined ? options.expert.trackFrequency : 60,
-      internetTestTimeout: options.expert?.internetTestTimeout !== undefined ? options.expert.internetTestTimeout : 2000,
-      apiCron: options.expert?.apiCron || '*/10 * * * *',
-      apiTimeout: options.expert?.apiTimeout !== undefined ? options.expert.apiTimeout : 30
-    };
-  }
-
-  /**
-   * Validate boat API key
-   */
-  validateApiKey(config) {
-    if (!config.boatApiKey || config.boatApiKey.trim() === '') {
-      throw new Error(
-        '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.'
-      );
-    }
-  }
-
-  /**
-   * Resolve track directory path (absolute or relative to data dir)
-   */
-  resolveTrackDir(config, dataDirPath) {
-    if (!path.isAbsolute(config.trackDir)) {
-      return path.join(dataDirPath, config.trackDir);
-    }
-    return config.trackDir;
-  }
-
-  /**
-   * Randomize CRON schedule to avoid all instances running at same time
-   */
-  randomizeCron(config) {
-    if (!config.apiCron || config.apiCron === '*/10 * * * *') {
-      const startMinute = Math.floor(Math.random() * 10);
-      const startSecond = Math.floor(Math.random() * 60);
-      config.apiCron = `${startSecond} ${startMinute}/10 * * * *`;
-    }
-    return config;
-  }
-
-  /**
-   * Get the full schema for plugin configuration
-   */
-  static getSchema(pluginName) {
-    return {
-      title: pluginName,
-      description: 'Some parameters need for use',
-      type: 'object',
-      properties: {
-        // Mandatory Settings Group
-        mandatory: {
-          type: 'object',
-          title: 'Mandatory Settings',
-          properties: {
-            boatApiKey: {
-              type: 'string',
-              title: 'Boat API Key',
-              description: 'Boat API Key from noforeignland.com. Can be found in Account > Settings > Boat tracking > API Key.'
-            }
-          }
-        },
-        
-        // Advanced Settings Group
-        advanced: {
-          type: 'object',
-          title: 'Advanced Settings',
-          properties: {
-            minMove: {
-              type: 'number',
-              title: 'Minimum boat move to log in meters',
-              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)',
-              default: 80
-            },
-            minSpeed: {
-              type: 'number',
-              title: 'Minimum boat speed to log in knots',
-              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)',
-              default: 1.5
-            },
-            sendWhileMoving: {
-              type: 'boolean',
-              title: 'Attempt sending location while moving',
-              description: 'Should the plugin attempt to send tracking data to NFL while detecting the vessel is moving or only when stopped?',
-              default: true
-            },
-            ping_api_every_24h: {
-              type: 'boolean',
-              title: 'Force a send every 24 hours',
-              description: 'Keeps your boat active on NFL in your current location even if you do not move',
-              default: true
-            }
-          }
-        },
-        
-        // Expert Settings Group
-        expert: {
-          type: 'object',
-          title: 'Expert Settings',
-          properties: {
-            filterSource: {
-              type: 'string',
-              title: 'Position source device',
-              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.'
-            },
-            trackDir: {
-              type: 'string',
-              title: 'Directory to cache tracks',
-              description: 'EMPTY DEFAULT IS FINE - Path to store track data. Relative paths are stored in plugin data directory. Absolute paths can point anywhere.\nDefault: nfl-track'
-            },
-            keepFiles: {
-              type: 'boolean',
-              title: 'Keep track files on disk',
-              description: 'If you have a lot of hard drive space you can keep the track files for logging purposes.',
-              default: false
-            },
-            trackFrequency: {
-              type: 'integer',
-              title: 'Position tracking frequency in seconds',
-              description: 'To keep file sizes small we only log positions once in a while (unless you set this value to 0)',
-              default: 60
-            },
-            apiCron: {
-              type: 'string',
-              title: 'Send attempt CRON',
-              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/',
-              default: '*/10 * * * *'
-            },
-            internetTestTimeout: {
-              type: 'number',
-              title: 'Timeout for testing internet connection in ms',
-              description: 'Set this number higher for slower computers and internet connections',
-              default: 2000
-            },
-            apiTimeout: {
-              type: 'integer',
-              title: 'API request timeout in seconds',
-              description: 'Timeout for sending data to NFL API. Increase for slow connections.',
-              default: 30,
-              minimum: 10,
-              maximum: 180
-            }
-          }
-        }
-      }
-    };
-  }
-}
-
-module.exports = ConfigManager;