signalk-to-noforeignland 0.1.25 → 0.1.27

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.
Files changed (7) hide show
  1. package/.github/workflows/github.yml +30 -0
  2. package/CHANGELOG.md +69 -49
  3. package/README.md +26 -26
  4. package/doc/beta_install.md +62 -0
  5. package/index.js +758 -638
  6. package/package.json +32 -28
  7. package/track/nfl-track-sent.jsonl +2 -0
package/.github/workflows/github.yml ADDED
@@ -0,0 +1,30 @@
1
+ name: Publish Package
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - 'v*'
7
+
8
+ permissions:
9
+ id-token: write # Required for OIDC authentication
10
+ contents: read
11
+
12
+ jobs:
13
+ publish:
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+
18
+ - uses: actions/setup-node@v4
19
+ with:
20
+ node-version: '20'
21
+ registry-url: 'https://registry.npmjs.org'
22
+
23
+ - name: Install dependencies
24
+ run: npm ci
25
+
26
+ - name: Run tests if available
27
+ run: npm test --if-present
28
+
29
+ - name: Publish to NPM
30
+ run: npm publish
package/CHANGELOG.md CHANGED
@@ -1,49 +1,69 @@
1
- 0.1.25
2
- * CHANGE: Minimum boat move default increased from 50m to 80m
3
- * CHANGE: Updated the README.md
4
- * CHANGE: Use public ipv4 DNS instead of local with cache for testInternet()
5
- * Final version after successful testing SV MOIN and SV KIAPA NUI
6
-
7
- 0.1.25-beta.3
8
- * NEW: Check if boat key is set on startup, else report error to dashboard
9
- * 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.
10
- * CHANGE: Migration of < 0.1.25 Plugin settings to new structure.
11
- * CHANGE: PluginStatus last track sent "Never" changed to "Not transfered since plugin start" to avoid confusions.
12
-
13
-
14
- 0.1.25-beta.2
15
- * CHANGE: Typo in pluginName fixed
16
- * CHANGE: Dates for SetPlugin now ISO8601 formated (https://github.com/noforeignland/nfl-signalk/issues/9)
17
-
18
- 0.1.25-beta.1
19
- * 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.
20
-
21
- 0.1.24
22
- * 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
23
- * 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.
24
- * CHANGE: Renamed CHANGELOG to CHANGELOG.md
25
- * CHANGE: CHANGELOG ORDER - newest on top.
26
- * Final version after successful testing SV MOIN and SV KIAPA NUI
27
-
28
- 0.1.23
29
- * Final version after successful testing SV MOIN and SV KIAPA NUI
30
-
31
- 0.1.23-beta.1
32
- * Renamed branch to follow the release versions.
33
- * CLEANUP - More debug info for the SK dashboard using this.app.setPluginError
34
- * CLEANUP - Removed CreateGPX, was only used for removed Email transmission of the track
35
-
36
- 0.1.22-beta.2
37
-
38
- * CLEANUP and move to Object Oriented Javascript
39
-
40
- 0.1.22-beta.1
41
-
42
- * CONFIG: Attempt sending location while moving - Default changed from false to true
43
- * CONFIG: Ping added for 24h ping if boat is not moved. - Default: true
44
- * Package.json - Nodemailer dependency removed
45
- * Marked for removal - Depricated "sendEmailData" function.
46
- * REMOVED - sendEmail.js
47
- * CLEANUP - Renamed emaiCron to apiCron
48
- * NEW: 24h api ping, when enabled, even if boat didn't move.
49
-
1
+ 0.1.27
2
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
3
+
4
+ 0.1.27-beta.1
5
+ * NEW: NPMJS requires new method for publishing. The old tokens will expire Nov 19th, 2025, so moving to OIDC authentication.
6
+ * NEW: Check the GPS status in navigation.position, else retry and throw PluginError on Dashboard
7
+ * 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:
8
+ * * New points accumulate in nfl-track-pending.jsonl
9
+ * * Send succeeds → API confirms receipt
10
+ * * If keepFiles=true: The content of pending file is appended to nfl-track-sent.jsonl (line 588)
11
+ * * Pending file is deleted
12
+ * * Next GPS points → create a new pending file
13
+ * * Next successful send → appends again to the same nfl-track-sent.jsonl
14
+
15
+ 0.1.26
16
+ * Same as 0.1.26-beta.1
17
+
18
+ 0.1.26-beta.1
19
+ * CHANGE: PluginStatus last track sent "Not transfered since plugin start" gets truncated by the dashboard. Changed to "None since start"
20
+
21
+ 0.1.25
22
+ * CHANGE: Minimum boat move default increased from 50m to 80m
23
+ * CHANGE: Updated the README.md
24
+ * CHANGE: Use public ipv4 DNS instead of local with cache for testInternet()
25
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
26
+
27
+ 0.1.25-beta.3
28
+ * NEW: Check if boat key is set on startup, else report error to dashboard
29
+ * 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.
30
+ * CHANGE: Migration of < 0.1.25 Plugin settings to new structure.
31
+ * CHANGE: PluginStatus last track sent "Never" changed to "Not transfered since plugin start" to avoid confusions.
32
+
33
+
34
+ 0.1.25-beta.2
35
+ * CHANGE: Typo in pluginName fixed
36
+ * CHANGE: Dates for SetPlugin now ISO8601 formated (https://github.com/noforeignland/nfl-signalk/issues/9)
37
+
38
+ 0.1.25-beta.1
39
+ * 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.
40
+
41
+ 0.1.24
42
+ * 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
43
+ * 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.
44
+ * CHANGE: Renamed CHANGELOG to CHANGELOG.md
45
+ * CHANGE: CHANGELOG ORDER - newest on top.
46
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
47
+
48
+ 0.1.23
49
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
50
+
51
+ 0.1.23-beta.1
52
+ * Renamed branch to follow the release versions.
53
+ * CLEANUP - More debug info for the SK dashboard using this.app.setPluginError
54
+ * CLEANUP - Removed CreateGPX, was only used for removed Email transmission of the track
55
+
56
+ 0.1.22-beta.2
57
+
58
+ * CLEANUP and move to Object Oriented Javascript
59
+
60
+ 0.1.22-beta.1
61
+
62
+ * CONFIG: Attempt sending location while moving - Default changed from false to true
63
+ * CONFIG: Ping added for 24h ping if boat is not moved. - Default: true
64
+ * Package.json - Nodemailer dependency removed
65
+ * Marked for removal - Depricated "sendEmailData" function.
66
+ * REMOVED - sendEmail.js
67
+ * CLEANUP - Renamed emaiCron to apiCron
68
+ * NEW: 24h api ping, when enabled, even if boat didn't move.
69
+
package/README.md CHANGED
@@ -1,26 +1,26 @@
1
- # SignalK To NFL
2
- Effortlessly log your boat's movement to **noforeignland.com**
3
-
4
- ## Features
5
- * Automatically log your position to NFL
6
- * Send detailed tracks to log your entire trip and not just your final position
7
- * Can be used in near real time or cache and upload when stopped and data-connection is available.
8
- * Can sent a 24h keepalive, when off the boat for a while.
9
-
10
- ## Issues
11
- * Report issues on GitHub (https://github.com/noforeignland/nfl-signalk/issues)
12
-
13
- ## Requirements
14
- * An internet connection is required in order to update NFL.
15
- * A navigation.position data path inside Signal K for self, which is your current GPS position
16
- * A **noforeignland.com** account
17
- * Your Boat API Key from the **noforeignland.com** website:
18
- * Account > Settings > Boat tracking > API Key
19
-
20
- > Note your Boat API Key is not available in the app.
21
- > You must sign in to the **noforeignland.com** website (using the same authentication method you use for the app: Google. Facebook, Email).
22
-
23
- ## Configuration
24
- 1. Add your boat's API Key into the Server > Plugin Config > Signal K to Noforeignland > Boat API Key
25
- 2. Hit "Submit"
26
- 3. Restart the Signal K server
1
+ # Signal K To NFL
2
+ Effortlessly log your boat's movement to **noforeignland.com**
3
+
4
+ ## Features
5
+ * Automatically log your position to NFL
6
+ * Send detailed tracks to log your entire trip and not just your final position
7
+ * Can be used in near real time or cache and upload when stopped and data-connection is available.
8
+ * Can sent a 24h keepalive, when off the boat for a while.
9
+
10
+ ## Issues
11
+ * Report issues on GitHub (https://github.com/noforeignland/nfl-signalk/issues)
12
+
13
+ ## Requirements
14
+ * An internet connection is required in order to update NFL.
15
+ * A navigation.position data path inside Signal K for self, which is your current GPS position
16
+ * A **noforeignland.com** account
17
+ * Your Boat API Key from the **noforeignland.com** website:
18
+ * Account > Settings > Boat tracking > API Key
19
+
20
+ > Note your Boat API Key is not available in the app.
21
+ > You must sign in to the **noforeignland.com** website (using the same authentication method you use for the app: Google. Facebook, Email).
22
+
23
+ ## Configuration
24
+ 1. Add your boat's API Key into the Server > Plugin Config > Signal K to Noforeignland > Boat API Key
25
+ 2. Hit "Submit"
26
+ 3. Restart the Signal K server
package/doc/beta_install.md ADDED
@@ -0,0 +1,62 @@
1
+ How-to install the latest beta on your device?
2
+
3
+ This guide assumes you have a default install with default folders.
4
+ This is written for a Cerbo GX or 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
+ **For Raspberry PI:**
8
+
9
+ 1. Backup old data
10
+
11
+ ```
12
+ cd ~
13
+ mkdir nfl-backup
14
+ cp -a .signalk/node_modules/signalk-to-noforeignland/* nfl-backup/
15
+ ```
16
+
17
+ 2. Get new files from repo (main for latest)
18
+
19
+ ```
20
+ cd ~/.signalk/node_modules/signalk-to-noforeignland/
21
+ rm *
22
+ #NOTE: Trackdir will not be deleted, this is what we want.
23
+ wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
24
+ unzip main.zip
25
+ cp -r nfl-signalk-main/* .
26
+ rm main.zip
27
+ rm -rf nfl-signalk-main/
28
+ ```
29
+
30
+ 3. Restart Server & Check logs
31
+
32
+ ```
33
+ sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
34
+ ```
35
+
36
+
37
+ **For Cerbo GX with Image Large:**
38
+ 1. Backup old data
39
+
40
+ ```
41
+ cd ~
42
+ mkdir nfl-backup
43
+ cp -a /data/conf/signalk/node_modules/signalk-to-noforeignland/* nfl-backup
44
+ ```
45
+
46
+ 2. Get new files from repo (main for latest)
47
+
48
+ ```
49
+ cd /data/conf/signalk/node_modules/signalk-to-noforeignland/
50
+ rm *
51
+ # NOTE: Trackdir will not be deleted, this is what we want.
52
+ wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
53
+ unzip main.zip
54
+ cp -r nfl-signalk-main/* .
55
+ rm main.zip
56
+ rm -rf nfl-signalk-main/
57
+ ```
58
+
59
+ 3. Restart Server & Check logs
60
+ ```
61
+ Restart Server vom Webgui and check logs in Webgui
62
+ ```