@mxtommy/kip 3.10.0-beta.8 → 3.10.0

package/plugin/openApi.json

@@ -0,0 +1,367 @@
+{
+    "openapi": "3.0.0",
+    "info": {
+        "version": "1.0.0",
+        "title": "KIP Remote Displays API",
+        "description": "API endpoints to list KIP displays and control the active screen for a given KIP instance via Signal K self.displays tree.\n\nUsage:\n- List displays:\n  curl -s http://localhost:3000/plugins/kip/displays\n- Read a display's screens:\n  curl -s http://localhost:3000/plugins/kip/displays/{displayId}\n- Set a display entry:\n  curl -s -X PUT -H 'Content-Type: application/json' -d '{\"displayName\":\"Mast\"}' http://localhost:3000/plugins/kip/displays/{displayId}\n- Get active screen:\n  curl -s http://localhost:3000/plugins/kip/displays/{displayId}/activeScreen\n- Set active screen:\n  curl -s -X PUT -H 'Content-Type: application/json' -d '{\"screenIdx\":1}' http://localhost:3000/plugins/kip/displays/{displayId}/activeScreen",
+        "termsOfService": "http://signalk.org/terms/",
+        "license": {
+            "name": "Apache 2.0",
+            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+        }
+    },
+    "externalDocs": {
+        "url": "http://signalk.org/specification/",
+        "description": "Signal K specification."
+    },
+    "servers": [
+        {
+            "url": "/"
+        }
+    ],
+    "tags": [
+        {
+            "name": "Displays",
+            "description": "KIP display discovery and control."
+        }
+    ],
+    "components": {
+        "schemas": {
+            "DisplayInfo": {
+                "type": "object",
+                "properties": {
+                    "displayId": {
+                        "type": "string",
+                        "description": "KIP instance UUID"
+                    },
+                    "displayName": {
+                        "type": "string",
+                        "nullable": true
+                    }
+                },
+                "required": [
+                    "displayId"
+                ]
+            },
+            "ScreenItem": {
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "icon": {
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "id",
+                    "name",
+                    "icon"
+                ]
+            },
+            "SuccessResponse": {
+                "type": "object",
+                "properties": {
+                    "state": {
+                        "type": "string",
+                        "enum": [
+                            "SUCCESS"
+                        ]
+                    },
+                    "statusCode": {
+                        "type": "integer",
+                        "enum": [
+                            200
+                        ]
+                    }
+                },
+                "required": [
+                    "state",
+                    "statusCode"
+                ]
+            },
+            "ErrorResponse": {
+                "type": "object",
+                "properties": {
+                    "state": {
+                        "type": "string",
+                        "enum": [
+                            "FAILED"
+                        ]
+                    },
+                    "statusCode": {
+                        "type": "integer"
+                    },
+                    "message": {
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "state",
+                    "statusCode",
+                    "message"
+                ]
+            },
+            "ActiveScreenSetRequest": {
+                "type": "object",
+                "properties": {
+                    "screenIdx": {
+                        "type": "integer",
+                        "nullable": true,
+                        "description": "Index of active screen or null to clear"
+                    }
+                }
+            },
+            "AnyObjectOrNull": {
+                "oneOf": [
+                    {
+                        "type": "object",
+                        "additionalProperties": true
+                    },
+                    {
+                        "type": "null"
+                    }
+                ]
+            }
+        },
+        "parameters": {
+            "DisplayIdParam": {
+                "in": "path",
+                "required": true,
+                "name": "displayId",
+                "description": "KIP instance UUID",
+                "schema": {
+                    "type": "string"
+                }
+            }
+        },
+        "securitySchemes": {
+            "bearerAuth": {
+                "type": "http",
+                "scheme": "bearer",
+                "bearerFormat": "JWT"
+            },
+            "cookieAuth": {
+                "type": "apiKey",
+                "in": "cookie",
+                "name": "JAUTHENTICATION"
+            }
+        }
+    },
+    "security": [
+        {
+            "cookieAuth": []
+        },
+        {
+            "bearerAuth": []
+        }
+    ],
+    "paths": {
+        "/plugins/kip/displays": {
+            "get": {
+                "tags": [
+                    "Displays"
+                ],
+                "summary": "List available KIP displays",
+                "responses": {
+                    "200": {
+                        "description": "List of KIP instances discovered under self.displays",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "array",
+                                    "items": {
+                                        "$ref": "#/components/schemas/DisplayInfo"
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad request",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ErrorResponse"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "/plugins/kip/displays/{displayId}": {
+            "parameters": [
+                {
+                    "$ref": "#/components/parameters/DisplayIdParam"
+                }
+            ],
+            "get": {
+                "tags": [
+                    "Displays"
+                ],
+                "summary": "List screens for a display (self.displays.{displayId}.value.screens)",
+                "responses": {
+                    "200": {
+                        "description": "Array of screen entries",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "array",
+                                    "items": {
+                                        "$ref": "#/components/schemas/ScreenItem"
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "404": {
+                        "description": "Not found",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ErrorResponse"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad request",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ErrorResponse"
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+            "put": {
+                "tags": [
+                    "Displays"
+                ],
+                "summary": "Set display entry under self.displays.{displayId}",
+                "requestBody": {
+                    "required": false,
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/AnyObjectOrNull"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "Updated",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/SuccessResponse"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad request",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ErrorResponse"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "/plugins/kip/displays/{displayId}/activeScreen": {
+            "parameters": [
+                {
+                    "$ref": "#/components/parameters/DisplayIdParam"
+                }
+            ],
+            "get": {
+                "tags": [
+                    "Displays"
+                ],
+                "summary": "Get active screen index for display",
+                "responses": {
+                    "200": {
+                        "description": "Active screen index or null",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "integer",
+                                    "nullable": true
+                                }
+                            }
+                        }
+                    },
+                    "404": {
+                        "description": "Not found",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ErrorResponse"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad request",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ErrorResponse"
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+            "put": {
+                "tags": [
+                    "Displays"
+                ],
+                "summary": "Set active screen index for display",
+                "requestBody": {
+                    "required": false,
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/ActiveScreenSetRequest"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "Updated",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/SuccessResponse"
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad request",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ErrorResponse"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/public/3rdpartylicenses.txt

@@ -478,58 +478,6 @@ 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.
 
---------------------------------------------------------------------------------
-Package: @angular/router
-License: "MIT"
-
-The MIT License
-
-Copyright (c) 2010-2025 Google LLC. https://angular.dev/license
-
-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:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-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.
-
---------------------------------------------------------------------------------
-Package: compare-versions
-License: "MIT"
-
-The MIT License (MIT)
-
-Copyright (c) 2015-2021 Ole Michelsen
-
-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:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-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.
-
 --------------------------------------------------------------------------------
 Package: rxjs
 License: "Apache-2.0"
@@ -789,6 +737,32 @@ maintained libraries used by this software which have their own
 licenses; we recommend you read them, as their terms may differ from the
 terms above.
 
+--------------------------------------------------------------------------------
+Package: compare-versions
+License: "MIT"
+
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 Ole Michelsen
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.
+
 --------------------------------------------------------------------------------
 Package: @angular/forms
 License: "MIT"
@@ -883,6 +857,32 @@ 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.
 
+--------------------------------------------------------------------------------
+Package: @angular/router
+License: "MIT"
+
+The MIT License
+
+Copyright (c) 2010-2025 Google LLC. https://angular.dev/license
+
+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:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.
+
 --------------------------------------------------------------------------------
 Package: core-js
 License: "MIT"

package/public/assets/help-docs/kiosk.md

@@ -0,0 +1,192 @@
+# Raspberry Pi Kiosk Mode (Chromium)
+
+This guide launches Chromium in kiosk mode to display KIP at:
+http://<sk_server_IP>:3000/@mxtommy/kip/#/page/0
+
+It supports Raspberry Pi OS Bullseye (X11/LXDE) and Bookworm (Wayland).
+
+## What is “kiosk mode”?
+Kiosk mode runs a single application full-screen and suppresses most desktop UI. In this guide, Chromium loads KIP and stays on screen like a dedicated instrument display.
+
+- What it does:
+  - Launches Chromium full-screen without toolbars (“chrome”).
+  - Autostarts after login; optional auto-restart via systemd.
+  - Disables screen blanking; can hide the mouse cursor.
+- What it does not do:
+  - It is not a full OS lockdown or content filter.
+- Exit/maintenance:
+  - Desktop autostart: press Alt+F4 to close, or switch to a TTY (Ctrl+Alt+F2) and run: pkill chromium-browser || pkill chromium.
+  - systemd user service: systemctl --user stop kiosk.service (disable with systemctl --user disable kiosk.service).
+
+
+## 1) Prerequisites
+
+- Raspberry Pi OS with Desktop, user: `pi` (or adjust paths).
+- Chromium installed:
+  ```
+  sudo apt update
+  sudo apt install -y chromium-browser || sudo apt install -y chromium
+  ```
+- Optional (hide mouse cursor):
+  ```
+  sudo apt install -y unclutter
+  ```
+- Enable Desktop autologin:
+  ```
+  sudo raspi-config
+  ```
+  System Options → Boot / Auto Login → Desktop Autologin
+
+- Disable screen blanking
+  - Wayland (Bookworm): raspi-config → Display Options → Screen Blanking → No
+  - X11 (Bullseye): we also disable via `xset` in the script below.
+
+## 2) Create the kiosk launcher script
+
+```
+sudo nano /home/pi/kiosk.sh
+```
+
+Paste:
+
+```
+#!/usr/bin/env bash
+set -euo pipefail
+
+# URL for KIP (adjust as needed)
+URL="${URL:-http://<sk_server_IP>:3000/@mxtommy/kip/#/page/0}"
+
+# Pick Chromium binary
+BROWSER="$(command -v chromium-browser || true)"
+if [[ -z "${BROWSER}" ]]; then
+  BROWSER="$(command -v chromium || true)"
+fi
+if [[ -z "${BROWSER}" ]]; then
+  echo "Chromium not installed. Try: sudo apt update && sudo apt install -y chromium-browser || sudo apt install -y chromium"
+  exit 1
+fi
+
+# Hide mouse cursor if unclutter is available
+if command -v unclutter >/dev/null 2>&1; then
+  unclutter -idle 0 -root &
+fi
+
+# Disable screen blanking on X11 (LXDE). On Wayland, use raspi-config instead.
+if [[ "${XDG_SESSION_TYPE:-}" == "x11" ]]; then
+  xset s off -dpms
+  xset s noblank
+fi
+
+# Optional: wait for network/host (best-effort, up to ~2 minutes)
+host="$(echo "$URL" | sed -E 's#^[a-z]+://([^:/]+).*$#\1#')"
+if command -v ping >/dev/null 2>&1; then
+  for i in {1..60}; do
+    ping -c1 -W1 "$host" >/dev/null 2>&1 && break || sleep 2
+  done
+fi
+
+exec "$BROWSER" \
+  --kiosk \
+  --start-fullscreen \
+  --no-first-run \
+  --noerrdialogs \
+  --disable-session-crashed-bubble \
+  --disable-translate \
+  --disable-features=TranslateUI \
+  --enable-features=OverlayScrollbar \
+  --autoplay-policy=no-user-gesture-required \
+  --check-for-update-interval=31536000 \
+  --app="$URL"
+```
+
+Save, then:
+
+```
+sudo chmod +x /home/pi/kiosk.sh
+```
+
+Tip: You can override the URL without editing the script using:
+```
+URL="http://signalk.local:3000/@mxtommy/kip/#/page/0" /home/pi/kiosk.sh
+```
+
+## 3A) Autostart via Desktop (.desktop) – simplest
+
+Create an autostart entry:
+
+```
+mkdir -p ~/.config/autostart
+nano ~/.config/autostart/kiosk.desktop
+```
+
+Paste:
+
+```
+[Desktop Entry]
+Type=Application
+Name=KIP Kiosk
+Exec=/home/pi/kiosk.sh
+Terminal=false
+X-GNOME-Autostart-enabled=true
+```
+
+This launches after the desktop session starts.
+
+## 3B) Autostart via systemd (user) – robust, auto‑restart
+
+Recommended if you want Chromium to restart on crash.
+
+```
+mkdir -p ~/.config/systemd/user
+nano ~/.config/systemd/user/kiosk.service
+```
+
+Paste:
+
+```
+[Unit]
+Description=KIP Chromium Kiosk
+After=graphical-session.target network-online.target
+Wants=network-online.target
+
+[Service]
+Type=simple
+Environment=URL=http://<sk_server_IP>:3000/@mxtommy/kip/#/page/0
+ExecStart=/home/pi/kiosk.sh
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=graphical-session.target
+```
+
+Enable:
+
+```
+systemctl --user daemon-reload
+systemctl --user enable --now kiosk.service
+```
+
+Logs (for debugging):
+```
+journalctl --user -u kiosk.service -f
+```
+
+Note: This runs after user login to the desktop. Ensure Desktop Autologin is enabled (Step 1).
+
+## 4) Reboot and verify
+
+```
+sudo reboot
+```
+
+Chromium should open full-screen at:
+http://<sk_server_IP>:3000/@mxtommy/kip/#/page/0
+
+## Troubleshooting
+
+- Blank screen on Bookworm: confirm Screen Blanking is disabled in raspi-config (Wayland ignores xset).
+- Chromium not found: install package `chromium-browser` or `chromium` (varies by OS version).
+- Wrong URL: KIP is served under /@mxtommy/kip/. Ensure the full path is used.
+- Certificates: prefer HTTP or trusted TLS. Avoid `--ignore-certificate-errors` in kiosk.
+- systemd service not starting: check `journalctl --user -u kiosk.service -f

package/public/assets/help-docs/menu.json

@@ -9,5 +9,6 @@
   { "title": "Datasets and Data Chart Widget", "file": "datasets.md" },
   { "title": "Gafana Integration", "file": "grafana.md" },
   { "title": "InfluxDB and Signal K", "file": "influxdb.md" },
+  { "title": "Kiosk Mode", "file": "kiosk.md" },
   { "title": "Contact Us", "file": "contact-us.md" }
 ]