@enyo-energy/energy-app-sdk 0.0.34

package/dist/cjs/implementations/modbus/EnergyAppModbusMeter.cjs

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnergyAppModbusMeter = void 0;
+const node_crypto_1 = require("node:crypto");
+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 enyo_source_enum_js_1 = require("../../types/enyo-source.enum.cjs");
+const interfaces_js_1 = require("./interfaces.cjs");
+const EnergyAppModbusRegisterMapper_js_1 = require("./EnergyAppModbusRegisterMapper.cjs");
+const EnergyAppModbusConnectionHealth_js_1 = require("./EnergyAppModbusConnectionHealth.cjs");
+const EnergyAppModbusFaultTolerantReader_js_1 = require("./EnergyAppModbusFaultTolerantReader.cjs");
+const enyo_meter_appliance_js_1 = require("../../types/enyo-meter-appliance.cjs");
+class EnergyAppModbusMeter {
+    client;
+    config;
+    networkDevice;
+    _registerMapper;
+    _connectionHealth;
+    _modbusInstance;
+    _appliance;
+    constructor(client, config, networkDevice) {
+        this.client = client;
+        this.config = config;
+        this.networkDevice = networkDevice;
+        this.config = config;
+        this.client = client;
+        this.networkDevice = networkDevice;
+        this._registerMapper = new EnergyAppModbusRegisterMapper_js_1.EnergyAppModbusRegisterMapper();
+        this._connectionHealth = new EnergyAppModbusConnectionHealth_js_1.EnergyAppModbusConnectionHealth();
+        // Validate configuration
+        const validation = this._registerMapper.validateRegisterMap(config.registers);
+        if (!validation.valid) {
+            throw new interfaces_js_1.EnergyAppModbusConfigurationError(`Invalid meter configuration: ${validation.errors.join(', ')}`);
+        }
+    }
+    get appliance() {
+        if (!this._appliance) {
+            throw new Error('Meter appliance not initialized. Call connect() first.');
+        }
+        return this._appliance;
+    }
+    async connect() {
+        try {
+            console.log(`Connecting to meter at ${this.networkDevice.hostname}...`);
+            // Create modbus connection
+            this._modbusInstance = await this.client.useModbus().connect({
+                host: this.networkDevice.hostname,
+                unitId: this.config.options?.unitId || 1,
+                port: this.config.options?.port || 502,
+                timeout: this.config.options?.timeout || 5000
+            });
+            // Initialize appliance
+            await this._initializeAppliance();
+            console.log(`Successfully connected to meter ${this.config.name[0]?.name} at ${this.networkDevice.hostname}`);
+        }
+        catch (error) {
+            throw new interfaces_js_1.EnergyAppModbusConnectionError(`Failed to connect to meter at ${this.networkDevice.hostname}: ${error.message}`, error);
+        }
+    }
+    async disconnect() {
+        if (this._modbusInstance) {
+            try {
+                await this._modbusInstance.disconnect();
+                console.log(`Disconnected from meter at ${this.networkDevice.hostname}`);
+            }
+            catch (error) {
+                console.warn(`Error disconnecting from meter: ${error.message}`);
+            }
+            finally {
+                this._modbusInstance = undefined;
+            }
+        }
+    }
+    isConnected() {
+        return this._modbusInstance !== undefined && this._connectionHealth.isHealthy();
+    }
+    async updateData() {
+        if (!this._modbusInstance || !this._appliance) {
+            throw new Error('Meter not connected. Call connect() first.');
+        }
+        const reader = new EnergyAppModbusFaultTolerantReader_js_1.EnergyAppModbusFaultTolerantReader(this._modbusInstance, this._connectionHealth);
+        const registerData = await this._registerMapper.readMultipleRegisters(reader, this.config.registers);
+        // Extract meter data with fallbacks
+        const gridFeedInPowerW = registerData.gridFeedInPower || 0;
+        const gridConsumptionPowerW = registerData.gridConsumptionPower || 0;
+        const gridFeedInWh = registerData.gridFeedInEnergy || 0;
+        const gridConsumptionWh = registerData.gridConsumptionEnergy || 0;
+        // Calculate net grid power (positive = consumption, negative = feed-in)
+        const gridPowerW = this.config.registers.gridPower !== undefined ? registerData.gridPower : (gridConsumptionPowerW - gridFeedInPowerW);
+        const message = {
+            type: 'message',
+            source: enyo_source_enum_js_1.EnyoSourceEnum.Device,
+            id: (0, node_crypto_1.randomUUID)(),
+            timestampIso: new Date().toISOString(),
+            message: enyo_data_bus_value_js_1.EnyoDataBusMessageEnum.MeterValuesUpdateV1,
+            applianceId: this._appliance.id,
+            data: {
+                gridPowerW,
+                gridFeedInWh,
+                gridConsumptionWh
+            },
+            resolution: '10s'
+        };
+        console.log(`Meter Data (${this.config.name[0]?.name}): Grid Power=${gridPowerW}W (Feed-in=${gridFeedInPowerW}W, Consumption=${gridConsumptionPowerW}W), Feed-in Energy=${gridFeedInWh}Wh, Consumption Energy=${gridConsumptionWh}Wh`);
+        return [message];
+    }
+    // Convenience methods for accessing specific register values
+    async getGridPower() {
+        if (!this._modbusInstance) {
+            return null;
+        }
+        const reader = new EnergyAppModbusFaultTolerantReader_js_1.EnergyAppModbusFaultTolerantReader(this._modbusInstance, this._connectionHealth);
+        // Try direct grid power register first
+        if (this.config.registers.gridPower) {
+            const result = await this._registerMapper.readRegister(reader, this.config.registers.gridPower);
+            if (result.success) {
+                return result.value;
+            }
+        }
+        // Calculate from feed-in and consumption
+        if (this.config.registers.gridFeedInPower && this.config.registers.gridConsumptionPower) {
+            const feedInResult = await this._registerMapper.readRegister(reader, this.config.registers.gridFeedInPower);
+            const consumptionResult = await this._registerMapper.readRegister(reader, this.config.registers.gridConsumptionPower);
+            if (feedInResult.success && consumptionResult.success) {
+                return consumptionResult.value - feedInResult.value;
+            }
+        }
+        return null;
+    }
+    async getGridFeedInEnergy() {
+        if (!this._modbusInstance || !this.config.registers.gridFeedInEnergy) {
+            return null;
+        }
+        const reader = new EnergyAppModbusFaultTolerantReader_js_1.EnergyAppModbusFaultTolerantReader(this._modbusInstance, this._connectionHealth);
+        const result = await this._registerMapper.readRegister(reader, this.config.registers.gridFeedInEnergy);
+        return result.success ? result.value : null;
+    }
+    async getGridConsumptionEnergy() {
+        if (!this._modbusInstance || !this.config.registers.gridConsumptionEnergy) {
+            return null;
+        }
+        const reader = new EnergyAppModbusFaultTolerantReader_js_1.EnergyAppModbusFaultTolerantReader(this._modbusInstance, this._connectionHealth);
+        const result = await this._registerMapper.readRegister(reader, this.config.registers.gridConsumptionEnergy);
+        return result.success ? result.value : null;
+    }
+    async _initializeAppliance() {
+        const appliances = await this.client.useAppliances().list();
+        let existingAppliance = appliances.find(a => a.networkDeviceIds.includes(this.networkDevice.id) &&
+            a.type === enyo_appliance_js_1.EnyoApplianceTypeEnum.Meter);
+        if (!existingAppliance) {
+            // Create new appliance
+            existingAppliance = {
+                id: (0, node_crypto_1.randomUUID)(),
+                type: enyo_appliance_js_1.EnyoApplianceTypeEnum.Meter,
+                networkDeviceIds: [this.networkDevice.id],
+                name: this.config.name,
+                metadata: {
+                    state: enyo_appliance_js_1.EnyoApplianceStateEnum.Connected,
+                    connectionType: enyo_appliance_js_1.EnyoApplianceConnectionType.Connector,
+                    ...this.config.options?.topology && { topology: this.config.options.topology }
+                },
+                topology: {
+                    features: [enyo_appliance_js_1.EnyoApplianceTopologyFeatureEnum.IntermediateOfPrimaryMeter]
+                },
+                meter: {
+                    availableFeatures: [enyo_meter_appliance_js_1.EnyoMeterApplianceAvailableFeaturesEnum.LivePowerConsumption, enyo_meter_appliance_js_1.EnyoMeterApplianceAvailableFeaturesEnum.MeterValues]
+                }
+            };
+            await this.client.useAppliances().save(existingAppliance, undefined);
+            console.log(`Created new meter appliance: ${this.config.name[0]?.name}`);
+        }
+        else {
+            // Update existing appliance
+            existingAppliance = {
+                ...existingAppliance,
+                name: this.config.name,
+                metadata: {
+                    ...existingAppliance.metadata,
+                    connectionType: enyo_appliance_js_1.EnyoApplianceConnectionType.Connector,
+                    state: enyo_appliance_js_1.EnyoApplianceStateEnum.Connected,
+                    ...this.config.options?.topology && { topology: this.config.options.topology }
+                },
+                topology: {
+                    features: [enyo_appliance_js_1.EnyoApplianceTopologyFeatureEnum.IntermediateOfPrimaryMeter]
+                },
+                meter: {
+                    availableFeatures: [enyo_meter_appliance_js_1.EnyoMeterApplianceAvailableFeaturesEnum.LivePowerConsumption, enyo_meter_appliance_js_1.EnyoMeterApplianceAvailableFeaturesEnum.MeterValues]
+                }
+            };
+            await this.client.useAppliances().save(existingAppliance, existingAppliance?.id);
+            console.log(`Updated existing meter appliance: ${this.config.name[0]?.name}`);
+        }
+        this._appliance = existingAppliance;
+    }
+    modbusClient() {
+        return this._modbusInstance;
+    }
+}
+exports.EnergyAppModbusMeter = EnergyAppModbusMeter;

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

@@ -0,0 +1,26 @@
+import type { EnergyAppModbusInstance } from "../../packages/energy-app-modbus.cjs";
+import { EnyoAppliance } from "../../types/enyo-appliance.cjs";
+import type { EnyoNetworkDevice } from "../../types/enyo-network-device.cjs";
+import { type EnyoDataBusMessage } from "../../types/enyo-data-bus-value.cjs";
+import { type EnergyAppModbusDevice, type EnergyAppModbusMeterConfig } from './interfaces.cjs';
+import { EnergyApp } from "../../index.cjs";
+export declare class EnergyAppModbusMeter implements EnergyAppModbusDevice {
+    readonly client: EnergyApp;
+    readonly config: EnergyAppModbusMeterConfig;
+    readonly networkDevice: EnyoNetworkDevice;
+    private readonly _registerMapper;
+    private readonly _connectionHealth;
+    private _modbusInstance?;
+    private _appliance?;
+    constructor(client: EnergyApp, config: EnergyAppModbusMeterConfig, networkDevice: EnyoNetworkDevice);
+    get appliance(): EnyoAppliance;
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    isConnected(): boolean;
+    updateData(): Promise<EnyoDataBusMessage[]>;
+    getGridPower(): Promise<number | null>;
+    getGridFeedInEnergy(): Promise<number | null>;
+    getGridConsumptionEnergy(): Promise<number | null>;
+    private _initializeAppliance;
+    modbusClient(): EnergyAppModbusInstance | undefined;
+}

package/dist/cjs/implementations/modbus/EnergyAppModbusRegisterMapper.cjs

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnergyAppModbusRegisterMapper = void 0;
+const interfaces_js_1 = require("./interfaces.cjs");
+const EnergyAppModbusDataTypeConverter_js_1 = require("./EnergyAppModbusDataTypeConverter.cjs");
+class EnergyAppModbusRegisterMapper {
+    dataTypeConverter;
+    constructor(dataTypeConverter) {
+        this.dataTypeConverter = dataTypeConverter || new EnergyAppModbusDataTypeConverter_js_1.EnergyAppModbusDataTypeConverter();
+    }
+    async readRegister(reader, config) {
+        try {
+            // Calculate quantity if not provided
+            const quantity = config.quantity || this.dataTypeConverter.getRegisterQuantity(config.dataType);
+            const result = await reader.readHoldingRegisters(config.address, quantity);
+            if (!result.success || !result.value) {
+                return {
+                    success: false,
+                    error: new interfaces_js_1.EnergyAppModbusReadError(`Failed to read register ${config.address}: ${result.error?.message || 'Unknown error'}`, config.address)
+                };
+            }
+            const convertedValue = this.dataTypeConverter.convertFromBuffer(result.value, config.dataType, config.scale, config.quantity);
+            // Validate the converted value
+            if (!this.dataTypeConverter.isValidValue(convertedValue, config.dataType)) {
+                return {
+                    success: false,
+                    error: new interfaces_js_1.EnergyAppModbusReadError(`Invalid value 0x${convertedValue.toString(16)} for register ${config.address}`, config.address)
+                };
+            }
+            return {
+                success: true,
+                value: convertedValue
+            };
+        }
+        catch (error) {
+            return {
+                success: false,
+                error: new interfaces_js_1.EnergyAppModbusReadError(`Error reading register ${config.address}: ${error.message}`, config.address)
+            };
+        }
+    }
+    async readMultipleRegisters(reader, registerMap) {
+        const results = {};
+        const failures = [];
+        // Read all registers
+        for (const [name, config] of Object.entries(registerMap)) {
+            if (!config) {
+                continue;
+            }
+            const result = await this.readRegister(reader, config);
+            if (result.success) {
+                results[name] = result.value;
+            }
+            else {
+                // Check if this register was required
+                if (config.required) {
+                    failures.push(`${name} (${config.address})`);
+                }
+                console.warn(`Failed to read register ${name} (${config.address}): ${result.error?.message}`);
+            }
+        }
+        // If any required registers failed, log warning
+        if (failures.length > 0) {
+            console.warn(`Failed to read required registers: ${failures.join(', ')}`);
+        }
+        return results;
+    }
+    validateRegisterMap(registerMap) {
+        const errors = [];
+        for (const [name, config] of Object.entries(registerMap)) {
+            if (!config) {
+                continue;
+            }
+            // Validate address
+            if (!Number.isInteger(config.address) || config.address < 1) {
+                errors.push(`Invalid address for register '${name}': ${config.address}`);
+            }
+            // Validate data type
+            const validDataTypes = ['uint16', 'int16', 'uint32', 'int32', 'float32', 'string'];
+            if (!validDataTypes.includes(config.dataType)) {
+                errors.push(`Invalid data type for register '${name}': ${config.dataType}`);
+            }
+            // Validate scale
+            if (config.scale !== undefined && (!Number.isInteger(config.scale) || config.scale < 0)) {
+                errors.push(`Invalid scale for register '${name}': ${config.scale}`);
+            }
+            // Validate quantity
+            if (config.quantity !== undefined && (!Number.isInteger(config.quantity) || config.quantity < 1)) {
+                errors.push(`Invalid quantity for register '${name}': ${config.quantity}`);
+            }
+        }
+        return {
+            valid: errors.length === 0,
+            errors
+        };
+    }
+}
+exports.EnergyAppModbusRegisterMapper = EnergyAppModbusRegisterMapper;

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

@@ -0,0 +1,13 @@
+import { type IRegisterMapper, type IRegisterReader, type IDataTypeConverter, type EnergyAppModbusRegisterConfig, type EnergyAppRegisterMap, type RegisterReadResult } from './interfaces.cjs';
+export declare class EnergyAppModbusRegisterMapper implements IRegisterMapper {
+    private readonly dataTypeConverter;
+    constructor(dataTypeConverter?: IDataTypeConverter);
+    readRegister<T>(reader: IRegisterReader, config: EnergyAppModbusRegisterConfig): Promise<RegisterReadResult<T>>;
+    readMultipleRegisters(reader: IRegisterReader, registerMap: EnergyAppRegisterMap): Promise<{
+        [key: string]: any;
+    }>;
+    validateRegisterMap(registerMap: EnergyAppRegisterMap): {
+        valid: boolean;
+        errors: string[];
+    };
+}

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnergyAppModbusReadError = exports.EnergyAppModbusConnectionError = exports.EnergyAppModbusConfigurationError = void 0;
+// Error types
+class EnergyAppModbusConfigurationError extends Error {
+    constructor(message) {
+        super(`Modbus Configuration Error: ${message}`);
+        this.name = 'ModbusConfigurationError';
+    }
+}
+exports.EnergyAppModbusConfigurationError = EnergyAppModbusConfigurationError;
+class EnergyAppModbusConnectionError extends Error {
+    cause;
+    constructor(message, cause) {
+        super(`Modbus Connection Error: ${message}`);
+        this.cause = cause;
+        this.name = 'ModbusConnectionError';
+    }
+}
+exports.EnergyAppModbusConnectionError = EnergyAppModbusConnectionError;
+class EnergyAppModbusReadError extends Error {
+    register;
+    constructor(message, register) {
+        super(`Modbus Read Error: ${message}`);
+        this.register = register;
+        this.name = 'ModbusReadError';
+    }
+}
+exports.EnergyAppModbusReadError = EnergyAppModbusReadError;

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

@@ -0,0 +1,202 @@
+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";
+/**
+ * Data Types for Modbus Register Configuration
+ *
+ * @description Supported data types for reading Modbus registers
+ * - Numeric types: uint16, int16, uint32, int32, float32
+ * - String type: string (requires length property in register config)
+ */
+export type EnergyAppModbusDataType = 'uint16' | 'int16' | 'uint32' | 'int32' | 'float32' | 'string';
+export interface EnergyAppBatteryStateValueMapping {
+    value: number;
+    mappedState: EnyoBatteryStateEnum;
+}
+export interface EnergyAppInverterStateValueMapping {
+    value: number;
+    mappedState: EnyoInverterStateEnum;
+}
+/**
+ * Register Configuration Interface
+ *
+ * @description Configuration for reading a Modbus register
+ */
+export interface EnergyAppModbusRegisterConfig {
+    /** Modbus register address */
+    address: number;
+    /** Data type of the register value */
+    dataType: EnergyAppModbusDataType;
+    /** For FIX2, FIX3 scaling (divide by 10^scale) - only applies to numeric types */
+    scale?: number;
+    /** Number of registers to read (auto-calculated from dataType if not provided) */
+    quantity?: number;
+    /** 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[];
+}
+export interface EnergyAppRegisterMap {
+    [key: string]: EnergyAppModbusRegisterConfig | undefined;
+}
+export interface EnergyAppModbusConnectionOptions {
+    unitId?: number;
+    port?: number;
+    timeout?: number;
+    retryAttempts?: number;
+    retryDelayMs?: number;
+}
+export interface EnergyAppModbusDeviceConfig {
+    name: EnyoApplianceName[];
+    registers: EnergyAppRegisterMap;
+    options?: EnergyAppModbusConnectionOptions & {
+        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;
+    error?: Error;
+}
+export interface IRegisterReader {
+    readHoldingRegisters(startAddress: number, quantity: number): Promise<RegisterReadResult<Buffer>>;
+    readInputRegisters?(startAddress: number, quantity: number): Promise<RegisterReadResult<Buffer>>;
+    isHealthy(): boolean;
+}
+export interface IRegisterMapper {
+    readRegister<T>(reader: IRegisterReader, config: EnergyAppModbusRegisterConfig): Promise<RegisterReadResult<T>>;
+    readMultipleRegisters(reader: IRegisterReader, registerMap: EnergyAppRegisterMap): Promise<{
+        [key: string]: any;
+    }>;
+    validateRegisterMap(registerMap: EnergyAppRegisterMap): {
+        valid: boolean;
+        errors: string[];
+    };
+}
+/**
+ * Data Type Converter Interface
+ *
+ * @description Interface for converting raw Modbus buffer data into appropriate JavaScript types
+ */
+export interface IDataTypeConverter {
+    /**
+     * Converts raw buffer data from Modbus registers into appropriate JavaScript types
+     *
+     * @param buffer - Raw buffer data from Modbus registers
+     * @param dataType - The expected data type for conversion
+     * @param scale - Optional scaling factor for numeric types (divide by 10^scale)
+     * @param quantity - Required for string types, specifies the string length in characters
+     */
+    convertFromBuffer(buffer: Buffer, dataType: EnergyAppModbusDataType, scale?: number, quantity?: number): any;
+    /**
+     * Validates if a value is valid for the given data type
+     *
+     * @param value - The value to validate
+     * @param dataType - The expected data type
+     */
+    isValidValue(value: any, dataType: EnergyAppModbusDataType): boolean;
+    /**
+     * Calculates the number of Modbus registers required for a given data type
+     *
+     * @param dataType - The data type to calculate register quantity for
+     */
+    getRegisterQuantity(dataType: EnergyAppModbusDataType): number;
+}
+export interface IConnectionHealth {
+    recordSuccess(): void;
+    recordFailure(error: Error): void;
+    isHealthy(): boolean;
+    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);
+}
+export declare class EnergyAppModbusConnectionError extends Error {
+    readonly cause?: Error | undefined;
+    constructor(message: string, cause?: Error | undefined);
+}
+export declare class EnergyAppModbusReadError extends Error {
+    readonly register?: number | undefined;
+    constructor(message: string, register?: number | undefined);
+}