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

package/dist/implementations/appliances/in-memory-appliance-manager.js

@@ -1,5 +1,6 @@
 import { EnyoApplianceConnectionType, EnyoApplianceStateEnum } from "../../types/enyo-appliance.js";
 import { ApplianceManager } from "./appliance-manager.js";
+import { randomUUID } from "node:crypto";
 /**
  * Demo implementation of ApplianceManager that stores all data in memory.
  * This class provides the same interface as ApplianceManager but doesn't
@@ -19,48 +20,58 @@ export class InMemoryApplianceManager extends ApplianceManager {
     }
     /**
      * Creates or updates an appliance in memory.
-     * @param config The appliance configuration
-     * @param existingApplianceId Optional ID of an existing appliance to update
+     * @param appliance The appliance configuration
      * @returns The ID of the created or updated appliance
      */
-    async createOrUpdateAppliance(config, existingApplianceId) {
-        const applianceId = existingApplianceId || `appliance_${this.nextId++}`;
+    async createOrUpdateAppliance(appliance) {
         // Build network device IDs list
-        const networkDeviceIds = config.networkDevices?.map(d => d.id) ?? [];
-        // Get existing metadata if updating
-        const existingAppliance = existingApplianceId ? this.memoryStore.get(existingApplianceId) : null;
+        const networkDeviceIds = appliance.networkDevices?.map(d => d.id) ?? [];
+        // Try to find existing appliance using identifier strategy
+        let existingAppliance;
+        const identifier = this.config.identifierStrategy.extract(appliance);
+        if (identifier) {
+            const existing = await this.findByIdentifier(identifier);
+            if (existing.length > 0) {
+                existingAppliance = existing[0];
+                if (this.config.enableLogging) {
+                    console.log(`Found existing appliance with ID ${existingAppliance.id} for identifier ${identifier}`);
+                }
+            }
+        }
         // Merge metadata with defaults and existing values
         const metadata = {
-            connectionType: config.metadata?.connectionType ||
+            connectionType: appliance.metadata?.connectionType ||
                 existingAppliance?.metadata?.connectionType ||
                 EnyoApplianceConnectionType.Connector,
-            state: config.metadata?.state ||
+            state: appliance.metadata?.state ||
                 existingAppliance?.metadata?.state ||
                 EnyoApplianceStateEnum.Connected,
-            ...config.metadata
+            ...appliance.metadata
         };
         // Build appliance data
+        const applianceId = existingAppliance?.id || randomUUID();
         const applianceData = {
             id: applianceId,
-            name: config.name,
-            type: config.type,
+            name: appliance.name,
+            type: appliance.type,
             networkDeviceIds,
             metadata,
-            ...(config.topology && { topology: config.topology })
+            ...(appliance.topology && { topology: appliance.topology }),
+            meter: appliance.meter,
+            heatpump: appliance.heatpump,
+            battery: appliance.battery,
+            charger: appliance.charger,
+            inverter: appliance.inverter,
         };
-        // Add type-specific metadata
-        if (config.typeMetadata) {
-            Object.assign(applianceData, config.typeMetadata);
-        }
         // Save to memory store
         this.memoryStore.set(applianceId, applianceData);
         // Store network devices if provided
-        if (config.networkDevices) {
-            this.networkDevicesStore.set(applianceId, config.networkDevices);
+        if (appliance.networkDevices) {
+            this.networkDevicesStore.set(applianceId, appliance.networkDevices);
         }
         // Update cache
-        this.updateCache(applianceData, config.networkDevices?.[0]);
-        console.log(`[DEMO] ${existingApplianceId ? 'Updated' : 'Created'} appliance ${applianceId} of type ${config.type}`);
+        this.updateCache(applianceData);
+        console.log(`[DEMO] ${existingAppliance ? 'Updated' : 'Created'} appliance ${applianceId} of type ${appliance.type}`);
         return applianceId;
     }
     /**
@@ -96,10 +107,10 @@ export class InMemoryApplianceManager extends ApplianceManager {
         const strategy = this.getIdentifierStrategy();
         for (const appliance of this.memoryStore.values()) {
             const networkDevices = await this.getNetworkDevicesForApplianceDemo(appliance);
-            const extractedId = strategy.extract(appliance, networkDevices[0]);
+            const extractedId = strategy.extract(appliance);
             if (extractedId === identifier) {
                 matches.push(appliance);
-                this.updateCache(appliance, networkDevices[0]);
+                this.updateCache(appliance);
             }
         }
         return matches;
@@ -114,7 +125,7 @@ export class InMemoryApplianceManager extends ApplianceManager {
         for (const strategy of strategies) {
             for (const appliance of this.memoryStore.values()) {
                 const networkDevices = await this.getNetworkDevicesForApplianceDemo(appliance);
-                const identifier = strategy.extract(appliance, networkDevices[0]);
+                const identifier = strategy.extract(appliance);
                 if (identifier === searchValue) {
                     return {
                         appliance,
@@ -254,7 +265,7 @@ export class InMemoryApplianceManager extends ApplianceManager {
         this.clearCache();
         for (const appliance of this.memoryStore.values()) {
             const networkDevices = await this.getNetworkDevicesForApplianceDemo(appliance);
-            this.updateCache(appliance, networkDevices[0]);
+            this.updateCache(appliance);
         }
     }
     /**

package/dist/implementations/modbus/EnergyAppModbusDataTypeConverter.js

@@ -16,6 +16,10 @@ export class EnergyAppModbusDataTypeConverter {
     convertFromBuffer(buffer, dataType, scale, quantity) {
         try {
             switch (dataType) {
+                case 'acc16': {
+                    const value = buffer.readUInt16BE(0);
+                    return this.applyScale(value, scale);
+                }
                 case 'uint16': {
                     const value = buffer.readUInt16BE(0);
                     return this.applyScale(value, scale);
@@ -24,6 +28,10 @@ export class EnergyAppModbusDataTypeConverter {
                     const value = buffer.readInt16BE(0);
                     return this.applyScale(value, scale);
                 }
+                case 'acc32': {
+                    const value = buffer.readUInt32BE(0);
+                    return this.applyScale(value, scale);
+                }
                 case 'uint32': {
                     const value = buffer.readUInt32BE(0);
                     return this.applyScale(value, scale);

package/dist/implementations/modbus/interfaces.d.ts

@@ -6,7 +6,7 @@ import type { EnyoApplianceName, EnyoApplianceTopology } from "../../types/enyo-
  * - 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 type EnergyAppModbusDataType = 'uint16' | 'int16' | 'uint32' | 'int32' | 'float32' | 'string' | 'acc32' | 'acc16';
 export interface EnergyAppModbusStateValueMapping<T> {
     value: number;
     mappedState: T;
@@ -55,6 +55,10 @@ export interface RegisterReadResult<T = any> {
 export interface IRegisterReader {
     readHoldingRegisters(startAddress: number, quantity: number): Promise<RegisterReadResult<Buffer>>;
     readInputRegisters?(startAddress: number, quantity: number): Promise<RegisterReadResult<Buffer>>;
+    readHoldingRegisterWithType<T = any>(address: number, dataType: EnergyAppModbusDataType, options?: {
+        scale?: number;
+        quantity?: number;
+    }): Promise<RegisterReadResult<T>>;
     isHealthy(): boolean;
 }
 export interface IRegisterMapper {

package/dist/index.d.ts

@@ -13,6 +13,7 @@ import { EnergyAppAuthentication } from "./packages/energy-app-authentication.js
 import { EnergyAppSettings } from "./packages/energy-app-settings.js";
 import { EnergyAppElectricityPrices } from "./packages/energy-app-electricity-prices.js";
 import { EnergyAppNotification } from "./packages/energy-app-notification.js";
+import { EnergyAppSecretManager } from "./packages/energy-app-secret-manager.js";
 export * from './energy-app-package-definition.js';
 export * from './version.js';
 export * from './implementations/ocpp/ocpp16.js';
@@ -23,6 +24,7 @@ export * from './types/enyo-settings.js';
 export * from './types/enyo-energy-tariff.js';
 export * from './types/enyo-electricity-prices.js';
 export * from './types/enyo-notification.js';
+export * from './types/enyo-secret-manager.js';
 export * from './implementations/appliances/appliance-manager.js';
 export * from './implementations/appliances/identifier-strategies.js';
 export declare class EnergyApp implements EnyoEnergyAppSdk {
@@ -47,6 +49,12 @@ export declare class EnergyApp implements EnyoEnergyAppSdk {
     useSettings(): EnergyAppSettings;
     useElectricityPrices(): EnergyAppElectricityPrices;
     useNotification(): EnergyAppNotification;
+    /**
+     * Gets the Secret Manager API for retrieving secrets from the developer organization.
+     * Provides methods to fetch secrets that have been configured in the developer org's secret store.
+     * @returns The Secret Manager API instance
+     */
+    useSecretManager(): EnergyAppSecretManager;
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/index.js

@@ -9,6 +9,7 @@ export * from './types/enyo-settings.js';
 export * from './types/enyo-energy-tariff.js';
 export * from './types/enyo-electricity-prices.js';
 export * from './types/enyo-notification.js';
+export * from './types/enyo-secret-manager.js';
 export * from './implementations/appliances/appliance-manager.js';
 export * from './implementations/appliances/identifier-strategies.js';
 export class EnergyApp {
@@ -88,6 +89,14 @@ export class EnergyApp {
     useNotification() {
         return this.energyAppSdk.useNotification();
     }
+    /**
+     * Gets the Secret Manager API for retrieving secrets from the developer organization.
+     * Provides methods to fetch secrets that have been configured in the developer org's secret store.
+     * @returns The Secret Manager API instance
+     */
+    useSecretManager() {
+        return this.energyAppSdk.useSecretManager();
+    }
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/packages/energy-app-secret-manager.d.ts

@@ -0,0 +1,61 @@
+import { SecretValue } from "../types/enyo-secret-manager.js";
+export interface EnergyAppSecretManager {
+    /**
+     * Retrieves and decrypts a single secret from the developer organization's secret store.
+     * The secret must have been previously configured in the developer org using the enyo CLI.
+     *
+     * @param secretName - The name of the secret to retrieve (e.g., "ostrom_oauth")
+     * @param encryptionKey - The encryption key used to decrypt the secret
+     * @returns Promise that resolves to an object containing the decrypted secret's key-value pairs
+     * @throws {SecretNotFoundError} If the secret does not exist
+     * @throws {SecretRetrievalError} If there's an error retrieving or decrypting the secret
+     *
+     * @example
+     * ```typescript
+     * const secretManager = energyApp.useSecretManager();
+     * const oauthSecret = await secretManager.getSecret("oauth", encryptionKey);
+     * // Returns: { client_id: "...", client_secret: "..." }
+     * ```
+     */
+    getSecret(secretName: string, encryptionKey: string): Promise<SecretValue>;
+    /**
+     * Retrieves and decrypts multiple secrets from the developer organization's secret store in a single request.
+     * This is more efficient than making multiple individual requests.
+     * All secrets must have been previously configured using the enyo CLI.
+     *
+     * @param secretNames - Array of secret names to retrieve
+     * @param encryptionKey - The encryption key used to decrypt the secrets
+     * @returns Promise that resolves to a record mapping secret names to their decrypted values
+     * @throws {SecretNotFoundError} If any of the secrets do not exist
+     * @throws {SecretRetrievalError} If there's an error retrieving or decrypting the secrets
+     *
+     * @example
+     * ```typescript
+     * const secretManager = energyApp.useSecretManager();
+     * const encryptionKey = process.env.SECRET_ENCRYPTION_KEY;
+     * const secrets = await secretManager.getSecrets(["api_keys", "oauth_config"], encryptionKey);
+     * // Returns: {
+     * //   "api_keys": { api_key: "...", api_secret: "..." },
+     * //   "oauth_config": { client_id: "...", client_secret: "..." }
+     * // }
+     * ```
+     */
+    getSecrets(secretNames: string[], encryptionKey: string): Promise<Record<string, SecretValue>>;
+    /**
+     * Lists all available secret names that can be retrieved from the developer organization.
+     * This can be useful for discovering what secrets have been configured.
+     * Note: This returns only the names of secrets, not their values.
+     *
+     * @returns Promise that resolves to an array of available secret names
+     * @throws {SecretRetrievalError} If there's an error listing the secrets
+     *
+     * @example
+     * ```typescript
+     * const secretManager = energyApp.useSecretManager();
+     * const encryptionKey = process.env.SECRET_ENCRYPTION_KEY;
+     * const availableSecrets = await secretManager.listAvailableSecrets(encryptionKey);
+     * // Returns: ["oauth", "api_keys", "database_config"]
+     * ```
+     */
+    listAvailableSecrets(): Promise<string[]>;
+}

package/dist/packages/energy-app-secret-manager.js

@@ -0,0 +1 @@
+export {};

package/dist/types/enyo-data-bus-value.d.ts

@@ -207,16 +207,27 @@ export interface EnyoDataBusInverterValuesV1 extends EnyoDataBusMessage {
     /** ID of the appliance that delivered these values */
     applianceId: string;
     data: {
+        /** Operation State of the inverter */
         state?: EnyoInverterStateEnum;
         /** Current PV Production (in Watt) */
         pvPowerW: number;
-        /** voltage of Phase L1 to N*/
+        /** voltage of Phase L1 to N in V */
         voltageL1: number;
-        /** voltage of Phase L2 to N*/
+        /** voltage of Phase L2 to N in V */
         voltageL2?: number;
-        /** voltage of Phase L3 to N*/
+        /** voltage of Phase L3 to N in V */
         voltageL3?: number;
+        /** Current of Phase L1 to N in A */
+        currentL1?: number;
+        /** Current of Phase L2 to N in A */
+        currentL2?: number;
+        /** Current of Phase L3 to N in A */
+        currentL3?: number;
+        /** DC Power in W */
+        dcPowerW?: number;
+        /** Active power Limitation of the Inverter */
         activePowerLimitationW?: number;
+        /** DC String values. Please only provide active strings */
         strings?: EnyoDataBusInverterValuesV1String[];
     };
 }

package/dist/types/enyo-secret-manager.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Represents a secret value object containing key-value pairs.
+ * The secret is retrieved from the developer organization's secret store.
+ */
+export interface SecretValue {
+    [key: string]: string;
+}
+/**
+ * Request structure for fetching a single secret.
+ */
+export interface SecretRequest {
+    /** The name of the secret to retrieve */
+    secretName: string;
+}
+/**
+ * Response structure for secret retrieval operations.
+ */
+export interface SecretResponse {
+    /** The name of the secret */
+    secretName: string;
+    /** The secret values as key-value pairs */
+    values: SecretValue;
+}
+/**
+ * Error that occurs when a secret cannot be found.
+ */
+export declare class SecretNotFoundError extends Error {
+}
+/**
+ * Error that occurs when secret retrieval fails.
+ */
+export declare class SecretRetrievalError extends Error {
+}

package/dist/types/enyo-secret-manager.js

@@ -0,0 +1,10 @@
+/**
+ * Error that occurs when a secret cannot be found.
+ */
+export class SecretNotFoundError extends Error {
+}
+/**
+ * Error that occurs when secret retrieval fails.
+ */
+export class SecretRetrievalError extends Error {
+}

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.39";
+export declare const SDK_VERSION = "0.0.41";
 /**
  * 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.39';
+export const SDK_VERSION = '0.0.41';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enyo-energy/energy-app-sdk",
-  "version": "0.0.39",
+  "version": "0.0.41",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",