@enyo-energy/sunspec-sdk 0.0.31 → 0.0.33

package/dist/sunspec-interfaces.js

@@ -2,10 +2,12 @@
  * SunSpec block interfaces with block numbers
  */
 export const DEFAULT_RETRY_CONFIG = {
-    initialDelayMs: 1000,
-    maxDelayMs: 30000,
-    backoffFactor: 1.5,
-    maxAttempts: 10
+    phases: [
+        { intervalMs: 10_000, durationMs: 60_000 }, // Phase 1: every 10s for 1 minute
+        { intervalMs: 30_000, durationMs: 120_000 }, // Phase 2: every 30s for 2 minutes
+        { intervalMs: 60_000, durationMs: 300_000 }, // Phase 3: every 1m for 5 minutes
+        { intervalMs: 300_000, durationMs: 0 }, // Phase 4: every 5m forever
+    ]
 };
 /**
  * Common Sunspec Model IDs
@@ -58,6 +60,87 @@ export var SunspecBatteryChargeState;
     SunspecBatteryChargeState[SunspecBatteryChargeState["HOLDING"] = 6] = "HOLDING";
     SunspecBatteryChargeState[SunspecBatteryChargeState["TESTING"] = 7] = "TESTING";
 })(SunspecBatteryChargeState || (SunspecBatteryChargeState = {}));
+/**
+ * Battery Control Mode values for Model 802
+ * Offset 17: LocRemCtl - Local/Remote control mode
+ */
+export var SunspecBatteryControlMode;
+(function (SunspecBatteryControlMode) {
+    SunspecBatteryControlMode[SunspecBatteryControlMode["REMOTE"] = 0] = "REMOTE";
+    SunspecBatteryControlMode[SunspecBatteryControlMode["LOCAL"] = 1] = "LOCAL";
+})(SunspecBatteryControlMode || (SunspecBatteryControlMode = {}));
+/**
+ * Battery Type values for Model 802
+ * Offset 21: Typ - Battery type
+ */
+export var SunspecBatteryType;
+(function (SunspecBatteryType) {
+    SunspecBatteryType[SunspecBatteryType["NOT_APPLICABLE_UNKNOWN"] = 0] = "NOT_APPLICABLE_UNKNOWN";
+    SunspecBatteryType[SunspecBatteryType["LEAD_ACID"] = 1] = "LEAD_ACID";
+    SunspecBatteryType[SunspecBatteryType["NICKEL_METAL_HYDRIDE"] = 2] = "NICKEL_METAL_HYDRIDE";
+    SunspecBatteryType[SunspecBatteryType["NICKEL_CADMIUM"] = 3] = "NICKEL_CADMIUM";
+    SunspecBatteryType[SunspecBatteryType["LITHIUM_ION"] = 4] = "LITHIUM_ION";
+    SunspecBatteryType[SunspecBatteryType["CARBON_ZINC"] = 5] = "CARBON_ZINC";
+    SunspecBatteryType[SunspecBatteryType["ZINC_CHLORIDE"] = 6] = "ZINC_CHLORIDE";
+    SunspecBatteryType[SunspecBatteryType["ALKALINE"] = 7] = "ALKALINE";
+    SunspecBatteryType[SunspecBatteryType["RECHARGEABLE_ALKALINE"] = 8] = "RECHARGEABLE_ALKALINE";
+    SunspecBatteryType[SunspecBatteryType["SODIUM_SULFUR"] = 9] = "SODIUM_SULFUR";
+    SunspecBatteryType[SunspecBatteryType["FLOW"] = 10] = "FLOW";
+    SunspecBatteryType[SunspecBatteryType["SUPER_CAPACITOR"] = 11] = "SUPER_CAPACITOR";
+    SunspecBatteryType[SunspecBatteryType["OTHER"] = 99] = "OTHER";
+})(SunspecBatteryType || (SunspecBatteryType = {}));
+/**
+ * Battery Bank State values for Model 802
+ * Offset 22: State - Battery bank state
+ */
+export var SunspecBatteryBankState;
+(function (SunspecBatteryBankState) {
+    SunspecBatteryBankState[SunspecBatteryBankState["DISCONNECTED"] = 1] = "DISCONNECTED";
+    SunspecBatteryBankState[SunspecBatteryBankState["INITIALIZING"] = 2] = "INITIALIZING";
+    SunspecBatteryBankState[SunspecBatteryBankState["CONNECTED"] = 3] = "CONNECTED";
+    SunspecBatteryBankState[SunspecBatteryBankState["STANDBY"] = 4] = "STANDBY";
+    SunspecBatteryBankState[SunspecBatteryBankState["SOC_PROTECTION"] = 5] = "SOC_PROTECTION";
+    SunspecBatteryBankState[SunspecBatteryBankState["SUSPENDING"] = 6] = "SUSPENDING";
+    SunspecBatteryBankState[SunspecBatteryBankState["FAULT"] = 99] = "FAULT";
+})(SunspecBatteryBankState || (SunspecBatteryBankState = {}));
+/**
+ * Battery Event 1 bit positions for Model 802
+ * Offset 26-27: Evt1 - Battery event bitfield
+ */
+export var SunspecBatteryEvent1;
+(function (SunspecBatteryEvent1) {
+    SunspecBatteryEvent1[SunspecBatteryEvent1["COMMUNICATION_ERROR"] = 0] = "COMMUNICATION_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_TEMP_ALARM"] = 1] = "OVER_TEMP_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_TEMP_WARNING"] = 2] = "OVER_TEMP_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_TEMP_ALARM"] = 3] = "UNDER_TEMP_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_TEMP_WARNING"] = 4] = "UNDER_TEMP_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_CHARGE_CURRENT_ALARM"] = 5] = "OVER_CHARGE_CURRENT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_CHARGE_CURRENT_WARNING"] = 6] = "OVER_CHARGE_CURRENT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_DISCHARGE_CURRENT_ALARM"] = 7] = "OVER_DISCHARGE_CURRENT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_DISCHARGE_CURRENT_WARNING"] = 8] = "OVER_DISCHARGE_CURRENT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_VOLT_ALARM"] = 9] = "OVER_VOLT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_VOLT_WARNING"] = 10] = "OVER_VOLT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_VOLT_ALARM"] = 11] = "UNDER_VOLT_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_VOLT_WARNING"] = 12] = "UNDER_VOLT_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_SOC_MIN_ALARM"] = 13] = "UNDER_SOC_MIN_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["UNDER_SOC_MIN_WARNING"] = 14] = "UNDER_SOC_MIN_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_SOC_MAX_ALARM"] = 15] = "OVER_SOC_MAX_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OVER_SOC_MAX_WARNING"] = 16] = "OVER_SOC_MAX_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["VOLTAGE_IMBALANCE_WARNING"] = 17] = "VOLTAGE_IMBALANCE_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["TEMPERATURE_IMBALANCE_ALARM"] = 18] = "TEMPERATURE_IMBALANCE_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["TEMPERATURE_IMBALANCE_WARNING"] = 19] = "TEMPERATURE_IMBALANCE_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CONTACTOR_ERROR"] = 20] = "CONTACTOR_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["FAN_ERROR"] = 21] = "FAN_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["FUSE_ERROR"] = 22] = "FUSE_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["GROUND_FAULT"] = 23] = "GROUND_FAULT";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OPEN_DOOR_ERROR"] = 24] = "OPEN_DOOR_ERROR";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CURRENT_IMBALANCE_WARNING"] = 25] = "CURRENT_IMBALANCE_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OTHER_ALARM"] = 26] = "OTHER_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["OTHER_WARNING"] = 27] = "OTHER_WARNING";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["RESERVED_1"] = 28] = "RESERVED_1";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CONFIGURATION_ALARM"] = 29] = "CONFIGURATION_ALARM";
+    SunspecBatteryEvent1[SunspecBatteryEvent1["CONFIGURATION_WARNING"] = 30] = "CONFIGURATION_WARNING";
+})(SunspecBatteryEvent1 || (SunspecBatteryEvent1 = {}));
 /**
  * Storage Control Mode bitfield values for Model 124
  *
@@ -116,3 +199,24 @@ export var SunspecStorageMode;
     SunspecStorageMode["HOLDING"] = "holding";
     SunspecStorageMode["AUTO"] = "auto"; // Both charge and discharge allowed
 })(SunspecStorageMode || (SunspecStorageMode = {}));
+/**
+ * Battery control structure for writing to Model 124
+ * Used for controlling battery charge/discharge behavior
+ *
+ * IMPORTANT: To enable grid charging with specific power:
+ * 1. Set storCtlMod with appropriate bits to enable external control
+ * 2. Set chaGriSet = 1 to allow grid charging
+ * 3. Set wChaMax to the desired charging power in Watts
+ */
+export var SunspecInverterCapability;
+(function (SunspecInverterCapability) {
+    SunspecInverterCapability["FeedInLimit"] = "feed-in-limit";
+})(SunspecInverterCapability || (SunspecInverterCapability = {}));
+export var SunspecBatteryCapability;
+(function (SunspecBatteryCapability) {
+    SunspecBatteryCapability["GridCharging"] = "grid-charging";
+    SunspecBatteryCapability["DischargeLimit"] = "discharge-limit";
+})(SunspecBatteryCapability || (SunspecBatteryCapability = {}));
+export var SunspecMeterCapability;
+(function (SunspecMeterCapability) {
+})(SunspecMeterCapability || (SunspecMeterCapability = {}));

package/dist/sunspec-modbus-client.d.ts

@@ -16,9 +16,8 @@
  * - pad: 0x8000 (always returns this value)
  * - string: all registers 0x0000 (NULL)
  */
-import { type SunspecInverterControls, type SunspecInverterData, type SunspecInverterSettings, type SunspecMeterData, type SunspecModel, type SunspecMPPTData, type SunspecBatteryData, type SunspecBatteryControls, SunspecStorageMode, type IRetryConfig } from "./sunspec-interfaces.js";
-import { ConnectionRetryManager } from "./connection-retry-manager.js";
-import { IConnectionHealth } from "@enyo-energy/energy-app-sdk/dist/implementations/modbus/interfaces.js";
+import { type SunspecInverterControls, type SunspecInverterData, type SunspecInverterSettings, type SunspecMeterData, type SunspecModel, type SunspecMPPTData, type SunspecBatteryData, type SunspecBatteryBaseData, type SunspecBatteryControls, SunspecStorageMode } from "./sunspec-interfaces.js";
+import { EnergyAppModbusDataType, IConnectionHealth } from "@enyo-energy/energy-app-sdk/dist/implementations/modbus/interfaces.js";
 import { EnergyApp } from "@enyo-energy/energy-app-sdk";
 export declare class SunspecModbusClient {
     private energyApp;
@@ -29,9 +28,8 @@ export declare class SunspecModbusClient {
     private faultTolerantReader;
     private modbusDataTypeConverter;
     private connectionParams;
-    private retryManager;
     private autoReconnectEnabled;
-    constructor(energyApp: EnergyApp, retryConfig?: Partial<IRetryConfig>);
+    constructor(energyApp: EnergyApp);
     /**
      * Connect to Modbus device
      * @param host Primary host (hostname) to connect to
@@ -55,11 +53,6 @@ export declare class SunspecModbusClient {
      * Returns true if successful, false otherwise
      */
     private attemptConnection;
-    /**
-     * Check connection health and trigger automatic reconnection if unhealthy
-     * Returns true if connection is healthy or was successfully restored
-     */
-    ensureHealthyConnection(): Promise<boolean>;
     /**
      * Enable or disable automatic reconnection
      */
@@ -68,10 +61,6 @@ export declare class SunspecModbusClient {
      * Check if auto-reconnect is enabled
      */
     isAutoReconnectEnabled(): boolean;
-    /**
-     * Get the retry manager for advanced configuration
-     */
-    getRetryManager(): ConnectionRetryManager;
     /**
      * Detect the base address and addressing mode (0-based or 1-based) for SunSpec
      */
@@ -119,13 +108,13 @@ export declare class SunspecModbusClient {
     /**
      * Helper to read register value(s) using the fault-tolerant reader with data type conversion
      */
-    private readRegisterValue;
+    readRegisterValue(address: number, quantity: number | undefined, dataType: EnergyAppModbusDataType): Promise<number | string | number[]>;
     /**
      * Helper to write register value(s)
      */
-    private writeRegisterValue;
+    writeRegisterValue(address: number, value: number | number[], dataType?: EnergyAppModbusDataType): Promise<boolean>;
     /**
-     * Read inverter data from Model 103 (Three Phase)
+     * Read inverter data from Model 101 (Single Phase) / Model 103 (Three Phase)
      */
     readInverterData(): Promise<SunspecInverterData | null>;
     /**
@@ -140,10 +129,10 @@ export declare class SunspecModbusClient {
      * Apply scale factor to a value
      * Returns undefined if the value is unimplemented or scale factor is out of range
      */
-    private applyScaleFactor;
+    applyScaleFactor(value: number, scaleFactor: number, dataType?: 'uint16' | 'int16' | 'acc32', fieldName?: string, offset?: number, modelId?: number): number | undefined;
+    logRegisterRead(modelId: number, offset: number, fieldName: string, rawValue: number | string | undefined, dataType?: string): void;
     /**
-     * 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
@@ -164,7 +153,7 @@ export declare class SunspecModbusClient {
      */
     readMPPTData(moduleId?: number): Promise<SunspecMPPTData | null>;
     /**
-     * Read all available MPPT strings
+     * Read all MPPT strings from Model 160 (Multiple MPPT)
      */
     readAllMPPTData(): Promise<SunspecMPPTData[]>;
     /**
@@ -174,7 +163,23 @@ export declare class SunspecModbusClient {
      */
     private mapBatteryChargeState;
     /**
-     * Read battery data from Model 124 (Basic Storage Controls)
+     * Map battery type to human-readable name (Model 802)
+     */
+    private mapBatteryType;
+    /**
+     * Map battery bank state to human-readable name (Model 802)
+     */
+    private mapBatteryBankState;
+    /**
+     * Read Model 802 scale factors (offsets 52-63)
+     */
+    private readBatteryBaseScaleFactors;
+    /**
+     * Read battery base data from Model 802 (Battery Base)
+     */
+    readBatteryBaseData(): Promise<SunspecBatteryBaseData | null>;
+    /**
+     * Read battery data from Model 124 (Basic Storage) with fallback to Model 802 / Model 803
      */
     readBatteryData(): Promise<SunspecBatteryData | null>;
     /**
@@ -190,11 +195,11 @@ export declare class SunspecModbusClient {
      */
     enableGridCharging(enable: boolean): Promise<boolean>;
     /**
-     * Read current battery control settings
+     * Read battery control settings from Model 124 (Basic Storage Controls)
      */
     readBatteryControls(): Promise<SunspecBatteryControls | null>;
     /**
-     * Read meter data (Model 203 for 3-phase)
+     * Read meter data from Model 201 (Single Phase) / Model 203 (Three Phase) / Model 204 (Split Phase)
      */
     readMeterData(): Promise<SunspecMeterData | null>;
     /**
@@ -218,11 +223,11 @@ export declare class SunspecModbusClient {
      */
     getConnectionHealth(): IConnectionHealth;
     /**
-     * Read Block 121 - Inverter Basic Settings
+     * Read inverter settings from Model 121 (Inverter Settings)
      */
     readInverterSettings(): Promise<SunspecInverterSettings | null>;
     /**
-     * Read Block 123 - Immediate Inverter Controls
+     * Read inverter controls from Model 123 (Immediate Inverter Controls)
      */
     readInverterControls(): Promise<SunspecInverterControls | null>;
     /**
@@ -230,7 +235,18 @@ export declare class SunspecModbusClient {
      */
     writeInverterSettings(settings: Partial<SunspecInverterSettings>): Promise<boolean>;
     /**
-     * Write Block 123 - Immediate Inverter Controls
+     * Write inverter controls to Model 123 (Immediate Inverter Controls)
      */
     writeInverterControls(controls: Partial<SunspecInverterControls>): Promise<boolean>;
+    /**
+     * 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
+     */
+    setFeedInLimit(limitW: number | null): Promise<boolean>;
 }