@enyo-energy/sunspec-sdk 0.0.15 → 0.0.16

package/dist/cjs/sunspec-devices.cjs

@@ -102,16 +102,8 @@ class SunspecInverter extends BaseSunspecDevice {
             // Read inverter data
             const inverterData = await this.sunspecClient.readInverterData();
             const mpptDataList = await this.sunspecClient.readAllMPPTData();
+            const inverterSettings = await this.sunspecClient.readInverterSettings();
             if (inverterData) {
-                // Log what we're sending
-                console.log('Preparing Inverter Message:', {
-                    pvPowerW: inverterData.dcPower,
-                    acPower: inverterData.acPower,
-                    voltageL1: inverterData.voltageAN,
-                    voltageL2: inverterData.voltageBN,
-                    voltageL3: inverterData.voltageCN,
-                    stringsCount: mpptDataList.length
-                });
                 const inverterMessage = {
                     id: (0, node_crypto_1.randomUUID)(),
                     message: enyo_data_bus_value_js_1.EnyoDataBusMessageEnum.InverterValuesUpdateV1,
@@ -122,12 +114,12 @@ class SunspecInverter extends BaseSunspecDevice {
                     timestampIso: timestamp.toISOString(),
                     resolution,
                     data: {
-                        pvPowerW: inverterData.dcPower || 0, // Use DC power for PV power
-                        activePowerLimitationW: inverterData.acPower || 0,
+                        pvPowerW: inverterData.acPower || 0,
+                        activePowerLimitationW: inverterSettings?.WMax,
                         state: this.mapOperatingState(inverterData.operatingState),
                         voltageL1: inverterData.voltageAN || 0,
-                        voltageL2: inverterData.voltageBN ?? undefined, // Use undefined if unimplemented phase
-                        voltageL3: inverterData.voltageCN ?? undefined, // Use undefined if unimplemented phase
+                        voltageL2: inverterData.voltageBN ?? undefined,
+                        voltageL3: inverterData.voltageCN ?? undefined,
                         strings: this.mapMPPTToStrings(mpptDataList)
                     }
                 };
@@ -166,12 +158,38 @@ class SunspecInverter extends BaseSunspecDevice {
                 result.push({
                     index: index + 1,
                     voltage: mppt.dcVoltage ?? undefined, // Use null if undefined
-                    powerW: mppt.dcPower ?? 0 // Default to 0 if undefined
+                    powerW: mppt.dcPower ?? undefined // Default to 0 if undefined
                 });
             }
         });
         return result;
     }
+    mapMPPTOperatingState(state) {
+        switch (state) {
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.OFF:
+                return "OFF";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.SLEEPING:
+                return "SLEEPING";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.STARTING:
+                return "STARTING";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.MPPT:
+                return "MPPT";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.THROTTLED:
+                return "THROTTLED";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.SHUTTING_DOWN:
+                return "SHUTTING_DOWN";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.FAULT:
+                return "FAULT";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.STANDBY:
+                return "STANDBY";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.TEST:
+                return "TEST";
+            case sunspec_interfaces_js_1.SunspecMPPTOperatingState.RESERVED_10:
+                return "RESERVED_10";
+            default:
+                return `UNKNOWN(${state})`;
+        }
+    }
 }
 exports.SunspecInverter = SunspecInverter;
 /**
@@ -217,6 +235,32 @@ class SunspecBattery extends BaseSunspecDevice {
             await this.applianceManager.updateApplianceState(this.applianceId, enyo_appliance_js_1.EnyoApplianceConnectionType.Connector, enyo_appliance_js_1.EnyoApplianceStateEnum.Offline);
         }
     }
+    /**
+     * Map SunSpec battery charge state to Enyo battery state
+     */
+    mapToEnyoBatteryState(sunspecState) {
+        if (sunspecState === undefined) {
+            return undefined;
+        }
+        switch (sunspecState) {
+            case sunspec_interfaces_js_1.SunspecBatteryChargeState.OFF:
+                return enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Off;
+            case sunspec_interfaces_js_1.SunspecBatteryChargeState.EMPTY:
+                return enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Empty;
+            case sunspec_interfaces_js_1.SunspecBatteryChargeState.DISCHARGING:
+                return enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Discharging;
+            case sunspec_interfaces_js_1.SunspecBatteryChargeState.CHARGING:
+                return enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Charging;
+            case sunspec_interfaces_js_1.SunspecBatteryChargeState.FULL:
+                return enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Full;
+            case sunspec_interfaces_js_1.SunspecBatteryChargeState.HOLDING:
+                return enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Holding;
+            case sunspec_interfaces_js_1.SunspecBatteryChargeState.TESTING:
+                return enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Testing;
+            default:
+                return undefined;
+        }
+    }
     /**
      * Update battery data and return data bus messages
      */
@@ -227,24 +271,57 @@ class SunspecBattery extends BaseSunspecDevice {
         const messages = [];
         const timestamp = new Date();
         try {
-            // For now, return basic battery data
-            // In a real implementation, we would read from battery models
-            const batteryMessage = {
-                id: (0, node_crypto_1.randomUUID)(),
-                message: enyo_data_bus_value_js_1.EnyoDataBusMessageEnum.BatteryValuesUpdateV1,
-                type: 'message',
-                source: enyo_source_enum_js_1.EnyoSourceEnum.Device,
-                applianceId: this.applianceId,
-                clockId,
-                timestampIso: timestamp.toISOString(),
-                resolution,
-                data: {
-                    batterySoC: 50, // Placeholder - would read from battery model
-                    batteryPowerW: 0,
-                    state: enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Holding
+            // Read actual battery data from SunSpec device
+            const batteryData = await this.sunspecClient.readBatteryData();
+            if (batteryData) {
+                // Calculate battery power
+                let batteryPowerW = 0;
+                if (batteryData.chargePower !== undefined && batteryData.chargePower > 0) {
+                    batteryPowerW = batteryData.chargePower; // Positive for charging
                 }
-            };
-            messages.push(batteryMessage);
+                else if (batteryData.dischargePower !== undefined && batteryData.dischargePower > 0) {
+                    batteryPowerW = -batteryData.dischargePower; // Negative for discharging
+                }
+                const batteryMessage = {
+                    id: (0, node_crypto_1.randomUUID)(),
+                    message: enyo_data_bus_value_js_1.EnyoDataBusMessageEnum.BatteryValuesUpdateV1,
+                    type: 'message',
+                    source: enyo_source_enum_js_1.EnyoSourceEnum.Device,
+                    applianceId: this.applianceId,
+                    clockId,
+                    timestampIso: timestamp.toISOString(),
+                    resolution,
+                    data: {
+                        batterySoC: batteryData.soc || batteryData.chaState || 0,
+                        batteryPowerW: batteryPowerW,
+                        state: this.mapToEnyoBatteryState(batteryData.chaSt)
+                    }
+                };
+                messages.push(batteryMessage);
+                console.log(`Battery update - SoC: ${batteryData.soc?.toFixed(1)}%, ` +
+                    `Power: ${batteryPowerW.toFixed(0)}W, ` +
+                    `State: ${batteryData.chaStName || 'Unknown'}`);
+            }
+            else {
+                console.warn('No battery data available from device');
+                // Send a message with unknown/zero values
+                const batteryMessage = {
+                    id: (0, node_crypto_1.randomUUID)(),
+                    message: enyo_data_bus_value_js_1.EnyoDataBusMessageEnum.BatteryValuesUpdateV1,
+                    type: 'message',
+                    source: enyo_source_enum_js_1.EnyoSourceEnum.Device,
+                    applianceId: this.applianceId,
+                    clockId,
+                    timestampIso: timestamp.toISOString(),
+                    resolution,
+                    data: {
+                        batterySoC: 0,
+                        batteryPowerW: 0,
+                        state: undefined
+                    }
+                };
+                messages.push(batteryMessage);
+            }
             this.lastUpdateTime = timestamp.getTime();
         }
         catch (error) {
@@ -327,8 +404,8 @@ class SunspecMeter extends BaseSunspecDevice {
                     resolution,
                     data: {
                         gridPowerW: meterData.totalPower || 0,
-                        gridFeedInWh: Number(meterData.exportedEnergy || 0),
-                        gridConsumptionWh: Number(meterData.importedEnergy || 0),
+                        gridFeedInWh: meterData.exportedEnergy || 0,
+                        gridConsumptionWh: meterData.importedEnergy || 0,
                         selfConsumptionW: undefined,
                         selfConsumptionWh: undefined
                     }

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

@@ -53,6 +53,7 @@ export declare class SunspecInverter extends BaseSunspecDevice {
      * Map MPPT data to DC string structure for data bus
      */
     private mapMPPTToStrings;
+    private mapMPPTOperatingState;
 }
 /**
  * Sunspec Battery implementation
@@ -63,6 +64,10 @@ export declare class SunspecBattery extends BaseSunspecDevice {
      */
     connect(): Promise<void>;
     disconnect(): Promise<void>;
+    /**
+     * Map SunSpec battery charge state to Enyo battery state
+     */
+    private mapToEnyoBatteryState;
     /**
      * Update battery data and return data bus messages
      */

package/dist/cjs/sunspec-interfaces.cjs

@@ -3,7 +3,7 @@
  * SunSpec block interfaces with block numbers
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SunspecVArPctMode = exports.SunspecEnableControl = exports.SunspecConnectionControl = exports.SunspecModelId = void 0;
+exports.SunspecVArPctMode = exports.SunspecEnableControl = exports.SunspecConnectionControl = exports.SunspecStorageControlMode = exports.SunspecBatteryChargeState = exports.SunspecMPPTOperatingState = exports.SunspecModelId = void 0;
 /**
  * Common Sunspec Model IDs
  */
@@ -25,6 +25,44 @@ var SunspecModelId;
     SunspecModelId[SunspecModelId["Controls"] = 123] = "Controls";
     SunspecModelId[SunspecModelId["EndMarker"] = 65535] = "EndMarker";
 })(SunspecModelId || (exports.SunspecModelId = SunspecModelId = {}));
+/**
+ * MPPT Operating State values for Model 160
+ * These represent the DC module/string operating states
+ */
+var SunspecMPPTOperatingState;
+(function (SunspecMPPTOperatingState) {
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["OFF"] = 1] = "OFF";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["SLEEPING"] = 2] = "SLEEPING";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["STARTING"] = 3] = "STARTING";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["MPPT"] = 4] = "MPPT";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["THROTTLED"] = 5] = "THROTTLED";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["SHUTTING_DOWN"] = 6] = "SHUTTING_DOWN";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["FAULT"] = 7] = "FAULT";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["STANDBY"] = 8] = "STANDBY";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["TEST"] = 9] = "TEST";
+    SunspecMPPTOperatingState[SunspecMPPTOperatingState["RESERVED_10"] = 10] = "RESERVED_10";
+})(SunspecMPPTOperatingState || (exports.SunspecMPPTOperatingState = SunspecMPPTOperatingState = {}));
+/**
+ * Battery Charge State values for Model 124
+ */
+var SunspecBatteryChargeState;
+(function (SunspecBatteryChargeState) {
+    SunspecBatteryChargeState[SunspecBatteryChargeState["OFF"] = 1] = "OFF";
+    SunspecBatteryChargeState[SunspecBatteryChargeState["EMPTY"] = 2] = "EMPTY";
+    SunspecBatteryChargeState[SunspecBatteryChargeState["DISCHARGING"] = 3] = "DISCHARGING";
+    SunspecBatteryChargeState[SunspecBatteryChargeState["CHARGING"] = 4] = "CHARGING";
+    SunspecBatteryChargeState[SunspecBatteryChargeState["FULL"] = 5] = "FULL";
+    SunspecBatteryChargeState[SunspecBatteryChargeState["HOLDING"] = 6] = "HOLDING";
+    SunspecBatteryChargeState[SunspecBatteryChargeState["TESTING"] = 7] = "TESTING";
+})(SunspecBatteryChargeState || (exports.SunspecBatteryChargeState = SunspecBatteryChargeState = {}));
+/**
+ * Storage Control Mode bitfield values for Model 124
+ */
+var SunspecStorageControlMode;
+(function (SunspecStorageControlMode) {
+    SunspecStorageControlMode[SunspecStorageControlMode["CHARGE"] = 1] = "CHARGE";
+    SunspecStorageControlMode[SunspecStorageControlMode["DISCHARGE"] = 2] = "DISCHARGE"; // Bit 1 - Enable discharge mode
+})(SunspecStorageControlMode || (exports.SunspecStorageControlMode = SunspecStorageControlMode = {}));
 /**
  * Enum values for connection control
  */

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

@@ -98,6 +98,29 @@ export interface SunspecInverterData extends SunspecBlock {
 }
 /**
  * MPPT data structure based on Model 160
+ *
+ * SunSpec Model 160 - Multiple MPPT Inverter Extension Model
+ *
+ * Register Map (offsets relative to module start):
+ * - 0: ID - Module/String ID (uint16)
+ * - 1-8: N - Module/String Identifier (string, 16 chars)
+ * - 9: DCA - DC Current in Amps (uint16)
+ * - 10: DCA_SF - DC Current Scale Factor (sunssf/int16)
+ * - 11: DCV - DC Voltage in Volts (uint16)
+ * - 12: DCV_SF - DC Voltage Scale Factor (sunssf/int16)
+ * - 13: DCW - DC Power in Watts (uint16)
+ * - 14: DCW_SF - DC Power Scale Factor (sunssf/int16)
+ * - 15-16: DCWH - DC Energy in Watt-hours (acc32/uint32)
+ * - 17: DCWH_SF - DC Energy Scale Factor (sunssf/int16)
+ * - 18-19: Tms - Timestamp in seconds since epoch (uint32)
+ * - 20: Tmp - Module Temperature in Celsius (int16)
+ * - 21: Tmp_SF - Temperature Scale Factor (sunssf/int16)
+ * - 22: St - Operating State (enum16)
+ * - 23: StVnd - Vendor Operating State (enum16)
+ * - 24-25: Evt - Event Flags (bitfield32)
+ *
+ * Note: This is a repeating block model where each MPPT string/module
+ * occupies 26 registers (0-25). Multiple modules are stored sequentially.
  */
 export interface SunspecMPPTData extends SunspecBlock {
     blockNumber: 160;
@@ -115,14 +138,91 @@ export interface SunspecMPPTData extends SunspecBlock {
     temperature?: number;
     temperatureSF?: number;
     operatingState?: number;
-    vendorState?: number;
     events?: number;
 }
 /**
- * Battery data structure
+ * MPPT Operating State values for Model 160
+ * These represent the DC module/string operating states
+ */
+export declare enum SunspecMPPTOperatingState {
+    OFF = 1,
+    SLEEPING = 2,
+    STARTING = 3,
+    MPPT = 4,// Maximum Power Point Tracking active
+    THROTTLED = 5,// Power output is being limited
+    SHUTTING_DOWN = 6,
+    FAULT = 7,
+    STANDBY = 8,
+    TEST = 9,
+    RESERVED_10 = 10
+}
+/**
+ * Battery Charge State values for Model 124
+ */
+export declare enum SunspecBatteryChargeState {
+    OFF = 1,
+    EMPTY = 2,
+    DISCHARGING = 3,
+    CHARGING = 4,
+    FULL = 5,
+    HOLDING = 6,
+    TESTING = 7
+}
+/**
+ * Storage Control Mode bitfield values for Model 124
+ */
+export declare enum SunspecStorageControlMode {
+    CHARGE = 1,// Bit 0 - Enable charge mode
+    DISCHARGE = 2
+}
+/**
+ * Battery data structure based on Model 124 (Basic Storage Controls)
+ *
+ * SunSpec Model 124 Register Map:
+ * - 0-1: ID and Length
+ * - 2: WChaMax - Maximum charge setpoint (W)
+ * - 3: WChaGra - Maximum charging rate (% WChaMax/sec)
+ * - 4: WDisChaGra - Maximum discharge rate (% WChaMax/sec)
+ * - 5: StorCtl_Mod - Storage control mode bitfield
+ * - 6: VAChaMax - Maximum charging VA
+ * - 7: MinRsvPct - Minimum reserve percentage
+ * - 8: ChaState - State of charge (%)
+ * - 9: StorAval - Available storage (AH)
+ * - 10: InBatV - Internal battery voltage (V)
+ * - 11: ChaSt - Charge status enum
+ * - 12: OutWRte - Discharge rate (% WDisChaMax)
+ * - 13: InWRte - Charge rate (% WChaMax)
+ * - 14-16: Timing parameters
+ * - 17: ChaGriSet - Charge source setting
+ * - 18-25: Scale factors
  */
 export interface SunspecBatteryData extends SunspecBlock {
     blockNumber: 124 | 802 | 803;
+    wChaMax?: number;
+    wChaMaxSF?: number;
+    wChaGra?: number;
+    wDisChaGra?: number;
+    wChaDisChaGraSF?: number;
+    storCtlMod?: number;
+    vaChaMax?: number;
+    vaChaMaxSF?: number;
+    minRsvPct?: number;
+    minRsvPctSF?: number;
+    chaState?: number;
+    chaStateSF?: number;
+    storAval?: number;
+    storAvalSF?: number;
+    inBatV?: number;
+    inBatVSF?: number;
+    chaSt?: number;
+    chaStName?: string;
+    outWRte?: number;
+    inWRte?: number;
+    inOutWRteSF?: number;
+    inOutWRteWinTms?: number;
+    inOutWRteRvrtTms?: number;
+    inOutWRteRmpTms?: number;
+    chaGriSet?: number;
     soc?: number;
     soh?: number;
     chargePower?: number;