@noforeignland/signalk-to-noforeignland 1.0.1-beta.1 → 1.0.1-beta.8
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/.github/workflows/publish.yml +40 -35
- package/CHANGELOG.md +112 -109
- package/README.md +45 -45
- package/cleanup-old-plugin.js +80 -0
- package/doc/beta_install_cerbo.md +106 -0
- package/doc/beta_install_rpi.md +64 -0
- package/doc/dev +17 -0
- package/index.js +979 -902
- package/package.json +35 -35
- package/doc/beta_install.md +0 -60
- package/migrate-config.js +0 -56
|
@@ -1,35 +1,40 @@
|
|
|
1
|
-
name: Publish Package
|
|
2
|
-
|
|
3
|
-
on:
|
|
4
|
-
push:
|
|
5
|
-
tags:
|
|
6
|
-
- 'v*'
|
|
7
|
-
|
|
8
|
-
permissions:
|
|
9
|
-
id-token: write
|
|
10
|
-
contents: read
|
|
11
|
-
|
|
12
|
-
jobs:
|
|
13
|
-
publish:
|
|
14
|
-
runs-on: ubuntu-latest
|
|
15
|
-
|
|
16
|
-
steps:
|
|
17
|
-
- uses: actions/checkout@v4
|
|
18
|
-
|
|
19
|
-
- name: Clean workspace
|
|
20
|
-
run: git clean -xfd
|
|
21
|
-
|
|
22
|
-
- uses: actions/setup-node@v4
|
|
23
|
-
with:
|
|
24
|
-
node-version: '20'
|
|
25
|
-
registry-url: 'https://registry.npmjs.org'
|
|
26
|
-
|
|
27
|
-
# Ensure npm 11.5.1 or later is installed
|
|
28
|
-
- name: Update npm
|
|
29
|
-
run: npm install -g npm@latest
|
|
30
|
-
- run: npm install
|
|
31
|
-
|
|
32
|
-
- run: npm test
|
|
33
|
-
|
|
34
|
-
- name: Publish
|
|
35
|
-
run:
|
|
1
|
+
name: Publish Package
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- 'v*'
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
id-token: write
|
|
10
|
+
contents: read
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
publish:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
|
|
19
|
+
- name: Clean workspace
|
|
20
|
+
run: git clean -xfd
|
|
21
|
+
|
|
22
|
+
- uses: actions/setup-node@v4
|
|
23
|
+
with:
|
|
24
|
+
node-version: '20'
|
|
25
|
+
registry-url: 'https://registry.npmjs.org'
|
|
26
|
+
|
|
27
|
+
# Ensure npm 11.5.1 or later is installed
|
|
28
|
+
- name: Update npm
|
|
29
|
+
run: npm install -g npm@latest
|
|
30
|
+
- run: npm install
|
|
31
|
+
|
|
32
|
+
- run: npm test
|
|
33
|
+
|
|
34
|
+
- name: Publish
|
|
35
|
+
run: |
|
|
36
|
+
if [[ "${{ github.ref }}" == refs/tags/*-beta.* ]] || [[ "${{ github.ref }}" == refs/tags/*-rc.* ]]; then
|
|
37
|
+
npm publish --provenance --access public --tag beta
|
|
38
|
+
else
|
|
39
|
+
npm publish --provenance --access public
|
|
40
|
+
fi
|
package/CHANGELOG.md
CHANGED
|
@@ -1,109 +1,112 @@
|
|
|
1
|
-
1.0.
|
|
2
|
-
* CHANGE:
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
0.
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
The
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
0.1.
|
|
16
|
-
* CHANGE:
|
|
17
|
-
|
|
18
|
-
0.1.29
|
|
19
|
-
*
|
|
20
|
-
|
|
21
|
-
0.1.29-beta.
|
|
22
|
-
*
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
* CHANGE:
|
|
26
|
-
* CHANGE:
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
*
|
|
30
|
-
|
|
31
|
-
0.1.28
|
|
32
|
-
*
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
*
|
|
36
|
-
* CHANGE:
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
* CHANGE:
|
|
40
|
-
|
|
41
|
-
0.1.
|
|
42
|
-
*
|
|
43
|
-
|
|
44
|
-
0.1.27
|
|
45
|
-
*
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
*
|
|
57
|
-
|
|
58
|
-
0.1.26
|
|
59
|
-
*
|
|
60
|
-
|
|
61
|
-
0.1.
|
|
62
|
-
* CHANGE:
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
*
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
*
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
*
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
* CHANGE:
|
|
80
|
-
|
|
81
|
-
0.1.
|
|
82
|
-
* CHANGE:
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
* CHANGE:
|
|
86
|
-
*
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
* Final version after successful testing SV MOIN and
|
|
90
|
-
|
|
91
|
-
0.1.23
|
|
92
|
-
*
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
|
|
1
|
+
1.0.1
|
|
2
|
+
* CHANGE: Cleanup previous installs and migrate plugin config, removes depricated old plugins.
|
|
3
|
+
|
|
4
|
+
1.0.0
|
|
5
|
+
* 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.
|
|
6
|
+
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.
|
|
7
|
+
|
|
8
|
+
0.2.x
|
|
9
|
+
* CHANGE: Deployment via OIDC authentication
|
|
10
|
+
npmjs.org is revoking all deployment keys Nov 19th. The future deployment shall be via trusted publishers, so the workflow changes from publishing local -> npmjs to local -> github -> npmjs.
|
|
11
|
+
To fullfil this we had to deprecate the old package and deploy it under the scope of the org noforeignland in npmjs. This is the reason, why you don't see the old package anymore in the Appstore.
|
|
12
|
+
|
|
13
|
+
The "new" one has to be installed once manually, after that everything is back to normal and you are fine.
|
|
14
|
+
|
|
15
|
+
0.1.3x
|
|
16
|
+
* CHANGE: Working on Deployment via OIDC authentication
|
|
17
|
+
|
|
18
|
+
0.1.29
|
|
19
|
+
* CHANGE: Removed unused dependency "is-reachable" in package.json
|
|
20
|
+
|
|
21
|
+
0.1.29-beta.2
|
|
22
|
+
* NEW: setPluginError and error in data path if Internet Connection is not working.
|
|
23
|
+
|
|
24
|
+
0.1.29-beta.1
|
|
25
|
+
* CHANGE: After talking to Treppo from Sugnal K core team we should use the data path "noforeignland.*", code and docs changed.
|
|
26
|
+
* CHANGE: README.md info added and format optimized
|
|
27
|
+
* CHANGE: GPS source at the end for setPluginStatus - Cerbo has a long source name and truncates it.
|
|
28
|
+
* CHANGE: Use "npm install instead" of "npm ci" to push from Github to npmjs using OIDC authentication
|
|
29
|
+
* CHANGE: Moved navigation.position source from path noforeignland.status to noforeignland.source
|
|
30
|
+
|
|
31
|
+
0.1.28
|
|
32
|
+
* BUGFIX: No GPS data found - introduced in 0.1.27 - Thanks Piotr
|
|
33
|
+
|
|
34
|
+
0.1.28-beta.2
|
|
35
|
+
* EXPERIMENTAL: Signal K data path to visualize the plugin behaviour or error in Node Red, KIP, etc. Using plugin.signalk-to-noforeignland.* for now. See README.md for details.
|
|
36
|
+
* CHANGE: Using app.getDataDirPath() to store transient data, thanks Jeremy, they are now in "plugin-config-data/signalk-to-noforeignland/nfl-track" and renamed to pending.json1 and sent.json1
|
|
37
|
+
* CHANGE: Optimize GPS detection if multiple navigation.position from different sources exist.
|
|
38
|
+
* CHANGE: PluginStatus optimized for limited space available.
|
|
39
|
+
* CHANGE: doc/beta_install.md changed for new file structure.
|
|
40
|
+
|
|
41
|
+
0.1.28-beta.1
|
|
42
|
+
* CHANGE: By design SK deletes the track folder upon Pluging update via the Appstore, so we have to save the long term track in a different location, default folder: signalk-to-noforeignland-data
|
|
43
|
+
|
|
44
|
+
0.1.27
|
|
45
|
+
* Final version after successful testing SV MOIN and SV KIAPA NUI
|
|
46
|
+
|
|
47
|
+
0.1.27-beta.1
|
|
48
|
+
* NEW: NPMJS requires new method for publishing. The old tokens will expire Nov 19th, 2025, so moving to OIDC authentication.
|
|
49
|
+
* NEW: Check the GPS status in navigation.position, else retry and throw PluginError on Dashboard
|
|
50
|
+
* CHANGE: Keep track data on disk rewritten and migrate old files to new structure, so nfl-track-sent.jsonl becomes a continuous archive of all sent track data over time, when enabled. New Logic:
|
|
51
|
+
* New points accumulate in nfl-track-pending.jsonl
|
|
52
|
+
* Send succeeds → API confirms receipt
|
|
53
|
+
* If keepFiles=true: The content of pending file is appended to nfl-track-sent.jsonl (line 588)
|
|
54
|
+
* Pending file is deleted
|
|
55
|
+
* Next GPS points → create a new pending file
|
|
56
|
+
* Next successful send → appends again to the same nfl-track-sent.jsonl
|
|
57
|
+
|
|
58
|
+
0.1.26
|
|
59
|
+
* Same as 0.1.26-beta.1
|
|
60
|
+
|
|
61
|
+
0.1.26-beta.1
|
|
62
|
+
* CHANGE: PluginStatus last track sent "Not transfered since plugin start" gets truncated by the dashboard. Changed to "None since start"
|
|
63
|
+
|
|
64
|
+
0.1.25
|
|
65
|
+
* CHANGE: Minimum boat move default increased from 50m to 80m
|
|
66
|
+
* CHANGE: Updated the README.md
|
|
67
|
+
* CHANGE: Use public ipv4 DNS instead of local with cache for testInternet()
|
|
68
|
+
* Final version after successful testing SV MOIN and SV KIAPA NUI
|
|
69
|
+
|
|
70
|
+
0.1.25-beta.3
|
|
71
|
+
* NEW: Check if boat key is set on startup, else report error to dashboard
|
|
72
|
+
* CHANGE: Changing the order and label of the Plugin Settings to make it more clear for unexpierienced users and grouped to Mandatory, Advanced and Expert.
|
|
73
|
+
* CHANGE: Migration of < 0.1.25 Plugin settings to new structure.
|
|
74
|
+
* CHANGE: PluginStatus last track sent "Never" changed to "Not transfered since plugin start" to avoid confusions.
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
0.1.25-beta.2
|
|
78
|
+
* CHANGE: Typo in pluginName fixed
|
|
79
|
+
* CHANGE: Dates for SetPlugin now ISO8601 formated (https://github.com/noforeignland/nfl-signalk/issues/9)
|
|
80
|
+
|
|
81
|
+
0.1.25-beta.1
|
|
82
|
+
* CHANGE: User mattzilla470 reported timout Issues on VE Cerbo with a small CPU and using 4G (https://github.com/noforeignland/nfl-signalk/issues/7). So added a timout option in the plugin config and a tripple retry while increasing the timeout for the API call.
|
|
83
|
+
|
|
84
|
+
0.1.24
|
|
85
|
+
* 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
|
|
86
|
+
* 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.
|
|
87
|
+
* CHANGE: Renamed CHANGELOG to CHANGELOG.md
|
|
88
|
+
* CHANGE: CHANGELOG ORDER - newest on top.
|
|
89
|
+
* Final version after successful testing SV MOIN and SV KIAPA NUI
|
|
90
|
+
|
|
91
|
+
0.1.23
|
|
92
|
+
* Final version after successful testing SV MOIN and SV KIAPA NUI
|
|
93
|
+
|
|
94
|
+
0.1.23-beta.1
|
|
95
|
+
* Renamed branch to follow the release versions.
|
|
96
|
+
* CLEANUP - More debug info for the SK dashboard using this.app.setPluginError
|
|
97
|
+
* CLEANUP - Removed CreateGPX, was only used for removed Email transmission of the track
|
|
98
|
+
|
|
99
|
+
0.1.22-beta.2
|
|
100
|
+
|
|
101
|
+
* CLEANUP and move to Object Oriented Javascript
|
|
102
|
+
|
|
103
|
+
0.1.22-beta.1
|
|
104
|
+
|
|
105
|
+
* CONFIG: Attempt sending location while moving - Default changed from false to true
|
|
106
|
+
* CONFIG: Ping added for 24h ping if boat is not moved. - Default: true
|
|
107
|
+
* Package.json - Nodemailer dependency removed
|
|
108
|
+
* Marked for removal - Depricated "sendEmailData" function.
|
|
109
|
+
* REMOVED - sendEmail.js
|
|
110
|
+
* CLEANUP - Renamed emaiCron to apiCron
|
|
111
|
+
* NEW: 24h api ping, when enabled, even if boat didn't move.
|
|
112
|
+
|
package/README.md
CHANGED
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
# Signal K To Noforeignland
|
|
2
|
-
Effortlessly log your boat's movement to **noforeignland.com**
|
|
3
|
-
|
|
4
|
-
## Important for 0.1.x users
|
|
5
|
-
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.
|
|
6
|
-
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.
|
|
7
|
-
|
|
8
|
-
## Features
|
|
9
|
-
* Automatically log your position to noforeignland.com
|
|
10
|
-
* Send detailed tracks to log your entire trip and not just your final position
|
|
11
|
-
* Can be used in near real time or cache and upload when stopped and data-connection is available
|
|
12
|
-
* Sends 24h keepalive
|
|
13
|
-
* Option to archive your track on the local disk
|
|
14
|
-
* Detailed plugin information in the SK dashboard
|
|
15
|
-
* SK data paths about the plugin status for your own dashboard or Node Red coding
|
|
16
|
-
|
|
17
|
-
## Issues
|
|
18
|
-
* Server -> Plugin Config -> Signal K to Noforeignland -> Enable debug log (top right)
|
|
19
|
-
* Report issues on GitHub (https://github.com/noforeignland/nfl-signalk/issues)
|
|
20
|
-
|
|
21
|
-
## Requirements
|
|
22
|
-
* An internet connection is required in order to update noforeignland.com
|
|
23
|
-
* A navigation.position data path inside Signal K for self, which is your current GPS position
|
|
24
|
-
* A **noforeignland.com** account
|
|
25
|
-
* Your Boat API Key from the **noforeignland.com** website:
|
|
26
|
-
* Account > Settings > Boat tracking > API Key
|
|
27
|
-
|
|
28
|
-
> Note your Boat API Key is not available in the app.
|
|
29
|
-
> You must sign in to the **noforeignland.com** website (using the same authentication method you use for the app: Google. Facebook, Email).
|
|
30
|
-
|
|
31
|
-
## Configuration
|
|
32
|
-
1. Add your boat's API Key into the Server > Plugin Config > Signal K to Noforeignland > Boat API Key
|
|
33
|
-
2. Hit "Submit"
|
|
34
|
-
3. Restart the Signal K server
|
|
35
|
-
|
|
36
|
-
## Data paths created by this plugin
|
|
37
|
-
```
|
|
38
|
-
noforeignland.savepoint - ISO8601 timestamp - when was last point saved to trackfile
|
|
39
|
-
noforeignland.savepoint_local - locale timestamp - when was last point saved to trackfile
|
|
40
|
-
noforeignland.sent_to_api - ISO8601 timestamp - last successful transfer to the API
|
|
41
|
-
noforeignland.sent_to_api_local - locale timestamp - last successful transfer to the API
|
|
42
|
-
noforeignland.status - string - Status & Error messages
|
|
43
|
-
noforeignland.status_boolean - number - 0 = normal operation, 1 = error
|
|
44
|
-
noforeignland.source - string - string - data source of navigation.position
|
|
45
|
-
notifications.noforeignland.status_boolean - json object - auto created
|
|
1
|
+
# Signal K To Noforeignland
|
|
2
|
+
Effortlessly log your boat's movement to **noforeignland.com**
|
|
3
|
+
|
|
4
|
+
## Important for 0.1.x users
|
|
5
|
+
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.
|
|
6
|
+
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.
|
|
7
|
+
|
|
8
|
+
## Features
|
|
9
|
+
* Automatically log your position to noforeignland.com
|
|
10
|
+
* Send detailed tracks to log your entire trip and not just your final position
|
|
11
|
+
* Can be used in near real time or cache and upload when stopped and data-connection is available
|
|
12
|
+
* Sends 24h keepalive
|
|
13
|
+
* Option to archive your track on the local disk
|
|
14
|
+
* Detailed plugin information in the SK dashboard
|
|
15
|
+
* SK data paths about the plugin status for your own dashboard or Node Red coding
|
|
16
|
+
|
|
17
|
+
## Issues
|
|
18
|
+
* Server -> Plugin Config -> Signal K to Noforeignland -> Enable debug log (top right)
|
|
19
|
+
* Report issues on GitHub (https://github.com/noforeignland/nfl-signalk/issues)
|
|
20
|
+
|
|
21
|
+
## Requirements
|
|
22
|
+
* An internet connection is required in order to update noforeignland.com
|
|
23
|
+
* A navigation.position data path inside Signal K for self, which is your current GPS position
|
|
24
|
+
* A **noforeignland.com** account
|
|
25
|
+
* Your Boat API Key from the **noforeignland.com** website:
|
|
26
|
+
* Account > Settings > Boat tracking > API Key
|
|
27
|
+
|
|
28
|
+
> Note your Boat API Key is not available in the app.
|
|
29
|
+
> You must sign in to the **noforeignland.com** website (using the same authentication method you use for the app: Google. Facebook, Email).
|
|
30
|
+
|
|
31
|
+
## Configuration
|
|
32
|
+
1. Add your boat's API Key into the Server > Plugin Config > Signal K to Noforeignland > Boat API Key
|
|
33
|
+
2. Hit "Submit"
|
|
34
|
+
3. Restart the Signal K server
|
|
35
|
+
|
|
36
|
+
## Data paths created by this plugin
|
|
37
|
+
```
|
|
38
|
+
noforeignland.savepoint - ISO8601 timestamp - when was last point saved to trackfile
|
|
39
|
+
noforeignland.savepoint_local - locale timestamp - when was last point saved to trackfile
|
|
40
|
+
noforeignland.sent_to_api - ISO8601 timestamp - last successful transfer to the API
|
|
41
|
+
noforeignland.sent_to_api_local - locale timestamp - last successful transfer to the API
|
|
42
|
+
noforeignland.status - string - Status & Error messages
|
|
43
|
+
noforeignland.status_boolean - number - 0 = normal operation, 1 = error
|
|
44
|
+
noforeignland.source - string - string - data source of navigation.position
|
|
45
|
+
notifications.noforeignland.status_boolean - json object - auto created
|
|
46
46
|
```
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Cleanup script for old plugin versions
|
|
5
|
+
* This runs as a standalone script during npm postinstall
|
|
6
|
+
* NOT a class - just a simple executable script
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
const fs = require('fs');
|
|
10
|
+
const path = require('path');
|
|
11
|
+
|
|
12
|
+
// Detect SignalK directory (standard ~/.signalk or Victron Cerbo /data/conf/signalk)
|
|
13
|
+
function getSignalKDir() {
|
|
14
|
+
const victronPath = '/data/conf/signalk';
|
|
15
|
+
const homePath = path.join(process.env.HOME || '', '.signalk');
|
|
16
|
+
|
|
17
|
+
// Check Victron path first
|
|
18
|
+
if (fs.existsSync(victronPath)) {
|
|
19
|
+
return victronPath;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
return homePath;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
const signalkDir = getSignalKDir();
|
|
26
|
+
console.log(`Using SignalK directory: ${signalkDir}`);
|
|
27
|
+
|
|
28
|
+
// 1. Migration (only for signalk-to-noforeignland config)
|
|
29
|
+
try {
|
|
30
|
+
const configPath = path.join(signalkDir, 'plugin-config-data');
|
|
31
|
+
const oldConfig = path.join(configPath, 'signalk-to-noforeignland.json');
|
|
32
|
+
const newConfig = path.join(configPath, '@noforeignland-signalk-to-noforeignland.json');
|
|
33
|
+
|
|
34
|
+
if (fs.existsSync(oldConfig) && !fs.existsSync(newConfig)) {
|
|
35
|
+
fs.copyFileSync(oldConfig, newConfig);
|
|
36
|
+
fs.copyFileSync(oldConfig, `${oldConfig}.backup`);
|
|
37
|
+
console.log('✓ Configuration migrated');
|
|
38
|
+
}
|
|
39
|
+
} catch (e) {
|
|
40
|
+
console.warn('Could not migrate config:', e.message);
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
// 2. Uninstall old plugins (with delay so npm can finish)
|
|
44
|
+
setTimeout(() => {
|
|
45
|
+
try {
|
|
46
|
+
const oldPlugins = [
|
|
47
|
+
{ dir: path.join(signalkDir, 'node_modules', 'signalk-to-noforeignland'), name: 'signalk-to-noforeignland' },
|
|
48
|
+
{ dir: path.join(signalkDir, 'node_modules', 'signalk-to-nfl'), name: 'signalk-to-nfl' }
|
|
49
|
+
];
|
|
50
|
+
|
|
51
|
+
let removedAny = false;
|
|
52
|
+
const failedPlugins = [];
|
|
53
|
+
|
|
54
|
+
for (const plugin of oldPlugins) {
|
|
55
|
+
if (fs.existsSync(plugin.dir)) {
|
|
56
|
+
try {
|
|
57
|
+
console.log(`Removing old plugin "${plugin.name}"...`);
|
|
58
|
+
// Direct deletion is safer than npm uninstall during installation
|
|
59
|
+
fs.rmSync(plugin.dir, { recursive: true, force: true });
|
|
60
|
+
console.log(`✓ Old plugin "${plugin.name}" removed`);
|
|
61
|
+
removedAny = true;
|
|
62
|
+
} catch (e) {
|
|
63
|
+
console.warn(`Could not remove "${plugin.name}":`, e.message);
|
|
64
|
+
failedPlugins.push(plugin.name);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
if (failedPlugins.length > 0) {
|
|
70
|
+
const uninstallCmd = failedPlugins.join(' ');
|
|
71
|
+
console.warn(`Please run manually: npm uninstall ${uninstallCmd}`);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
if (!removedAny && failedPlugins.length === 0) {
|
|
75
|
+
console.log('No old plugins found - already clean!');
|
|
76
|
+
}
|
|
77
|
+
} catch (e) {
|
|
78
|
+
console.warn('Error during cleanup:', e.message);
|
|
79
|
+
}
|
|
80
|
+
}, 2000); // Wait 2 seconds for npm to finish
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
How-to install the latest beta or dev tree (unstable) on your device?
|
|
2
|
+
|
|
3
|
+
This guide assumes you have a default install with default folders.
|
|
4
|
+
This is written for a Victron Cerbo GX jump to the section you need want to go to.
|
|
5
|
+
It is recommended to enable the Debug Log for this plugin in Server -> Plugin Config before updating.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
# Pre-requirements
|
|
9
|
+
On the Cerbo GUI enable SSH access and set a afmin password
|
|
10
|
+
Windows User: Download putty (for ssh) and Winscp (for secure fie copy)
|
|
11
|
+
|
|
12
|
+
## On GUI v1:
|
|
13
|
+
1. Click "Menu" (bottom right)
|
|
14
|
+
2. Settings > General
|
|
15
|
+
3. Set root password
|
|
16
|
+
4. Enable "SSH on LAN"
|
|
17
|
+
|
|
18
|
+
## On GUI v2:
|
|
19
|
+
1. Settings -> General
|
|
20
|
+
2. Set root password
|
|
21
|
+
3. Enable "SSH on LAN"
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
# Backup old data
|
|
25
|
+
|
|
26
|
+
## BEST + SLOW: Full signalk copy to local computer
|
|
27
|
+
1. Connect your Cerbo with WinSCP
|
|
28
|
+
2. Copy the folder "/data/conf/signalk" to your local PC
|
|
29
|
+
|
|
30
|
+
## Alternative Cerbo has a SD Card connected:
|
|
31
|
+
1. ssh to the Cerbo
|
|
32
|
+
```
|
|
33
|
+
df -h
|
|
34
|
+
# showns for me that /dev/mmcblk0p1 has 29GB free and is mounted to /run/media/mmcblk0p1
|
|
35
|
+
# This is a SD card that is manually inserted.
|
|
36
|
+
|
|
37
|
+
mount
|
|
38
|
+
# confirms this for me with output:
|
|
39
|
+
# /dev/mmcblk0p1 on /run/media/mmcblk0p1 type vfat (rw,relatime,fmask=0022,dmask=0022,codepage=437,iocharset=iso8859-1,shortname=mixed,errors=remount-ro)
|
|
40
|
+
|
|
41
|
+
cp -r /data/conf/signalk /run/media/mmcblk0p1/signalk-backup
|
|
42
|
+
# copies the files for you, it will take some time, as the CPU and IO are not the fastest
|
|
43
|
+
|
|
44
|
+
ls –la /run/media/mmcblk0p1/signalk-backup
|
|
45
|
+
# Verify that folder and files exist.
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
# npmjs beta on Cerbo
|
|
50
|
+
|
|
51
|
+
## Install latest beta
|
|
52
|
+
1. SSH to the Cerbo:
|
|
53
|
+
```
|
|
54
|
+
cd /data/conf/signalk
|
|
55
|
+
|
|
56
|
+
npm i @noforeignland/signalk-to-noforeignland@beta
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
2. Restart Server & Check logs
|
|
61
|
+
```
|
|
62
|
+
Restart Server vom Webgui and check logs in Webgui
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## Install specific beta version f.e. 1.0.1-beta.5
|
|
67
|
+
1. SSH to the Cerbo:
|
|
68
|
+
```
|
|
69
|
+
cd /data/conf/signalk
|
|
70
|
+
|
|
71
|
+
# Here use the beta version you want to install
|
|
72
|
+
npm i @noforeignland/signalk-to-noforeignland@1.0.1-beta.5
|
|
73
|
+
```
|
|
74
|
+
2. Restart Server & Check logs
|
|
75
|
+
```
|
|
76
|
+
Restart Server vom Webgui and check logs in Webgui
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
----------------------------------------
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
# dev tree (unstable) install - NOT RECOMMENDED
|
|
84
|
+
|
|
85
|
+
1. Backup as above
|
|
86
|
+
|
|
87
|
+
2. Get new files from repo (main for latest)
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
cd ~
|
|
91
|
+
mkdir dev
|
|
92
|
+
cd dev
|
|
93
|
+
wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
|
|
94
|
+
unzip main.zip
|
|
95
|
+
cd nfl-signalk-main/
|
|
96
|
+
npm pack
|
|
97
|
+
|
|
98
|
+
cd /data/conf/signalk
|
|
99
|
+
npm install ~/dev/nfl-signalk-main/<your_npm_pack.tgz>
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
3. Restart Server & Check logs
|
|
104
|
+
```
|
|
105
|
+
Restart Server vom Webgui and check logs in Webgui
|
|
106
|
+
```
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
How-to install the latest beta or dev tree (unstable) on your device?
|
|
2
|
+
|
|
3
|
+
This guide assumes you have a default install with default folders.
|
|
4
|
+
This is written for a RPI, jump to the section you need want to go to.
|
|
5
|
+
It is recommended to enable the Debug Log for this plugin in Server -> Plugin Config before updating.
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
# Backup old data
|
|
9
|
+
```
|
|
10
|
+
cp -a ~/.signalk ~/signalk-backup
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
# npmjs beta on RPI
|
|
14
|
+
|
|
15
|
+
## Install latest beta
|
|
16
|
+
```
|
|
17
|
+
cd ~.signalk
|
|
18
|
+
|
|
19
|
+
npm i @noforeignland/signalk-to-noforeignland@beta
|
|
20
|
+
|
|
21
|
+
sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Install a specific beta
|
|
25
|
+
```
|
|
26
|
+
cd ~.signalk
|
|
27
|
+
|
|
28
|
+
# Here use the beta version you want to install
|
|
29
|
+
npm i @noforeignland/signalk-to-noforeignland@1.0.1-beta.5
|
|
30
|
+
|
|
31
|
+
sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
--------------------------
|
|
35
|
+
|
|
36
|
+
# dev tree (unstable) - NOT RECOMMENDED
|
|
37
|
+
1. Backup old data
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
cd ~
|
|
41
|
+
cp -a .signalk/ signalk-backup
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
2. Get new files from repo (main for latest)
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
cd ~
|
|
48
|
+
mkdir dev
|
|
49
|
+
cd dev
|
|
50
|
+
wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
|
|
51
|
+
unzip main.zip
|
|
52
|
+
cd nfl-signalk-main/
|
|
53
|
+
npm pack
|
|
54
|
+
|
|
55
|
+
cd ~/.signalk
|
|
56
|
+
npm install ~/dev/nfl-signalk-main/<your_npm_pack.tgz>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
3. Restart Server & Check logs
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
|
|
63
|
+
```
|
|
64
|
+
|