@mxtommy/kip 4.6.0-beta.2 → 4.7.0-beta.10

package/public/assets/help-docs/history-api.md

@@ -1,14 +1,8 @@
-## Using the History-API to Obtain Historical Data 
+## Using External History-API Provider to Obtain Historical Data 
 
-KIP can automatically request History Provider historical data points when opening chart widgets, seamlessly integrating past data with live updates.
+KIP can, using a special type of plugin called a History Provider, automatically request historical data points when opening chart widgets, seamlessly integrating past data with live updates.
 
-This enables the display of minutes, hours, days, weeks, etc. of pre-populated historical data immediately—no waiting, no empty charts. The History-API is used to achieve this.
-
-A History Provider can also be used as a source for the widget historical data feature.
-
-## What Is the History-API?
-
-A Signal K server endpoint that provides access to recorded historical data. Behind the endpoint, the data is served by a history provider plugin. KIP automatically requests historical data points when opening chart widgets, pre-filling the chart instead of starting empty.
+This enables the display of minutes, hours, days, weeks, etc. of pre-populated historical data immediately—no waiting, no empty charts.
 
 ## Which Widgets Support History?
 
@@ -20,15 +14,16 @@ A Signal K server endpoint that provides access to recorded historical data. Beh
 ### Wind Trends Widget
 - **Supported**: Yes, uses fixed paths (True Wind Direction and Speed).
 - **Requirements**: Time Span of `5 minutes` or `30 minutes`.
-- See [Wind Trends Fixed Paths](#wind-trends-fixed-paths) below for configuration details.
+- See Wind Trends Fixed Paths below for configuration details.
 
-### Numeric Widget (with Mini Chart)
+### Mini-chart
+NOTE: This is the optional chart that can be display in the background of the Numeric Widget.
 - **Supported**: No. Mini charts use very short time windows (12 seconds) and skip history seeding.
 - Mini charts start live-only for performance reasons.
 
 ## What Plugins and Signal K Version Are Required?
 
-The History-API requires Signal K version 2.22.1 or above and one plugin that records data to a persistent store. Currently, two plugins support the History-API:
+You will need both support for the History-API version 2 and a compatible History provider. The History-API version 2 was introduced in Signal K version 2.22.1. Currently, two plugins support the v2 History-API:
 
 ### 1. signalk-to-influxdb2, v2.0.0 or above
 - **Purpose**: Records Signal K data to an InfluxDB v2 time-series database. Requires pre-installed InfluxDB v2.
@@ -62,40 +57,55 @@ After history data loads:
 - The chart will display only live data starting from when it was opened.
 - This is normal and does not indicate an error.
 
-## Wind Trends Fixed Paths
+## Provider Configuration Information
+
+For performance reasons, all KIP charts display a maximum of 120 datapoints. KIP looks at the chart's configured time span 'window', and ask the provider to gather the requested data and to return results as 120 datapoints.
+
+When configuring your provider's path sampling rates, insure your sampling rules meet this requirement. Slower sampling rates will create charts with fewer datapoints/of lesser resolution. Higher sampling rates will NOT create charts with more datapoints/of higher resolution.
+
+### Historical Widget Charts
+
+Collect an appropriate mount of data samples for the smallest **last 15 minutes** window; every 7.5 seconds. Every 15 seconds is not too bad a resolution either.
+
+### Wind Trends Fixed Paths
 
 The Wind Trends widget uses two fixed Signal K paths:
 - **True Wind Direction**: `environment.wind.directionTrue`
 - **True Wind Speed**: `environment.wind.speedTrue`
 
-For Wind Trends to display historical data, both of these paths **must be configured in your chosen History-API plugin**. Check your plugin documentation to ensure these paths are included in the capture list.
+For Wind Trends to display historical data, both of these paths **must be configured in your chosen History-API plugin**.
+
+Plan an appropriate data sampling rate to support the chart duration (5 and 30 minutes are supported).
 
 ## Limitations
 
-For historical data to seed widgets, you need to, in most cases, manually configure your chosen provider to collect the said data. This is not an automatic process.
+For historical data to seed charts, you need to, in most cases, to manually configure your chosen provider to collect the said data. This is not an automatic process when using a External History Provider.
 
 ## Troubleshooting
 
 ### History Data Is Not Showing
 
-**Check 1: Is the History-API plugin installed?**
+**Check 1: Are the Technical Requirements Meet?**
+- Confirm that Signal K server version 2.22.1 or above in installed.
+
+**Check 2: Is the History-API plugin installed?**
 - Confirm that a History-API plugin is installed and enabled on your Signal K server.
 - Verify that the plugin is running without errors (check server logs).
 
-**Check 2: Are the paths configured in the plugin?**
+**Check 3: Are the paths configured in the plugin?**
 - Open your plugin's configuration settings.
 - Confirm that the paths you're charting (e.g., `navigation.speedThroughWater`) are in the capture list.
 
-**Check 3: Is there historical data available?**
+**Check 4: Is there historical data available?**
 - If the plugin was just installed, data will start recording from that moment forward.
 - Charts will not show history for times before the plugin was enabled or the path configured for recording.
 - Allow the plugin to record data for a while (days or weeks) before expecting deep history.
 
-**Check 4: Is the chart time scale eligible?**
+**Check 5: Is the chart time scale eligible?**
 - Very short time scales (seconds) skip history seeding for performance.
 - Use time scales of **minutes or longer** to enable history seeding.
 
-**Check 5: Are there any network or permission issues?**
+**Check 6: Are there any network or permission issues?**
 - Confirm that KIP can reach the Signal K server's History-API endpoint. Use the OpenApi link in the Server Admin pages to the test.
 - Check browser console logs (F12) for any HTTP errors from history requests.
 
@@ -113,4 +123,4 @@ For historical data to seed widgets, you need to, in most cases, manually config
 ## Questions or Issues?
 
 - Refer to the plugin and History-API documentation for plugin-specific configuration and troubleshooting.
-- For general questions or issues, see `Contact-Us` help page—the KIP community is active on Discord and GitHub.
+- For general questions or issues, see `Contact-Us` help page—the Signal K community is active on Discord and GitHub.

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

@@ -12,7 +12,7 @@
     "items": [
       { "title": "Node-RED (Getting Started)", "file": "nodered-control-flows.md" },
       { "title": "The Embed Page Viewer", "file": "embedwidget.md" },
-      { "title": "Using The History-API", "file": "history-api.md" },
+      { "title": "External History-API Provider", "file": "history-api.md" },
       { "title": "Grafana Integration", "file": "grafana.md" },
       { "title": "InfluxDB and Signal K", "file": "influxdb.md" }
     ]

package/public/assets/help-docs/nodered-control-flows.md

@@ -2,7 +2,7 @@
 
 This guide is for first-time Node-RED users who want KIP control widgets to trigger real actions (like GPIO or relay switching) through Signal K. It is not a full Node-RED product guide or a complete flow-programming course. It focuses on the Signal K and KIP-specific parts you need for digital switching.
 
-Before you start building flows, read **[Digital Switching and PUT Path Setup](putcontrols.md)** so you understand the core concepts, data flow, and control logic.
+Before you start building flows, read **[Digital Switching and PUT Path Setup](#/help/putcontrols.md)** so you understand the core concepts, data flow, and control logic.
 
 ## What You Are Building
 
@@ -120,6 +120,6 @@ Use these terms consistently while setting up your flow.
 Use these guides next as needed.
 
 - SignalK signalk-node-red: [Show and tell](https://github.com/SignalK/signalk-node-red/discussions/categories/show-and-tell)
-- Path requirements and widget compatibility: [Digital Switching and PUT Path Setup](putcontrols.md)
-- Finding paths and checking PUT support: [Data Inspector](datainspector.md)
-- Adding and configuring widgets: [Dashboards and Layout](dashboards.md)
+- Path requirements and widget compatibility: [Digital Switching and PUT Path Setup](#/help/putcontrols.md)
+- Finding paths and checking PUT support: [Data Inspector](#/help/datainspector.md)
+- Adding and configuring widgets: [Dashboards and Layout](#/help/dashboards.md)

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

@@ -4,7 +4,7 @@ Use KIP digital switching controls when you want to do real actions from your da
 
 The focus here is practical KIP setup: what path type to use, what PUT support is needed, and how to avoid common configuration mistakes. This guide supports built-in server handlers, custom plugins, and Node-RED flows.
 
-If you are new to Node-RED, start with this guide, then continue with **[Node-RED Control Flows for KIP Widgets (Beginner Guide)](nodered-control-flows.md)** for beginner flow examples.
+If you are new to Node-RED, start with this guide, then continue with **[Node-RED Control Flows for KIP Widgets (Beginner Guide)](#/help/nodered-control-flows.md)** for beginner flow examples.
 
 ## What PUT Does (and Does Not Do)
 
@@ -14,8 +14,8 @@ PUT writes a value to a Signal K path. By itself, that write does not trigger ha
 
 Examples of server-side handlers:
 - A built-in server handler
-- A Signal K plugin (see [Popular Digital Switching Plugins](#popular-digital-switching-plugins))
-- A Node-RED flow (see [Node-RED Control Flows for KIP Widgets (Beginner Guide)](nodered-control-flows.md))
+- A Signal K plugin (see Popular Digital Switching Plugins)
+- A Node-RED flow (see Node-RED Control Flows for KIP Widgets - Beginner Guide)
 
 ## Basic Requirements
 
@@ -96,6 +96,6 @@ If something does not work, check these first.
 
 Use these guides next as needed.
 
-- **Node-RED beginners:** [Node-RED Control Flows for KIP Widgets (Beginner Guide)](nodered-control-flows.md)
-- **Path discovery and validation:** [Data Inspector](datainspector.md)
-- **Widget overview and placement:** [Dashboards and Layout](dashboards.md)
+- **Node-RED beginners:** [Node-RED Control Flows for KIP Widgets (Beginner Guide)](#/help/nodered-control-flows.md)
+- **Path discovery and validation:** [Data Inspector](#/help/datainspector.md)
+- **Widget overview and placement:** [Dashboards and Layout](#/help/dashboards.md)

package/public/assets/help-docs/widget-historical-series.md

@@ -1,8 +1,49 @@
+## What is Historical Widget Data
 
+KIP is built first for live sailing data.  
+To make charts useful right away and give you easy access to widget history, KIP includes a simple built-in history feature called Time-Series.
 
-## Widget Historical Chart
+With this built-in feature, KIP automatically:
+1. Keeps widget history available for quick viewing.
+2. Pre-seeds Data Chart and Wind Trends so they show recent trends immediately.
+3. Syncs with dashboard and widget configuration, and automatically prunes old or unused data.
 
-Widgets that use numeric paths automatically track and store data for their configured paths. This lets you easily view charts showing the last 15 minutes, 1 hour, 8 hours, or 24 hours of data.
+## Who Is It For
+
+This is for users who want history to “just work”:
+* No extra setup.
+* No plugin to install.
+* No data storage rules and retention policies to configure.
+
+It is made for quick, hassle-free chart history, not data engineering.
+
+## Built-In Time-Series vs External History Provider
+
+### Built-In Time-Series (default)
+- Works automatically with your dashboards and widgets.
+- Stores only the data KIP needs for widget history and chart startup.
+- Keeps a small rolling history and removes older data.
+- If you change widgets or chart paths, KIP updates history storage rules automatically.
+- No screen to manually manage what gets recorded.
+
+#### What Time-Series Don't Do
+- KIP’s built-in Time-Series is not a full data-logging system. You cannot manually set capture paths, sampling policies, or long-term retention rules in built-in mode. Use an External History Provider for this purpose. 
+- The dialog window displaying widget history offers **a fixed set** of the last 15 minutes, 1 hour, 8 hours, or 24 hours of data. If you are in need of more flexible and powerful data analytics capabilities, use Grafana and similar purpose built, comprehensive platforms.
+
+### External History Provider (advanced)
+
+KIP can disable its built-in Time-Series/provider registration and query any History-API compatible provider instead.  
+You then manage capture and retention in that provider.
+
+Choose this if you need full control, such as:
+
+- Long-term record keeping.
+- Custom retention and sampling rules.
+- Analytics or integration with other tools.
+
+When you switch to an external History-API provider, KIP still uses History API queries, but capture/retention behavior is managed by that provider so you then have to **manually manage capture and retention in that provider**.
+
+See [External History-API Provider](#/help/history-api.md) for details.
 
 ## Accessing Widget Historical Charts
 
@@ -32,7 +73,7 @@ Most widgets that use numeric paths support history, including the Horizon widge
 - Mini charts start live-only for performance reasons.
 
 ### History Seeding
-When you open a chart widget with a large time scale (minutes or larger):
+When you open a dashboard containing a Data Chart/Wind Trends widget with a large time scale (minutes or larger):
 1. KIP requests historical data points.
 2. The chart immediately displays the historical trend.
 
@@ -42,25 +83,28 @@ After history data loads:
 - The chart smoothly transitions from history to live updates.
 - Old data points are removed to maintain a rolling window of the configured time scale.
 
-## How Does Historical Widget Data Work?
-
-KIP and its server-side plugin work together to seamlessly monitor dashboard and widget configurations. For numeric and chart-type widgets (such as Data Chart and Wind Trends), time-series data is automatically captured and managed in the background. For the Data Chart widget, this enables pre-filling the chart instead of starting empty.
+## What are the Requirements for Historical Widget Data To Work?
 
-Time-series data is pruned automatically, retaining only the data required by active widgets and only for the time ranges those widgets display. This process is fully transparent, requires no manual intervention, and keeps server storage efficient and lean.
+I use KIP's Time-Series built-in feature:
+- Node.JS v20.5.0+: The built-in automatic Time-Series feature (integrated management of data) uses node:sqlite released in Node.JS v20.5.0.
+- Signal K version 2.22.1+: The history querying service uses the History-API v2, introduced in Signal K version 2.22.1.
 
-This feature uses History-API query/request, introduced in Signal K version 2.22.1.
+I use an External History Provider:
+- Signal K version 2.22.1+: The history querying service uses the History-API v2, introduced in Signal K version 2.22.1.
 
 ## Configuration Options
 
 Configuration options are found in **Settings → Options → Display** under the Widget Historical Data section.
 
 You can:
-- Disable KIP's automatic time-series and data capture services and use a History-API provider of your choice. See [Using The History-API](history-api.md) in the Integrations Help menu for more details.
-- Disable access to widget historical charts (disables two-finger tap, mouse right-click, or two-finger click on trackpads).
+- Disable KIP's automatic Time-Series in favor of the History-API provider of your choice (See [External History-API Provider](#/help/history-api.md) in the Integrations Help menu for more details).
+- Disable access to widget historical charts dialogue (disables two-finger tap, mouse right-click, or two-finger click on trackpads).
 
-If you don't want to use this feature, set the option to use a History API provider (this turns off the plugin's data collection), and disable widget historical charts to also disable the UI elements.
+If you want to completely disable the history feature, under the **Settings → Options → Display** tab in the Widget Historical Data group:
+- Select "Other: Use a different History API provider and configure data logging manually" option. This stops the plugin's data capture and historical query services.
+- Toggle the "Disable widget historical charts" switch. This disables pointer events to access the charts dialogue window.
 
 ## Questions or Issues?
 
-- Refer to [Using The History-API](history-api.md) to learn how to use other History API providers.
+- Refer to [External History-API Provider](#/help/history-api.md) to learn how to use other History API providers.
 - For general questions or issues, see the `Contact-Us` help page—the KIP community is active on Discord and GitHub.

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

@@ -6,7 +6,7 @@ Stay informed about your vessel’s data with Signal K’s state notifications.
 ## Zones & Notification Configuration
 
 **Zones** are value ranges defined as metadata for each data path. Learn more at the [Signal K Metadata documentation](https://signalk.org/specification/1.7.0/doc/data_model_metadata.html).  
-To configure metadata in Signal K, visit the [Data Browser server page](/admin/#/databrowser) and enable the **Meta Data** switch. Here, you can add or edit **methods** and **zones** for any path you want to monitor.
+To configure metadata in Signal K, visit the [Data Browser server page](/../../admin/#/databrowser) and enable the **Meta Data** switch. Here, you can add or edit **methods** and **zones** for any path you want to monitor.
 
 > **Note:** Zone values use base units (e.g., wind speed in meters per second). Define your zone ranges using the base unit for each path. KIP will automatically convert and display these values according to your widget’s unit settings.
 

package/public/assets/svg/icons.svg

@@ -331,6 +331,23 @@
       <path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M10.3004 7.49991C10.3004 8.4943 9.49426 9.30041 8.49988 9.30041C7.50549 9.30041 6.69938 8.4943 6.69938 7.49991C6.69938 6.50553 7.50549 5.69942 8.49988 5.69942C9.49426 5.69942 10.3004 6.50553 10.3004 7.49991ZM11.205 8C10.9699 9.28029 9.84816 10.2504 8.49988 10.2504C7.1516 10.2504 6.0299 9.28029 5.79473 8H0.5C0.223858 8 0 7.77614 0 7.5C0 7.22386 0.223858 7 0.5 7H5.7947C6.0298 5.71962 7.15154 4.74942 8.49988 4.74942C9.84822 4.74942 10.9699 5.71962 11.2051 7H14.5C14.7761 7 15 7.22386 15 7.5C15 7.77614 14.7761 8 14.5 8H11.205Z" />
       <circle cx="8.5" cy="7.5" r="1.5" fill="var(--mat-sys-primary)" />
     </svg>
+    <svg id="battery_available" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 48 48">
+      <path stroke="currentColor" stroke-linecap="square" stroke-linejoin="round" stroke-miterlimit="10" stroke-width="3" d="M36.2142 13.502H7.28334c-2.36616 0 -4.28432 1.9181 -4.28432 4.2843v12.4311c0 2.3661 1.91816 4.2843 4.28432 4.2843H36.2142c2.3661 0 4.2843 -1.9182 4.2843 -4.2843V17.7863c0 -2.3662 -1.9182 -4.2843 -4.2843 -4.2843Z"></path>
+      <path fill="currentColor" stroke="currentColor" stroke-linecap="square" stroke-miterlimit="10" stroke-width="3" d="M22.1236 18.6504H8.40817c-0.20709 0 -0.37497 0.1679 -0.37497 0.375v9.9489c0 0.207 0.16788 0.3749 0.37497 0.3749H22.1236c0.2072 0 0.375 -0.1679 0.375 -0.3749v-9.9489c0 -0.2071 -0.1678 -0.375 -0.375 -0.375Z"></path>
+      <path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="3" d="M44.999 20.501v6.9987"></path>
+    </svg>
+    <svg id="battery_charging"  xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 16 16">
+      <path fill="var(--mat-sys-primary)" d="M9.585 2.568a0.5 0.5 0 0 1 0.226 0.58L8.677 6.832h1.99a0.5 0.5 0 0 1 0.364 0.843l-5.334 5.667a0.5 0.5 0 0 1 -0.842 -0.49L5.99 9.167H4a0.5 0.5 0 0 1 -0.364 -0.843l5.333 -5.667a0.5 0.5 0 0 1 0.616 -0.09z" stroke-width="1"></path>
+      <path d="M2 4h4.332l-0.94 1H2a1 1 0 0 0 -1 1v4a1 1 0 0 0 1 1h2.38l-0.308 1H2a2 2 0 0 1 -2 -2V6a2 2 0 0 1 2 -2" stroke-width="1"></path>
+      <path d="M2 6h2.45L2.908 7.639A1.5 1.5 0 0 0 3.313 10H2zm8.595 -2 -0.308 1H12a1 1 0 0 1 1 1v4a1 1 0 0 1 -1 1H9.276l-0.942 1H12a2 2 0 0 0 2 -2V6a2 2 0 0 0 -2 -2z" stroke-width="1"></path>
+      <path d="M12 10h-1.783l1.542 -1.639q0.146 -0.156 0.241 -0.34zm0 -3.354V6h-0.646a1.5 1.5 0 0 1 0.646 0.646M16 8a1.5 1.5 0 0 1 -1.5 1.5v-3A1.5 1.5 0 0 1 16 8" stroke-width="1"></path>
+    </svg>
+    <svg id="power_available" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24">
+        <path fill="currentColor" d="M12 2c5.5228 0 10 4.47715 10 10 0 5.5228 -4.4772 10 -10 10 -5.52285 0 -10 -4.4772 -10 -10C2 6.47715 6.47715 2 12 2m1 8h3.5l-5.4678 9.9395c0.3174 0.0382 0.6401 0.0605 0.9678 0.0605 4.4183 0 8 -3.5817 8 -8 0 -4.07955 -3.0538 -7.44434 -7 -7.93652zm-1 -6c-4.41828 0 -8 3.58172 -8 8 0 4.0795 3.05384 7.4433 7 7.9355V14H7.5l5.4668 -9.94043C12.6498 4.02138 12.3273 4 12 4" stroke-width="1"></path>
+    </svg>
+    <svg id="power_renewal" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24">
+        <path fill="currentColor" d="M4.06445 13C4.55672 16.9461 7.92051 20 12 20c2.3364 -0.0002 4.4372 -1.0031 5.8994 -2.6006L15.5 15h6v6l-2.1855 -2.1855C17.4894 20.7734 14.8887 21.9998 12 22c-5.18532 0 -9.44843 -3.9467 -9.9502 -9zM12.5 10H16l-4.5 9v-5H8l4.5 -9zM12 2c5.1851 0.00028 9.4485 3.94685 9.9502 9h-2.0147C19.4434 7.05399 16.0793 4.00027 12 4 9.66354 4 7.56264 5.00292 6.10059 6.60059L8.5 9h-6V3l2.18457 2.18457C6.50965 3.22563 9.11128 2 12 2" stroke-width="1"></path>
+    </svg>
     <svg id="dashboard-beating-starboard" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24">
       <g id="g9" transform="matrix(-0.70710678,0.70710678,0.70710678,0.70710678,8.8211956,-6.2237242)">
         <path d="M 12,5.9999999 C 16,9.777778 17.777778,15.444445 16,23 H 8.0000001 C 6.2222223,15.444445 8.0000001,9.777778 12,5.9999999 Z" fill="var(--mat-sys-tertiary)" id="path1" style="stroke-width:0.229061" />