@noforeignland/signalk-to-noforeignland 1.0.1-beta.5 → 1.0.1-beta.8

package/CHANGELOG.md

@@ -1,5 +1,5 @@
 1.0.1
-* CHANGE: Cleanup previous installs and migrate plugin config.
+* CHANGE: Cleanup previous installs and migrate plugin config, removes depricated old plugins.
 
 1.0.0
 * CHANGE: Package now released unter npmjs org noforeignland in version 1.0.0 due to deployment changes in npmjs and the need of trustworthy sources. All npmjs keys will be revoked Nov 19th, 2025. 

package/cleanup-old-plugin.js

@@ -1,11 +1,33 @@
-const { execSync } = require('child_process');
+#!/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');
 
-// 1. Migration
+// 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 configDir = path.join(process.env.HOME || '', '.signalk');
-  const configPath = path.join(configDir, 'plugin-config-data');
+  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');
   
@@ -18,19 +40,41 @@ try {
   console.warn('Could not migrate config:', e.message);
 }
 
-// 2. Uninstall (mit Verzögerung, damit npm fertig ist)
+// 2. Uninstall old plugins (with delay so npm can finish)
 setTimeout(() => {
   try {
-    const signalkDir = path.join(process.env.HOME || '', '.signalk');
-    const oldPluginDir = path.join(signalkDir, 'node_modules', 'signalk-to-noforeignland');
+    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 (fs.existsSync(oldPluginDir)) {
-      console.log('Removing old plugin...');
-      // Direktes Löschen ist sicherer als npm uninstall während Installation
-      fs.rmSync(oldPluginDir, { recursive: true, force: true });
-      console.log('✓ Old plugin removed');
+    if (!removedAny && failedPlugins.length === 0) {
+      console.log('No old plugins found - already clean!');
     }
   } catch (e) {
-    console.warn('Could not remove old plugin automatically. Please run: npm uninstall signalk-to-noforeignland');
+    console.warn('Error during cleanup:', e.message);
   }
-}, 2000); // 2 Sekunden warten bis npm fertig ist
+}, 2000); // Wait 2 seconds for npm to finish

package/doc/beta_install_cerbo.md

@@ -0,0 +1,106 @@
+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
+
+```
+
+2. Restart Server & Check logs
+```
+Restart Server vom Webgui and check logs in Webgui
+```
+
+
+## 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
+```
+2. Restart Server & Check logs
+```
+Restart Server vom Webgui and check logs in Webgui
+```
+
+
+----------------------------------------
+
+
+# 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>
+
+```
+
+3. Restart Server & Check logs
+```
+Restart Server vom Webgui and check logs in Webgui
+```

package/doc/beta_install_rpi.md

@@ -0,0 +1,64 @@
+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/doc/dev

@@ -1,3 +1,7 @@
+
+INTERNAL NOTES ONLY, IGNORE.
+
+
 cd ~/dirk/nfl-signalk
 
 # Aktuelle Version zu Beta machen

package/index.js

@@ -279,8 +279,10 @@ class SignalkToNoforeignland {
       return;
     }
 
-    // NEW: Cleanup old plugin
-    await this.cleanupOldPlugin();
+    // Cleanup old plugin (fire and forget, non-blocking)
+    this.cleanupOldPlugin().catch(err => {
+      this.app.debug('Error in cleanupOldPlugin:', err.message);
+    });
 
     // Migrate old track files
     await this.migrateOldTrackFile();
@@ -310,52 +312,77 @@ class SignalkToNoforeignland {
     this.startPositionHealthCheck();
   }
 
-async cleanupOldPlugin() {
-  try {
-    // 1. Config Migration
-    const configDir = process.env.SIGNALK_NODE_CONFIG_DIR || 
-                      path.join(process.env.HOME || process.env.USERPROFILE, '.signalk');
-    const configPath = path.join(configDir, 'plugin-config-data');
-    const oldConfigFile = path.join(configPath, 'signalk-to-noforeignland.json');
-    const newConfigFile = path.join(configPath, '@noforeignland-signalk-to-noforeignland.json');
-    
-    if (fs.existsSync(oldConfigFile) && !fs.existsSync(newConfigFile)) {
-      this.app.debug('Migrating configuration from old plugin...');
-      fs.copyFileSync(oldConfigFile, newConfigFile);
-      fs.copyFileSync(oldConfigFile, `${oldConfigFile}.backup`);
-      this.app.debug('✓ Configuration migrated successfully');
-    }
-    
-    // 2. Check if old plugin still exists
-    const oldPluginDir = path.join(configDir, 'node_modules', 'signalk-to-noforeignland');
-    
-    if (fs.existsSync(oldPluginDir)) {
-      this.app.debug('Old plugin "signalk-to-noforeignland" detected');
-      this.app.setPluginError(
-        'Old plugin "signalk-to-noforeignland" is still installed. ' +
-        'Please uninstall it manually: cd ~/.signalk && npm uninstall signalk-to-noforeignland'
-      );
+  async cleanupOldPlugin() {
+    try {
+      // Detect SignalK directory (standard or Victron Cerbo)
+      const victronPath = '/data/conf/signalk';
+      const standardPath = process.env.SIGNALK_NODE_CONFIG_DIR || 
+                           path.join(process.env.HOME || process.env.USERPROFILE, '.signalk');
       
-      // Try to remove it after a delay (non-blocking)
-      setTimeout(async () => {
-        try {
-          this.app.debug('Attempting to remove old plugin directory...');
-          await fs.remove(oldPluginDir);
-          this.app.debug('✓ Old plugin directory removed');
-          // Clear error if removal successful
-          this.setPluginStatus('Started (old plugin cleaned up)');
-        } catch (err) {
-          this.app.debug('Could not automatically remove old plugin:', err.message);
-          this.app.debug('Please manually run: npm uninstall signalk-to-noforeignland');
-        }
-      }, 5000); // 5 Sekunden warten bis SignalK vollständig gestartet ist
+      const configDir = fs.existsSync(victronPath) ? victronPath : standardPath;
+      this.app.debug(`Using SignalK directory: ${configDir}`);
+      
+      const configPath = path.join(configDir, 'plugin-config-data');
+      
+      // 1. Config Migration - only from signalk-to-noforeignland
+      const oldConfigFile = path.join(configPath, 'signalk-to-noforeignland.json');
+      const newConfigFile = path.join(configPath, '@noforeignland-signalk-to-noforeignland.json');
+      
+      if (fs.existsSync(oldConfigFile) && !fs.existsSync(newConfigFile)) {
+        this.app.debug('Migrating configuration from old plugin "signalk-to-noforeignland"...');
+        fs.copyFileSync(oldConfigFile, newConfigFile);
+        fs.copyFileSync(oldConfigFile, `${oldConfigFile}.backup`);
+        this.app.debug('✓ Configuration migrated successfully');
+      }
+      
+      // 2. Check if old plugins still exist (including very old signalk-to-nfl)
+      const oldPlugins = [
+        { dir: path.join(configDir, 'node_modules', 'signalk-to-noforeignland'), name: 'signalk-to-noforeignland' },
+        { dir: path.join(configDir, 'node_modules', 'signalk-to-nfl'), name: 'signalk-to-nfl' }
+      ];
+      
+      const foundOldPlugins = oldPlugins.filter(plugin => fs.existsSync(plugin.dir));
+      
+      if (foundOldPlugins.length > 0) {
+        const pluginNames = foundOldPlugins.map(p => `"${p.name}"`).join(' and ');
+        const uninstallCmd = foundOldPlugins.map(p => p.name).join(' ');
+        
+        this.app.debug(`Old plugin(s) detected: ${pluginNames}`);
+        this.app.setPluginError(
+          `Old plugin(s) ${pluginNames} still installed. ` +
+          `Please uninstall manually: cd ${configDir} && npm uninstall ${uninstallCmd}`
+        );
+        
+        // Try to remove them after a delay (non-blocking)
+        setTimeout(async () => {
+          let anyRemoved = false;
+          let anyFailed = false;
+          
+          for (const plugin of foundOldPlugins) {
+            try {
+              this.app.debug(`Attempting to remove old plugin directory: ${plugin.name}...`);
+              await fs.remove(plugin.dir);
+              this.app.debug(`✓ Old plugin "${plugin.name}" directory removed`);
+              anyRemoved = true;
+            } catch (err) {
+              this.app.debug(`Could not automatically remove old plugin "${plugin.name}":`, err.message);
+              anyFailed = true;
+            }
+          }
+          
+          if (anyRemoved && !anyFailed) {
+            this.setPluginStatus('Started (old plugins cleaned up)');
+          } else if (anyFailed) {
+            const remainingPlugins = foundOldPlugins.map(p => p.name).join(' ');
+            this.app.debug(`Please manually run: cd ${configDir} && npm uninstall ${remainingPlugins}`);
+          }
+        }, 5000); // 5 seconds wait for SignalK to fully start
+      }
+      
+    } catch (err) {
+      this.app.debug('Error during old plugin cleanup:', err.message);
     }
-    
-  } catch (err) {
-    this.app.debug('Error during old plugin cleanup:', err.message);
   }
-}
-
 
   async migrateOldTrackFile() {
     const oldTrackFile = path.join(this.options.trackDir, 'nfl-track.jsonl');
@@ -674,54 +701,54 @@ async cleanupOldPlugin() {
     return res;
   }
 
-startPositionHealthCheck() {
-  this.positionCheckInterval = setInterval(() => {
-    const now = new Date().getTime();
-    const timeSinceLastPosition = this.lastPositionReceived 
-      ? (now - this.lastPositionReceived) / 1000 
-      : null;
-    
-    const activeSource = this.options.filterSource || this.autoSelectedSource || 'any';
-    const filterMsg = activeSource !== 'any' ? ` from source '${activeSource}'` : '';
-    
-    if (!this.lastPositionReceived) {
-      const errorMsg = this.options.filterSource
-        ? `No GPS position data received from filtered source '${this.options.filterSource}'. Check Expert Settings > Position source device, or leave empty to use any GPS source.`
-        : 'No GPS position data received. Check that your GPS is connected and SignalK is receiving navigation.position data.';
-      this.setPluginError(errorMsg);
-      this.app.debug('Position health check: No position data ever received' + filterMsg);
-    } else if (timeSinceLastPosition > 300) {
-      const errorMsg = this.options.filterSource
-        ? `No GPS position data${filterMsg} for ${Math.floor(timeSinceLastPosition / 60)} minutes. Check that source '${this.options.filterSource}' is active, or change/clear Position source device in Expert Settings.`
-        : `No GPS position data${filterMsg} for ${Math.floor(timeSinceLastPosition / 60)} minutes. Check your GPS connection.`;
-      this.setPluginError(errorMsg);
-      this.app.debug(`Position health check: No position for ${timeSinceLastPosition.toFixed(0)} seconds` + filterMsg);
-    } else {
-      this.app.debug(`Position health check: OK (last position ${timeSinceLastPosition.toFixed(0)} seconds ago${filterMsg})`);
+  startPositionHealthCheck() {
+    this.positionCheckInterval = setInterval(() => {
+      const now = new Date().getTime();
+      const timeSinceLastPosition = this.lastPositionReceived 
+        ? (now - this.lastPositionReceived) / 1000 
+        : null;
       
-      // Clear any previous errors when position health is OK
-      if (this.currentError) {
-        const activeSource = this.options.filterSource || this.autoSelectedSource || '';
-        const sourcePrefix = activeSource ? `${activeSource} | ` : '';
-        const saveTime = this.lastPosition ? new Date(this.lastPosition.currentTime).toISOString() : 'None since start';
-        const transferTime = this.lastSuccessfulTransfer ? this.lastSuccessfulTransfer.toISOString() : 'None since start';
-        this.setPluginStatus(`Save: ${saveTime} | Transfer: ${transferTime} | ${sourcePrefix}`);
-      }
-    }
-  }, 5 * 60 * 1000);
-  
-  // Initial check after 2 minutes of startup
-  setTimeout(() => {
-    if (!this.lastPositionReceived) {
       const activeSource = this.options.filterSource || this.autoSelectedSource || 'any';
-      const errorMsg = this.options.filterSource
-        ? `No GPS position data received after 2 minutes from filtered source '${this.options.filterSource}'. Check Expert Settings > Position source device. You may need to leave it empty to use any available GPS source.`
-        : 'No GPS position data received after 2 minutes. Check that your GPS is connected and SignalK is receiving navigation.position data.';
-      this.setPluginError(errorMsg);
-      this.app.debug('Initial position check: No position data received' + (activeSource !== 'any' ? ` from source '${activeSource}'` : ''));
-    }
-  }, 2 * 60 * 1000);
-}
+      const filterMsg = activeSource !== 'any' ? ` from source '${activeSource}'` : '';
+      
+      if (!this.lastPositionReceived) {
+        const errorMsg = this.options.filterSource
+          ? `No GPS position data received from filtered source '${this.options.filterSource}'. Check Expert Settings > Position source device, or leave empty to use any GPS source.`
+          : 'No GPS position data received. Check that your GPS is connected and SignalK is receiving navigation.position data.';
+        this.setPluginError(errorMsg);
+        this.app.debug('Position health check: No position data ever received' + filterMsg);
+      } else if (timeSinceLastPosition > 300) {
+        const errorMsg = this.options.filterSource
+          ? `No GPS position data${filterMsg} for ${Math.floor(timeSinceLastPosition / 60)} minutes. Check that source '${this.options.filterSource}' is active, or change/clear Position source device in Expert Settings.`
+          : `No GPS position data${filterMsg} for ${Math.floor(timeSinceLastPosition / 60)} minutes. Check your GPS connection.`;
+        this.setPluginError(errorMsg);
+        this.app.debug(`Position health check: No position for ${timeSinceLastPosition.toFixed(0)} seconds` + filterMsg);
+      } else {
+        this.app.debug(`Position health check: OK (last position ${timeSinceLastPosition.toFixed(0)} seconds ago${filterMsg})`);
+        
+        // Clear any previous errors when position health is OK
+        if (this.currentError) {
+          const activeSource = this.options.filterSource || this.autoSelectedSource || '';
+          const sourcePrefix = activeSource ? `${activeSource} | ` : '';
+          const saveTime = this.lastPosition ? new Date(this.lastPosition.currentTime).toISOString() : 'None since start';
+          const transferTime = this.lastSuccessfulTransfer ? this.lastSuccessfulTransfer.toISOString() : 'None since start';
+          this.setPluginStatus(`Save: ${saveTime} | Transfer: ${transferTime} | ${sourcePrefix}`);
+        }
+      }
+    }, 5 * 60 * 1000);
+    
+    // Initial check after 2 minutes of startup
+    setTimeout(() => {
+      if (!this.lastPositionReceived) {
+        const activeSource = this.options.filterSource || this.autoSelectedSource || 'any';
+        const errorMsg = this.options.filterSource
+          ? `No GPS position data received after 2 minutes from filtered source '${this.options.filterSource}'. Check Expert Settings > Position source device. You may need to leave it empty to use any available GPS source.`
+          : 'No GPS position data received after 2 minutes. Check that your GPS is connected and SignalK is receiving navigation.position data.';
+        this.setPluginError(errorMsg);
+        this.app.debug('Initial position check: No position data received' + (activeSource !== 'any' ? ` from source '${activeSource}'` : ''));
+      }
+    }, 2 * 60 * 1000);
+  }
 
   async interval() {
     const boatMoving = this.checkBoatMoving();

package/package.json

@@ -3,7 +3,7 @@
   "signalk": {
     "id": "@noforeignland/signalk-to-noforeignland"
   },
-  "version": "1.0.1-beta.5",
+  "version": "1.0.1-beta.8",
   "description": "SignalK track logger to noforeignland.com",
   "main": "index.js",
   "keywords": [
@@ -24,7 +24,8 @@
     "node": ">=18.0.0"
   },
   "scripts": {
-    "test": "echo \"No tests specified\" && exit 0"
+    "test": "echo \"No tests specified\" && exit 0",
+    "postinstall": "node cleanup-old-plugin.js"
   },
   "dependencies": {
     "cron": "^2.1.0",

package/doc/beta_install.md

@@ -1,60 +0,0 @@
-How-to install the latest beta on your device?
-
-This guide assumes you have a default install with default folders.
-This is written for a Cerbo GX or 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.
-
-**For Raspberry PI:** 
-
-1. Backup old data
-
-```
-cd ~
-mkdir nfl-backup
-cp -a .signalk/node_modules/signalk-to-noforeignland/* nfl-backup/
-```
-
-2.  Get new files from repo (main for latest)
-
-```
-cd ~/.signalk/node_modules/signalk-to-noforeignland/
-rm -rf *
-wget  https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
-unzip main.zip
-cp -r nfl-signalk-main/* .
-rm main.zip
-rm -rf nfl-signalk-main/
-```
-
-3.  Restart Server & Check logs
-
-```
-sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
-```
-
-
-**For Cerbo GX with Image Large:**
-1. Backup old data
-
-```
-cd ~
-mkdir nfl-backup
-cp -a /data/conf/signalk/node_modules/signalk-to-noforeignland/*  nfl-backup
-```
-
-2. Get new files from repo (main for latest)
-
-```
-cd /data/conf/signalk/node_modules/signalk-to-noforeignland/
-rm -rf *
-wget  https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
-unzip main.zip
-cp -r nfl-signalk-main/* .
-rm main.zip
-rm -rf nfl-signalk-main/
-```
-
-3. Restart Server & Check logs
-```
-Restart Server vom Webgui and check logs in Webgui
-```