@enyo-energy/energy-app-sdk 0.0.37 → 0.0.39

package/dist/cjs/implementations/modbus/interfaces.d.cts

@@ -1,8 +1,4 @@
-import type { EnergyApp } from "../../index.cjs";
-import type { EnyoNetworkDevice } from "../../types/enyo-network-device.cjs";
-import type { EnyoAppliance, EnyoApplianceName, EnyoApplianceTopology } from "../../types/enyo-appliance.cjs";
-import { EnyoBatteryStateEnum, EnyoDataBusMessage, EnyoInverterStateEnum } from "../../types/enyo-data-bus-value.cjs";
-import { EnergyAppModbusInstance } from "../../packages/energy-app-modbus.cjs";
+import type { EnyoApplianceName, EnyoApplianceTopology } from "../../types/enyo-appliance.cjs";
 /**
  * Data Types for Modbus Register Configuration
  *
@@ -11,20 +7,16 @@ import { EnergyAppModbusInstance } from "../../packages/energy-app-modbus.cjs";
  * - String type: string (requires length property in register config)
  */
 export type EnergyAppModbusDataType = 'uint16' | 'int16' | 'uint32' | 'int32' | 'float32' | 'string';
-export interface EnergyAppBatteryStateValueMapping {
+export interface EnergyAppModbusStateValueMapping<T> {
     value: number;
-    mappedState: EnyoBatteryStateEnum;
-}
-export interface EnergyAppInverterStateValueMapping {
-    value: number;
-    mappedState: EnyoInverterStateEnum;
+    mappedState: T;
 }
 /**
  * Register Configuration Interface
  *
  * @description Configuration for reading a Modbus register
  */
-export interface EnergyAppModbusRegisterConfig {
+export interface EnergyAppModbusRegisterConfig<T> {
     /** Modbus register address */
     address: number;
     /** Data type of the register value */
@@ -36,10 +28,10 @@ export interface EnergyAppModbusRegisterConfig {
     /** Whether this register is required for device operation */
     required?: boolean;
     /** For mapping numeric values to enum states (only applies to numeric types) */
-    valueMapping?: EnergyAppBatteryStateValueMapping[] | EnergyAppInverterStateValueMapping[];
+    valueMapping?: EnergyAppModbusStateValueMapping<T>[];
 }
 export interface EnergyAppRegisterMap {
-    [key: string]: EnergyAppModbusRegisterConfig | undefined;
+    [key: string]: EnergyAppModbusRegisterConfig<any> | undefined;
 }
 export interface EnergyAppModbusConnectionOptions {
     unitId?: number;
@@ -55,54 +47,6 @@ export interface EnergyAppModbusDeviceConfig {
         topology?: EnyoApplianceTopology;
     };
 }
-export interface EnergyAppModbusInverterConfig extends EnergyAppModbusDeviceConfig {
-    registers: {
-        serialNumber?: EnergyAppModbusRegisterConfig;
-        power?: EnergyAppModbusRegisterConfig;
-        voltageL1?: EnergyAppModbusRegisterConfig;
-        voltageL2?: EnergyAppModbusRegisterConfig;
-        voltageL3?: EnergyAppModbusRegisterConfig;
-        maxPvProductionW?: EnergyAppModbusRegisterConfig;
-        state?: EnergyAppModbusRegisterConfig;
-        activePowerLimitationW?: EnergyAppModbusRegisterConfig;
-        string1Power?: EnergyAppModbusRegisterConfig;
-        string1Voltage?: EnergyAppModbusRegisterConfig;
-        string2Power?: EnergyAppModbusRegisterConfig;
-        string2Voltage?: EnergyAppModbusRegisterConfig;
-        string3Power?: EnergyAppModbusRegisterConfig;
-        string3Voltage?: EnergyAppModbusRegisterConfig;
-        string4Power?: EnergyAppModbusRegisterConfig;
-        string4Voltage?: EnergyAppModbusRegisterConfig;
-        [key: string]: EnergyAppModbusRegisterConfig | undefined;
-    };
-}
-export interface EnergyAppModbusBatteryConfig extends EnergyAppModbusDeviceConfig {
-    inverter?: IEnergyAppModbusInverter;
-    registers: {
-        current?: EnergyAppModbusRegisterConfig;
-        voltage?: EnergyAppModbusRegisterConfig;
-        soc?: EnergyAppModbusRegisterConfig;
-        power?: EnergyAppModbusRegisterConfig;
-        temperature?: EnergyAppModbusRegisterConfig;
-        state?: EnergyAppModbusRegisterConfig;
-        maxCapacityWh?: EnergyAppModbusRegisterConfig;
-        maxDischargePowerW?: EnergyAppModbusRegisterConfig;
-        maxChargingPowerW?: EnergyAppModbusRegisterConfig;
-        drainPercentage?: EnergyAppModbusRegisterConfig;
-        loadPercentage?: EnergyAppModbusRegisterConfig;
-        [key: string]: EnergyAppModbusRegisterConfig | undefined;
-    };
-}
-export interface EnergyAppModbusMeterConfig extends EnergyAppModbusDeviceConfig {
-    registers: {
-        gridPower?: EnergyAppModbusRegisterConfig;
-        gridFeedInPower?: EnergyAppModbusRegisterConfig;
-        gridConsumptionPower?: EnergyAppModbusRegisterConfig;
-        gridFeedInEnergy?: EnergyAppModbusRegisterConfig;
-        gridConsumptionEnergy?: EnergyAppModbusRegisterConfig;
-        [key: string]: EnergyAppModbusRegisterConfig | undefined;
-    };
-}
 export interface RegisterReadResult<T = any> {
     success: boolean;
     value?: T;
@@ -114,7 +58,7 @@ export interface IRegisterReader {
     isHealthy(): boolean;
 }
 export interface IRegisterMapper {
-    readRegister<T>(reader: IRegisterReader, config: EnergyAppModbusRegisterConfig): Promise<RegisterReadResult<T>>;
+    readRegister<T, E>(reader: IRegisterReader, config: EnergyAppModbusRegisterConfig<E>): Promise<RegisterReadResult<T>>;
     readMultipleRegisters(reader: IRegisterReader, registerMap: EnergyAppRegisterMap): Promise<{
         [key: string]: any;
     }>;
@@ -159,36 +103,6 @@ export interface IConnectionHealth {
     getConsecutiveFailures(): number;
     getLastError(): Error | undefined;
 }
-export interface EnergyAppModbusDevice {
-    readonly client: EnergyApp;
-    readonly config: EnergyAppModbusDeviceConfig;
-    readonly appliance: EnyoAppliance;
-    readonly networkDevice: EnyoNetworkDevice;
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    isConnected(): boolean;
-    updateData(): Promise<EnyoDataBusMessage[]>;
-    modbusClient(): EnergyAppModbusInstance | undefined;
-}
-export interface IEnergyAppModbusInverter extends EnergyAppModbusDevice {
-    readonly config: EnergyAppModbusInverterConfig;
-    getSerialNumber(): Promise<string | null>;
-    getCurrentPower(): Promise<number | null>;
-    getTotalEnergy(): Promise<number | null>;
-}
-export interface IEnergyAppModbusBattery extends EnergyAppModbusDevice {
-    readonly config: EnergyAppModbusBatteryConfig;
-    readonly inverter?: IEnergyAppModbusInverter;
-    getSoc(): Promise<number | null>;
-    getCurrent(): Promise<number | null>;
-    getPower(): Promise<number | null>;
-}
-export interface IEnergyAppModbusMeter extends EnergyAppModbusDevice {
-    readonly config: EnergyAppModbusMeterConfig;
-    getGridPower(): Promise<number | null>;
-    getGridFeedInEnergy(): Promise<number | null>;
-    getGridConsumptionEnergy(): Promise<number | null>;
-}
 export declare class EnergyAppModbusConfigurationError extends Error {
     constructor(message: string);
 }

package/dist/cjs/implementations/modbus/sunspec/sunspec-devices.cjs

@@ -0,0 +1,342 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SunspecMeter = exports.SunspecBattery = exports.SunspecInverter = exports.BaseSunspecDevice = void 0;
+const enyo_appliance_js_1 = require("../../../types/enyo-appliance.cjs");
+const enyo_data_bus_value_js_1 = require("../../../types/enyo-data-bus-value.cjs");
+const sunspec_modbus_client_js_1 = require("./sunspec-modbus-client.cjs");
+/**
+ * Base abstract class for all Sunspec devices
+ */
+class BaseSunspecDevice {
+    energyApp;
+    name;
+    networkDevice;
+    sunspecClient;
+    applianceManager;
+    unitId;
+    applianceId;
+    lastUpdateTime = 0;
+    constructor(energyApp, name, networkDevice, sunspecClient, applianceManager, unitId = 1) {
+        this.energyApp = energyApp;
+        this.name = name;
+        this.networkDevice = networkDevice;
+        this.sunspecClient = sunspecClient;
+        this.applianceManager = applianceManager;
+        this.unitId = unitId;
+    }
+    /**
+     * Check if the device is connected
+     */
+    isConnected() {
+        return this.sunspecClient.isConnected();
+    }
+    /**
+     * Get the appliance IDs managed by this device
+     */
+    /**
+     * Ensure the Sunspec client is connected and models are discovered
+     */
+    async ensureConnected() {
+        if (!this.sunspecClient.isConnected()) {
+            await this.sunspecClient.connect(this.networkDevice.ipAddress, 502, this.unitId);
+            await this.sunspecClient.discoverModels();
+        }
+    }
+}
+exports.BaseSunspecDevice = BaseSunspecDevice;
+/**
+ * Sunspec Inverter implementation using dynamic model discovery
+ */
+class SunspecInverter extends BaseSunspecDevice {
+    mpptData = [];
+    async connect() {
+        // Ensure Sunspec client is connected
+        if (!this.sunspecClient.isConnected()) {
+            await this.sunspecClient.connect(this.networkDevice.ipAddress, 502, this.unitId);
+            await this.sunspecClient.discoverModels();
+        }
+        // Get device info from common block
+        const commonData = await this.sunspecClient.readCommonBlock();
+        // Create or update appliance
+        try {
+            this.applianceId = await this.applianceManager.createOrUpdateAppliance({
+                name: this.name,
+                type: enyo_appliance_js_1.EnyoApplianceTypeEnum.Inverter,
+                networkDevices: [this.networkDevice],
+                metadata: {
+                    connectionType: enyo_appliance_js_1.EnyoApplianceConnectionType.Connector,
+                    state: enyo_appliance_js_1.EnyoApplianceStateEnum.Connected,
+                    serialNumber: commonData?.serialNumber,
+                    modelName: commonData?.model,
+                    vendorName: commonData?.manufacturer,
+                }
+            });
+            console.log(`Sunspec Inverter connected: ${this.networkDevice.hostname} (${this.applianceId})`);
+        }
+        catch (error) {
+            console.error(`Failed to create inverter appliance: ${error}`);
+        }
+        // Check for MPPT models
+        const mpptModel = this.sunspecClient.findModel(sunspec_modbus_client_js_1.SunspecModelId.MPPT);
+        if (mpptModel) {
+            console.log(`MPPT model found for inverter ${this.networkDevice.hostname}`);
+        }
+    }
+    async disconnect() {
+        if (this.applianceId) {
+            await this.applianceManager.updateApplianceState(this.applianceId, enyo_appliance_js_1.EnyoApplianceConnectionType.Connector, enyo_appliance_js_1.EnyoApplianceStateEnum.Offline);
+        }
+        // Note: We don't disconnect the sunspecClient as it may be shared
+    }
+    isConnected() {
+        return this.sunspecClient.isConnected();
+    }
+    async updateData() {
+        if (!this.isConnected()) {
+            return [];
+        }
+        const messages = [];
+        const timestamp = Date.now();
+        try {
+            // Read inverter data
+            const inverterData = await this.sunspecClient.readInverterData();
+            if (inverterData) {
+                // Map operating state
+                const operatingState = this.mapOperatingState(inverterData.operatingState);
+                const inverterMessage = {
+                    type: 'inverter',
+                    appliances: this.name,
+                    data: {
+                        timestamp,
+                        power: inverterData.acPower,
+                        dcPower: inverterData.dcPower,
+                        voltage: inverterData.voltageAN, // Phase A voltage
+                        voltageL1: inverterData.voltageAN,
+                        voltageL2: inverterData.voltageBN,
+                        voltageL3: inverterData.voltageCN,
+                        current: inverterData.acCurrent,
+                        currentL1: inverterData.phaseACurrent,
+                        currentL2: inverterData.phaseBCurrent,
+                        currentL3: inverterData.phaseCCurrent,
+                        frequency: inverterData.frequency,
+                        temperature: inverterData.cabinetTemperature,
+                        state: operatingState,
+                        energy: Number(inverterData.acEnergy || 0),
+                        apparentPower: inverterData.apparentPower,
+                        reactivePower: inverterData.reactivePower,
+                        powerFactor: inverterData.powerFactor
+                    }
+                };
+                messages.push(inverterMessage);
+            }
+            // Read MPPT data if available
+            const mpptDataList = await this.sunspecClient.readAllMPPTData();
+            for (const mpptData of mpptDataList) {
+                const mpptMessage = {
+                    type: 'mppt',
+                    appliances: this.name,
+                    data: {
+                        timestamp,
+                        stringId: mpptData.id,
+                        dcCurrent: mpptData.dcCurrent,
+                        dcVoltage: mpptData.dcVoltage,
+                        dcPower: mpptData.dcPower,
+                        temperature: mpptData.temperature,
+                        energy: Number(mpptData.dcEnergy || 0)
+                    }
+                };
+                messages.push(mpptMessage);
+            }
+            this.lastUpdateTime = timestamp;
+            this.mpptData = mpptDataList; // Store MPPT data for later use
+        }
+        catch (error) {
+            console.error(`Error updating inverter data: ${error}`);
+        }
+        return messages;
+    }
+    mapOperatingState(state) {
+        if (!state)
+            return enyo_data_bus_value_js_1.EnyoInverterStateEnum.Off;
+        const stateMap = {
+            1: enyo_data_bus_value_js_1.EnyoInverterStateEnum.Off,
+            2: enyo_data_bus_value_js_1.EnyoInverterStateEnum.Sleeping,
+            3: enyo_data_bus_value_js_1.EnyoInverterStateEnum.Starting,
+            4: enyo_data_bus_value_js_1.EnyoInverterStateEnum.Mppt,
+            5: enyo_data_bus_value_js_1.EnyoInverterStateEnum.Throttled,
+            6: enyo_data_bus_value_js_1.EnyoInverterStateEnum.ShuttingDown,
+            7: enyo_data_bus_value_js_1.EnyoInverterStateEnum.Fault,
+            8: enyo_data_bus_value_js_1.EnyoInverterStateEnum.Standby
+        };
+        return stateMap[state] || enyo_data_bus_value_js_1.EnyoInverterStateEnum.Off;
+    }
+}
+exports.SunspecInverter = SunspecInverter;
+/**
+ * Sunspec Battery implementation
+ */
+class SunspecBattery extends BaseSunspecDevice {
+    /**
+     * Connect to the battery and create/update the appliance
+     */
+    async connect() {
+        // Ensure Sunspec client is connected
+        await this.ensureConnected();
+        // Check if battery models exist
+        const hasBattery = this.sunspecClient.findModel(sunspec_modbus_client_js_1.SunspecModelId.Battery) !== undefined ||
+            this.sunspecClient.findModel(sunspec_modbus_client_js_1.SunspecModelId.BatteryBase) !== undefined;
+        if (!hasBattery) {
+            throw new Error('No battery model found in device');
+        }
+        // Get device info
+        const commonData = await this.sunspecClient.readCommonBlock();
+        // Create or update appliance
+        try {
+            this.applianceId = await this.applianceManager.createOrUpdateAppliance({
+                name: this.name,
+                type: enyo_appliance_js_1.EnyoApplianceTypeEnum.Storage,
+                networkDevices: [this.networkDevice],
+                metadata: {
+                    connectionType: enyo_appliance_js_1.EnyoApplianceConnectionType.Connector,
+                    state: enyo_appliance_js_1.EnyoApplianceStateEnum.Connected,
+                    serialNumber: commonData?.serialNumber ? `${commonData.serialNumber}-BAT` : undefined,
+                    modelName: commonData?.model ? `${commonData.model} Battery` : 'Battery',
+                    vendorName: commonData?.manufacturer,
+                }
+            });
+            console.log(`Sunspec Battery connected: ${this.networkDevice.hostname} (${this.applianceId})`);
+        }
+        catch (error) {
+            console.error(`Failed to create battery appliance: ${error}`);
+        }
+    }
+    async disconnect() {
+        if (this.applianceId) {
+            await this.applianceManager.updateApplianceState(this.applianceId, enyo_appliance_js_1.EnyoApplianceConnectionType.Connector, enyo_appliance_js_1.EnyoApplianceStateEnum.Offline);
+        }
+    }
+    /**
+     * Update battery data and return data bus messages
+     */
+    async updateData() {
+        if (!this.isConnected()) {
+            return [];
+        }
+        const messages = [];
+        const timestamp = Date.now();
+        try {
+            // For now, return basic battery data
+            // In a real implementation, we would read from battery models
+            const batteryMessage = {
+                type: 'battery',
+                appliances: this.name,
+                data: {
+                    timestamp,
+                    soc: 50, // Placeholder - would read from battery model
+                    power: 0,
+                    voltage: 0,
+                    current: 0,
+                    temperature: 25,
+                    state: enyo_data_bus_value_js_1.EnyoBatteryStateEnum.Holding
+                }
+            };
+            messages.push(batteryMessage);
+            this.lastUpdateTime = timestamp;
+        }
+        catch (error) {
+            console.error(`Error updating battery data: ${error}`);
+        }
+        return messages;
+    }
+}
+exports.SunspecBattery = SunspecBattery;
+/**
+ * Sunspec Meter implementation
+ */
+class SunspecMeter extends BaseSunspecDevice {
+    /**
+     * Connect to the meter and create/update the appliance
+     */
+    async connect() {
+        // Connect with specific unit ID for meter
+        await this.ensureConnected();
+        // Check if meter models exist
+        const hasMeter = this.sunspecClient.findModel(sunspec_modbus_client_js_1.SunspecModelId.Meter3Phase) !== undefined ||
+            this.sunspecClient.findModel(sunspec_modbus_client_js_1.SunspecModelId.MeterWye) !== undefined ||
+            this.sunspecClient.findModel(sunspec_modbus_client_js_1.SunspecModelId.MeterSinglePhase) !== undefined;
+        if (!hasMeter) {
+            throw new Error('No meter model found in device');
+        }
+        // Get device info
+        const commonData = await this.sunspecClient.readCommonBlock();
+        // Create or update appliance
+        try {
+            this.applianceId = await this.applianceManager.createOrUpdateAppliance({
+                name: this.name,
+                type: enyo_appliance_js_1.EnyoApplianceTypeEnum.Meter,
+                networkDevices: [this.networkDevice],
+                metadata: {
+                    connectionType: enyo_appliance_js_1.EnyoApplianceConnectionType.Connector,
+                    state: enyo_appliance_js_1.EnyoApplianceStateEnum.Connected,
+                    serialNumber: commonData?.serialNumber ? `${commonData.serialNumber}-MTR` : undefined,
+                    modelName: commonData?.model ? `${commonData.model} Meter` : 'Meter',
+                    vendorName: commonData?.manufacturer,
+                }
+            });
+            console.log(`Sunspec Meter connected: ${this.networkDevice.hostname} unit ${this.unitId} (${this.applianceId})`);
+        }
+        catch (error) {
+            console.error(`Failed to create meter appliance: ${error}`);
+        }
+    }
+    /**
+     * Disconnect from the meter and update appliance state
+     */
+    async disconnect() {
+        if (this.applianceId) {
+            await this.applianceManager.updateApplianceState(this.applianceId, enyo_appliance_js_1.EnyoApplianceConnectionType.Connector, enyo_appliance_js_1.EnyoApplianceStateEnum.Offline);
+        }
+        // Disconnect the client since meter uses its own connection
+        await this.sunspecClient.disconnect();
+    }
+    /**
+     * Update meter data and return data bus messages
+     */
+    async updateData() {
+        if (!this.isConnected()) {
+            return [];
+        }
+        const messages = [];
+        const timestamp = Date.now();
+        try {
+            // Read meter data
+            const meterData = await this.sunspecClient.readMeterData();
+            if (meterData) {
+                const meterMessage = {
+                    type: 'meter',
+                    appliances: this.name,
+                    data: {
+                        timestamp,
+                        totalPower: meterData.totalPower,
+                        phaseAPower: meterData.phaseAPower,
+                        phaseBPower: meterData.phaseBPower,
+                        phaseCPower: meterData.phaseCPower,
+                        totalEnergy: Number(meterData.totalEnergy || 0),
+                        exportedEnergy: Number(meterData.exportedEnergy || 0),
+                        importedEnergy: Number(meterData.importedEnergy || 0),
+                        voltage: meterData.voltage,
+                        current: meterData.current,
+                        frequency: meterData.frequency
+                    }
+                };
+                messages.push(meterMessage);
+            }
+            this.lastUpdateTime = timestamp;
+        }
+        catch (error) {
+            console.error(`Error updating meter data: ${error}`);
+        }
+        return messages;
+    }
+}
+exports.SunspecMeter = SunspecMeter;

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

@@ -0,0 +1,95 @@
+import type { EnergyApp } from "../../../index.cjs";
+import type { EnyoNetworkDevice } from "../../../types/enyo-network-device.cjs";
+import type { EnyoApplianceName } from "../../../types/enyo-appliance.cjs";
+import { ApplianceManager } from "../../appliances/appliance-manager.cjs";
+import { SunspecModbusClient } from "./sunspec-modbus-client.cjs";
+/**
+ * Data bus message structure for Sunspec devices
+ */
+export interface DataBusMessage {
+    type: string;
+    appliances: EnyoApplianceName[];
+    data: {
+        [key: string]: any;
+        timestamp: number;
+    };
+}
+/**
+ * Base abstract class for all Sunspec devices
+ */
+export declare abstract class BaseSunspecDevice {
+    protected readonly energyApp: EnergyApp;
+    readonly name: EnyoApplianceName[];
+    readonly networkDevice: EnyoNetworkDevice;
+    protected readonly sunspecClient: SunspecModbusClient;
+    protected readonly applianceManager: ApplianceManager;
+    protected readonly unitId: number;
+    protected applianceId?: string;
+    protected lastUpdateTime: number;
+    protected constructor(energyApp: EnergyApp, name: EnyoApplianceName[], networkDevice: EnyoNetworkDevice, sunspecClient: SunspecModbusClient, applianceManager: ApplianceManager, unitId?: number);
+    /**
+     * Connect to the device and create/update the appliance
+     */
+    abstract connect(): Promise<void>;
+    /**
+     * Disconnect from the device and update appliance state
+     */
+    abstract disconnect(): Promise<void>;
+    /**
+     * Update device data and return data bus messages
+     */
+    abstract updateData(): Promise<DataBusMessage[]>;
+    /**
+     * Check if the device is connected
+     */
+    isConnected(): boolean;
+    /**
+     * Get the appliance IDs managed by this device
+     */
+    /**
+     * Ensure the Sunspec client is connected and models are discovered
+     */
+    protected ensureConnected(): Promise<void>;
+}
+/**
+ * Sunspec Inverter implementation using dynamic model discovery
+ */
+export declare class SunspecInverter extends BaseSunspecDevice {
+    private mpptData;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    isConnected(): boolean;
+    updateData(): Promise<DataBusMessage[]>;
+    private mapOperatingState;
+}
+/**
+ * Sunspec Battery implementation
+ */
+export declare class SunspecBattery extends BaseSunspecDevice {
+    /**
+     * Connect to the battery and create/update the appliance
+     */
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    /**
+     * Update battery data and return data bus messages
+     */
+    updateData(): Promise<DataBusMessage[]>;
+}
+/**
+ * Sunspec Meter implementation
+ */
+export declare class SunspecMeter extends BaseSunspecDevice {
+    /**
+     * Connect to the meter and create/update the appliance
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect from the meter and update appliance state
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Update meter data and return data bus messages
+     */
+    updateData(): Promise<DataBusMessage[]>;
+}