@noforeignland/signalk-to-noforeignland 1.1.0-beta.3 → 1.2.0-beta.1

package/cleanup-old-plugin.js

@@ -1,80 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Cleanup script for old plugin versions
- * This runs as a standalone script during npm postinstall
- * NOT a class - just a simple executable script
- */
-
-const fs = require('fs');
-const path = require('path');
-
-// Detect SignalK directory (standard ~/.signalk or Victron Cerbo /data/conf/signalk)
-function getSignalKDir() {
-  const victronPath = '/data/conf/signalk';
-  const homePath = path.join(process.env.HOME || '', '.signalk');
-  
-  // Check Victron path first
-  if (fs.existsSync(victronPath)) {
-    return victronPath;
-  }
-  
-  return homePath;
-}
-
-const signalkDir = getSignalKDir();
-console.log(`Using SignalK directory: ${signalkDir}`);
-
-// 1. Migration (only for signalk-to-noforeignland config)
-try {
-  const configPath = path.join(signalkDir, 'plugin-config-data');
-  const oldConfig = path.join(configPath, 'signalk-to-noforeignland.json');
-  const newConfig = path.join(configPath, '@noforeignland-signalk-to-noforeignland.json');
-  
-  if (fs.existsSync(oldConfig) && !fs.existsSync(newConfig)) {
-    fs.copyFileSync(oldConfig, newConfig);
-    fs.copyFileSync(oldConfig, `${oldConfig}.backup`);
-    console.log('✓ Configuration migrated');
-  }
-} catch (e) {
-  console.warn('Could not migrate config:', e.message);
-}
-
-// 2. Uninstall old plugins (with delay so npm can finish)
-setTimeout(() => {
-  try {
-    const oldPlugins = [
-      { dir: path.join(signalkDir, 'node_modules', 'signalk-to-noforeignland'), name: 'signalk-to-noforeignland' },
-      { dir: path.join(signalkDir, 'node_modules', 'signalk-to-nfl'), name: 'signalk-to-nfl' }
-    ];
-    
-    let removedAny = false;
-    const failedPlugins = [];
-    
-    for (const plugin of oldPlugins) {
-      if (fs.existsSync(plugin.dir)) {
-        try {
-          console.log(`Removing old plugin "${plugin.name}"...`);
-          // Direct deletion is safer than npm uninstall during installation
-          fs.rmSync(plugin.dir, { recursive: true, force: true });
-          console.log(`✓ Old plugin "${plugin.name}" removed`);
-          removedAny = true;
-        } catch (e) {
-          console.warn(`Could not remove "${plugin.name}":`, e.message);
-          failedPlugins.push(plugin.name);
-        }
-      }
-    }
-    
-    if (failedPlugins.length > 0) {
-      const uninstallCmd = failedPlugins.join(' ');
-      console.warn(`Please run manually: npm uninstall ${uninstallCmd}`);
-    }
-    
-    if (!removedAny && failedPlugins.length === 0) {
-      console.log('No old plugins found - already clean!');
-    }
-  } catch (e) {
-    console.warn('Error during cleanup:', e.message);
-  }
-}, 2000); // Wait 2 seconds for npm to finish

package/doc/beta_install_cerbo.md

@@ -1,116 +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
-```

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,304 +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;
-      }
-      
-      // Test internet connection
-      const hasInternet = await this.trackSender.testInternet();
-      if (!hasInternet) {
-        const errorMsg = 'No internet connection detected. Unable to send tracking data to NFL. DNS lookups failed - check your internet connection.';
-        this.app.debug(errorMsg);
-        this.setPluginError(errorMsg);
-        return;
-      }
-      
-      // Send track data
-      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();
-};