@enyo-energy/sunspec-sdk 0.0.72 → 0.0.73

package/dist/cjs/sunspec-devices.cjs

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SunspecMeter = exports.SunspecBattery = exports.SunspecInverter = exports.BaseSunspecDevice = void 0;
+exports.detectFeaturesFromRegisters = detectFeaturesFromRegisters;
+exports.filterFeaturesByCalibrationResult = filterFeaturesByCalibrationResult;
 const sunspec_interfaces_js_1 = require("./sunspec-interfaces.cjs");
 const node_crypto_1 = require("node:crypto");
 const enyo_appliance_js_1 = require("@enyo-energy/energy-app-sdk/dist/types/enyo-appliance.js");
@@ -864,6 +866,54 @@ class SunspecInverter extends BaseSunspecDevice {
     }
 }
 exports.SunspecInverter = SunspecInverter;
+/**
+ * Pure register-presence detection — exported so it can be unit-tested
+ * without the full `SunspecBattery` scaffold. Maps each Model 124 writable
+ * register to the `EnyoBatteryFeature` it represents:
+ *
+ * - `chaGriSet`  → `GridCharging` (charge source PV/GRID)
+ * - `wChaMax`    → `ChargeLimitation` (max charge power)
+ * - `outWRte`    → `DischargeLimitation` (discharge rate %)
+ * - `storCtlMod` → `GridDischarging` (closest signal that external discharge
+ *                  control is available; the inverter decides where it goes)
+ */
+function detectFeaturesFromRegisters(batteryData) {
+    const features = [];
+    if (batteryData?.chaGriSet !== undefined)
+        features.push(enyo_battery_appliance_js_1.EnyoBatteryFeature.GridCharging);
+    if (batteryData?.wChaMax !== undefined)
+        features.push(enyo_battery_appliance_js_1.EnyoBatteryFeature.ChargeLimitation);
+    if (batteryData?.outWRte !== undefined)
+        features.push(enyo_battery_appliance_js_1.EnyoBatteryFeature.DischargeLimitation);
+    if (batteryData?.storCtlMod !== undefined)
+        features.push(enyo_battery_appliance_js_1.EnyoBatteryFeature.GridDischarging);
+    return features;
+}
+/**
+ * Apply the per-feature calibration filter to a register-detected set.
+ * Exported for unit-test access to the legacy-result fallback branch.
+ *
+ * The contract:
+ * - No `result` or `result.state !== 'calibrated'` → strip every controllable
+ *   feature (safe fallback while waiting for calibration).
+ * - `result.state === 'calibrated'` with a decodable per-feature payload →
+ *   publish only the controllable features whose probes passed.
+ * - `result.state === 'calibrated'` with **no** decodable payload → legacy
+ *   data (pre-feature-calibrator SDK). The new calibrator only marks
+ *   `state=calibrated` when at least one probe passes, so an empty decoded
+ *   set with `state=calibrated` unambiguously signals legacy results. Publish
+ *   the full detected set to preserve the old all-or-nothing semantics on
+ *   upgrade.
+ */
+function filterFeaturesByCalibrationResult(detected, result, controllable) {
+    if (!result || result.state !== 'calibrated') {
+        return detected.filter(f => !controllable.includes(f));
+    }
+    const passed = (0, sunspec_battery_feature_calibrator_js_1.decodeFeatureResults)(result.notes);
+    if (passed.size === 0)
+        return detected;
+    return detected.filter(f => !controllable.includes(f) || passed.has(f));
+}
 /**
  * Sunspec Battery implementation
  */
@@ -939,14 +989,7 @@ class SunspecBattery extends BaseSunspecDevice {
      * {@link resolveAdvertisedFeatures}.
      */
     detectFromRegisters(batteryData) {
-        const features = [];
-        if (batteryData?.chaGriSet !== undefined) {
-            features.push(enyo_battery_appliance_js_1.EnyoBatteryFeature.GridCharging);
-        }
-        if (batteryData?.wChaMax !== undefined) {
-            features.push(enyo_battery_appliance_js_1.EnyoBatteryFeature.ChargeLimitation);
-        }
-        return features;
+        return detectFeaturesFromRegisters(batteryData);
     }
     /**
      * Resolve `appliance.battery.features` for the configured mode. Called on
@@ -964,18 +1007,10 @@ class SunspecBattery extends BaseSunspecDevice {
                 return intersect(this.detectFromRegisters(batteryData));
             case sunspec_interfaces_js_1.SunspecBatteryFeatureModeKind.CalibrationBased: {
                 const detected = intersect(this.detectFromRegisters(batteryData));
-                if (!this.applianceId || !this.calibrationResultStore) {
-                    return detected.filter(f => !SunspecBattery.CONTROLLABLE_FEATURES.includes(f));
-                }
-                const result = this.calibrationResultStore.getResult(this.applianceId);
-                if (!result || result.state !== 'calibrated') {
-                    return detected.filter(f => !SunspecBattery.CONTROLLABLE_FEATURES.includes(f));
-                }
-                // Per-feature gating: only publish controllable features whose
-                // probe passed during the last calibration. See
-                // `decodeFeatureResults` and `SunspecBatteryFeatureCalibrator`.
-                const passed = (0, sunspec_battery_feature_calibrator_js_1.decodeFeatureResults)(result.notes);
-                return detected.filter(f => !SunspecBattery.CONTROLLABLE_FEATURES.includes(f) || passed.has(f));
+                const result = this.applianceId
+                    ? this.calibrationResultStore?.getResult(this.applianceId)
+                    : undefined;
+                return filterFeaturesByCalibrationResult(detected, result, SunspecBattery.CONTROLLABLE_FEATURES);
             }
         }
     }

package/dist/cjs/sunspec-devices.d.cts

@@ -1,11 +1,12 @@
-import { type IRetryConfig, type SunspecBatteryBaseData, SunspecBatteryCapability, type SunspecBatteryControls, type SunspecBatteryFeatureMode, type SunspecInverterData, SunspecInverterCapability, SunspecMeterCapability, SunspecStorageMode } from "./sunspec-interfaces.cjs";
+import { type IRetryConfig, type SunspecBatteryBaseData, SunspecBatteryCapability, type SunspecBatteryControls, type SunspecBatteryData, type SunspecBatteryFeatureMode, type SunspecInverterData, SunspecInverterCapability, SunspecMeterCapability, SunspecStorageMode } from "./sunspec-interfaces.cjs";
 import { ApplianceManager, EnergyApp } from "@enyo-energy/energy-app-sdk";
 import { type EnyoAppliance, type EnyoApplianceErrorCode, EnyoApplianceName } from "@enyo-energy/energy-app-sdk/dist/types/enyo-appliance.js";
 import { EnyoNetworkDevice } from "@enyo-energy/energy-app-sdk/dist/types/enyo-network-device.js";
 import { SunspecModbusClient } from "./sunspec-modbus-client.cjs";
 import { ConnectionRetryManager } from "./connection-retry-manager.cjs";
 import { EnyoCommandAcknowledgeAnswerEnum, EnyoDataBusMessage, EnyoDataBusMessageEnum, EnyoDataBusMessageResolution } from "@enyo-energy/energy-app-sdk/dist/types/enyo-data-bus-value.js";
-import { BatteryCalibrator, type BatteryCalibratorConfig, type CalibrationResultStore, type CalibrationSnapshot, type RestoreReason, SnapshotService } from "@enyo-energy/appliance-calibration";
+import { BatteryCalibrator, type BatteryCalibratorConfig, type CalibrationResult, type CalibrationResultStore, type CalibrationSnapshot, type RestoreReason, SnapshotService } from "@enyo-energy/appliance-calibration";
+import { EnyoBatteryFeature } from "@enyo-energy/energy-app-sdk/dist/types/enyo-battery-appliance.js";
 import { EnergyAppDataBus } from "@enyo-energy/energy-app-sdk/dist/packages/energy-app-data-bus.js";
 /**
  * Base abstract class for all Sunspec devices
@@ -188,6 +189,35 @@ export declare class SunspecInverter extends BaseSunspecDevice {
      */
     private restoreInverterSnapshot;
 }
+/**
+ * Pure register-presence detection — exported so it can be unit-tested
+ * without the full `SunspecBattery` scaffold. Maps each Model 124 writable
+ * register to the `EnyoBatteryFeature` it represents:
+ *
+ * - `chaGriSet`  → `GridCharging` (charge source PV/GRID)
+ * - `wChaMax`    → `ChargeLimitation` (max charge power)
+ * - `outWRte`    → `DischargeLimitation` (discharge rate %)
+ * - `storCtlMod` → `GridDischarging` (closest signal that external discharge
+ *                  control is available; the inverter decides where it goes)
+ */
+export declare function detectFeaturesFromRegisters(batteryData: SunspecBatteryData | null): EnyoBatteryFeature[];
+/**
+ * Apply the per-feature calibration filter to a register-detected set.
+ * Exported for unit-test access to the legacy-result fallback branch.
+ *
+ * The contract:
+ * - No `result` or `result.state !== 'calibrated'` → strip every controllable
+ *   feature (safe fallback while waiting for calibration).
+ * - `result.state === 'calibrated'` with a decodable per-feature payload →
+ *   publish only the controllable features whose probes passed.
+ * - `result.state === 'calibrated'` with **no** decodable payload → legacy
+ *   data (pre-feature-calibrator SDK). The new calibrator only marks
+ *   `state=calibrated` when at least one probe passes, so an empty decoded
+ *   set with `state=calibrated` unambiguously signals legacy results. Publish
+ *   the full detected set to preserve the old all-or-nothing semantics on
+ *   upgrade.
+ */
+export declare function filterFeaturesByCalibrationResult(detected: EnyoBatteryFeature[], result: CalibrationResult | undefined, controllable: readonly EnyoBatteryFeature[]): EnyoBatteryFeature[];
 /**
  * Sunspec Battery implementation
  */

package/dist/cjs/version.cjs

@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
 /**
  * Current version of the enyo Energy App SDK.
  */
-exports.SDK_VERSION = '0.0.72';
+exports.SDK_VERSION = '0.0.73';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/cjs/version.d.cts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.72";
+export declare const SDK_VERSION = "0.0.73";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/sunspec-devices.d.ts

@@ -1,11 +1,12 @@
-import { type IRetryConfig, type SunspecBatteryBaseData, SunspecBatteryCapability, type SunspecBatteryControls, type SunspecBatteryFeatureMode, type SunspecInverterData, SunspecInverterCapability, SunspecMeterCapability, SunspecStorageMode } from "./sunspec-interfaces.js";
+import { type IRetryConfig, type SunspecBatteryBaseData, SunspecBatteryCapability, type SunspecBatteryControls, type SunspecBatteryData, type SunspecBatteryFeatureMode, type SunspecInverterData, SunspecInverterCapability, SunspecMeterCapability, SunspecStorageMode } from "./sunspec-interfaces.js";
 import { ApplianceManager, EnergyApp } from "@enyo-energy/energy-app-sdk";
 import { type EnyoAppliance, type EnyoApplianceErrorCode, EnyoApplianceName } from "@enyo-energy/energy-app-sdk/dist/types/enyo-appliance.js";
 import { EnyoNetworkDevice } from "@enyo-energy/energy-app-sdk/dist/types/enyo-network-device.js";
 import { SunspecModbusClient } from "./sunspec-modbus-client.js";
 import { ConnectionRetryManager } from "./connection-retry-manager.js";
 import { EnyoCommandAcknowledgeAnswerEnum, EnyoDataBusMessage, EnyoDataBusMessageEnum, EnyoDataBusMessageResolution } from "@enyo-energy/energy-app-sdk/dist/types/enyo-data-bus-value.js";
-import { BatteryCalibrator, type BatteryCalibratorConfig, type CalibrationResultStore, type CalibrationSnapshot, type RestoreReason, SnapshotService } from "@enyo-energy/appliance-calibration";
+import { BatteryCalibrator, type BatteryCalibratorConfig, type CalibrationResult, type CalibrationResultStore, type CalibrationSnapshot, type RestoreReason, SnapshotService } from "@enyo-energy/appliance-calibration";
+import { EnyoBatteryFeature } from "@enyo-energy/energy-app-sdk/dist/types/enyo-battery-appliance.js";
 import { EnergyAppDataBus } from "@enyo-energy/energy-app-sdk/dist/packages/energy-app-data-bus.js";
 /**
  * Base abstract class for all Sunspec devices
@@ -188,6 +189,35 @@ export declare class SunspecInverter extends BaseSunspecDevice {
      */
     private restoreInverterSnapshot;
 }
+/**
+ * Pure register-presence detection — exported so it can be unit-tested
+ * without the full `SunspecBattery` scaffold. Maps each Model 124 writable
+ * register to the `EnyoBatteryFeature` it represents:
+ *
+ * - `chaGriSet`  → `GridCharging` (charge source PV/GRID)
+ * - `wChaMax`    → `ChargeLimitation` (max charge power)
+ * - `outWRte`    → `DischargeLimitation` (discharge rate %)
+ * - `storCtlMod` → `GridDischarging` (closest signal that external discharge
+ *                  control is available; the inverter decides where it goes)
+ */
+export declare function detectFeaturesFromRegisters(batteryData: SunspecBatteryData | null): EnyoBatteryFeature[];
+/**
+ * Apply the per-feature calibration filter to a register-detected set.
+ * Exported for unit-test access to the legacy-result fallback branch.
+ *
+ * The contract:
+ * - No `result` or `result.state !== 'calibrated'` → strip every controllable
+ *   feature (safe fallback while waiting for calibration).
+ * - `result.state === 'calibrated'` with a decodable per-feature payload →
+ *   publish only the controllable features whose probes passed.
+ * - `result.state === 'calibrated'` with **no** decodable payload → legacy
+ *   data (pre-feature-calibrator SDK). The new calibrator only marks
+ *   `state=calibrated` when at least one probe passes, so an empty decoded
+ *   set with `state=calibrated` unambiguously signals legacy results. Publish
+ *   the full detected set to preserve the old all-or-nothing semantics on
+ *   upgrade.
+ */
+export declare function filterFeaturesByCalibrationResult(detected: EnyoBatteryFeature[], result: CalibrationResult | undefined, controllable: readonly EnyoBatteryFeature[]): EnyoBatteryFeature[];
 /**
  * Sunspec Battery implementation
  */

package/dist/sunspec-devices.js

@@ -859,6 +859,54 @@ export class SunspecInverter extends BaseSunspecDevice {
         }
     }
 }
+/**
+ * Pure register-presence detection — exported so it can be unit-tested
+ * without the full `SunspecBattery` scaffold. Maps each Model 124 writable
+ * register to the `EnyoBatteryFeature` it represents:
+ *
+ * - `chaGriSet`  → `GridCharging` (charge source PV/GRID)
+ * - `wChaMax`    → `ChargeLimitation` (max charge power)
+ * - `outWRte`    → `DischargeLimitation` (discharge rate %)
+ * - `storCtlMod` → `GridDischarging` (closest signal that external discharge
+ *                  control is available; the inverter decides where it goes)
+ */
+export function detectFeaturesFromRegisters(batteryData) {
+    const features = [];
+    if (batteryData?.chaGriSet !== undefined)
+        features.push(EnyoBatteryFeature.GridCharging);
+    if (batteryData?.wChaMax !== undefined)
+        features.push(EnyoBatteryFeature.ChargeLimitation);
+    if (batteryData?.outWRte !== undefined)
+        features.push(EnyoBatteryFeature.DischargeLimitation);
+    if (batteryData?.storCtlMod !== undefined)
+        features.push(EnyoBatteryFeature.GridDischarging);
+    return features;
+}
+/**
+ * Apply the per-feature calibration filter to a register-detected set.
+ * Exported for unit-test access to the legacy-result fallback branch.
+ *
+ * The contract:
+ * - No `result` or `result.state !== 'calibrated'` → strip every controllable
+ *   feature (safe fallback while waiting for calibration).
+ * - `result.state === 'calibrated'` with a decodable per-feature payload →
+ *   publish only the controllable features whose probes passed.
+ * - `result.state === 'calibrated'` with **no** decodable payload → legacy
+ *   data (pre-feature-calibrator SDK). The new calibrator only marks
+ *   `state=calibrated` when at least one probe passes, so an empty decoded
+ *   set with `state=calibrated` unambiguously signals legacy results. Publish
+ *   the full detected set to preserve the old all-or-nothing semantics on
+ *   upgrade.
+ */
+export function filterFeaturesByCalibrationResult(detected, result, controllable) {
+    if (!result || result.state !== 'calibrated') {
+        return detected.filter(f => !controllable.includes(f));
+    }
+    const passed = decodeFeatureResults(result.notes);
+    if (passed.size === 0)
+        return detected;
+    return detected.filter(f => !controllable.includes(f) || passed.has(f));
+}
 /**
  * Sunspec Battery implementation
  */
@@ -934,14 +982,7 @@ export class SunspecBattery extends BaseSunspecDevice {
      * {@link resolveAdvertisedFeatures}.
      */
     detectFromRegisters(batteryData) {
-        const features = [];
-        if (batteryData?.chaGriSet !== undefined) {
-            features.push(EnyoBatteryFeature.GridCharging);
-        }
-        if (batteryData?.wChaMax !== undefined) {
-            features.push(EnyoBatteryFeature.ChargeLimitation);
-        }
-        return features;
+        return detectFeaturesFromRegisters(batteryData);
     }
     /**
      * Resolve `appliance.battery.features` for the configured mode. Called on
@@ -959,18 +1000,10 @@ export class SunspecBattery extends BaseSunspecDevice {
                 return intersect(this.detectFromRegisters(batteryData));
             case SunspecBatteryFeatureModeKind.CalibrationBased: {
                 const detected = intersect(this.detectFromRegisters(batteryData));
-                if (!this.applianceId || !this.calibrationResultStore) {
-                    return detected.filter(f => !SunspecBattery.CONTROLLABLE_FEATURES.includes(f));
-                }
-                const result = this.calibrationResultStore.getResult(this.applianceId);
-                if (!result || result.state !== 'calibrated') {
-                    return detected.filter(f => !SunspecBattery.CONTROLLABLE_FEATURES.includes(f));
-                }
-                // Per-feature gating: only publish controllable features whose
-                // probe passed during the last calibration. See
-                // `decodeFeatureResults` and `SunspecBatteryFeatureCalibrator`.
-                const passed = decodeFeatureResults(result.notes);
-                return detected.filter(f => !SunspecBattery.CONTROLLABLE_FEATURES.includes(f) || passed.has(f));
+                const result = this.applianceId
+                    ? this.calibrationResultStore?.getResult(this.applianceId)
+                    : undefined;
+                return filterFeaturesByCalibrationResult(detected, result, SunspecBattery.CONTROLLABLE_FEATURES);
             }
         }
     }

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.72";
+export declare const SDK_VERSION = "0.0.73";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/version.js

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export const SDK_VERSION = '0.0.72';
+export const SDK_VERSION = '0.0.73';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enyo-energy/sunspec-sdk",
-  "version": "0.0.72",
+  "version": "0.0.73",
   "description": "enyo Energy Sunspec SDK",
   "type": "module",
   "main": "dist/index.js",