@noforeignland/signalk-to-noforeignland 0.2.1 → 0.2.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.
@@ -1,35 +1,32 @@
1
- name: Publish Package
2
-
3
- on:
4
- push:
5
- tags:
6
- - 'v*' # version tags e.g. v0.1.41
7
-
8
- permissions:
9
- id-token: write # REQUIRED for OIDC
10
- contents: read
11
- packages: write
12
-
13
- jobs:
14
- publish:
15
- runs-on: ubuntu-latest
16
-
17
- steps:
18
- # 1. Checkout code
19
- - uses: actions/checkout@v4
20
-
21
- # 2. Setup Node.js and enable OIDC auth
22
- - uses: actions/setup-node@v4
23
- with:
24
- node-version: '20'
25
- registry-url: 'https://registry.npmjs.org'
26
- always-auth: true
27
-
28
- # 3. Install deps
29
- - run: npm ci
30
-
31
- # 4. Run tests (optional)
32
- - run: npm test
33
-
34
- # 5. Publish via OIDC (NO token, NO login!)
35
- - run: npm publish --access public --provenance
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
+ - run: npm install
28
+
29
+ - run: npm test
30
+
31
+ - name: Publish
32
+ run: npm publish --provenance --access public
package/CHANGELOG.md CHANGED
@@ -1,116 +1,122 @@
1
- 0.2.0
2
- * CHANGE: Deployment via OIDC authentication
3
-
4
- 0.1.35
5
- * CHANGE: Deployment via OIDC authentication
6
-
7
- 0.1.34
8
- * CHANGE: Fix repository URL format
9
-
10
- 0.1.33
11
- * CHANGE: Deployment via OIDC authentication
12
-
13
- 0.1.32
14
- * CHANGE: Deployment via OIDC authentication
15
-
16
- 0.1.31
17
- * CHANGE: Deployment via OIDC authentication
18
-
19
- 0.1.30
20
- * CHANGE: Deployment via OIDC authentication
21
-
22
- 0.1.29
23
- * CHANGE: Removed unused dependency "is-reachable" in package.json
24
-
25
- 0.1.29-beta.2
26
- * NEW: setPluginError and error in data path if Internet Connection is not working.
27
-
28
- 0.1.29-beta.1
29
- * CHANGE: After talking to Treppo from Sugnal K core team we should use the data path "noforeignland.*", code and docs changed.
30
- * CHANGE: README.md info added and format optimized
31
- * CHANGE: GPS source at the end for setPluginStatus - Cerbo has a long source name and truncates it.
32
- * CHANGE: Use "npm install instead" of "npm ci" to push from Github to npmjs using OIDC authentication
33
- * CHANGE: Moved navigation.position source from path noforeignland.status to noforeignland.source
34
-
35
- 0.1.28
36
- * BUGFIX: No GPS data found - introduced in 0.1.27 - Thanks Piotr
37
-
38
- 0.1.28-beta.2
39
- * 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.
40
- * 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
41
- * CHANGE: Optimize GPS detection if multiple navigation.position from different sources exist.
42
- * CHANGE: PluginStatus optimized for limited space available.
43
- * CHANGE: doc/beta_install.md changed for new file structure.
44
-
45
- 0.1.28-beta.1
46
- * 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
47
-
48
- 0.1.27
49
- * Final version after successful testing SV MOIN and SV KIAPA NUI
50
-
51
- 0.1.27-beta.1
52
- * NEW: NPMJS requires new method for publishing. The old tokens will expire Nov 19th, 2025, so moving to OIDC authentication.
53
- * NEW: Check the GPS status in navigation.position, else retry and throw PluginError on Dashboard
54
- * 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:
55
- * New points accumulate in nfl-track-pending.jsonl
56
- * Send succeeds → API confirms receipt
57
- * If keepFiles=true: The content of pending file is appended to nfl-track-sent.jsonl (line 588)
58
- * Pending file is deleted
59
- * Next GPS points create a new pending file
60
- * Next successful send appends again to the same nfl-track-sent.jsonl
61
-
62
- 0.1.26
63
- * Same as 0.1.26-beta.1
64
-
65
- 0.1.26-beta.1
66
- * CHANGE: PluginStatus last track sent "Not transfered since plugin start" gets truncated by the dashboard. Changed to "None since start"
67
-
68
- 0.1.25
69
- * CHANGE: Minimum boat move default increased from 50m to 80m
70
- * CHANGE: Updated the README.md
71
- * CHANGE: Use public ipv4 DNS instead of local with cache for testInternet()
72
- * Final version after successful testing SV MOIN and SV KIAPA NUI
73
-
74
- 0.1.25-beta.3
75
- * NEW: Check if boat key is set on startup, else report error to dashboard
76
- * 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.
77
- * CHANGE: Migration of < 0.1.25 Plugin settings to new structure.
78
- * CHANGE: PluginStatus last track sent "Never" changed to "Not transfered since plugin start" to avoid confusions.
79
-
80
-
81
- 0.1.25-beta.2
82
- * CHANGE: Typo in pluginName fixed
83
- * CHANGE: Dates for SetPlugin now ISO8601 formated (https://github.com/noforeignland/nfl-signalk/issues/9)
84
-
85
- 0.1.25-beta.1
86
- * 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.
87
-
88
- 0.1.24
89
- * 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
90
- * 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.
91
- * CHANGE: Renamed CHANGELOG to CHANGELOG.md
92
- * CHANGE: CHANGELOG ORDER - newest on top.
93
- * Final version after successful testing SV MOIN and SV KIAPA NUI
94
-
95
- 0.1.23
96
- * Final version after successful testing SV MOIN and SV KIAPA NUI
97
-
98
- 0.1.23-beta.1
99
- * Renamed branch to follow the release versions.
100
- * CLEANUP - More debug info for the SK dashboard using this.app.setPluginError
101
- * CLEANUP - Removed CreateGPX, was only used for removed Email transmission of the track
102
-
103
- 0.1.22-beta.2
104
-
105
- * CLEANUP and move to Object Oriented Javascript
106
-
107
- 0.1.22-beta.1
108
-
109
- * CONFIG: Attempt sending location while moving - Default changed from false to true
110
- * CONFIG: Ping added for 24h ping if boat is not moved. - Default: true
111
- * Package.json - Nodemailer dependency removed
112
- * Marked for removal - Depricated "sendEmailData" function.
113
- * REMOVED - sendEmail.js
114
- * CLEANUP - Renamed emaiCron to apiCron
115
- * NEW: 24h api ping, when enabled, even if boat didn't move.
116
-
1
+ 0.2.2
2
+ * CHANGE: Deployment via OIDC authentication
3
+
4
+ 0.2.1
5
+ * CHANGE: Deployment via OIDC authentication
6
+
7
+ 0.2.0
8
+ * CHANGE: Deployment via OIDC authentication
9
+
10
+ 0.1.35
11
+ * CHANGE: Deployment via OIDC authentication
12
+
13
+ 0.1.34
14
+ * CHANGE: Fix repository URL format
15
+
16
+ 0.1.33
17
+ * CHANGE: Deployment via OIDC authentication
18
+
19
+ 0.1.32
20
+ * CHANGE: Deployment via OIDC authentication
21
+
22
+ 0.1.31
23
+ * CHANGE: Deployment via OIDC authentication
24
+
25
+ 0.1.30
26
+ * CHANGE: Deployment via OIDC authentication
27
+
28
+ 0.1.29
29
+ * CHANGE: Removed unused dependency "is-reachable" in package.json
30
+
31
+ 0.1.29-beta.2
32
+ * NEW: setPluginError and error in data path if Internet Connection is not working.
33
+
34
+ 0.1.29-beta.1
35
+ * CHANGE: After talking to Treppo from Sugnal K core team we should use the data path "noforeignland.*", code and docs changed.
36
+ * CHANGE: README.md info added and format optimized
37
+ * CHANGE: GPS source at the end for setPluginStatus - Cerbo has a long source name and truncates it.
38
+ * CHANGE: Use "npm install instead" of "npm ci" to push from Github to npmjs using OIDC authentication
39
+ * CHANGE: Moved navigation.position source from path noforeignland.status to noforeignland.source
40
+
41
+ 0.1.28
42
+ * BUGFIX: No GPS data found - introduced in 0.1.27 - Thanks Piotr
43
+
44
+ 0.1.28-beta.2
45
+ * 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.
46
+ * 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
47
+ * CHANGE: Optimize GPS detection if multiple navigation.position from different sources exist.
48
+ * CHANGE: PluginStatus optimized for limited space available.
49
+ * CHANGE: doc/beta_install.md changed for new file structure.
50
+
51
+ 0.1.28-beta.1
52
+ * 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
53
+
54
+ 0.1.27
55
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
56
+
57
+ 0.1.27-beta.1
58
+ * NEW: NPMJS requires new method for publishing. The old tokens will expire Nov 19th, 2025, so moving to OIDC authentication.
59
+ * NEW: Check the GPS status in navigation.position, else retry and throw PluginError on Dashboard
60
+ * 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:
61
+ * New points accumulate in nfl-track-pending.jsonl
62
+ * Send succeeds → API confirms receipt
63
+ * If keepFiles=true: The content of pending file is appended to nfl-track-sent.jsonl (line 588)
64
+ * Pending file is deleted
65
+ * Next GPS points → create a new pending file
66
+ * Next successful send appends again to the same nfl-track-sent.jsonl
67
+
68
+ 0.1.26
69
+ * Same as 0.1.26-beta.1
70
+
71
+ 0.1.26-beta.1
72
+ * CHANGE: PluginStatus last track sent "Not transfered since plugin start" gets truncated by the dashboard. Changed to "None since start"
73
+
74
+ 0.1.25
75
+ * CHANGE: Minimum boat move default increased from 50m to 80m
76
+ * CHANGE: Updated the README.md
77
+ * CHANGE: Use public ipv4 DNS instead of local with cache for testInternet()
78
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
79
+
80
+ 0.1.25-beta.3
81
+ * NEW: Check if boat key is set on startup, else report error to dashboard
82
+ * 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.
83
+ * CHANGE: Migration of < 0.1.25 Plugin settings to new structure.
84
+ * CHANGE: PluginStatus last track sent "Never" changed to "Not transfered since plugin start" to avoid confusions.
85
+
86
+
87
+ 0.1.25-beta.2
88
+ * CHANGE: Typo in pluginName fixed
89
+ * CHANGE: Dates for SetPlugin now ISO8601 formated (https://github.com/noforeignland/nfl-signalk/issues/9)
90
+
91
+ 0.1.25-beta.1
92
+ * 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.
93
+
94
+ 0.1.24
95
+ * 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
96
+ * 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.
97
+ * CHANGE: Renamed CHANGELOG to CHANGELOG.md
98
+ * CHANGE: CHANGELOG ORDER - newest on top.
99
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
100
+
101
+ 0.1.23
102
+ * Final version after successful testing SV MOIN and SV KIAPA NUI
103
+
104
+ 0.1.23-beta.1
105
+ * Renamed branch to follow the release versions.
106
+ * CLEANUP - More debug info for the SK dashboard using this.app.setPluginError
107
+ * CLEANUP - Removed CreateGPX, was only used for removed Email transmission of the track
108
+
109
+ 0.1.22-beta.2
110
+
111
+ * CLEANUP and move to Object Oriented Javascript
112
+
113
+ 0.1.22-beta.1
114
+
115
+ * CONFIG: Attempt sending location while moving - Default changed from false to true
116
+ * CONFIG: Ping added for 24h ping if boat is not moved. - Default: true
117
+ * Package.json - Nodemailer dependency removed
118
+ * Marked for removal - Depricated "sendEmailData" function.
119
+ * REMOVED - sendEmail.js
120
+ * CLEANUP - Renamed emaiCron to apiCron
121
+ * NEW: 24h api ping, when enabled, even if boat didn't move.
122
+
package/README.md CHANGED
@@ -1,42 +1,42 @@
1
- # Signal K To Noforeignland
2
- Effortlessly log your boat's movement to **noforeignland.com**
3
-
4
- ## Features
5
- * Automatically log your position to noforeignland.com
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
- * Sends 24h keepalive
9
- * Option to archive your track on the local disk
10
- * Detailed plugin information in the SK dashboard
11
- * SK data paths about the plugin status for your own dashboard or Node Red coding
12
-
13
- ## Issues
14
- * Server -> Plugin Config -> Signal K to Noforeignland -> Enable debug log (top right)
15
- * Report issues on GitHub (https://github.com/noforeignland/nfl-signalk/issues)
16
-
17
- ## Requirements
18
- * An internet connection is required in order to update noforeignland.com
19
- * A navigation.position data path inside Signal K for self, which is your current GPS position
20
- * A **noforeignland.com** account
21
- * Your Boat API Key from the **noforeignland.com** website:
22
- * Account > Settings > Boat tracking > API Key
23
-
24
- > Note your Boat API Key is not available in the app.
25
- > You must sign in to the **noforeignland.com** website (using the same authentication method you use for the app: Google. Facebook, Email).
26
-
27
- ## Configuration
28
- 1. Add your boat's API Key into the Server > Plugin Config > Signal K to Noforeignland > Boat API Key
29
- 2. Hit "Submit"
30
- 3. Restart the Signal K server
31
-
32
- ## Data paths created by this plugin
33
- ```
34
- noforeignland.savepoint - ISO8601 timestamp - when was last point saved to trackfile
35
- noforeignland.savepoint_local - locale timestamp - when was last point saved to trackfile
36
- noforeignland.sent_to_api - ISO8601 timestamp - last successful transfer to the API
37
- noforeignland.sent_to_api_local - locale timestamp - last successful transfer to the API
38
- noforeignland.status - string - Status & Error messages
39
- noforeignland.status_boolean - number - 0 = normal operation, 1 = error
40
- noforeignland.source - string - string - data source of navigation.position
41
- 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
+ ## Features
5
+ * Automatically log your position to noforeignland.com
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
+ * Sends 24h keepalive
9
+ * Option to archive your track on the local disk
10
+ * Detailed plugin information in the SK dashboard
11
+ * SK data paths about the plugin status for your own dashboard or Node Red coding
12
+
13
+ ## Issues
14
+ * Server -> Plugin Config -> Signal K to Noforeignland -> Enable debug log (top right)
15
+ * Report issues on GitHub (https://github.com/noforeignland/nfl-signalk/issues)
16
+
17
+ ## Requirements
18
+ * An internet connection is required in order to update noforeignland.com
19
+ * A navigation.position data path inside Signal K for self, which is your current GPS position
20
+ * A **noforeignland.com** account
21
+ * Your Boat API Key from the **noforeignland.com** website:
22
+ * Account > Settings > Boat tracking > API Key
23
+
24
+ > Note your Boat API Key is not available in the app.
25
+ > You must sign in to the **noforeignland.com** website (using the same authentication method you use for the app: Google. Facebook, Email).
26
+
27
+ ## Configuration
28
+ 1. Add your boat's API Key into the Server > Plugin Config > Signal K to Noforeignland > Boat API Key
29
+ 2. Hit "Submit"
30
+ 3. Restart the Signal K server
31
+
32
+ ## Data paths created by this plugin
33
+ ```
34
+ noforeignland.savepoint - ISO8601 timestamp - when was last point saved to trackfile
35
+ noforeignland.savepoint_local - locale timestamp - when was last point saved to trackfile
36
+ noforeignland.sent_to_api - ISO8601 timestamp - last successful transfer to the API
37
+ noforeignland.sent_to_api_local - locale timestamp - last successful transfer to the API
38
+ noforeignland.status - string - Status & Error messages
39
+ noforeignland.status_boolean - number - 0 = normal operation, 1 = error
40
+ noforeignland.source - string - string - data source of navigation.position
41
+ notifications.noforeignland.status_boolean - json object - auto created
42
42
  ```
@@ -1,60 +1,60 @@
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 -rf *
22
- wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
23
- unzip main.zip
24
- cp -r nfl-signalk-main/* .
25
- rm main.zip
26
- rm -rf nfl-signalk-main/
27
- ```
28
-
29
- 3. Restart Server & Check logs
30
-
31
- ```
32
- sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
33
- ```
34
-
35
-
36
- **For Cerbo GX with Image Large:**
37
- 1. Backup old data
38
-
39
- ```
40
- cd ~
41
- mkdir nfl-backup
42
- cp -a /data/conf/signalk/node_modules/signalk-to-noforeignland/* nfl-backup
43
- ```
44
-
45
- 2. Get new files from repo (main for latest)
46
-
47
- ```
48
- cd /data/conf/signalk/node_modules/signalk-to-noforeignland/
49
- rm -rf *
50
- wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
51
- unzip main.zip
52
- cp -r nfl-signalk-main/* .
53
- rm main.zip
54
- rm -rf nfl-signalk-main/
55
- ```
56
-
57
- 3. Restart Server & Check logs
58
- ```
59
- Restart Server vom Webgui and check logs in Webgui
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 -rf *
22
+ wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
23
+ unzip main.zip
24
+ cp -r nfl-signalk-main/* .
25
+ rm main.zip
26
+ rm -rf nfl-signalk-main/
27
+ ```
28
+
29
+ 3. Restart Server & Check logs
30
+
31
+ ```
32
+ sudo systemctl restart signalk.service && sudo journalctl -u signalk.service -f
33
+ ```
34
+
35
+
36
+ **For Cerbo GX with Image Large:**
37
+ 1. Backup old data
38
+
39
+ ```
40
+ cd ~
41
+ mkdir nfl-backup
42
+ cp -a /data/conf/signalk/node_modules/signalk-to-noforeignland/* nfl-backup
43
+ ```
44
+
45
+ 2. Get new files from repo (main for latest)
46
+
47
+ ```
48
+ cd /data/conf/signalk/node_modules/signalk-to-noforeignland/
49
+ rm -rf *
50
+ wget https://github.com/noforeignland/nfl-signalk/archive/refs/heads/main.zip
51
+ unzip main.zip
52
+ cp -r nfl-signalk-main/* .
53
+ rm main.zip
54
+ rm -rf nfl-signalk-main/
55
+ ```
56
+
57
+ 3. Restart Server & Check logs
58
+ ```
59
+ Restart Server vom Webgui and check logs in Webgui
60
60
  ```