@mxtommy/kip 3.11.0 → 3.12.0

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 (55) hide show
  1. package/CHANGELOG.md +16 -2
  2. package/README.md +6 -6
  3. package/package.json +1 -1
  4. package/public/3rdpartylicenses.txt +61 -61
  5. package/public/assets/help-docs/community.md +78 -0
  6. package/public/assets/help-docs/configuration.md +1 -1
  7. package/public/assets/help-docs/contact-us.md +58 -8
  8. package/public/assets/help-docs/dashboards.md +117 -42
  9. package/public/assets/help-docs/datainspector.md +1 -1
  10. package/public/assets/help-docs/datasets.md +1 -1
  11. package/public/assets/help-docs/embedwidget.md +1 -1
  12. package/public/assets/help-docs/grafana.md +1 -1
  13. package/public/assets/help-docs/influxdb.md +1 -1
  14. package/public/assets/help-docs/kiosk.md +17 -1
  15. package/public/assets/help-docs/menu.json +4 -3
  16. package/public/assets/help-docs/putcontrols.md +5 -5
  17. package/public/assets/help-docs/welcome.md +46 -23
  18. package/public/assets/help-docs/zones.md +1 -1
  19. package/public/assets/svg/icons.svg +18 -18
  20. package/public/{chunk-K4BST2XF.js → chunk-3LKIOGV7.js} +1 -1
  21. package/public/{chunk-FPMCI7XZ.js → chunk-65TR3CWM.js} +1 -1
  22. package/public/{chunk-G4B4D3XR.js → chunk-6MRJ4C55.js} +1 -1
  23. package/public/{chunk-KPOCVRYH.js → chunk-7S37JBY2.js} +1 -1
  24. package/public/chunk-A5CYPNMD.js +2 -0
  25. package/public/chunk-BSAAN2EI.js +2 -0
  26. package/public/{chunk-2MAVQD65.js → chunk-CDPHRRZR.js} +1 -1
  27. package/public/{chunk-P4K222SI.js → chunk-D4DROTBC.js} +7 -7
  28. package/public/{chunk-PYBIMDD3.js → chunk-D4MWDRNW.js} +1 -1
  29. package/public/chunk-EPTIEPMQ.js +4 -0
  30. package/public/chunk-F5X5MWHG.js +0 -0
  31. package/public/{chunk-XE352AKG.js → chunk-I454VRMK.js} +1 -1
  32. package/public/chunk-IQG4DDQX.js +1 -0
  33. package/public/{chunk-VZ77T3BF.js → chunk-K5OOC3CF.js} +3 -3
  34. package/public/{chunk-IZAPOSYM.js → chunk-NOLKBYOV.js} +1 -1
  35. package/public/chunk-QOXZFV6P.js +47 -0
  36. package/public/{chunk-GMZROOAF.js → chunk-RMLGKVWE.js} +1 -1
  37. package/public/chunk-T6TC7KWG.js +1 -0
  38. package/public/{chunk-6NRGS3BZ.js → chunk-UHKP2PC3.js} +1 -1
  39. package/public/{chunk-I6UWIF55.js → chunk-UTCRLFYC.js} +1 -1
  40. package/public/{chunk-XFU5YJJP.js → chunk-VEJNBHWJ.js} +1 -1
  41. package/public/{chunk-F4VOQO2M.js → chunk-XLJT6YPP.js} +1 -1
  42. package/public/chunk-YCW2UBVQ.js +1 -0
  43. package/public/{chunk-ANRGX57I.js → chunk-YPUCOH35.js} +12 -12
  44. package/public/chunk-YVLZ2UAQ.js +2 -0
  45. package/public/{chunk-5MLB3PYZ.js → chunk-Z5MCM3TT.js} +10 -10
  46. package/public/{chunk-EJ4JM3HG.js → chunk-ZEV6YXHP.js} +1 -1
  47. package/public/{chunk-TIXQ3FAF.js → chunk-ZPCYFQPB.js} +1 -1
  48. package/public/index.html +1 -1
  49. package/public/main-7TSLA2U5.js +5 -0
  50. package/public/chunk-66OJ5PZF.js +0 -2
  51. package/public/chunk-GIZH6HIB.js +0 -2
  52. package/public/chunk-N3HCHSSE.js +0 -2
  53. package/public/chunk-S4OKR5KN.js +0 -1
  54. package/public/chunk-TARCFDF4.js +0 -4
  55. package/public/main-KP322K7A.js +0 -51
package/CHANGELOG.md CHANGED
@@ -1,8 +1,22 @@
1
+ # v 3.12.0
2
+ # New Features
3
+ * Chartplotter Mode: A dual‑panel, performance‑tuned split experience that lets you run KIP dashboards and Freeboard‑SK together in one adaptive shell. Keep the chart live while moving between dashboards. Seamless side‑by‑side in landscape, smart vertical stacking in portrait and as always, designed for mobile and touch. Use the per‑dashboard forced collapse option for data‑focused layouts while Freeboard remains active in the background. Drag resize split distribution with commit‑on‑save editing. This feature brings you:
4
+ * Freeboard-SK chart continuity while you cycle dashboards (full-on dedicated MFD feel, Signal K native!)
5
+ * Remote dashboard switching compatible (no chart context loss)
6
+ * Split collapse and change dashboard transitive animations
7
+ * Per‑dashboard collapse flag to lock map closed for data‑dense layouts
8
+ * Optional Freeboard‑SK widget still available if persistent background map not required
9
+ # Improvements
10
+ * Updated help documentation:
11
+ * New Community section: curated video library, creator channel directory, contribution guidelines (PR / Discord #showcase) and ecosystem resource table.
12
+ * Added optional Chromium "No Sleep" and resource usage optimization launch parameters to the "Kiosk Mode" documentation.
13
+ * Enhanced "Digital Switching and PUT" section with links to supported devices.
14
+ * "Managing Dashboards" tips and recommendations update.
1
15
  # v 3.11.0
2
- # New Feature
16
+ # New Features
3
17
  * Level gauge: Dual-scale heel angle indicator combining a high‑precision ±5° fine level with a wide ±40° coarse arc for fast trim tuning and broader heel / sea‑state monitoring. **Special thanks to @fymmot for permission to integrate his plugin code. See https://github.com/fymmot/signalk-heel-angle**
4
18
  # Improvements
5
- * Minor Switch Panel state visibility improvement using bold fonts and a blow effect. Fixes #813
19
+ * Minor Switch Panel state visibility improvement using bold fonts and a glow effect. Fixes #813
6
20
  * Enhance Countdown Timer Widget with Configurable Time and Sound Alerts. Fixes #814
7
21
  ## Fixes
8
22
  * Dashboard edit button in disabled state on initial app load. Fixes #809
package/README.md CHANGED
@@ -1,4 +1,7 @@
1
1
  # KIP – Signal K Multi-Function Display (MFD) and Marine Instrument Panel
2
+ [![Help Docs](https://img.shields.io/badge/Help-Docs-blue)](src/assets/help-docs/welcome.md)
3
+ [![Community Videos](https://img.shields.io/badge/Community-Videos-purple)](src/assets/help-docs/community.md)
4
+ [![Contact](https://img.shields.io/badge/Contact-Get_in_touch-success)](src/assets/help-docs/contact-us.md)
2
5
 
3
6
  **KIP is the most popular Signal K MFD and marine instrument panel: plug-and-play, touch-optimized, pre-installed, and ready-to-use across all devices.**
4
7
 
@@ -64,18 +67,15 @@ Run KIP in full-screen mode without browser controls, just like a native mobile
64
67
  - Effortlessly create and customize dashboards using an intuitive grid layout system.
65
68
  - Add, resize, and align widgets to design tailored displays for your specific needs.
66
69
  - Duplicate widgets or entire dashboards, including their configurations, with a single click.
67
- - Organize and reorder dashboards by adding names and arranging them to suit your workflow.
68
- - Seamlessly switch between multiple dashboards for different roles, devices, or use cases.
69
-
70
- ### Multiple User Profiles
71
- Create and manage profiles for different roles, devices, or use cases. Each profile can have its own dashboard configurations and settings.
70
+ - Simply drag dashboards to reorganize them. Double-click any dashboard to open the icon gallery and give each page a unique visual identity.
71
+ - Seamlessly switch between multiple configuration profles for different roles and devices or use cases.
72
72
 
73
73
  ## User Experience
74
74
 
75
75
  ### Flexible and Easy
76
76
  Meant to build purposeful dashboards with however many widgets you want, wherever you want them.
77
77
 
78
- Add, resize, and position the widgets of your choosing. Need more? Add as many additional dashboards as you wish to keep your display purposeful. Simply swipe up and down to quickly cycle through dashboards.
78
+ Add, resize, and position the widgets of your choosing. Need more? Add as many additional dashboards as you wish to keep your display purposeful. Simply swipe up and down to quickly cycle through dashboards or effortlessly jump between dashboards with a single tap in the action sidenav, always knowing exactly where you are thanks to clear highlighting of your current dashboard.
79
79
 
80
80
  Add widget lists sorted by category
81
81
  ![Layouts Configuration Image](./images/KipWidgetConfig-layout-1024.png)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mxtommy/kip",
3
- "version": "3.11.0",
3
+ "version": "3.12.0",
4
4
  "description": "An advanced and versatile marine instrumentation package to display Signal K data.",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -1,30 +1,4 @@
1
1
 
2
- --------------------------------------------------------------------------------
3
- Package: @godind/canvas-gauges
4
- License: "MIT"
5
-
6
- The MIT License (MIT)
7
-
8
- Copyright (c) 2016 Mykhailo Stadnyk <mikhus@gmail.com>
9
-
10
- Permission is hereby granted, free of charge, to any person obtaining a copy
11
- of this software and associated documentation files (the "Software"), to deal
12
- in the Software without restriction, including without limitation the rights
13
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
- copies of the Software, and to permit persons to whom the Software is
15
- furnished to do so, subject to the following conditions:
16
-
17
- The above copyright notice and this permission notice shall be included in
18
- all copies or substantial portions of the Software.
19
-
20
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
- SOFTWARE.
27
-
28
2
  --------------------------------------------------------------------------------
29
3
  Package: howler
30
4
  License: "MIT"
@@ -50,12 +24,12 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
50
24
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
51
25
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
52
26
  --------------------------------------------------------------------------------
53
- Package: gridstack
27
+ Package: @angular/material
54
28
  License: "MIT"
55
29
 
56
- MIT License
30
+ The MIT License
57
31
 
58
- Copyright (c) 2019-2023 Alain Dumesny. v0.4.0 and older (c) 2014-2018 Pavel Reznikov, Dylan Weiss
32
+ Copyright (c) 2025 Google LLC.
59
33
 
60
34
  Permission is hereby granted, free of charge, to any person obtaining a copy
61
35
  of this software and associated documentation files (the "Software"), to deal
@@ -64,16 +38,16 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
64
38
  copies of the Software, and to permit persons to whom the Software is
65
39
  furnished to do so, subject to the following conditions:
66
40
 
67
- The above copyright notice and this permission notice shall be included in all
68
- copies or substantial portions of the Software.
41
+ The above copyright notice and this permission notice shall be included in
42
+ all copies or substantial portions of the Software.
69
43
 
70
44
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
71
45
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
72
46
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
73
47
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
74
48
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
75
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
76
- SOFTWARE.
49
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
50
+ THE SOFTWARE.
77
51
 
78
52
  --------------------------------------------------------------------------------
79
53
  Package: @angular/animations
@@ -102,10 +76,12 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
102
76
  THE SOFTWARE.
103
77
 
104
78
  --------------------------------------------------------------------------------
105
- Package: ngx-resize-observer
79
+ Package: @angular/platform-browser
106
80
  License: "MIT"
107
81
 
108
- Copyright (c) 2017 Tyler Akins
82
+ The MIT License
83
+
84
+ Copyright (c) 2010-2025 Google LLC. https://angular.dev/license
109
85
 
110
86
  Permission is hereby granted, free of charge, to any person obtaining a copy
111
87
  of this software and associated documentation files (the "Software"), to deal
@@ -114,24 +90,24 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
114
90
  copies of the Software, and to permit persons to whom the Software is
115
91
  furnished to do so, subject to the following conditions:
116
92
 
117
- The above copyright notice and this permission notice shall be included in all
118
- copies or substantial portions of the Software.
93
+ The above copyright notice and this permission notice shall be included in
94
+ all copies or substantial portions of the Software.
119
95
 
120
96
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
121
97
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
122
98
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
123
99
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
124
100
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
125
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
126
- SOFTWARE.
101
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
102
+ THE SOFTWARE.
127
103
 
128
104
  --------------------------------------------------------------------------------
129
- Package: @angular/material
105
+ Package: @godind/canvas-gauges
130
106
  License: "MIT"
131
107
 
132
- The MIT License
108
+ The MIT License (MIT)
133
109
 
134
- Copyright (c) 2025 Google LLC.
110
+ Copyright (c) 2016 Mykhailo Stadnyk <mikhus@gmail.com>
135
111
 
136
112
  Permission is hereby granted, free of charge, to any person obtaining a copy
137
113
  of this software and associated documentation files (the "Software"), to deal
@@ -148,30 +124,40 @@ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
148
124
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
149
125
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
150
126
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
151
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
152
- THE SOFTWARE.
127
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
128
+ SOFTWARE.
153
129
 
154
130
  --------------------------------------------------------------------------------
155
- Package: chartjs-plugin-annotation
131
+ Package: gridstack
156
132
  License: "MIT"
157
133
 
158
- The MIT License (MIT)
134
+ MIT License
159
135
 
160
- Copyright (c) 2016-2021 chartjs-plugin-annotation Contributors
136
+ Copyright (c) 2019-2023 Alain Dumesny. v0.4.0 and older (c) 2014-2018 Pavel Reznikov, Dylan Weiss
161
137
 
162
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
138
+ Permission is hereby granted, free of charge, to any person obtaining a copy
139
+ of this software and associated documentation files (the "Software"), to deal
140
+ in the Software without restriction, including without limitation the rights
141
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
142
+ copies of the Software, and to permit persons to whom the Software is
143
+ furnished to do so, subject to the following conditions:
163
144
 
164
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
145
+ The above copyright notice and this permission notice shall be included in all
146
+ copies or substantial portions of the Software.
165
147
 
166
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
148
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
149
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
150
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
151
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
152
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
153
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
154
+ SOFTWARE.
167
155
 
168
156
  --------------------------------------------------------------------------------
169
- Package: @godind/ng-canvas-gauges
157
+ Package: ngx-resize-observer
170
158
  License: "MIT"
171
159
 
172
- MIT License
173
-
174
- Copyright (c) 2017 Vlad Martynenko <vladimir.martynenko.work@gmail.com>
160
+ Copyright (c) 2017 Tyler Akins
175
161
 
176
162
  Permission is hereby granted, free of charge, to any person obtaining a copy
177
163
  of this software and associated documentation files (the "Software"), to deal
@@ -192,12 +178,26 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
192
178
  SOFTWARE.
193
179
 
194
180
  --------------------------------------------------------------------------------
195
- Package: @angular/platform-browser
181
+ Package: chartjs-plugin-annotation
196
182
  License: "MIT"
197
183
 
198
- The MIT License
184
+ The MIT License (MIT)
199
185
 
200
- Copyright (c) 2010-2025 Google LLC. https://angular.dev/license
186
+ Copyright (c) 2016-2021 chartjs-plugin-annotation Contributors
187
+
188
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
189
+
190
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
191
+
192
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
193
+
194
+ --------------------------------------------------------------------------------
195
+ Package: @godind/ng-canvas-gauges
196
+ License: "MIT"
197
+
198
+ MIT License
199
+
200
+ Copyright (c) 2017 Vlad Martynenko <vladimir.martynenko.work@gmail.com>
201
201
 
202
202
  Permission is hereby granted, free of charge, to any person obtaining a copy
203
203
  of this software and associated documentation files (the "Software"), to deal
@@ -206,16 +206,16 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
206
206
  copies of the Software, and to permit persons to whom the Software is
207
207
  furnished to do so, subject to the following conditions:
208
208
 
209
- The above copyright notice and this permission notice shall be included in
210
- all copies or substantial portions of the Software.
209
+ The above copyright notice and this permission notice shall be included in all
210
+ copies or substantial portions of the Software.
211
211
 
212
212
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
213
213
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
214
214
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
215
215
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
216
216
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
217
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
218
- THE SOFTWARE.
217
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
218
+ SOFTWARE.
219
219
 
220
220
  --------------------------------------------------------------------------------
221
221
  Package: @angular/cdk
@@ -0,0 +1,78 @@
1
+ # Online Community Content
2
+
3
+ > Want to contribute a video or resource? Share your links by [submitting a PR to this page](https://github.com/mxtommy/Kip/blob/master/src/assets/help-docs/community.md), use the [KIP Discord channel](https://discord.gg/AMDYT2DQga) or open a [GitHub issue](https://github.com/mxtommy/Kip/issues)**!
4
+
5
+ Explore KIP in action and learn from the community. Below are curated videos, creator channels, and related ecosystem resources.
6
+
7
+ ## Community Video Library
8
+ Curated videos created by community members. Ordered to highlight broad onboarding value first.
9
+
10
+ | Thumbnail | Video | Focus | Author / Channel |
11
+ |-----------|-------|-------|------------------|
12
+ | ![KIP v3 Overview](https://i.ytimg.com/vi/53s4JsivXjU/hqdefault.jpg) | [KIP v3 – New Features, Setup & Configuration Walkthrough (Full Overview)](https://www.youtube.com/watch?v=53s4JsivXjU) | Full platform overview & configuration | Boating with the Baileys |
13
+ | ![Raspberry Pi Dashboard Review](https://i.ytimg.com/vi/vDWr8qbK55s/hqdefault.jpg) | [Full review raspberry PI dashboard for sailboats. SV GOAT teach](https://www.youtube.com/watch?v=vDWr8qbK55s) | Hardware + dashboard review (Raspberry Pi) | sailing sv goat |
14
+ | ![Open Source Boat Build Part IV](https://i.ytimg.com/vi/BOPwfBOE1DE/hqdefault.jpg) | [Building an Open Source Boat with Raspberry Pi & NMEA 2000 - Part IV - OpenPlotter, Signal K, KIP](https://www.youtube.com/watch?v=BOPwfBOE1DE) | Integration & onboard system build | The Florida Captain |
15
+ | ![SignalK Racer Widgets](https://i.ytimg.com/vi/oFX2F0z5xqU/hqdefault.jpg) | [SignalK racer plugin KIP widgets – July 2025](https://www.youtube.com/watch?v=oFX2F0z5xqU) | Racing plugin KIP widgets demo | Gregory J Wilkins |
16
+ | ![Charla Nautica Friki](https://i.ytimg.com/vi/3pnVsj44VO4/hqdefault.jpg) | [I Charla Náutica Friki: Raspberry, Domótica, Signal K, Interconexión de Equipos…](https://www.youtube.com/watch?v=3pnVsj44VO4) | Spanish session: ecosystem & integration | Luisloflipa Sailing |
17
+
18
+ Improve or add entries: PR or Discord #showcase.
19
+
20
+ ---
21
+
22
+ ## Authors & Channels
23
+ Creator channels producing helpful KIP or Signal K related content.
24
+
25
+ ### Boating with the Baileys
26
+ - Channel: https://www.youtube.com/@BoatingwiththeBaileys
27
+ - Focus: End‑user onboarding, feature walkthroughs, configuration best practices.
28
+ - Featured Video: [KIP v3 – New Features, Setup & Configuration Walkthrough](https://www.youtube.com/watch?v=53s4JsivXjU)
29
+
30
+ ### Sailing sv goat
31
+ - Channel: https://www.youtube.com/@sv_goat
32
+ - Focus: Practical onboard installs, Raspberry Pi builds, real‑world usage.
33
+ - Featured Video: [Full review Raspberry Pi dashboard for sailboats](https://www.youtube.com/watch?v=vDWr8qbK55s)
34
+
35
+ ### The Florida Captain
36
+ - Channel: https://www.youtube.com/@TheFloridaCaptain
37
+ - Focus: Open source boat build series, NMEA 2000 integration, system architecture.
38
+ - Featured Video: [Open Source Boat Build Part IV](https://www.youtube.com/watch?v=BOPwfBOE1DE)
39
+
40
+ ### Gregory J Wilkins
41
+ - Channel: https://www.youtube.com/@gregoryjwilkins6001
42
+ - Focus: Racing plugin experimentation, tactical visualization, performance tooling.
43
+ - Featured Video: [SignalK Racer Plugin KIP Widgets](https://www.youtube.com/watch?v=oFX2F0z5xqU)
44
+
45
+ ### Luisloflipa Sailing
46
+ - Channel: https://www.youtube.com/@luisloflipa
47
+ - Focus: Spanish-language coverage, integration discussions, DIY marine electronics.
48
+ - Featured Video: [Charla Náutica Friki](https://www.youtube.com/watch?v=3pnVsj44VO4)
49
+
50
+ ### Want to Be Listed?
51
+ Open a PR or post in Discord #showcase with:
52
+ - Channel name + link
53
+ - Focus summary (1 line)
54
+ - One featured video (link + short purpose sentence)
55
+
56
+ ---
57
+
58
+ ---
59
+
60
+ ## More Community Resources
61
+
62
+ - [Signal K Home page](https://signalk.org/) — The open marine data standard powering KIP
63
+ - [Signal K Discord](https://discord.com/invite/uuZrwz4dCS) — Live chat server: questions, support, contribute and collaborate
64
+ - [Signal K GutHub Project](https://github.com/SignalK) — Feature requests, bug reports, and feedback
65
+ - [SensESP](https://signalk.org/SensESP/) — A Signal K sensor development toolkit for the ESP32 platform
66
+ - [OpenMarine Community](https://openmarine.net/) — OpenPlotter, MacArthur HAT and open source marine tech
67
+
68
+ ## More Community Resources
69
+
70
+ - [Signal K Home page](https://signalk.org/) — The open marine data standard powering KIP
71
+ - [Signal K Discord](https://discord.com/invite/uuZrwz4dCS) — Live chat server: questions, support, contribute and collaborate
72
+ - [Signal K GutHub Project](https://github.com/SignalK) — Feature requests, bug reports, and feedback
73
+ - [SensESP](https://signalk.org/SensESP/) — A Signal K sensor development toolkit for the ESP32 platform
74
+ - [OpenMarine Community](https://openmarine.net/) — OpenPlotter, MacArthur HAT and open source marine tech
75
+
76
+ ---
77
+
78
+ > Want to contribute a video or resource? Share your link in the Discord #showcase channel or open a GitHub issue!
@@ -1,4 +1,4 @@
1
- # Configuration Management
1
+ ## Configuration Management
2
2
 
3
3
  KIP provides a "Login to Server" option that determines where your configuration is stored. It is **strongly recommended** to enable server login in the **Settings** under the **Connectivity** tab. This ensures your configurations are stored remotely on the Signal K server and allows automatic loading of configuration from any device. See the "Creating a Signal K user" section below for information on how to create a user.
4
4
 
@@ -1,16 +1,66 @@
1
- # Get in Touch
1
+ ## Get in Touch
2
2
 
3
- We’d love to hear from you! KIP has an active community on the Signal K Discord server. Join us to get help, explore what others are doing with KIP and Signal K, stay updated with the latest news, and share your ideas.
3
+ We’d love to hear from you. The KIP community is active and friendly—whether you are just getting started, troubleshooting an installation, or brainstorming a new idea.
4
4
 
5
- 👉 **Join the conversation in the [KIP Discord channel](https://discord.gg/AMDYT2DQga).**
5
+ 👉 **Chat with the community in the [KIP Discord channel](https://discord.gg/AMDYT2DQga).**
6
+
7
+ Use Discord for quick questions, sharing dashboards, comparing hardware setups, and learning how others integrate KIP with Signal K.
6
8
 
7
9
  ---
8
10
 
9
- ## Feature Requests and Bug Reports
11
+ ## When to Use GitHub Issues
12
+
13
+ Please open a GitHub issue anytime you:
14
+ - Want to request a feature or enhancement
15
+ - Find a bug or regression
16
+ - Notice incorrect documentation
17
+ - Have a reproducible performance or stability problem
18
+
19
+ 🔗 **Create or review issues here: [KIP GitHub Issues](https://github.com/mxtommy/Kip/issues)**
20
+
21
+ Before creating a new issue:
22
+ 1. Use the search box to see if it already exists (add keywords like the widget name, setting, or error text).
23
+ 2. If you find an existing issue, add a comment or reaction instead of opening a duplicate.
10
24
 
11
- Have a great idea for a new feature? Found a bug? Let us know!
12
- Submit your feature requests or report issues directly on our GitHub project page:
25
+ ### What to Include in a Bug Report
26
+ Provide clear, specific details so we can reproduce and fix the problem faster:
27
+ - What you expected vs. what happened
28
+ - Steps to reproduce (numbered list if possible)
29
+ - KIP version (see About / build info) and deployment method (e.g. Signal K app store, manual build)
30
+ - Signal K server version
31
+ - Browser + version (e.g. Firefox 128, Chrome 129, Safari 18)
32
+ - Relevant widget(s) or data paths (e.g. `navigation.speedOverGround`)
33
+ - Screenshots or a short GIF (if visual)
34
+ - Console errors (from browser dev tools) if any
35
+
36
+ ### Feature Requests
37
+ Tell us:
38
+ - The problem you want to solve (not only the solution you imagine)
39
+ - Why it matters / how it improves use onboard
40
+ - Any related Signal K paths or data sources
41
+ - Rough idea of UI needs (new widget? setting? config option?)
42
+
43
+ If you’re willing to help test or prototype—say so. That speeds things up.
44
+
45
+ ---
46
+
47
+ ## Response Expectations
48
+ - Discord: often same-day community responses; core maintainer availability may vary.
49
+ - GitHub issues: triage typically within a few days; complex features may be discussed before acceptance.
50
+ - Pull requests: reviews depend on scope—small fixes are faster.
51
+
52
+ If something critical slips through, feel free to politely bump the issue after about a week.
53
+
54
+ ---
55
+
56
+ ## Contributing Beyond Issues
57
+ - Share dashboards, layouts, or usage patterns. Use the Discord #showcase chanel with a few pictures (great inspiration for others!).
58
+ - Help answer other users’ questions on Discord.
59
+ - Test new widgets or configuration flows and give feedback.
60
+
61
+ ---
13
62
 
14
- 🔗 **[KIP GitHub Issues](https://github.com/mxtommy/Kip/issues)**
63
+ ## Thank You
64
+ Your feedback, curiosity, and ideas directly shape KIP. Whether it’s a tiny typo fix or a major feature concept—every contribution moves the project forward.
15
65
 
16
- Your feedback helps us make KIP even better. Thank you for contributing!
66
+ Fair winds, and happy hacking.
@@ -1,42 +1,117 @@
1
- # Managing Dashboards
2
- You can organize your dashboards from the Dashboards page. To edit a dashboard layout, first visualize the dashboard and unlock it.
3
-
4
- ## Dashboard Pages
5
- On the Dashboards page, you can add, reorder, delete, rename, and duplicate dashboards. Each dashboard can have a custom name and icon for easy identification. The dashboard name is briefly visible when you cycle through dashboards. Available actions include:
6
- - **Long press** a dashboard to delete or duplicate it.
7
- - **Double tap** a dashboard to rename it and select an icon.
8
- - **Touch and drag** to reorder dashboards.
9
- - Use the **(+)** button to add a new dashboard.
10
-
11
- When renaming or creating a dashboard, you can choose from a variety of icons to visually represent the dashboard's purpose (e.g., navigation, engine monitoring, weather). Icons are displayed in the dashboard menu for quick recognition.
12
-
13
- ## Editing Layout
14
- To edit a dashboard's widgets and arrangement, you need to unlock its layout. View the desired dashboard, access the **Actions menu** on the right-hand side, and tap the bottom **unlock button**. The widgets will become surrounded by dashed borders, indicating you are in edit mode. Actions you can perform while editing a layout include:
15
- - **Long press** an empty area of the dashboard to add a widget (you may need to free up space first).
16
- - **Double tap** a widget to edit its configuration.
17
- - **Touch and drag** a widget to reposition it.
18
- - **Touch and drag** the edges of a widget to resize it.
19
- - **Long press** a widget to delete or duplicate it.
20
- - Use the lower right **Check button** to save changes or the **X button** to discard layout changes.
21
-
22
- ## Widget Gallery
23
- KIP's widgets are versatile visual presentation controls with advanced configuration options to suit your needs. Below is a list of available widgets:
24
-
25
- - **Numeric Display**: Create gauges to display any numerical data sent by your system, such as SOG, depth, wind speed, VMG, refrigerator temperature, or weather data.
26
- - **Text Display**: Display textual data sent by your system, such as MPPT state, vessel details, next waypoint, Fusion radio song information, system component statuses, or configuration details.
27
- - **Date Display**: A timezone-aware control with flexible presentation formatting support.
28
- - **Boolean Control Panel**: A switchboard to configure and operate remote devices, such as light switches, bilge pumps, solenoids, or any Signal K path that supports boolean PUT operations.
29
- - **Position**: Displays the vessel's longitude and latitude based on available GPS devices.
30
- - **Static Label**: A static text widget that allows you to add customizable labels to your dashboard, helping to organize and clarify your layout effectively.
31
- - **Simple Linear Gauge**: A simple horizontal visual display ideal for electrical numerical data, such as chargers, MPPT, or shunts.
32
- - **Linear Gauge**: Visually display any numerical data on a vertical or horizontal scale, such as tank and reservoir levels or battery remaining capacity.
33
- - **Radial Gauge**: Visually display any numerical data on a radial scale, such as boat speed, wind speed, or engine RPM.
34
- - **Compass Gauge**: A card or marine compass to display directional data, such as heading, bearing to the next waypoint, or wind angle.
35
- - **Steel Style Gauge**: An old-school look-and-feel radial and linear gauge.
36
- - **Pitch & Roll**: Horizon-style attitude indicator showing live pitch and roll to monitor trim, heel, and sea-state response.
37
- - **Wind Steering Display**: A typical sailboat wind gauge.
38
- - **Freeboard-SK Chart Plotter**: A high-quality Signal K implementation of the Freeboard integration widget.
39
- - **Autopilot Head**: Operate your autopilot remotely from any device.
40
- - **Data Chart**: Visualize data trends over time.
41
- - **Race Timer**: Track regatta start sequences.
42
- - **Embedded Webpage**: Integrate any web-based content or application into your KIP layout, such as Grafana dashboards, Node-RED dashboards, or your own standalone web app. This widget supports any content that does not cross domains.
1
+ ## Managing Dashboards
2
+ Dashboards let you group widgets by task—navigation, engines, energy, weather, racing, night watch, and more. This guide covers creating, organizing, and editing dashboards, plus an overview of available widget types.
3
+
4
+ ---
5
+
6
+ ## 1. Dashboard Pages Panel
7
+ Open the Actions menu and select Settings.
8
+
9
+ Here you can:
10
+ - Add a new dashboard (+ button)
11
+ - Reorder dashboards (drag with touch or mouse)
12
+ - Rename and pick an icon (double tap or double click)
13
+ - Duplicate a dashboard (long press or long click → Duplicate)
14
+ - Delete a dashboard (long press or long click Delete)
15
+
16
+ Choose icons that reflect each dashboard’s purpose (e.g. compass for navigation, droplet for tanks, bolt for power). Icons appear wherever dashboards are listed.
17
+
18
+ ### Gesture / Action Summary
19
+ | Action | Touch / Mobile | Mouse / Desktop |
20
+ |---------------|-----------------------|------------------------|
21
+ | Add dashboard | Tap (+) | Click (+) |
22
+ | Reorder | Drag tile | Drag tile |
23
+ | Rename/Icon | Double tap | Double click |
24
+ | Duplicate | Long press → Duplicate | Long click → Duplicate |
25
+ | Delete | Long press Delete | Long click Delete |
26
+
27
+ ---
28
+
29
+ ## 2. Editing Dashboard Layouts
30
+ 1. Navigate to the dashboard you want to change (swipe or use dashboard selector).
31
+ 2. Open the Actions menu.
32
+ 3. Tap the Unlock/Lock button at the bottom to toggle edit mode.
33
+
34
+ In edit mode, widgets show dashed outlines.
35
+
36
+ ### What You Can Do in Edit Mode
37
+ - Add a widget (long press empty space → Add Widget)
38
+ - Move a widget (drag)
39
+ - Resize a widget (drag edges/corners)
40
+ - Configure a widget (double tap/double click)
41
+ - Duplicate a widget (long press → Duplicate)
42
+ - Delete a widget (long press Delete, then confirm)
43
+ - Save changes (Check button) or discard (X button) in the lower right
44
+
45
+ Tip: If you can’t add a widget, free up space by resizing or moving existing ones first.
46
+
47
+ ---
48
+
49
+ ## 3. Workflow: From Idea to Dashboard
50
+ 1. Define the purpose (e.g. “Night Nav” = heading, COG, SOG, depth, wind, batteries, minimal brightness)
51
+ 2. Create or duplicate a dashboard similar to what you want
52
+ 3. Enter edit mode and add required widgets
53
+ 4. Configure each widget’s data paths (keep sample times reasonable to reduce churn)
54
+ 5. Arrange and size for readability at your viewing distance
55
+ 6. Exit edit mode and test switching at real brightness/environment
56
+
57
+ ---
58
+
59
+ ## 4. Widget Gallery (Overview)
60
+ KIP widgets turn Signal K data into readable visuals and controls. Available widget types:
61
+
62
+ - **Numeric** – Displays numeric data in a clear and concise format, with options to show min/max values and a background minichart for trends.
63
+ - **Text** – Displays text data with customizable color formatting.
64
+ - **Date & Time** – Shows date and time with custom formatting and timezone correction.
65
+ - **Position** – Displays latitude and longitude for location tracking and navigation.
66
+ - **Static Label** – Add customizable labels to organize and clarify your dashboard layout.
67
+ - **Switch Panel** – Group of toggle switches, indicator lights, and press buttons for digital switching and operations.
68
+ - **Slider** – Range slider for adjusting values (e.g. lighting intensity).
69
+ - **Compact Linear** – Simple horizontal linear gauge with a large value label and modern look.
70
+ - **Linear** – Horizontal or vertical linear gauge with zone highlighting.
71
+ - **Radial** – Radial gauge with configurable dials and zone highlighting.
72
+ - **Compass** – Rotating compass gauge with multiple cardinal indicator options.
73
+ - **Level Gauge** – Dual-scale heel angle indicator for trim tuning and sea-state monitoring.
74
+ - **Pitch & Roll** – Horizon-style attitude indicator showing live pitch and roll degrees.
75
+ - **Classic Steel** – Traditional steel-look linear & radial gauges with range sizes and zone highlights.
76
+ - **Windsteer** – Combines wind, wind sectors, heading, COG, and waypoint info for wind steering.
77
+ - **Wind Trends** – Real-time True Wind trends with dual axes for direction and speed, live values, and averages.
78
+ - **Freeboard-SK** – Adds the Freeboard-SK chart plotter as a widget with automatic sign-in.
79
+ - **Autopilot Head** – Typical autopilot controls for compatible Signal K Autopilot devices.
80
+ - **Realtime Data Chart** – Visualizes data on a real-time chart with actuals, averages, and min/max.
81
+ - **Embed Webpage Viewer** – Embeds external web apps (Grafana, Node-RED, etc.) into your dashboard.
82
+ - **Racesteer** – Race steering display fusing polar performance data with live conditions for optimal tactics.
83
+ - **Racer - Start Line Insight** – Set and adjust start line ends, see distance, favored end, and line bias; integrates with Freeboard SK.
84
+ - **Racer - Start Timer** – Advanced racing countdown timer with OCS status and auto dashboard switching.
85
+ - **Countdown Timer** – Simple race start countdown timer with start, pause, sync, and reset options.
86
+
87
+ ---
88
+
89
+ ## 5. Performance & Layout Tips
90
+ - Favor clarity over cramming: leave space around high‑priority values
91
+ - Group related widgets (navigation, energy, engines, environment)
92
+ - Use consistent units per dashboard (e.g. all speeds in knots, all temps in °C or °F—don’t mix)
93
+ - For night dashboards, adjust brightness or use the all‑red theme in Settings → Options → Display
94
+ - Duplicate a working layout before making major changes (easy rollback)
95
+ - Keep sampling intervals modest (1000 ms+) unless fast reaction is essential
96
+ - Know your device’s hardware limits and adjust widget count per dashboard accordingly
97
+ - Avoid embedding too many external webpages—each adds load
98
+
99
+ ---
100
+
101
+ ## 6. Troubleshooting
102
+ | Issue | Possible Cause | Fix |
103
+ |------------------------|---------------------------------------|---------------------------------------------------------------------|
104
+ | Data shows “—” or blank| Path missing/not configured/null value | Open widget config, verify Signal K path exists and updates. Use Data Inspector and Signal K Data Browser to view raw data from the server. |
105
+ | Wrong units | Default convert unit used | Edit widget config paths and set the desired target unit. |
106
+ | Slow dashboard switching| Excessive data sampling/too many widgets| Increase sample times; remove unused widgets. Split widgets into separate dashboards. Optimize system resource usage. |
107
+ | Embedded page blank | Cross‑origin blocked | See "Embed Page Viewer" help section. |
108
+
109
+ ---
110
+
111
+ ## 7. Next Steps
112
+ See also:
113
+ - Remote Control (switch dashboards on unattended displays)
114
+ - Night Mode (automatic theme + brightness)
115
+ - Contact / Issues (report widget feature ideas)
116
+
117
+ Refine incrementally—small improvements keep dashboards readable and reliable.
@@ -1,4 +1,4 @@
1
- # Data Inspector
1
+ ## Data Inspector
2
2
 
3
3
  The Data Inspector is a powerful tool in KIP that allows you to view all Signal K paths and the data received from the server in real time. It provides detailed insights into the data being transmitted, including metadata, sources, and supported operations. This guide explains how to use the Data Inspector effectively.
4
4
 
@@ -1,4 +1,4 @@
1
- # Datasets and Data Chart Widget
1
+ ## Datasets and Data Chart Widget
2
2
 
3
3
  Datasets and the Data Chart widget work together to provide real-time data visualization in KIP. They allow you to collect and display historical data trends for Signal K paths, enabling better decision-making and monitoring. This guide explains how to configure and use Datasets and the Data Chart widget effectively.
4
4
 
@@ -1,4 +1,4 @@
1
- # Using the Embed Page Viewer Widget
1
+ ## Using the Embed Page Viewer Widget
2
2
 
3
3
  The Embed Page Viewer widget allows you to display external web pages or web applications directly within your dashboard. By default, the Embed Page Viewer widget does not allow input (touch, mouse and keyboard interactions) with the content in the Embed. To enable interactions, check the setting the widget's options.
4
4