@mxtommy/kip 3.9.0-beta.16 → 3.9.0-beta.20

package/README.md

@@ -16,20 +16,9 @@ Key features include:
 - **Multiple User Profiles**: Tailor configurations for different roles, devices, or use cases.
 - **Cross-Device Compatibility**: Access KIP remotely on any device by navigating to `http://<Signal K Server URL>:<port>/@mxtommy/kip`.
 
-Typical complementary components you may install (many are often bundled with Signal K distributions):
-
-**Navigation & Charting**
-- **Freeboard‑SK** – Multi‑station, web chart plotter dedicated to Signal K: routes, waypoints, charts, alarms, weather layers, and instrument overlays.
-
-**Visual Flow / Automation**
-- **Node‑RED** – Low‑code, flow‑based wiring of devices, APIs, online services, and custom logic (alert escalation, device control automation, data enrichment, protocol bridging).
-
-**Data Storage & Analytics**
-- **InfluxDB / other TSDB** – High‑resolution historical storage of sensor & performance metrics beyond what lightweight widget charts should retain.
-- **Grafana** – Rich exploratory / comparative dashboards, ad‑hoc queries, alert rules on stored metrics, correlation across heterogeneous data sources.
-
 KIP is open-source under the MIT license, built by the community and 100% free. Join the community on Discord or contribute to the project on GitHub!
 
+## Read the Help introduction How-to
 ## Read the Help introduction How-to
 Read the [Introduction](https://github.com/mxtommy/Kip/blob/master/src/assets/help-docs/welcome.md) help file.
 
@@ -134,6 +123,32 @@ For example, Signal K will notify KIP when a water depth or temperature sensor r
 ## Multiple User Profiles
 If you have different roles on board: captain, skipper, tactician, navigator, engineer—or simply different people with different needs, each can tailor KIP as they wish. The use of profiles also allows you to tie specific configuration arrangements to use cases or device form factors.
 
+## Complementary Components
+Typical complementary components you may install (many are often bundled with Signal K distributions):
+
+**Navigation & Charting**
+- **Freeboard‑SK** – Multi‑station, web chart plotter dedicated to Signal K: routes, waypoints, charts, alarms, weather layers, and instrument overlays.
+
+**Visual Flow / Automation**
+- **Node‑RED** – Low‑code, flow‑based wiring of devices, APIs, online services, and custom logic (alert escalation, device control automation, data enrichment, protocol bridging).
+
+**Data Storage & Analytics**
+- **InfluxDB / other TSDB** – High‑resolution historical storage of sensor & performance metrics beyond what lightweight widget charts should retain.
+- **Grafana** – Rich exploratory / comparative dashboards, ad‑hoc queries, alert rules on stored metrics, correlation across heterogeneous data sources.
+
+## Complementary Components
+Typical complementary components you may install (many are often bundled with Signal K distributions):
+
+**Navigation & Charting**
+- **Freeboard‑SK** – Multi‑station, web chart plotter dedicated to Signal K: routes, waypoints, charts, alarms, weather layers, and instrument overlays.
+
+**Visual Flow / Automation**
+- **Node‑RED** – Low‑code, flow‑based wiring of devices, APIs, online services, and custom logic (alert escalation, device control automation, data enrichment, protocol bridging).
+
+**Data Storage & Analytics**
+- **InfluxDB / other TSDB** – High‑resolution historical storage of sensor & performance metrics beyond what lightweight widget charts should retain.
+- **Grafana** – Rich exploratory / comparative dashboards, ad‑hoc queries, alert rules on stored metrics, correlation across heterogeneous data sources.
+
 # Connect, Share, and Support
 KIP has its own Discord Signal K channel for getting in touch. Join us at https://discord.gg/AMDYT2DQga
 
@@ -166,6 +181,28 @@ Keeping KIP focused preserves responsiveness (lower CPU / memory), reduces UI cl
 
 In short: use KIP to see & act on live sailing information; use the complementary tools to store it long‑term, analyze it deeply, automate decisions, or build advanced integrations.
 
+## Project Scope
+What KIP IS about:
+- Real‑time presentation of vessel & environment data (navigation, performance, systems) pulled from Signal K.
+- Fast, legible, touchscreen‑friendly dashboards for underway decision making.
+- Configurable widgets (gauges, charts, timers, controls) tuned for sailing operations.
+
+What KIP deliberately IS NOT trying to become:
+- A full data lake / long‑term time‑series historian.
+- A general purpose automation / rules / orchestration engine.
+- A universal external web‑app embedding or mash‑up framework.
+- A low‑code integration hub for arbitrarily wiring protocols and services.
+
+Those domains already have excellent, specialized open‑source tools. Instead of re‑implementing them, KIP plays nicely alongside them within a Signal K based onboard stack.
+
+**Processing & Extensions**
+- **Signal K Plugins** – Domain‑specific enrichment (polars, performance calculations, derived environmental data, routing aids) published directly into the Signal K data model that KIP can then display.
+
+**Why this separation matters**
+Keeping KIP focused preserves responsiveness (lower CPU / memory), reduces UI clutter, and accelerates iteration on core sailing UX. Heavy analytics, complex workflow logic, and broad third‑party embedding stay where they are strongest—outside—but still feed KIP through the common Signal K data fabric.
+
+In short: use KIP to see & act on live sailing information; use the complementary tools to store it long‑term, analyze it deeply, automate decisions, or build advanced integrations.
+
 **Tools**
 Linux, Mac, RPi, or Windows dev platform supported
 1. Install the latest Node version (v16+, v18 recommended)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxtommy/kip",
-  "version": "3.9.0-beta.16",
+  "version": "3.9.0-beta.20",
   "description": "An advanced and versatile marine instrumentation package to display Signal K data.",
   "license": "MIT",
   "author": {

package/public/app-help.component.css.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["src/app/core/components/app-help/app-help.component.scss"],
+  "sourcesContent": [".fullpage-header {\n  display: flex;\n  justify-content: space-between;\n  align-items: center;\n}\n\n.fullpage-header-title {\n  margin-block-start: 0px;\n  margin-block-end: 0px;\n  padding: 18px 24px 13px 24px;\n  color: var(--mat-dialog-subhead-color, var(--mat-sys-on-surface, rgba(0, 0, 0, 0.87)));\n  font-family: var(--mat-dialog-subhead-font, var(--mat-sys-headline-small-font, inherit));\n  line-height: var(--mat-dialog-subhead-line-height, var(--mat-sys-headline-small-line-height, 1.5rem));\n  font-size: var(--mat-dialog-subhead-size, var(--mat-sys-headline-small-size, 1rem));\n  font-weight: var(--mat-dialog-subhead-weight, var(--mat-sys-headline-small-weight, 400));\n  letter-spacing: var(--mat-dialog-subhead-tracking, var(--mat-sys-headline-small-tracking, 0.03125em));\n}\n\n.mat-mdc-dialog-content {\n  max-height: max-content;\n}\n\n.markdown-content {\n  display: block;\n  height: calc(100% - 75px);\n  width: 100%;\n  overflow-x: scroll;\n  padding: 25px;\n}\n\n.dialog-close-icon {\n  display: flex;\n  flex-direction: row;\n  flex-wrap: nowrap;\n  gap: 5px;\n  padding-right: 15px;\n}\n"],
+  "mappings": ";AAAA,CAAA;AACE,WAAA;AACA,mBAAA;AACA,eAAA;;AAGF,CAAA;AACE,sBAAA;AACA,oBAAA;AACA,WAAA,KAAA,KAAA,KAAA;AACA,SAAA,IAAA,0BAAA,EAAA,IAAA,oBAAA,EAAA,KAAA,CAAA,EAAA,CAAA,EAAA,CAAA,EAAA;AACA,eAAA,IAAA,yBAAA,EAAA,IAAA,6BAAA,EAAA;AACA,eAAA,IAAA,gCAAA,EAAA,IAAA,oCAAA,EAAA;AACA,aAAA,IAAA,yBAAA,EAAA,IAAA,6BAAA,EAAA;AACA,eAAA,IAAA,2BAAA,EAAA,IAAA,+BAAA,EAAA;AACA,kBAAA,IAAA,6BAAA,EAAA,IAAA,iCAAA,EAAA;;AAGF,CAAA;AACE,cAAA;;AAGF,CAAA;AACE,WAAA;AACA,UAAA,KAAA,KAAA,EAAA;AACA,SAAA;AACA,cAAA;AACA,WAAA;;AAGF,CAAA;AACE,WAAA;AACA,kBAAA;AACA,aAAA;AACA,OAAA;AACA,iBAAA;;",
+  "names": []
+}

package/public/app.component.css.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["src/app/app.component.scss"],
+  "sourcesContent": [".sidenav-container {\n  height: 100%;\n  width: 100%;\n}\n\nmat-sidenav-content {\n overflow-y: hidden;\n overflow-x: hidden;\n}\n\nmat-sidenav.sidenav-notifications {\n  width: 230px;\n  z-index: 1200; // ensure sidenav sits above the notification overlay panel\n}\n\nmat-sidenav.sidenav-actions {\n  width: 135px;\n  z-index: 1200; // ensure actions sidenav stacks above overlay\n  overflow-x: hidden; // Ensure action sidenav content doesn't overflow horizontally\n}\n"],
+  "mappings": ";AAAA,CAAA;AACE,UAAA;AACA,SAAA;;AAGF;AACC,cAAA;AACA,cAAA;;AAGD,WAAA,CAAA;AACE,SAAA;AACA,WAAA;;AAGF,WAAA,CAAA;AACE,SAAA;AACA,WAAA;AACA,cAAA;;",
+  "names": []
+}