@mxtommy/kip 4.8.0-beta.1 → 4.8.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v4.8.0
+## New Features
+* Solar Charger Widget: Get instant clarity on your solar system with a compact, purpose-built Solar Charger Widget. Track individual panels or full arrays in real time, including State of Charge, remaining capacity, remaining time, voltage, current, power flow, and temperature. Device discovery is automatic, and Zones support keeps warnings and alarms state highly visible.
+* AC/DC Charger Widget: Monitor charging performance at a glance with a compact AC/DC Charger Widget. View single or multiple chargers with charge mode, voltage, current, power and temperature. Chargers are discovered automatically.
+## Improvements
+* Battery Monitor Widget visual cleanup for better readability and tighter consistency with the electrical widget family.
+* Framework upgrades and core refactoring to improve long-term maintainability and runtime performance.
+## Fixes
+* Improved Battery Monitor text contrast when color state is Alert (yellow), making critical values easier to read. Fixes #1027
+* Restored Countdown Timer visibility in Add Widgets.
 # v4.7.0
 ## New Features
 * Battery Monitor Widget: Stay on top of your vessel’s power system with a dedicated compact Battery Monitor Widget. Instantly view individual batteries or whole banks, including State of Charge, remaining capacity, remaining time, voltage, current, power flow, and temperature. Batteries are detected automatically, with Signal K Zones support for clear warning and alarm visibility at a glance.

package/LICENSE

@@ -19,3 +19,6 @@ 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.
+
+This repository may not be used to train machine learning or AI models
+without explicit permission from the author.

package/README.md

@@ -96,34 +96,27 @@ Organize your dashboards and access tools.
 
 ## Widget Library
 All KIP widgets are visual presentation controls that are very versatile, with multiple advanced configuration options available to suit your needs:
-- **Numeric**: Create gauges to display any numerical data sent by your system: SOG, depth, wind speed, VMG, refrigerator temperature, weather data, etc.
-- **Text**: Create gauges to display any textual data sent by your system: MPPT state, vessel details, next waypoint, Fusion radio song information, noon and sun phases, any system component configuration detail or status available, etc.
-- **Date & Time**: A timezone-aware control with flexible presentation formatting support.
-- **Position**: Position coordinates in textual format.
-- **Simple Linear gauge**: A visual display for electrical numerical data: chargers, MPPT, shunt, etc.
-- **Linear gauge**: Visually display any numerical data on a vertical or horizontal scale: tank and reservoir levels, battery remaining capacity, etc.
-- **Radial gauge**: Visually display any numerical data on a radial scale: boat speed, wind speed, engine RPM, etc.
-- **Compass gauge**: A card or marine compass to display directional data such as heading, bearing to next waypoint, wind angle, etc.
-- **Radial and linear Steel gauge**: Old-school look & feel gauges.
-- **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.
-- **Pitch & Roll gauge**: Horizon-style attitude indicator showing live pitch and roll for monitoring trim, heel, and sea-state response.
-- **Battery Monitor**: Stay on top of batteries or whole banks state with a compact view displaying State of Charge, remaining capacity, remaining time, voltage, current, power flow, and temperature.
-- **Solar Charger**: Track solar generation and charging performance at a glance with live panel output, battery-side metrics, and clear charger and relay status indicators.
-- **Windsteer**: Combines wind, wind sectors, heading, COG, and waypoint info for sailboat wind steering.
-- **Racesteer**: Sailboat race steering display fusing polar performance data with live conditions for optimal tactics.
-- **Countdown Timer**: A simple start sequences timer.
-- **Racer Start Timer**: Advanced race countdown timer with OCS (On Course Side) detection and automatic dashboard switching.
-- **Start Line Insight**: Analyze and visualize the start line for tactical racing advantage, including favored end and distance-to-line.
-- **Boolean Control Panel**: A digital switchboard to configure and operate remote devices: lights, bilge pumps, solenoids, or any Signal K compatible device that supports On/Off operations.
-- **Slider**: A versatile control that allows users to adjust values within a defined range by sliding. Commonly used for settings like light intensity, volume control, or any parameter requiring fine-tuned adjustments.
-- **Multi State Switch**: Lists all available device modes/states (e.g., On, Off, Charge Only, Invert Only), highlights the current state, and lets you select a new state to send to the device and see the result.
-- **Zones State Panel**: Monitor the health/state of multiple sensors and devices at a glance. Configure multiple paths per panel; each control uses KIP’s zone severity colors and status messages so warnings and alarms stand out immediately.
-- **Freeboard-SK Chart Plotter**: High-quality Signal K chartplotter integration widget.
-- **Autopilot Head**: Operate your autopilot from any device remotely.
+- **Compact Linear** – Simple horizontal linear gauge with a large value label and modern look.
+- **Linear** – Horizontal or vertical linear gauge with zone highlighting.
+- **Radial** – Radial gauge with configurable dials and zone highlighting.
+- **Compass** – Rotating compass gauge with multiple cardinal indicator options.
+- **Level Gauge** – Dual-scale heel angle indicator for trim tuning and sea-state monitoring.
+- **Pitch & Roll** – Horizon-style attitude indicator showing live pitch and roll degrees.
+- **Classic Steel** – Traditional steel-look linear & radial gauges with range sizes and zone highlights.
+- **Windsteer** – Combines wind, wind sectors, heading, COG, and waypoint info for wind steering.
+- **Wind Trends** – Real-time True Wind trends with dual axes for direction and speed, live values, and averages.
+- **Battery Monitor** - Display batteries or whole banks state State of Charge, remaining capacity, remaining time, voltage, current, power flow, and temperature.
+- **Solar Charger**- Track solar generation and charging performance at a glance with live panel output, battery-side metrics, and clear charger and relay status indicators.
+- **AC/DC Charger**- Monitor charging performance at a glance with a compact AC/DC Charger Widget. View single or multiple chargers with charge mode, voltage, current, power and temperature. Chargers are discovered automatically.
+- **Freeboard-SK** – Adds the Freeboard-SK chart plotter as a widget with automatic sign-in.
+- **Autopilot Head** – Typical autopilot controls for compatible Signal K Autopilot devices.
+- **Realtime Data Chart** – Visualizes data on a real-time chart with actuals, averages, and min/max.
 - **AIS Radar**: Display AIS targets with range rings, interactive target details, and quick zoom and filtering controls.
-- **Data Chart**: Visualize data trends over time.
-- **Embedded Webpage**: A powerful way to display web-based apps published on your Signal K server, such as Grafana and Node-RED dashboards, or your own standalone web app.
-- **Label**: A static text widget.
+- **Embed Webpage Viewer** – Embeds external web apps (Grafana, Node-RED, etc.) into your dashboard.
+- **Racesteer** – Race steering display fusing polar performance data with live conditions for optimal tactics.
+- **Racer - Start Line Insight** – Set and adjust start line ends, see distance, favored end, and line bias; integrates with Freeboard SK.
+- **Racer - Start Timer** – Advanced racing countdown timer with OCS status and auto dashboard switching.
+- **Countdown Timer** – Simple race start countdown timer with start, pause, sync, and reset options.
 
 Get the latest version of KIP to see what's new!
 
@@ -141,7 +134,7 @@ Grafana integration with other widgets
 ![Embedded Webpage Concept Image](./images/KipGaugeSample3-1024x508.png)
 
 ## Historical Data
-Experience effortless insight into your vessel’s past with KIP’s Widget Historical Charts—automatically track, store, and visualize key data, unlocking instant access charts showing up to the last full day of performance. Whether you’re sailing or docked, simply tap or right-click widgets to reveal a seamless history dialog—no setup, no clutter, just the trends you need. With full support for Data Driven widgets, live-to-history transitions, KIP puts your boat’s story at your fingertips—so you can make smarter decisions, spot patterns, and sail with confidence.
+Experience effortless insight into your vessel’s past with KIP’s Widget Historical Charts—automatically track, store, and visualize key data, unlocking instant access charts showing up to the last full day of performance. Whether you’re sailing or docked, simply two-finger tap or right-click widgets to reveal a seamless history dialog—no setup, no clutter, just the trends you need. When combining data visualisation using Data Driven widgets, live-to-history transitions, KIP puts your boat’s story at your fingertips—so you can make smarter decisions, spot patterns, and sail with confidence.
 
 ## Night Modes
 Keep your night vision with automatic or manual day and night switching to a color preserving dim mode or an all Red theme. The images below look very dark, but at night... they are perfect!
@@ -265,17 +258,26 @@ Once done with your work, from your fork's working branch, make a GitHub pull re
 For comprehensive development guidance, please refer to these instruction files:
 
 ### Primary Instructions
-- **[COPILOT.md](./COPILOT.md)**: Complete KIP project guidelines including architecture, services, widget development patterns, theming, and Signal K integration.
+- **[Project Instructions](./.github/instructions/project.instructions.md)**: KIP policy owner for architecture/domain rules, including widget creation and Host2 contracts.
+- **[COPILOT.md](./COPILOT.md)**: Architecture context, rationale, and evolution notes (non-policy).
 - **[Angular Instructions](./.github/instructions/angular.instructions.md)**: Modern Angular v21+ coding standards, component patterns, and framework best practices.
 - **[Copilot Agent Instructions](./.github/copilot-instructions.md)**: Architecture details and coding-agent guardrails for this repository.
 
 ### Development Workflow
-1. **Start Here**: Read `COPILOT.md` for KIP-specific architecture and patterns.
+1. **Start Here**: Read `.github/instructions/project.instructions.md` for KIP policy contracts.
 2. **Angular Standards**: Follow `.github/instructions/angular.instructions.md` for modern Angular development.
-3. **Setup & Build**: Use this README for project setup and build commands.
+3. **Architecture Context**: Use `COPILOT.md` for rationale and dated architecture notes.
+4. **Setup & Build**: Use this README for project setup and build commands.
+
+### Widget Creation Workflow
+1. Scaffold with `npm run generate:widget` (Host2 schematic-first path).
+2. Use `docs/widget-schematic.md` for CLI flags, prompting behavior, and troubleshooting.
+3. Follow Host2 runtime/stream patterns in `.agents/skills/kip-host2-widget/SKILL.md`.
+4. Apply widget creation implementation checklist from `.agents/skills/kip-widget-creation/SKILL.md`.
+5. Keep enforceable behavior aligned with `.github/instructions/project.instructions.md` (`Widget Creation Domain Rules`).
 
 ### Key Priorities
-- **Widget Development**: Use the Host2 widget pattern (signals + directives) and scaffold new widgets with the `create-host2-widget` schematic (see `COPILOT.md`).
+- **Widget Development**: Use Host2 patterns and scaffold with the `create-host2-widget` schematic (see `docs/widget-schematic.md`).
 - **Angular Patterns**: Use signals, standalone components, and modern control flow.
 - **Theming**: Follow KIP's theme system for consistent UI.
 - **Code Quality**: Run `npm run lint` before commits.
@@ -288,3 +290,6 @@ KIP has its own Discord Signal K channel for getting in touch. Join us at https:
 # Features, Ideas, Bugs
 See KIP's GitHub project for the latest feature requests:
 https://github.com/mxtommy/Kip/issues
+
+This repository may not be used to train machine learning or AI models
+without explicit permission from the author.

package/package.json

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

package/plugin/history-series.service.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HistorySeriesService = exports.isKipTemplateSeriesDefinition = exports.isKipSolarTemplateSeriesDefinition = exports.isKipSeriesEnabled = exports.isKipConcreteSeriesDefinition = exports.isKipBmsTemplateSeriesDefinition = void 0;
+exports.HistorySeriesService = exports.isKipTemplateSeriesDefinition = exports.isKipSolarTemplateSeriesDefinition = exports.isKipSeriesEnabled = exports.isKipElectricalTemplateSeriesDefinition = exports.isKipConcreteSeriesDefinition = exports.isKipBmsTemplateSeriesDefinition = void 0;
 const kip_series_contract_1 = require("./kip-series-contract");
+Object.defineProperty(exports, "isKipElectricalTemplateSeriesDefinition", { enumerable: true, get: function () { return kip_series_contract_1.isKipElectricalTemplateSeriesDefinition; } });
 Object.defineProperty(exports, "isKipBmsTemplateSeriesDefinition", { enumerable: true, get: function () { return kip_series_contract_1.isKipBmsTemplateSeriesDefinition; } });
 Object.defineProperty(exports, "isKipConcreteSeriesDefinition", { enumerable: true, get: function () { return kip_series_contract_1.isKipConcreteSeriesDefinition; } });
 Object.defineProperty(exports, "isKipSeriesEnabled", { enumerable: true, get: function () { return kip_series_contract_1.isKipSeriesEnabled; } });
@@ -227,6 +228,18 @@ class HistorySeriesService {
             if (!seriesKeys || seriesKeys.length === 0) {
                 return;
             }
+            const hasSpecificSourceMatch = seriesKeys.some(seriesKey => {
+                const series = this.seriesById.get(seriesKey);
+                if (!series) {
+                    return false;
+                }
+                const seriesContext = series.context ?? 'vessels.self';
+                if (!this.isContextMatch(seriesContext, context)) {
+                    return false;
+                }
+                const seriesSource = series.source ?? 'default';
+                return seriesSource !== 'default' && seriesSource === source;
+            });
             seriesKeys.forEach(seriesKey => {
                 const series = this.seriesById.get(seriesKey);
                 if (!series) {
@@ -240,6 +253,9 @@ class HistorySeriesService {
                 if (!this.isSourceMatch(seriesSource, source)) {
                     return;
                 }
+                if (seriesSource === 'default' && source !== 'default' && hasSpecificSourceMatch) {
+                    return;
+                }
                 if (this.recordSampleByKey(seriesKey, leaf.value, ts)) {
                     recorded += 1;
                 }
@@ -328,8 +344,9 @@ class HistorySeriesService {
             && leftComparable.ownerWidgetSelector === rightComparable.ownerWidgetSelector
             && leftComparable.path === rightComparable.path
             && leftComparable.expansionMode === rightComparable.expansionMode
-            && this.areStringArraysEquivalent(leftComparable.allowedBatteryIds, rightComparable.allowedBatteryIds)
-            && this.areStringArraysEquivalent(leftComparable.allowedSolarIds, rightComparable.allowedSolarIds)
+            && leftComparable.familyKey === rightComparable.familyKey
+            && this.areStringArraysEquivalent(leftComparable.allowedIds, rightComparable.allowedIds)
+            && this.areTrackedDevicesEquivalent(leftComparable.trackedDevices, rightComparable.trackedDevices)
             && leftComparable.source === rightComparable.source
             && leftComparable.context === rightComparable.context
             && leftComparable.timeScale === rightComparable.timeScale
@@ -344,11 +361,22 @@ class HistorySeriesService {
         void reconcileTs;
         return {
             ...comparable,
-            allowedBatteryIds: this.normalizeComparableStringArray(comparable.allowedBatteryIds),
-            allowedSolarIds: this.normalizeComparableStringArray(comparable.allowedSolarIds),
+            allowedIds: this.normalizeComparableStringArray(comparable.allowedIds),
+            trackedDevices: this.normalizeComparableTrackedDevices(comparable.trackedDevices),
             methods: this.normalizeComparableStringArray(comparable.methods)
         };
     }
+    areTrackedDevicesEquivalent(left, right) {
+        const normalizedLeft = this.normalizeComparableTrackedDevices(left) ?? [];
+        const normalizedRight = this.normalizeComparableTrackedDevices(right) ?? [];
+        if (normalizedLeft.length !== normalizedRight.length) {
+            return false;
+        }
+        return normalizedLeft.every((value, index) => {
+            const candidate = normalizedRight[index];
+            return value.id === candidate?.id && value.source === candidate?.source;
+        });
+    }
     areStringArraysEquivalent(left, right) {
         const normalizedLeft = this.normalizeComparableStringArray(left) ?? [];
         const normalizedRight = this.normalizeComparableStringArray(right) ?? [];
@@ -365,6 +393,31 @@ class HistorySeriesService {
             .filter((value) => typeof value === 'string')
             .sort((left, right) => left.localeCompare(right));
     }
+    normalizeComparableTrackedDevices(values) {
+        if (!Array.isArray(values) || values.length === 0) {
+            return undefined;
+        }
+        const normalizedByKey = new Map();
+        values.forEach(value => {
+            if (!value || typeof value !== 'object') {
+                return;
+            }
+            const id = typeof value.id === 'string' ? value.id.trim() : '';
+            const sourceText = typeof value.source === 'string' ? value.source.trim() : '';
+            const source = sourceText.length > 0 ? sourceText : 'default';
+            if (!id) {
+                return;
+            }
+            normalizedByKey.set(`${id}||${source}`, { id, source });
+        });
+        if (normalizedByKey.size === 0) {
+            return undefined;
+        }
+        return Array.from(normalizedByKey.values()).sort((left, right) => {
+            const idCompare = left.id.localeCompare(right.id);
+            return idCompare !== 0 ? idCompare : left.source.localeCompare(right.source);
+        });
+    }
     isChartWidget(ownerWidgetSelector, ownerWidgetUuid) {
         if (ownerWidgetSelector === 'widget-data-chart' || ownerWidgetSelector === 'widget-windtrends-chart') {
             return true;
@@ -391,18 +444,29 @@ class HistorySeriesService {
         }
         const ownerWidgetSelector = typeof input.ownerWidgetSelector === 'string' ? input.ownerWidgetSelector.trim() : null;
         const expansionMode = input.expansionMode ?? null;
-        if (expansionMode === 'bms-battery-tree' && ownerWidgetSelector !== 'widget-bms') {
-            throw new Error('BMS template series must use ownerWidgetSelector "widget-bms"');
-        }
-        if (expansionMode === 'solar-tree' && ownerWidgetSelector !== 'widget-solar-charger') {
-            throw new Error('Solar template series must use ownerWidgetSelector "widget-solar-charger"');
+        const familyKey = expansionMode ? this.expansionModeToFamilyKey(expansionMode) : null;
+        let normalizedTemplateSelector = null;
+        if (expansionMode) {
+            const selectorByMode = {
+                'bms-battery-tree': 'widget-bms',
+                'solar-tree': 'widget-solar-charger',
+                'charger-tree': 'widget-charger',
+                'inverter-tree': 'widget-inverter',
+                'alternator-tree': 'widget-alternator',
+                'ac-tree': 'widget-ac'
+            };
+            const requiredSelector = selectorByMode[expansionMode];
+            if (ownerWidgetSelector !== requiredSelector) {
+                throw new Error(`Template series mode "${expansionMode}" must use ownerWidgetSelector "${requiredSelector}"`);
+            }
+            normalizedTemplateSelector = requiredSelector;
         }
         const normalizedMethods = this.normalizeComparableStringArray(input.methods);
-        const normalizedAllowedBatteryIds = expansionMode === 'bms-battery-tree'
-            ? this.normalizeComparableStringArray(input.allowedBatteryIds)
+        const normalizedAllowedIds = expansionMode
+            ? this.normalizeComparableStringArray(input.allowedIds)
             : undefined;
-        const normalizedAllowedSolarIds = expansionMode === 'solar-tree'
-            ? this.normalizeComparableStringArray(input.allowedSolarIds)
+        const normalizedTrackedDevices = expansionMode
+            ? this.normalizeComparableTrackedDevices(input.trackedDevices)
             : undefined;
         const isDataWidget = this.isChartWidget(ownerWidgetSelector, ownerWidgetUuid);
         const retentionMs = this.resolveRetentionMs(input);
@@ -423,6 +487,7 @@ class HistorySeriesService {
             ownerWidgetUuid,
             ownerWidgetSelector,
             path,
+            familyKey,
             source: input.source ?? 'default',
             context: input.context ?? 'vessels.self',
             timeScale: input.timeScale ?? null,
@@ -433,34 +498,44 @@ class HistorySeriesService {
             methods: normalizedMethods,
             reconcileTs: input.reconcileTs
         };
-        if (expansionMode === 'bms-battery-tree') {
+        if (expansionMode) {
             const templateSeries = {
                 ...normalizedBase,
-                ownerWidgetSelector: 'widget-bms',
+                ownerWidgetSelector: normalizedTemplateSelector,
                 expansionMode,
-                allowedBatteryIds: normalizedAllowedBatteryIds ?? null,
-                allowedSolarIds: null
-            };
-            return templateSeries;
-        }
-        if (expansionMode === 'solar-tree') {
-            const templateSeries = {
-                ...normalizedBase,
-                ownerWidgetSelector: 'widget-solar-charger',
-                expansionMode,
-                allowedBatteryIds: null,
-                allowedSolarIds: normalizedAllowedSolarIds ?? null
+                familyKey,
+                allowedIds: normalizedAllowedIds ?? null,
+                trackedDevices: normalizedTrackedDevices ?? null
             };
             return templateSeries;
         }
         const concreteSeries = {
             ...normalizedBase,
             expansionMode: null,
-            allowedBatteryIds: null,
-            allowedSolarIds: null
+            familyKey: null,
+            allowedIds: null,
+            trackedDevices: null
         };
         return concreteSeries;
     }
+    expansionModeToFamilyKey(mode) {
+        switch (mode) {
+            case 'bms-battery-tree':
+                return 'batteries';
+            case 'solar-tree':
+                return 'solar';
+            case 'charger-tree':
+                return 'chargers';
+            case 'inverter-tree':
+                return 'inverters';
+            case 'alternator-tree':
+                return 'alternators';
+            case 'ac-tree':
+                return 'ac';
+            default:
+                throw new Error(`Unsupported expansion mode: ${String(mode)}`);
+        }
+    }
     resolveRetentionMs(series) {
         if (Number.isFinite(series.retentionDurationMs) && series.retentionDurationMs > 0) {
             return series.retentionDurationMs;