@enyo-energy/energy-app-sdk 0.0.96 → 0.0.97

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

@@ -1,4 +1,5 @@
 import { EnergyManagerFeatureEnum, EnergyManagerInfo } from "../types/enyo-energy-manager.cjs";
+import { EnyoDiagnosticsControlPlan } from "../types/enyo-diagnostics.cjs";
 /**
  * Interface for retrieving energy manager information and capabilities.
  * The energy manager is responsible for optimizing energy usage across appliances.
@@ -23,4 +24,33 @@ export interface EnergyAppEnergyManager {
     getEnergyManagerInfo(): Promise<EnergyManagerInfo | null>;
     /** Only for Energy Manager Energy Apps: Register the features which are provided*/
     registerFeatures(features: EnergyManagerFeatureEnum[]): void;
+    /**
+     * Only for Energy Manager Energy Apps: Publishes the energy manager's control plan forecast.
+     * The control plan contains time-slotted commands for each appliance along with
+     * estimated costs and grid power values.
+     *
+     * @param controlPlan - The time-slotted control plan with commands for each appliance
+     *   and estimated costs
+     *
+     * @example
+     * ```typescript
+     * const energyManager = energyApp.useEnergyManager();
+     * energyManager.publishForecast({
+     *     commands: [
+     *         {
+     *             type: EnyoApplianceTypeEnum.Storage,
+     *             applianceId: 'battery-1',
+     *             decision: BatteryDecision.Charge,
+     *             powerW: 3000,
+     *             durationInMinutes: 60
+     *         }
+     *     ],
+     *     generatedAtIso: new Date().toISOString(),
+     *     totalEstimatedCostEur: 3.50,
+     *     totalGridImportKwh: 12.5,
+     *     totalGridExportKwh: 4.2
+     * });
+     * ```
+     */
+    publishForecast(controlPlan: EnyoDiagnosticsControlPlan): void;
 }

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

@@ -20,11 +20,11 @@ export type DhwState = "charging" | "discharging" | "idle";
 /** Heating circuit state. */
 export type HeatingState = "active" | "idle";
 /** Battery control decision issued by the energy manager. */
-export type BatteryDecision = "normal" | "block_discharge" | "charge_from_grid" | "force_discharge";
+export type BatteryDecision = "block_discharge" | "charge_from_grid" | "force_discharge";
 /** EV charging control decision issued by the energy manager. */
-export type EvDecision = "normal" | "charging_pv" | "charging_grid" | "charging_mixed";
+export type EvDecision = "charging_pv" | "charging_grid" | "charging_mixed";
 /** Heat pump control decision issued by the energy manager. */
-export type HeatpumpDecision = "normal" | "dhw_boost" | "room_overheating" | "buffer_tank_boost";
+export type HeatpumpDecision = "dhw_boost" | "room_overheating" | "buffer_tank_boost";
 export interface EnyoDiagnosticsForecastInverterAppliance {
     type: EnyoApplianceTypeEnum.Inverter;
     applianceId: string;
@@ -159,10 +159,14 @@ export interface EnyoDiagnosticsStorageControlCommand {
     type: EnyoApplianceTypeEnum.Storage;
     /** Target appliance ID. */
     applianceId: string;
+    /** ISO 8601 timestamp when this command starts. */
+    timestampIso: string;
     /** Control decision for the battery. */
     decision: BatteryDecision;
     /** Target power in Watts. */
     powerW: number;
+    /** Duration of this command in minutes. */
+    durationInMinutes: number;
     /** Optional target state of charge as a percentage. */
     targetSoCPercent?: number;
 }
@@ -171,10 +175,14 @@ export interface EnyoDiagnosticsChargerControlCommand {
     type: EnyoApplianceTypeEnum.Charger;
     /** Target appliance ID. */
     applianceId: string;
+    /** ISO 8601 timestamp when this command starts. */
+    timestampIso: string;
     /** Control decision for the EV charger. */
     decision: EvDecision;
     /** Charging power in Watts. */
     chargingPowerW: number;
+    /** Duration of this command in minutes. */
+    durationInMinutes: number;
     /** Optional charging limit in kW. */
     chargingLimitKw?: number;
 }
@@ -183,30 +191,23 @@ export interface EnyoDiagnosticsHeatpumpControlCommand {
     type: EnyoApplianceTypeEnum.Heatpump;
     /** Target appliance ID. */
     applianceId: string;
+    /** ISO 8601 timestamp when this command starts. */
+    timestampIso: string;
     /** Control decision for the heat pump. */
     decision: HeatpumpDecision;
     /** Target power in Watts. */
     powerW: number;
+    /** Duration of this command in minutes. */
+    durationInMinutes: number;
     /** Optional target temperature in Celsius. */
     targetTempC?: number;
 }
 /** Union of all appliance control command types. */
 export type EnyoDiagnosticsApplianceControlCommand = EnyoDiagnosticsStorageControlCommand | EnyoDiagnosticsChargerControlCommand | EnyoDiagnosticsHeatpumpControlCommand;
-/** A single time slot in a control plan with its associated commands. */
-export interface EnyoDiagnosticsControlSlot {
-    /** ISO 8601 timestamp for this slot. */
-    timestampIso: string;
-    /** Commands to execute during this slot. */
-    commands: EnyoDiagnosticsApplianceControlCommand[];
-    /** Estimated cost for this slot in EUR. */
-    estimatedSlotCostEur: number;
-    /** Estimated grid power in Watts for this slot. */
-    estimatedGridPowerW: number;
-}
-/** Complete control plan with time-slotted commands and cost estimates. */
+/** Complete control plan with duration-based commands and cost estimates. */
 export interface EnyoDiagnosticsControlPlan {
-    /** Time-slotted command sequence. */
-    slots: EnyoDiagnosticsControlSlot[];
+    /** Sequence of appliance control commands, each with its own duration. */
+    commands: EnyoDiagnosticsApplianceControlCommand[];
     /** ISO 8601 timestamp when this plan was generated. */
     generatedAtIso: string;
     /** Total estimated cost in EUR. */

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.96';
+exports.SDK_VERSION = '0.0.97';
 /**
  * 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.96";
+export declare const SDK_VERSION = "0.0.97";
 /**
  * Gets the current SDK version.
  * @returns The semantic version string of the SDK

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

@@ -1,4 +1,5 @@
 import { EnergyManagerFeatureEnum, EnergyManagerInfo } from "../types/enyo-energy-manager.js";
+import { EnyoDiagnosticsControlPlan } from "../types/enyo-diagnostics.js";
 /**
  * Interface for retrieving energy manager information and capabilities.
  * The energy manager is responsible for optimizing energy usage across appliances.
@@ -23,4 +24,33 @@ export interface EnergyAppEnergyManager {
     getEnergyManagerInfo(): Promise<EnergyManagerInfo | null>;
     /** Only for Energy Manager Energy Apps: Register the features which are provided*/
     registerFeatures(features: EnergyManagerFeatureEnum[]): void;
+    /**
+     * Only for Energy Manager Energy Apps: Publishes the energy manager's control plan forecast.
+     * The control plan contains time-slotted commands for each appliance along with
+     * estimated costs and grid power values.
+     *
+     * @param controlPlan - The time-slotted control plan with commands for each appliance
+     *   and estimated costs
+     *
+     * @example
+     * ```typescript
+     * const energyManager = energyApp.useEnergyManager();
+     * energyManager.publishForecast({
+     *     commands: [
+     *         {
+     *             type: EnyoApplianceTypeEnum.Storage,
+     *             applianceId: 'battery-1',
+     *             decision: BatteryDecision.Charge,
+     *             powerW: 3000,
+     *             durationInMinutes: 60
+     *         }
+     *     ],
+     *     generatedAtIso: new Date().toISOString(),
+     *     totalEstimatedCostEur: 3.50,
+     *     totalGridImportKwh: 12.5,
+     *     totalGridExportKwh: 4.2
+     * });
+     * ```
+     */
+    publishForecast(controlPlan: EnyoDiagnosticsControlPlan): void;
 }

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

@@ -20,11 +20,11 @@ export type DhwState = "charging" | "discharging" | "idle";
 /** Heating circuit state. */
 export type HeatingState = "active" | "idle";
 /** Battery control decision issued by the energy manager. */
-export type BatteryDecision = "normal" | "block_discharge" | "charge_from_grid" | "force_discharge";
+export type BatteryDecision = "block_discharge" | "charge_from_grid" | "force_discharge";
 /** EV charging control decision issued by the energy manager. */
-export type EvDecision = "normal" | "charging_pv" | "charging_grid" | "charging_mixed";
+export type EvDecision = "charging_pv" | "charging_grid" | "charging_mixed";
 /** Heat pump control decision issued by the energy manager. */
-export type HeatpumpDecision = "normal" | "dhw_boost" | "room_overheating" | "buffer_tank_boost";
+export type HeatpumpDecision = "dhw_boost" | "room_overheating" | "buffer_tank_boost";
 export interface EnyoDiagnosticsForecastInverterAppliance {
     type: EnyoApplianceTypeEnum.Inverter;
     applianceId: string;
@@ -159,10 +159,14 @@ export interface EnyoDiagnosticsStorageControlCommand {
     type: EnyoApplianceTypeEnum.Storage;
     /** Target appliance ID. */
     applianceId: string;
+    /** ISO 8601 timestamp when this command starts. */
+    timestampIso: string;
     /** Control decision for the battery. */
     decision: BatteryDecision;
     /** Target power in Watts. */
     powerW: number;
+    /** Duration of this command in minutes. */
+    durationInMinutes: number;
     /** Optional target state of charge as a percentage. */
     targetSoCPercent?: number;
 }
@@ -171,10 +175,14 @@ export interface EnyoDiagnosticsChargerControlCommand {
     type: EnyoApplianceTypeEnum.Charger;
     /** Target appliance ID. */
     applianceId: string;
+    /** ISO 8601 timestamp when this command starts. */
+    timestampIso: string;
     /** Control decision for the EV charger. */
     decision: EvDecision;
     /** Charging power in Watts. */
     chargingPowerW: number;
+    /** Duration of this command in minutes. */
+    durationInMinutes: number;
     /** Optional charging limit in kW. */
     chargingLimitKw?: number;
 }
@@ -183,30 +191,23 @@ export interface EnyoDiagnosticsHeatpumpControlCommand {
     type: EnyoApplianceTypeEnum.Heatpump;
     /** Target appliance ID. */
     applianceId: string;
+    /** ISO 8601 timestamp when this command starts. */
+    timestampIso: string;
     /** Control decision for the heat pump. */
     decision: HeatpumpDecision;
     /** Target power in Watts. */
     powerW: number;
+    /** Duration of this command in minutes. */
+    durationInMinutes: number;
     /** Optional target temperature in Celsius. */
     targetTempC?: number;
 }
 /** Union of all appliance control command types. */
 export type EnyoDiagnosticsApplianceControlCommand = EnyoDiagnosticsStorageControlCommand | EnyoDiagnosticsChargerControlCommand | EnyoDiagnosticsHeatpumpControlCommand;
-/** A single time slot in a control plan with its associated commands. */
-export interface EnyoDiagnosticsControlSlot {
-    /** ISO 8601 timestamp for this slot. */
-    timestampIso: string;
-    /** Commands to execute during this slot. */
-    commands: EnyoDiagnosticsApplianceControlCommand[];
-    /** Estimated cost for this slot in EUR. */
-    estimatedSlotCostEur: number;
-    /** Estimated grid power in Watts for this slot. */
-    estimatedGridPowerW: number;
-}
-/** Complete control plan with time-slotted commands and cost estimates. */
+/** Complete control plan with duration-based commands and cost estimates. */
 export interface EnyoDiagnosticsControlPlan {
-    /** Time-slotted command sequence. */
-    slots: EnyoDiagnosticsControlSlot[];
+    /** Sequence of appliance control commands, each with its own duration. */
+    commands: EnyoDiagnosticsApplianceControlCommand[];
     /** ISO 8601 timestamp when this plan was generated. */
     generatedAtIso: string;
     /** Total estimated cost in EUR. */

package/dist/version.d.ts

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