@noforeignland/signalk-to-noforeignland 1.0.1-beta.5 → 1.1.0-beta.2

package/CHANGELOG.md

@@ -1,5 +1,8 @@
+1.1.0
+* CHANGE: Refactored Project structure, see PROJECT_STRUCTURE.md
+
 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/README.md

@@ -2,8 +2,7 @@
 Effortlessly log your boat's movement to **noforeignland.com**
 
 ## Important for 0.1.x users
-Since 1.0.0 this 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. 
-Users of the old (depricated) 0.1.x versions need to install this new package once manually using the Signal K Appstore. The Plugin Configuration will be kept from the 0.1.x install. 
+Upgrade to >1.0.1 by installing this plugin from the Appstore ageain. Your old config will be migrated.
 
 ## Features
 * Automatically log your position to noforeignland.com
@@ -43,4 +42,12 @@ noforeignland.status                       - string            - Status & Error
 noforeignland.status_boolean               - number            - 0 = normal operation, 1 = error
 noforeignland.source - string              - string            - data source of navigation.position
 notifications.noforeignland.status_boolean - json object       - auto created
-```
+```
+
+https://github.com/noforeignland/nfl-signalk/issues
+
+# Virctron Cerbo GX Users
+
+## Limited storage
+Signal K can quickly exhaust the small onboard storage of the device, especially when a lot of logging is enabled. Vicron Energy addressed this here:
+https://www.victronenergy.com/live/venus-os:large#disk_space_issues_data_partition_full

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

@@ -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
+```
+