@enyo-energy/sunspec-sdk 0.0.32 → 0.0.34

package/dist/sunspec-modbus-client.js

@@ -16,8 +16,7 @@
  * - pad: 0x8000 (always returns this value)
  * - string: all registers 0x0000 (NULL)
  */
-import { SunspecModelId, SunspecBatteryChargeState, SunspecStorageControlMode, SunspecChargeSource, SunspecStorageMode, SunspecBatteryType, SunspecBatteryBankState } from "./sunspec-interfaces.js";
-import { ConnectionRetryManager } from "./connection-retry-manager.js";
+import { SunspecModelId, SunspecBatteryChargeState, SunspecStorageControlMode, SunspecChargeSource, SunspecEnableControl, SunspecStorageMode, SunspecBatteryType, SunspecBatteryBankState, } from "./sunspec-interfaces.js";
 import { EnergyAppModbusConnectionHealth } from "@enyo-energy/energy-app-sdk/dist/implementations/modbus/EnergyAppModbusConnectionHealth.js";
 import { EnergyAppModbusFaultTolerantReader } from "@enyo-energy/energy-app-sdk/dist/implementations/modbus/EnergyAppModbusFaultTolerantReader.js";
 import { EnergyAppModbusDataTypeConverter } from "@enyo-energy/energy-app-sdk/dist/implementations/modbus/EnergyAppModbusDataTypeConverter.js";
@@ -30,13 +29,11 @@ export class SunspecModbusClient {
     faultTolerantReader = null;
     modbusDataTypeConverter;
     connectionParams = null;
-    retryManager;
     autoReconnectEnabled = true;
-    constructor(energyApp, retryConfig) {
+    constructor(energyApp) {
         this.energyApp = energyApp;
         this.connectionHealth = new EnergyAppModbusConnectionHealth();
         this.modbusDataTypeConverter = new EnergyAppModbusDataTypeConverter();
-        this.retryManager = new ConnectionRetryManager(retryConfig);
     }
     /**
      * Connect to Modbus device
@@ -63,15 +60,12 @@ export class SunspecModbusClient {
         }
         this.connected = true;
         this.connectionHealth.recordSuccess();
-        this.retryManager.reset();
         console.log(`Connected to Sunspec device at ${host}:${port} unit ${unitId}`);
     }
     /**
      * Disconnect from Modbus device
      */
     async disconnect() {
-        // Cancel any pending retry attempts
-        this.retryManager.cancelPendingRetry();
         if (this.modbusClient && this.connected) {
             await this.modbusClient.disconnect();
             this.modbusClient = null;
@@ -150,61 +144,12 @@ export class SunspecModbusClient {
             return false;
         }
     }
-    /**
-     * Check connection health and trigger automatic reconnection if unhealthy
-     * Returns true if connection is healthy or was successfully restored
-     */
-    async ensureHealthyConnection() {
-        // If already healthy, return immediately
-        if (this.isHealthy()) {
-            return true;
-        }
-        // If no connection params, we can't reconnect
-        if (!this.connectionParams) {
-            console.error('Connection unhealthy and no connection parameters stored for reconnection.');
-            return false;
-        }
-        // If auto-reconnect is disabled, just report the status
-        if (!this.autoReconnectEnabled) {
-            console.log('Connection unhealthy but auto-reconnect is disabled.');
-            return false;
-        }
-        // If a retry is already in progress, don't start another
-        if (this.retryManager.isRetryInProgress()) {
-            console.log('Retry already in progress...');
-            return false;
-        }
-        console.log('Connection unhealthy, initiating reconnection with exponential backoff...');
-        // Attempt reconnection with exponential backoff
-        let success = false;
-        while (this.retryManager.shouldRetry() && !success) {
-            success = await this.retryManager.scheduleRetry(() => this.reconnect());
-            if (success) {
-                // Re-discover models after successful reconnection
-                try {
-                    await this.discoverModels();
-                    console.log('Models re-discovered after reconnection.');
-                }
-                catch (e) {
-                    console.warn('Failed to re-discover models after reconnection:', e);
-                }
-                return true;
-            }
-        }
-        if (!success) {
-            console.error('Failed to restore healthy connection after all retry attempts.');
-        }
-        return success;
-    }
     /**
      * Enable or disable automatic reconnection
      */
     setAutoReconnect(enabled) {
         this.autoReconnectEnabled = enabled;
         console.log(`Auto-reconnect ${enabled ? 'enabled' : 'disabled'}`);
-        if (!enabled) {
-            this.retryManager.cancelPendingRetry();
-        }
     }
     /**
      * Check if auto-reconnect is enabled
@@ -212,12 +157,6 @@ export class SunspecModbusClient {
     isAutoReconnectEnabled() {
         return this.autoReconnectEnabled;
     }
-    /**
-     * Get the retry manager for advanced configuration
-     */
-    getRetryManager() {
-        return this.retryManager;
-    }
     /**
      * Detect the base address and addressing mode (0-based or 1-based) for SunSpec
      */
@@ -497,7 +436,7 @@ export class SunspecModbusClient {
         }
     }
     /**
-     * Read inverter data from Model 103 (Three Phase)
+     * Read inverter data from Model 101 (Single Phase) / Model 103 (Three Phase)
      */
     async readInverterData() {
         const model = this.findModel(SunspecModelId.Inverter3Phase);
@@ -714,8 +653,7 @@ export class SunspecModbusClient {
         }
     }
     /**
-     * Read MPPT Scale Factors for a specific module
-     * Returns the scale factors for DC Current, DC Voltage, DC Power, and DC Energy
+     * Read scale factors from Model 160 (MPPT)
      *
      * MPPT Model 160 Scale Factor Register Offsets (relative to module start):
      * - DCA_SF (Current Scale Factor): Offset 2
@@ -835,7 +773,7 @@ export class SunspecModbusClient {
         }
     }
     /**
-     * Read all available MPPT strings
+     * Read all MPPT strings from Model 160 (Multiple MPPT)
      */
     async readAllMPPTData() {
         const mpptData = [];
@@ -1149,7 +1087,7 @@ export class SunspecModbusClient {
         }
     }
     /**
-     * Read battery data from Model 124 (Basic Storage Controls)
+     * Read battery data from Model 124 (Basic Storage) with fallback to Model 802 / Model 803
      */
     async readBatteryData() {
         // Try Model 124 first (Basic Storage Controls)
@@ -1417,7 +1355,7 @@ export class SunspecModbusClient {
         return this.writeBatteryControls({ chaGriSet });
     }
     /**
-     * Read current battery control settings
+     * Read battery control settings from Model 124 (Basic Storage Controls)
      */
     async readBatteryControls() {
         const model = this.findModel(SunspecModelId.Battery);
@@ -1462,7 +1400,7 @@ export class SunspecModbusClient {
         }
     }
     /**
-     * Read meter data (Model 203 for 3-phase)
+     * Read meter data from Model 201 (Single Phase) / Model 203 (Three Phase) / Model 204 (Split Phase)
      */
     async readMeterData() {
         let model = this.findModel(SunspecModelId.Meter3Phase);
@@ -1624,7 +1562,7 @@ export class SunspecModbusClient {
         return this.connectionHealth;
     }
     /**
-     * Read Block 121 - Inverter Basic Settings
+     * Read inverter settings from Model 121 (Inverter Settings)
      */
     async readInverterSettings() {
         const model = this.findModel(SunspecModelId.Settings);
@@ -1713,7 +1651,7 @@ export class SunspecModbusClient {
         }
     }
     /**
-     * Read Block 123 - Immediate Inverter Controls
+     * Read inverter controls from Model 123 (Immediate Inverter Controls)
      */
     async readInverterControls() {
         const model = this.findModel(SunspecModelId.Controls);
@@ -1843,7 +1781,7 @@ export class SunspecModbusClient {
         }
     }
     /**
-     * Write Block 123 - Immediate Inverter Controls
+     * Write inverter controls to Model 123 (Immediate Inverter Controls)
      */
     async writeInverterControls(controls) {
         const model = this.findModel(SunspecModelId.Controls);
@@ -1853,32 +1791,35 @@ export class SunspecModbusClient {
         }
         const baseAddr = model.address;
         try {
-            // Connection control
-            if (controls.Conn !== undefined && this.modbusClient) {
-                // Writing registers needs to be implemented in EnergyAppModbusInstance
-                console.log(`Would write connection control ${controls.Conn} to register ${baseAddr + 2}`);
+            // Connection control (Register 2)
+            if (controls.Conn !== undefined) {
+                await this.writeRegisterValue(baseAddr + 2, controls.Conn, 'uint16');
+                console.log(`Set connection control to ${controls.Conn}`);
             }
-            // Power limit control
-            if (controls.WMaxLimPct !== undefined && this.modbusClient) {
-                const sfBuffer = await this.modbusClient.readHoldingRegisters(baseAddr + 21, 1);
-                const scaleFactor = sfBuffer.readInt16BE(0);
+            // Power limit control (Register 3) - needs scale factor
+            if (controls.WMaxLimPct !== undefined) {
+                const scaleFactor = await this.readRegisterValue(baseAddr + 21, 1, 'int16');
                 const scaledValue = Math.round(controls.WMaxLimPct / Math.pow(10, scaleFactor));
-                console.log(`Would write power limit ${scaledValue} to register ${baseAddr + 3}`);
+                await this.writeRegisterValue(baseAddr + 3, scaledValue, 'uint16');
+                console.log(`Set power limit to ${controls.WMaxLimPct}% (scaled: ${scaledValue})`);
             }
-            if (controls.WMaxLim_Ena !== undefined && this.modbusClient) {
-                console.log(`Would write throttle enable ${controls.WMaxLim_Ena} to register ${baseAddr + 7}`);
+            // Throttle enable/disable (Register 7)
+            if (controls.WMaxLim_Ena !== undefined) {
+                await this.writeRegisterValue(baseAddr + 7, controls.WMaxLim_Ena, 'uint16');
+                console.log(`Set throttle enable to ${controls.WMaxLim_Ena}`);
             }
-            // Power factor control
-            if (controls.OutPFSet !== undefined && this.modbusClient) {
-                const sfBuffer = await this.modbusClient.readHoldingRegisters(baseAddr + 22, 1);
-                const scaleFactor = sfBuffer.readInt16BE(0);
+            // Power factor control (Register 8) - needs scale factor
+            if (controls.OutPFSet !== undefined) {
+                const scaleFactor = await this.readRegisterValue(baseAddr + 22, 1, 'int16');
                 const scaledValue = Math.round(controls.OutPFSet / Math.pow(10, scaleFactor));
-                console.log(`Would write power factor ${scaledValue} to register ${baseAddr + 8}`);
+                await this.writeRegisterValue(baseAddr + 8, scaledValue, 'int16');
+                console.log(`Set power factor to ${controls.OutPFSet} (scaled: ${scaledValue})`);
             }
-            if (controls.OutPFSet_Ena !== undefined && this.modbusClient) {
-                console.log(`Would write PF enable ${controls.OutPFSet_Ena} to register ${baseAddr + 12}`);
+            // Power factor enable/disable (Register 12)
+            if (controls.OutPFSet_Ena !== undefined) {
+                await this.writeRegisterValue(baseAddr + 12, controls.OutPFSet_Ena, 'uint16');
+                console.log(`Set PF enable to ${controls.OutPFSet_Ena}`);
             }
-            // Add more control writes as needed
             console.log('Inverter controls written successfully');
             return true;
         }
@@ -1887,4 +1828,33 @@ export class SunspecModbusClient {
             return false;
         }
     }
+    /**
+     * Set the inverter feed-in power limit using Model 123 (Immediate Inverter Controls)
+     *
+     * When limitW is a number, reads WMax from Model 121, computes percentage,
+     * writes WMaxLimPct and enables WMaxLim_Ena.
+     * When limitW is null, disables the limit by setting WMaxLim_Ena = DISABLED.
+     *
+     * @param limitW - Power limit in Watts, or null to remove the limit
+     * @returns true if successful, false otherwise
+     */
+    async setFeedInLimit(limitW) {
+        if (limitW === null) {
+            // Remove limit: disable WMaxLim_Ena
+            console.log('Removing feed-in limit (disabling WMaxLim_Ena)');
+            return this.writeInverterControls({ WMaxLim_Ena: SunspecEnableControl.DISABLED });
+        }
+        // Read WMax from Model 121 to compute percentage
+        const settings = await this.readInverterSettings();
+        if (!settings || !settings.WMax) {
+            console.error('Cannot set feed-in limit: unable to read WMax from Model 121');
+            return false;
+        }
+        const pct = (limitW / settings.WMax) * 100;
+        console.log(`Setting feed-in limit to ${limitW}W (${pct.toFixed(2)}% of WMax ${settings.WMax}W)`);
+        return this.writeInverterControls({
+            WMaxLimPct: pct,
+            WMaxLim_Ena: SunspecEnableControl.ENABLED
+        });
+    }
 }

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.32";
+export declare const SDK_VERSION = "0.0.34";
 /**
  * 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.32';
+export const SDK_VERSION = '0.0.34';
 /**
  * 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.32",
+  "version": "0.0.34",
   "description": "enyo Energy Sunspec SDK",
   "type": "module",
   "main": "dist/index.js",
@@ -37,7 +37,7 @@
     "typescript": "^5.8.3"
   },
   "dependencies": {
-    "@enyo-energy/energy-app-sdk": "^0.0.60"
+    "@enyo-energy/energy-app-sdk": "^0.0.68"
   },
   "volta": {
     "node": "22.17.0"