@enyo-energy/energy-app-sdk 0.0.125 → 0.0.126

package/dist/cjs/energy-app.cjs

@@ -263,6 +263,15 @@ class EnergyApp {
     useUdp() {
         return this.energyAppSdk.useUdp();
     }
+    /**
+     * Gets the Grid Connection Point API for retrieving details about the
+     * site's grid connection (main fuse rating in amperes, number of phases,
+     * and maximum allowed grid power in watts).
+     * @returns The Grid Connection Point API instance
+     */
+    useGridConnectionPoint() {
+        return this.energyAppSdk.useGridConnectionPoint();
+    }
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/cjs/energy-app.d.cts

@@ -32,6 +32,7 @@ import { EnergyAppDiagnostics } from "./packages/energy-app-diagnostics.cjs";
 import { EnergyAppLearningPhase } from "./packages/energy-app-learning-phase.cjs";
 import { EnergyAppWifi } from "./packages/energy-app-wifi.cjs";
 import { EnergyAppUdp } from "./packages/energy-app-udp.cjs";
+import { EnergyAppGridConnectionPoint } from "./packages/energy-app-grid-connection-point.cjs";
 /**
  * Concrete implementation of {@link EnyoEnergyAppSdk} that delegates every call
  * to the runtime-provided `energyAppSdkInstance` global.
@@ -200,6 +201,13 @@ export declare class EnergyApp implements EnyoEnergyAppSdk {
      *         is not granted.
      */
     useUdp(): EnergyAppUdp;
+    /**
+     * Gets the Grid Connection Point API for retrieving details about the
+     * site's grid connection (main fuse rating in amperes, number of phases,
+     * and maximum allowed grid power in watts).
+     * @returns The Grid Connection Point API instance
+     */
+    useGridConnectionPoint(): EnergyAppGridConnectionPoint;
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/cjs/enyo-energy-app-sdk.d.cts

@@ -31,6 +31,7 @@ import { EnergyAppDiagnostics } from "./packages/energy-app-diagnostics.cjs";
 import { EnergyAppLearningPhase } from "./packages/energy-app-learning-phase.cjs";
 import { EnergyAppWifi } from "./packages/energy-app-wifi.cjs";
 import { EnergyAppUdp } from "./packages/energy-app-udp.cjs";
+import { EnergyAppGridConnectionPoint } from "./packages/energy-app-grid-connection-point.cjs";
 export declare enum EnergyAppStateEnum {
     Launching = "launching",
     Running = "running",
@@ -121,4 +122,6 @@ export interface EnyoEnergyAppSdk {
     useWifi: () => EnergyAppWifi;
     /** Get the UDP communication API for binding sockets and exchanging datagrams */
     useUdp: () => EnergyAppUdp;
+    /** Get the Grid Connection Point API for retrieving fuse rating, phase count, and power limit of the site's grid connection */
+    useGridConnectionPoint: () => EnergyAppGridConnectionPoint;
 }

package/dist/cjs/implementations/appliances/appliance-manager.cjs

@@ -127,6 +127,7 @@ class ApplianceManager {
             inverter: appliance.inverter,
             temperatureSensor: appliance.temperatureSensor,
             airConditioning: appliance.airConditioning,
+            cloudPackageId: appliance.cloudPackageId,
         };
         // When updating an existing appliance, merge metadata to preserve existing keys
         let applianceData = newApplianceData;

package/dist/cjs/implementations/appliances/appliance-manager.d.cts

@@ -31,6 +31,12 @@ export interface ApplianceConfig {
     battery?: EnyoBatteryApplianceMetadata;
     temperatureSensor?: EnyoTemperatureSensorApplianceMetadata;
     airConditioning?: EnyoAirConditioningApplianceMetadata;
+    /**
+     * Optional identifier of the cloud-deployed energy app package that manages
+     * this appliance. Forwarded to {@link EnyoAppliance.cloudPackageId} when the
+     * appliance is created or updated.
+     */
+    cloudPackageId?: string;
 }
 /**
  * Configuration options for the ApplianceManager.
@@ -249,4 +255,9 @@ export interface PartialEnyoAppliance {
     airConditioning?: Partial<EnyoAirConditioningApplianceMetadata>;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional identifier of the cloud-deployed energy app package that manages
+     * this appliance. Mirrors {@link EnyoAppliance.cloudPackageId}.
+     */
+    cloudPackageId?: string;
 }

package/dist/cjs/index.cjs

@@ -60,6 +60,8 @@ __exportStar(require("./packages/energy-app-learning-phase.cjs"), exports);
 __exportStar(require("./types/enyo-wifi.cjs"), exports);
 __exportStar(require("./packages/energy-app-wifi.cjs"), exports);
 __exportStar(require("./packages/energy-app-udp.cjs"), exports);
+__exportStar(require("./types/enyo-grid-connection-point.cjs"), exports);
+__exportStar(require("./packages/energy-app-grid-connection-point.cjs"), exports);
 __exportStar(require("./types/enyo-air-conditioning-appliance.cjs"), exports);
 __exportStar(require("./types/enyo-onboarding.cjs"), exports);
 __exportStar(require("./packages/energy-app-onboarding.cjs"), exports);

package/dist/cjs/index.d.cts

@@ -44,6 +44,8 @@ export * from './packages/energy-app-learning-phase.cjs';
 export * from './types/enyo-wifi.cjs';
 export * from './packages/energy-app-wifi.cjs';
 export * from './packages/energy-app-udp.cjs';
+export * from './types/enyo-grid-connection-point.cjs';
+export * from './packages/energy-app-grid-connection-point.cjs';
 export * from './types/enyo-air-conditioning-appliance.cjs';
 export * from './types/enyo-onboarding.cjs';
 export * from './packages/energy-app-onboarding.cjs';

package/dist/cjs/packages/energy-app-grid-connection-point.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/packages/energy-app-grid-connection-point.d.cts

@@ -0,0 +1,34 @@
+import { EnyoGridConnectionPoint } from "../types/enyo-grid-connection-point.cjs";
+/**
+ * Interface for retrieving information about the site's grid connection point.
+ *
+ * The grid connection point describes the physical interface between the
+ * local electrical installation and the public grid, including the main
+ * fuse rating, the number of phases, and the maximum allowed grid power.
+ * Energy apps consume this information to size grid-import/export budgets,
+ * enforce per-phase current limits, and respect contractual or regulatory
+ * power caps.
+ */
+export interface EnergyAppGridConnectionPoint {
+    /**
+     * Retrieves the configured grid connection point details.
+     *
+     * Returns `null` when no grid connection point has been configured for
+     * the site yet (e.g. during initial onboarding).
+     *
+     * @returns Promise resolving to the grid connection point details, or
+     *   `null` if none is configured.
+     *
+     * @example
+     * ```typescript
+     * const gridConnectionPoint = energyApp.useGridConnectionPoint();
+     * const details = await gridConnectionPoint.getGridConnectionPoint();
+     * if (details) {
+     *     console.log(`Fuse: ${details.fuseAmpere} A`);
+     *     console.log(`Phases: ${details.numberOfPhases}`);
+     *     console.log(`Power limit: ${details.powerLimitW} W`);
+     * }
+     * ```
+     */
+    getGridConnectionPoint(): Promise<EnyoGridConnectionPoint | null>;
+}

package/dist/cjs/types/enyo-appliance.d.cts

@@ -184,4 +184,11 @@ export interface EnyoAppliance {
     airConditioning?: EnyoAirConditioningApplianceMetadata;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional identifier of the cloud-deployed energy app package that manages
+     * this appliance. Set when the appliance is provisioned and operated by a
+     * cloud package (e.g. {@link EnyoApplianceConnectionType.Cloud}), so that
+     * downstream consumers can correlate the appliance with its owning package.
+     */
+    cloudPackageId?: string;
 }

package/dist/cjs/types/enyo-grid-connection-point.cjs

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/enyo-grid-connection-point.d.cts

@@ -0,0 +1,35 @@
+/**
+ * Number of electrical phases provided by a grid connection.
+ * Most residential connections in Europe are single-phase (1) or three-phase (3);
+ * two-phase (split-phase, 2) connections also exist in some markets.
+ */
+export type EnyoGridConnectionPointPhaseCount = 1 | 2 | 3;
+/**
+ * Details about the site's grid connection point (the physical interface
+ * between the local electrical installation and the public grid).
+ *
+ * These values are typically defined by the grid operator (DSO) at
+ * installation time and are used by energy managers and integrations
+ * to plan grid-import/export budgets, derive per-phase current limits,
+ * and enforce regulatory or contractual power caps.
+ */
+export interface EnyoGridConnectionPoint {
+    /**
+     * Rated current of the main fuse protecting the grid connection point,
+     * in amperes (A). This is the per-phase fuse rating as installed by the
+     * grid operator (e.g. 25, 35, 63).
+     */
+    fuseAmpere: number;
+    /**
+     * Number of electrical phases provided by the grid connection
+     * (1 = single-phase, 2 = split-phase, 3 = three-phase).
+     */
+    numberOfPhases: EnyoGridConnectionPointPhaseCount;
+    /**
+     * Maximum active power, in watts (W), that may be drawn from or fed into
+     * the grid at the connection point. Derived from the fuse rating, phase
+     * count, and any contractual or regulatory limits imposed by the grid
+     * operator.
+     */
+    powerLimitW: number;
+}

package/dist/cjs/version.cjs

@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
 /**
  * Current version of the enyo Energy App SDK.
  */
-exports.SDK_VERSION = '0.0.125';
+exports.SDK_VERSION = '0.0.126';
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/cjs/version.d.cts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.125";
+export declare const SDK_VERSION = "0.0.126";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

package/dist/energy-app.d.ts

@@ -32,6 +32,7 @@ import { EnergyAppDiagnostics } from "./packages/energy-app-diagnostics.js";
 import { EnergyAppLearningPhase } from "./packages/energy-app-learning-phase.js";
 import { EnergyAppWifi } from "./packages/energy-app-wifi.js";
 import { EnergyAppUdp } from "./packages/energy-app-udp.js";
+import { EnergyAppGridConnectionPoint } from "./packages/energy-app-grid-connection-point.js";
 /**
  * Concrete implementation of {@link EnyoEnergyAppSdk} that delegates every call
  * to the runtime-provided `energyAppSdkInstance` global.
@@ -200,6 +201,13 @@ export declare class EnergyApp implements EnyoEnergyAppSdk {
      *         is not granted.
      */
     useUdp(): EnergyAppUdp;
+    /**
+     * Gets the Grid Connection Point API for retrieving details about the
+     * site's grid connection (main fuse rating in amperes, number of phases,
+     * and maximum allowed grid power in watts).
+     * @returns The Grid Connection Point API instance
+     */
+    useGridConnectionPoint(): EnergyAppGridConnectionPoint;
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/energy-app.js

@@ -260,6 +260,15 @@ export class EnergyApp {
     useUdp() {
         return this.energyAppSdk.useUdp();
     }
+    /**
+     * Gets the Grid Connection Point API for retrieving details about the
+     * site's grid connection (main fuse rating in amperes, number of phases,
+     * and maximum allowed grid power in watts).
+     * @returns The Grid Connection Point API instance
+     */
+    useGridConnectionPoint() {
+        return this.energyAppSdk.useGridConnectionPoint();
+    }
     /**
      * Gets the current SDK version.
      * @returns The semantic version string of the SDK

package/dist/enyo-energy-app-sdk.d.ts

@@ -31,6 +31,7 @@ import { EnergyAppDiagnostics } from "./packages/energy-app-diagnostics.js";
 import { EnergyAppLearningPhase } from "./packages/energy-app-learning-phase.js";
 import { EnergyAppWifi } from "./packages/energy-app-wifi.js";
 import { EnergyAppUdp } from "./packages/energy-app-udp.js";
+import { EnergyAppGridConnectionPoint } from "./packages/energy-app-grid-connection-point.js";
 export declare enum EnergyAppStateEnum {
     Launching = "launching",
     Running = "running",
@@ -121,4 +122,6 @@ export interface EnyoEnergyAppSdk {
     useWifi: () => EnergyAppWifi;
     /** Get the UDP communication API for binding sockets and exchanging datagrams */
     useUdp: () => EnergyAppUdp;
+    /** Get the Grid Connection Point API for retrieving fuse rating, phase count, and power limit of the site's grid connection */
+    useGridConnectionPoint: () => EnergyAppGridConnectionPoint;
 }

package/dist/implementations/appliances/appliance-manager.d.ts

@@ -31,6 +31,12 @@ export interface ApplianceConfig {
     battery?: EnyoBatteryApplianceMetadata;
     temperatureSensor?: EnyoTemperatureSensorApplianceMetadata;
     airConditioning?: EnyoAirConditioningApplianceMetadata;
+    /**
+     * Optional identifier of the cloud-deployed energy app package that manages
+     * this appliance. Forwarded to {@link EnyoAppliance.cloudPackageId} when the
+     * appliance is created or updated.
+     */
+    cloudPackageId?: string;
 }
 /**
  * Configuration options for the ApplianceManager.
@@ -249,4 +255,9 @@ export interface PartialEnyoAppliance {
     airConditioning?: Partial<EnyoAirConditioningApplianceMetadata>;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional identifier of the cloud-deployed energy app package that manages
+     * this appliance. Mirrors {@link EnyoAppliance.cloudPackageId}.
+     */
+    cloudPackageId?: string;
 }

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

@@ -124,6 +124,7 @@ export class ApplianceManager {
             inverter: appliance.inverter,
             temperatureSensor: appliance.temperatureSensor,
             airConditioning: appliance.airConditioning,
+            cloudPackageId: appliance.cloudPackageId,
         };
         // When updating an existing appliance, merge metadata to preserve existing keys
         let applianceData = newApplianceData;

package/dist/index.d.ts

@@ -44,6 +44,8 @@ export * from './packages/energy-app-learning-phase.js';
 export * from './types/enyo-wifi.js';
 export * from './packages/energy-app-wifi.js';
 export * from './packages/energy-app-udp.js';
+export * from './types/enyo-grid-connection-point.js';
+export * from './packages/energy-app-grid-connection-point.js';
 export * from './types/enyo-air-conditioning-appliance.js';
 export * from './types/enyo-onboarding.js';
 export * from './packages/energy-app-onboarding.js';

package/dist/index.js

@@ -44,6 +44,8 @@ export * from './packages/energy-app-learning-phase.js';
 export * from './types/enyo-wifi.js';
 export * from './packages/energy-app-wifi.js';
 export * from './packages/energy-app-udp.js';
+export * from './types/enyo-grid-connection-point.js';
+export * from './packages/energy-app-grid-connection-point.js';
 export * from './types/enyo-air-conditioning-appliance.js';
 export * from './types/enyo-onboarding.js';
 export * from './packages/energy-app-onboarding.js';

package/dist/packages/energy-app-grid-connection-point.d.ts

@@ -0,0 +1,34 @@
+import { EnyoGridConnectionPoint } from "../types/enyo-grid-connection-point.js";
+/**
+ * Interface for retrieving information about the site's grid connection point.
+ *
+ * The grid connection point describes the physical interface between the
+ * local electrical installation and the public grid, including the main
+ * fuse rating, the number of phases, and the maximum allowed grid power.
+ * Energy apps consume this information to size grid-import/export budgets,
+ * enforce per-phase current limits, and respect contractual or regulatory
+ * power caps.
+ */
+export interface EnergyAppGridConnectionPoint {
+    /**
+     * Retrieves the configured grid connection point details.
+     *
+     * Returns `null` when no grid connection point has been configured for
+     * the site yet (e.g. during initial onboarding).
+     *
+     * @returns Promise resolving to the grid connection point details, or
+     *   `null` if none is configured.
+     *
+     * @example
+     * ```typescript
+     * const gridConnectionPoint = energyApp.useGridConnectionPoint();
+     * const details = await gridConnectionPoint.getGridConnectionPoint();
+     * if (details) {
+     *     console.log(`Fuse: ${details.fuseAmpere} A`);
+     *     console.log(`Phases: ${details.numberOfPhases}`);
+     *     console.log(`Power limit: ${details.powerLimitW} W`);
+     * }
+     * ```
+     */
+    getGridConnectionPoint(): Promise<EnyoGridConnectionPoint | null>;
+}

package/dist/packages/energy-app-grid-connection-point.js

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

package/dist/types/enyo-appliance.d.ts

@@ -184,4 +184,11 @@ export interface EnyoAppliance {
     airConditioning?: EnyoAirConditioningApplianceMetadata;
     /** Optional custom name for the appliance, defined by the user */
     customName?: string;
+    /**
+     * Optional identifier of the cloud-deployed energy app package that manages
+     * this appliance. Set when the appliance is provisioned and operated by a
+     * cloud package (e.g. {@link EnyoApplianceConnectionType.Cloud}), so that
+     * downstream consumers can correlate the appliance with its owning package.
+     */
+    cloudPackageId?: string;
 }

package/dist/types/enyo-grid-connection-point.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Number of electrical phases provided by a grid connection.
+ * Most residential connections in Europe are single-phase (1) or three-phase (3);
+ * two-phase (split-phase, 2) connections also exist in some markets.
+ */
+export type EnyoGridConnectionPointPhaseCount = 1 | 2 | 3;
+/**
+ * Details about the site's grid connection point (the physical interface
+ * between the local electrical installation and the public grid).
+ *
+ * These values are typically defined by the grid operator (DSO) at
+ * installation time and are used by energy managers and integrations
+ * to plan grid-import/export budgets, derive per-phase current limits,
+ * and enforce regulatory or contractual power caps.
+ */
+export interface EnyoGridConnectionPoint {
+    /**
+     * Rated current of the main fuse protecting the grid connection point,
+     * in amperes (A). This is the per-phase fuse rating as installed by the
+     * grid operator (e.g. 25, 35, 63).
+     */
+    fuseAmpere: number;
+    /**
+     * Number of electrical phases provided by the grid connection
+     * (1 = single-phase, 2 = split-phase, 3 = three-phase).
+     */
+    numberOfPhases: EnyoGridConnectionPointPhaseCount;
+    /**
+     * Maximum active power, in watts (W), that may be drawn from or fed into
+     * the grid at the connection point. Derived from the fuse rating, phase
+     * count, and any contractual or regulatory limits imposed by the grid
+     * operator.
+     */
+    powerLimitW: number;
+}

package/dist/types/enyo-grid-connection-point.js

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

package/dist/version.d.ts

@@ -5,7 +5,7 @@
 /**
  * Current version of the enyo Energy App SDK.
  */
-export declare const SDK_VERSION = "0.0.125";
+export declare const SDK_VERSION = "0.0.126";
 /**
  * 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.125';
+export const SDK_VERSION = '0.0.126';
 /**
  * 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.125",
+  "version": "0.0.126",
   "description": "enyo Energy App SDK",
   "type": "module",
   "main": "dist/index.js",