@enyo-energy/sunspec-sdk 0.0.67 → 0.0.68

package/dist/cjs/sunspec-devices.cjs

@@ -278,7 +278,9 @@ class SunspecInverter extends BaseSunspecDevice {
         // Get device info from common block
         const commonData = await this.sunspecClient.readCommonBlock(this.unitId);
         const inverterSettings = await this.sunspecClient.readInverterSettings(this.unitId);
+        const inverterControls = await this.sunspecClient.readInverterControls(this.unitId);
         const mpptDataList = await this.sunspecClient.readAllMPPTData(this.unitId);
+        const activeProductionLimitationW = this.computeActiveProductionLimitW(inverterSettings, inverterControls);
         // Create or update appliance (skip if an existing appliance was provided)
         if (!this.applianceId) {
             try {
@@ -296,7 +298,8 @@ class SunspecInverter extends BaseSunspecDevice {
                     },
                     inverter: {
                         dcStrings: this.mapDcStringToApplianceMetadata(this.mapMPPTToStrings(mpptDataList)),
-                        maxPvProductionW: inverterSettings?.WMax
+                        maxPvProductionW: inverterSettings?.WMax,
+                        activeProductionLimitationW: activeProductionLimitationW
                     }
                 });
                 console.log(`Sunspec Inverter connected: ${this.networkDevice.hostname} (${this.applianceId})`);
@@ -318,7 +321,8 @@ class SunspecInverter extends BaseSunspecDevice {
                     inverter: {
                         ...existingAppliance?.inverter,
                         dcStrings: this.mapDcStringToApplianceMetadata(this.mapMPPTToStrings(mpptDataList)),
-                        maxPvProductionW: inverterSettings?.WMax
+                        maxPvProductionW: inverterSettings?.WMax,
+                        activeProductionLimitationW: activeProductionLimitationW
                     }
                 });
                 console.log(`Sunspec Inverter connected: ${this.networkDevice.hostname} (${this.applianceId})`);
@@ -355,7 +359,9 @@ class SunspecInverter extends BaseSunspecDevice {
             const inverterData = await this.sunspecClient.readInverterData(this.unitId);
             const mpptDataList = await this.sunspecClient.readAllMPPTData(this.unitId);
             const inverterSettings = await this.sunspecClient.readInverterSettings(this.unitId);
+            const inverterControls = await this.sunspecClient.readInverterControls(this.unitId);
             const dcStrings = this.mapMPPTToStrings(mpptDataList);
+            const activeProductionLimitationW = this.computeActiveProductionLimitW(inverterSettings, inverterControls);
             // SDK readers swallow modbus errors and return null/[]; detect that here so the
             // appliance is marked offline and the retry manager starts its backoff.
             if (await this.markOfflineIfUnhealthy()) {
@@ -396,7 +402,8 @@ class SunspecInverter extends BaseSunspecDevice {
                 await this.applianceManager.updateAppliance(this.applianceId, {
                     inverter: {
                         ...appliance?.inverter,
-                        dcStrings: this.mapDcStringToApplianceMetadata(dcStrings)
+                        dcStrings: this.mapDcStringToApplianceMetadata(dcStrings),
+                        activeProductionLimitationW: activeProductionLimitationW
                     }
                 });
             }
@@ -568,6 +575,25 @@ class SunspecInverter extends BaseSunspecDevice {
         console.log(`Inverter ${this.applianceId}: emitting faulted (${sunspec_interfaces_js_1.SUNSPEC_CONNECTION_LOST_CODE}) after ${consecutiveFailures} consecutive reconnect failures`);
         this.dataBus.sendMessage([message]);
     }
+    /**
+     * Compute the currently active feed-in / production limit in Watts from the
+     * Model 121 settings (WMax) and Model 123 controls (WMaxLim_Ena, WMaxLimPct).
+     * Returns null when no limit is applied, when the registers cannot be read,
+     * or when the limit equals WMax (i.e. not actually throttling) — null is
+     * returned (not undefined) so the field is cleared on the appliance.
+     */
+    computeActiveProductionLimitW(settings, controls) {
+        if (!settings?.WMax || !controls)
+            return null;
+        if (controls.WMaxLim_Ena !== sunspec_interfaces_js_1.SunspecEnableControl.ENABLED)
+            return null;
+        if (controls.WMaxLimPct === undefined)
+            return null;
+        const limitW = (settings.WMax * controls.WMaxLimPct) / 100;
+        if (limitW >= settings.WMax)
+            return null;
+        return limitW;
+    }
     mapOperatingState(state) {
         if (!state)
             return enyo_data_bus_value_js_1.EnyoInverterStateEnum.Off;
@@ -726,6 +752,8 @@ class SunspecBattery extends BaseSunspecDevice {
         if (batteryData?.wChaMax !== undefined) {
             features.push(enyo_battery_appliance_js_1.EnyoBatteryFeature.ChargeLimitation);
         }
+        const activeChargeLimitW = this.computeActiveChargeLimitW(batteryData);
+        const activeDischargeLimitW = this.computeActiveDischargeLimitW(batteryData);
         // Create or update appliance (skip if an existing appliance was provided)
         if (!this.applianceId) {
             try {
@@ -746,6 +774,8 @@ class SunspecBattery extends BaseSunspecDevice {
                         storageMode: this.mapToEnyoStorageMode(storageMode),
                         maxChargingPowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.inWRte !== undefined ? batteryData.wChaMax * batteryData.inWRte : undefined,
                         maxDischargePowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.outWRte !== undefined ? batteryData.wChaMax * batteryData.outWRte : undefined,
+                        activeChargeLimitW: activeChargeLimitW,
+                        activeDischargeLimitW: activeDischargeLimitW,
                         features,
                         gridChargingEnabled: batteryData?.chaGriSet === 1
                     }
@@ -772,6 +802,8 @@ class SunspecBattery extends BaseSunspecDevice {
                         storageMode: this.mapToEnyoStorageMode(storageMode),
                         maxChargingPowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.inWRte !== undefined ? batteryData.wChaMax * batteryData.inWRte : undefined,
                         maxDischargePowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.outWRte !== undefined ? batteryData.wChaMax * batteryData.outWRte : undefined,
+                        activeChargeLimitW: activeChargeLimitW,
+                        activeDischargeLimitW: activeDischargeLimitW,
                         features,
                         gridChargingEnabled: batteryData?.chaGriSet === 1
                     }
@@ -878,6 +910,8 @@ class SunspecBattery extends BaseSunspecDevice {
                         storageMode: this.mapToEnyoStorageMode(storageMode),
                         maxChargingPowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.inWRte !== undefined ? batteryData.wChaMax * batteryData.inWRte : undefined,
                         maxDischargePowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.outWRte !== undefined ? batteryData.wChaMax * batteryData.outWRte : undefined,
+                        activeChargeLimitW: this.computeActiveChargeLimitW(batteryData),
+                        activeDischargeLimitW: this.computeActiveDischargeLimitW(batteryData),
                         gridChargingEnabled: batteryData?.chaGriSet === 1
                     }
                 });
@@ -1056,6 +1090,34 @@ class SunspecBattery extends BaseSunspecDevice {
         const controls = await this.getBatteryControls();
         return this.determineStorageMode(controls);
     }
+    /**
+     * Compute the currently active charge limit in Watts from Model 124's
+     * wChaMax and the charge rate setpoint inWRte (% of WChaMax). Returns
+     * null when no limit is applied, when the registers cannot be read, or
+     * when the rate is at 100% (no throttling) — null is returned (not
+     * undefined) so the field is cleared on the appliance.
+     */
+    computeActiveChargeLimitW(batteryData) {
+        if (!batteryData || batteryData.wChaMax === undefined || batteryData.inWRte === undefined) {
+            return null;
+        }
+        if (batteryData.inWRte >= 100)
+            return null;
+        return (batteryData.wChaMax * batteryData.inWRte) / 100;
+    }
+    /**
+     * Compute the currently active discharge limit in Watts from Model 124's
+     * wChaMax and the discharge rate setpoint outWRte (% of WDisChaMax).
+     * Returns null when no limit is applied or the registers cannot be read.
+     */
+    computeActiveDischargeLimitW(batteryData) {
+        if (!batteryData || batteryData.wChaMax === undefined || batteryData.outWRte === undefined) {
+            return null;
+        }
+        if (batteryData.outWRte >= 100)
+            return null;
+        return (batteryData.wChaMax * batteryData.outWRte) / 100;
+    }
     determineStorageMode(controls) {
         if (!controls || controls.storCtlMod === undefined) {
             return null;

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

@@ -129,6 +129,14 @@ export declare class SunspecInverter extends BaseSunspecDevice {
     private persistErrorState;
     private detectAndEmitStatusTransition;
     protected onConnectionFailure(consecutiveFailures: number): Promise<void>;
+    /**
+     * Compute the currently active feed-in / production limit in Watts from the
+     * Model 121 settings (WMax) and Model 123 controls (WMaxLim_Ena, WMaxLimPct).
+     * Returns null when no limit is applied, when the registers cannot be read,
+     * or when the limit equals WMax (i.e. not actually throttling) — null is
+     * returned (not undefined) so the field is cleared on the appliance.
+     */
+    private computeActiveProductionLimitW;
     private mapOperatingState;
     /**
      * Map MPPT data to DC string structure for data bus
@@ -245,6 +253,20 @@ export declare class SunspecBattery extends BaseSunspecDevice {
      * @returns Promise<SunspecStorageMode | null> - Current mode or null if error
      */
     getStorageMode(): Promise<SunspecStorageMode | null>;
+    /**
+     * Compute the currently active charge limit in Watts from Model 124's
+     * wChaMax and the charge rate setpoint inWRte (% of WChaMax). Returns
+     * null when no limit is applied, when the registers cannot be read, or
+     * when the rate is at 100% (no throttling) — null is returned (not
+     * undefined) so the field is cleared on the appliance.
+     */
+    private computeActiveChargeLimitW;
+    /**
+     * Compute the currently active discharge limit in Watts from Model 124's
+     * wChaMax and the discharge rate setpoint outWRte (% of WDisChaMax).
+     * Returns null when no limit is applied or the registers cannot be read.
+     */
+    private computeActiveDischargeLimitW;
     private determineStorageMode;
     /**
      * Check if grid charging is enabled

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.67';
+exports.SDK_VERSION = '0.0.68';
 /**
  * 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.67";
+export declare const SDK_VERSION = "0.0.68";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/sunspec-devices.d.ts

@@ -129,6 +129,14 @@ export declare class SunspecInverter extends BaseSunspecDevice {
     private persistErrorState;
     private detectAndEmitStatusTransition;
     protected onConnectionFailure(consecutiveFailures: number): Promise<void>;
+    /**
+     * Compute the currently active feed-in / production limit in Watts from the
+     * Model 121 settings (WMax) and Model 123 controls (WMaxLim_Ena, WMaxLimPct).
+     * Returns null when no limit is applied, when the registers cannot be read,
+     * or when the limit equals WMax (i.e. not actually throttling) — null is
+     * returned (not undefined) so the field is cleared on the appliance.
+     */
+    private computeActiveProductionLimitW;
     private mapOperatingState;
     /**
      * Map MPPT data to DC string structure for data bus
@@ -245,6 +253,20 @@ export declare class SunspecBattery extends BaseSunspecDevice {
      * @returns Promise<SunspecStorageMode | null> - Current mode or null if error
      */
     getStorageMode(): Promise<SunspecStorageMode | null>;
+    /**
+     * Compute the currently active charge limit in Watts from Model 124's
+     * wChaMax and the charge rate setpoint inWRte (% of WChaMax). Returns
+     * null when no limit is applied, when the registers cannot be read, or
+     * when the rate is at 100% (no throttling) — null is returned (not
+     * undefined) so the field is cleared on the appliance.
+     */
+    private computeActiveChargeLimitW;
+    /**
+     * Compute the currently active discharge limit in Watts from Model 124's
+     * wChaMax and the discharge rate setpoint outWRte (% of WDisChaMax).
+     * Returns null when no limit is applied or the registers cannot be read.
+     */
+    private computeActiveDischargeLimitW;
     private determineStorageMode;
     /**
      * Check if grid charging is enabled

package/dist/sunspec-devices.js

@@ -1,4 +1,4 @@
-import { SunspecBatteryChargeState, SunspecInverterCapability, SunspecInverterEvent1, SunspecModelId, SunspecMPPTOperatingState, SunspecStorageMode, SUNSPEC_CONNECTION_LOST_CODE } from "./sunspec-interfaces.js";
+import { SunspecBatteryChargeState, SunspecEnableControl, SunspecInverterCapability, SunspecInverterEvent1, SunspecModelId, SunspecMPPTOperatingState, SunspecStorageMode, SUNSPEC_CONNECTION_LOST_CODE } from "./sunspec-interfaces.js";
 import { randomUUID } from "node:crypto";
 import { EnyoApplianceConnectionType, EnyoApplianceStateEnum, EnyoApplianceStatusEnum, EnyoApplianceTopologyFeatureEnum, EnyoApplianceTypeEnum } from "@enyo-energy/energy-app-sdk/dist/types/enyo-appliance.js";
 import { ConnectionRetryManager } from "./connection-retry-manager.js";
@@ -274,7 +274,9 @@ export class SunspecInverter extends BaseSunspecDevice {
         // Get device info from common block
         const commonData = await this.sunspecClient.readCommonBlock(this.unitId);
         const inverterSettings = await this.sunspecClient.readInverterSettings(this.unitId);
+        const inverterControls = await this.sunspecClient.readInverterControls(this.unitId);
         const mpptDataList = await this.sunspecClient.readAllMPPTData(this.unitId);
+        const activeProductionLimitationW = this.computeActiveProductionLimitW(inverterSettings, inverterControls);
         // Create or update appliance (skip if an existing appliance was provided)
         if (!this.applianceId) {
             try {
@@ -292,7 +294,8 @@ export class SunspecInverter extends BaseSunspecDevice {
                     },
                     inverter: {
                         dcStrings: this.mapDcStringToApplianceMetadata(this.mapMPPTToStrings(mpptDataList)),
-                        maxPvProductionW: inverterSettings?.WMax
+                        maxPvProductionW: inverterSettings?.WMax,
+                        activeProductionLimitationW: activeProductionLimitationW
                     }
                 });
                 console.log(`Sunspec Inverter connected: ${this.networkDevice.hostname} (${this.applianceId})`);
@@ -314,7 +317,8 @@ export class SunspecInverter extends BaseSunspecDevice {
                     inverter: {
                         ...existingAppliance?.inverter,
                         dcStrings: this.mapDcStringToApplianceMetadata(this.mapMPPTToStrings(mpptDataList)),
-                        maxPvProductionW: inverterSettings?.WMax
+                        maxPvProductionW: inverterSettings?.WMax,
+                        activeProductionLimitationW: activeProductionLimitationW
                     }
                 });
                 console.log(`Sunspec Inverter connected: ${this.networkDevice.hostname} (${this.applianceId})`);
@@ -351,7 +355,9 @@ export class SunspecInverter extends BaseSunspecDevice {
             const inverterData = await this.sunspecClient.readInverterData(this.unitId);
             const mpptDataList = await this.sunspecClient.readAllMPPTData(this.unitId);
             const inverterSettings = await this.sunspecClient.readInverterSettings(this.unitId);
+            const inverterControls = await this.sunspecClient.readInverterControls(this.unitId);
             const dcStrings = this.mapMPPTToStrings(mpptDataList);
+            const activeProductionLimitationW = this.computeActiveProductionLimitW(inverterSettings, inverterControls);
             // SDK readers swallow modbus errors and return null/[]; detect that here so the
             // appliance is marked offline and the retry manager starts its backoff.
             if (await this.markOfflineIfUnhealthy()) {
@@ -392,7 +398,8 @@ export class SunspecInverter extends BaseSunspecDevice {
                 await this.applianceManager.updateAppliance(this.applianceId, {
                     inverter: {
                         ...appliance?.inverter,
-                        dcStrings: this.mapDcStringToApplianceMetadata(dcStrings)
+                        dcStrings: this.mapDcStringToApplianceMetadata(dcStrings),
+                        activeProductionLimitationW: activeProductionLimitationW
                     }
                 });
             }
@@ -564,6 +571,25 @@ export class SunspecInverter extends BaseSunspecDevice {
         console.log(`Inverter ${this.applianceId}: emitting faulted (${SUNSPEC_CONNECTION_LOST_CODE}) after ${consecutiveFailures} consecutive reconnect failures`);
         this.dataBus.sendMessage([message]);
     }
+    /**
+     * Compute the currently active feed-in / production limit in Watts from the
+     * Model 121 settings (WMax) and Model 123 controls (WMaxLim_Ena, WMaxLimPct).
+     * Returns null when no limit is applied, when the registers cannot be read,
+     * or when the limit equals WMax (i.e. not actually throttling) — null is
+     * returned (not undefined) so the field is cleared on the appliance.
+     */
+    computeActiveProductionLimitW(settings, controls) {
+        if (!settings?.WMax || !controls)
+            return null;
+        if (controls.WMaxLim_Ena !== SunspecEnableControl.ENABLED)
+            return null;
+        if (controls.WMaxLimPct === undefined)
+            return null;
+        const limitW = (settings.WMax * controls.WMaxLimPct) / 100;
+        if (limitW >= settings.WMax)
+            return null;
+        return limitW;
+    }
     mapOperatingState(state) {
         if (!state)
             return EnyoInverterStateEnum.Off;
@@ -721,6 +747,8 @@ export class SunspecBattery extends BaseSunspecDevice {
         if (batteryData?.wChaMax !== undefined) {
             features.push(EnyoBatteryFeature.ChargeLimitation);
         }
+        const activeChargeLimitW = this.computeActiveChargeLimitW(batteryData);
+        const activeDischargeLimitW = this.computeActiveDischargeLimitW(batteryData);
         // Create or update appliance (skip if an existing appliance was provided)
         if (!this.applianceId) {
             try {
@@ -741,6 +769,8 @@ export class SunspecBattery extends BaseSunspecDevice {
                         storageMode: this.mapToEnyoStorageMode(storageMode),
                         maxChargingPowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.inWRte !== undefined ? batteryData.wChaMax * batteryData.inWRte : undefined,
                         maxDischargePowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.outWRte !== undefined ? batteryData.wChaMax * batteryData.outWRte : undefined,
+                        activeChargeLimitW: activeChargeLimitW,
+                        activeDischargeLimitW: activeDischargeLimitW,
                         features,
                         gridChargingEnabled: batteryData?.chaGriSet === 1
                     }
@@ -767,6 +797,8 @@ export class SunspecBattery extends BaseSunspecDevice {
                         storageMode: this.mapToEnyoStorageMode(storageMode),
                         maxChargingPowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.inWRte !== undefined ? batteryData.wChaMax * batteryData.inWRte : undefined,
                         maxDischargePowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.outWRte !== undefined ? batteryData.wChaMax * batteryData.outWRte : undefined,
+                        activeChargeLimitW: activeChargeLimitW,
+                        activeDischargeLimitW: activeDischargeLimitW,
                         features,
                         gridChargingEnabled: batteryData?.chaGriSet === 1
                     }
@@ -873,6 +905,8 @@ export class SunspecBattery extends BaseSunspecDevice {
                         storageMode: this.mapToEnyoStorageMode(storageMode),
                         maxChargingPowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.inWRte !== undefined ? batteryData.wChaMax * batteryData.inWRte : undefined,
                         maxDischargePowerW: batteryData && batteryData.wChaMax !== undefined && batteryData.outWRte !== undefined ? batteryData.wChaMax * batteryData.outWRte : undefined,
+                        activeChargeLimitW: this.computeActiveChargeLimitW(batteryData),
+                        activeDischargeLimitW: this.computeActiveDischargeLimitW(batteryData),
                         gridChargingEnabled: batteryData?.chaGriSet === 1
                     }
                 });
@@ -1051,6 +1085,34 @@ export class SunspecBattery extends BaseSunspecDevice {
         const controls = await this.getBatteryControls();
         return this.determineStorageMode(controls);
     }
+    /**
+     * Compute the currently active charge limit in Watts from Model 124's
+     * wChaMax and the charge rate setpoint inWRte (% of WChaMax). Returns
+     * null when no limit is applied, when the registers cannot be read, or
+     * when the rate is at 100% (no throttling) — null is returned (not
+     * undefined) so the field is cleared on the appliance.
+     */
+    computeActiveChargeLimitW(batteryData) {
+        if (!batteryData || batteryData.wChaMax === undefined || batteryData.inWRte === undefined) {
+            return null;
+        }
+        if (batteryData.inWRte >= 100)
+            return null;
+        return (batteryData.wChaMax * batteryData.inWRte) / 100;
+    }
+    /**
+     * Compute the currently active discharge limit in Watts from Model 124's
+     * wChaMax and the discharge rate setpoint outWRte (% of WDisChaMax).
+     * Returns null when no limit is applied or the registers cannot be read.
+     */
+    computeActiveDischargeLimitW(batteryData) {
+        if (!batteryData || batteryData.wChaMax === undefined || batteryData.outWRte === undefined) {
+            return null;
+        }
+        if (batteryData.outWRte >= 100)
+            return null;
+        return (batteryData.wChaMax * batteryData.outWRte) / 100;
+    }
     determineStorageMode(controls) {
         if (!controls || controls.storCtlMod === undefined) {
             return null;

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.67";
+export declare const SDK_VERSION = "0.0.68";
 /**
  * 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.67';
+export const SDK_VERSION = '0.0.68';
 /**
  * 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.67",
+  "version": "0.0.68",
   "description": "enyo Energy Sunspec SDK",
   "type": "module",
   "main": "dist/index.js",