@enyo-energy/energy-app-sdk 1.11.0 → 1.12.0

package/README.md

@@ -3597,6 +3597,11 @@ Notes:
 - The same breakdown is available on category-level announcements via
   `context.targets` on `EnyoFlexibilityAnnouncementContext`, so the
   per-appliance and aggregated surfaces stay in step.
+- The V2 available-power commands carry the same breakdown in the other
+  direction: `targets` on `EnyoAvailablePowerCommandData` lets the energy manager
+  say what the granted envelope is meant for, using the same vocabulary, so a
+  grant can be read against the announcement it answers. It is advisory — the
+  command's `powerW` remains the only limit.
 
 ### Settings Management
 

package/dist/cjs/types/enyo-data-bus-value.d.cts

@@ -911,6 +911,20 @@ export interface EnyoAvailablePowerCommandData {
      * Must be non-negative. The appliance must not exceed this envelope.
      */
     powerW: number;
+    /**
+     * Optional breakdown of what the granted envelope is meant for and at which
+     * power — the same "how much watt for what" vocabulary an appliance uses to
+     * announce its flexibility
+     * ({@link EnyoDataBusApplianceFlexibilityAnnouncementV1}), so a grant can be
+     * read against the announcement it answers.
+     *
+     * Advisory, and never a second limit: `powerW` alone bounds what the
+     * appliance may draw. The shares SHOULD NOT exceed `powerW` in sum, may be
+     * partial, and a given target SHOULD appear at most once. An appliance that
+     * does not understand a target should fall back to spending the envelope as
+     * it sees fit rather than refusing it.
+     */
+    targets?: EnyoFlexibilityTargetPower[];
     /** Optional reason why this command was issued */
     reason?: EnyoDataBusCommandReason;
 }
@@ -2287,7 +2301,8 @@ export interface EnyoPowerSourceShare {
 /**
  * V2 command announcing the available / maximum active-power envelope (in
  * Watts) a heatpump may draw, together with optional context describing what
- * the power should be used for ({@link EnyoHeatpumpControlPurposeEnum}) and
+ * the power should be used for ({@link EnyoHeatpumpControlPurposeEnum}), how it
+ * splits across targets ({@link EnyoAvailablePowerCommandData.targets}), and
  * where it comes from ({@link EnyoPowerSourceShare}). Supersedes the deprecated
  * {@link EnyoDataBusHeatpumpAvailablePowerAnnouncementV1}.
  *
@@ -2304,6 +2319,14 @@ export interface EnyoDataBusSetHeatpumpAvailablePowerV2 extends EnyoDataBusMessa
         /**
          * What the heatpump should use the announced power for (e.g. DHW boost,
          * pre-heating). Advisory — the appliance may still apply its own logic.
+         *
+         * This names a single intent for the whole envelope, and covers intents
+         * that are not a heat sink at all ({@link
+         * EnyoHeatpumpControlPurposeEnum.PreHeating}). To instead split the
+         * envelope across sinks — "1500 W for hot water, 800 W for the buffer
+         * tank" — use {@link EnyoAvailablePowerCommandData.targets}. The two may
+         * be sent together; they are separate vocabularies and neither is derived
+         * from the other.
          */
         purpose?: EnyoHeatpumpControlPurposeEnum;
         /**

package/dist/cjs/types/enyo-flexibility-announcement.cjs

@@ -47,9 +47,10 @@ var EnyoFlexibilityHeatpumpTargetTypeEnum;
     EnyoFlexibilityHeatpumpTargetTypeEnum["Dhw"] = "dhw";
 })(EnyoFlexibilityHeatpumpTargetTypeEnum || (exports.EnyoFlexibilityHeatpumpTargetTypeEnum = EnyoFlexibilityHeatpumpTargetTypeEnum = {}));
 /**
- * What an announced share of flexibility is physically aimed at — the open
- * vocabulary behind the "how much watt for what" breakdown carried by
- * {@link EnyoFlexibilityTargetPower}.
+ * What a share of power is physically aimed at — the open vocabulary behind the
+ * "how much watt for what" breakdown carried by
+ * {@link EnyoFlexibilityTargetPower}, on flexibility announcements and on the
+ * available-power commands that answer them alike.
  *
  * The members present today all describe heat sinks, because thermal appliances
  * are the first ones to split their draw. The enum is deliberately **not**

package/dist/cjs/types/enyo-flexibility-announcement.d.cts

@@ -38,9 +38,10 @@ export declare enum EnyoFlexibilityHeatpumpTargetTypeEnum {
     Dhw = "dhw"
 }
 /**
- * What an announced share of flexibility is physically aimed at — the open
- * vocabulary behind the "how much watt for what" breakdown carried by
- * {@link EnyoFlexibilityTargetPower}.
+ * What a share of power is physically aimed at — the open vocabulary behind the
+ * "how much watt for what" breakdown carried by
+ * {@link EnyoFlexibilityTargetPower}, on flexibility announcements and on the
+ * available-power commands that answer them alike.
  *
  * The members present today all describe heat sinks, because thermal appliances
  * are the first ones to split their draw. The enum is deliberately **not**
@@ -99,13 +100,22 @@ export declare enum EnyoFlexibilityOptimizationModeEnum {
     PriceLimit = "price-limit"
 }
 /**
- * How much power the announced flexibility would draw for one target — one
- * entry of the "how much watt for what" breakdown behind an announcement.
+ * How much power is meant for one target — one entry of the "how much watt for
+ * what" breakdown.
  *
- * Purely informational context: the announcement's own energy figure stays
- * authoritative. A breakdown may be partial — its entries need not sum to the
- * appliance's full draw — but a given {@link target} SHOULD appear at most once
- * per breakdown.
+ * Used in both directions, with the same shape and the same vocabulary so the
+ * two can be read against each other:
+ *
+ * - **Appliance → manager**, on a flexibility announcement: what the announced
+ *   flexibility would be spent on.
+ * - **Manager → appliance**, on an available-power command
+ *   (`EnyoAvailablePowerCommandData.targets`): what the granted envelope is
+ *   meant for.
+ *
+ * Informational in both cases — the carrying message's own energy or power
+ * figure stays authoritative, and this breakdown never acts as a second limit. A
+ * breakdown may be partial, and a given {@link target} SHOULD appear at most
+ * once per breakdown.
  *
  * @example
  * ```typescript

package/dist/cjs/version.cjs

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

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

@@ -911,6 +911,20 @@ export interface EnyoAvailablePowerCommandData {
      * Must be non-negative. The appliance must not exceed this envelope.
      */
     powerW: number;
+    /**
+     * Optional breakdown of what the granted envelope is meant for and at which
+     * power — the same "how much watt for what" vocabulary an appliance uses to
+     * announce its flexibility
+     * ({@link EnyoDataBusApplianceFlexibilityAnnouncementV1}), so a grant can be
+     * read against the announcement it answers.
+     *
+     * Advisory, and never a second limit: `powerW` alone bounds what the
+     * appliance may draw. The shares SHOULD NOT exceed `powerW` in sum, may be
+     * partial, and a given target SHOULD appear at most once. An appliance that
+     * does not understand a target should fall back to spending the envelope as
+     * it sees fit rather than refusing it.
+     */
+    targets?: EnyoFlexibilityTargetPower[];
     /** Optional reason why this command was issued */
     reason?: EnyoDataBusCommandReason;
 }
@@ -2287,7 +2301,8 @@ export interface EnyoPowerSourceShare {
 /**
  * V2 command announcing the available / maximum active-power envelope (in
  * Watts) a heatpump may draw, together with optional context describing what
- * the power should be used for ({@link EnyoHeatpumpControlPurposeEnum}) and
+ * the power should be used for ({@link EnyoHeatpumpControlPurposeEnum}), how it
+ * splits across targets ({@link EnyoAvailablePowerCommandData.targets}), and
  * where it comes from ({@link EnyoPowerSourceShare}). Supersedes the deprecated
  * {@link EnyoDataBusHeatpumpAvailablePowerAnnouncementV1}.
  *
@@ -2304,6 +2319,14 @@ export interface EnyoDataBusSetHeatpumpAvailablePowerV2 extends EnyoDataBusMessa
         /**
          * What the heatpump should use the announced power for (e.g. DHW boost,
          * pre-heating). Advisory — the appliance may still apply its own logic.
+         *
+         * This names a single intent for the whole envelope, and covers intents
+         * that are not a heat sink at all ({@link
+         * EnyoHeatpumpControlPurposeEnum.PreHeating}). To instead split the
+         * envelope across sinks — "1500 W for hot water, 800 W for the buffer
+         * tank" — use {@link EnyoAvailablePowerCommandData.targets}. The two may
+         * be sent together; they are separate vocabularies and neither is derived
+         * from the other.
          */
         purpose?: EnyoHeatpumpControlPurposeEnum;
         /**

package/dist/types/enyo-flexibility-announcement.d.ts

@@ -38,9 +38,10 @@ export declare enum EnyoFlexibilityHeatpumpTargetTypeEnum {
     Dhw = "dhw"
 }
 /**
- * What an announced share of flexibility is physically aimed at — the open
- * vocabulary behind the "how much watt for what" breakdown carried by
- * {@link EnyoFlexibilityTargetPower}.
+ * What a share of power is physically aimed at — the open vocabulary behind the
+ * "how much watt for what" breakdown carried by
+ * {@link EnyoFlexibilityTargetPower}, on flexibility announcements and on the
+ * available-power commands that answer them alike.
  *
  * The members present today all describe heat sinks, because thermal appliances
  * are the first ones to split their draw. The enum is deliberately **not**
@@ -99,13 +100,22 @@ export declare enum EnyoFlexibilityOptimizationModeEnum {
     PriceLimit = "price-limit"
 }
 /**
- * How much power the announced flexibility would draw for one target — one
- * entry of the "how much watt for what" breakdown behind an announcement.
+ * How much power is meant for one target — one entry of the "how much watt for
+ * what" breakdown.
  *
- * Purely informational context: the announcement's own energy figure stays
- * authoritative. A breakdown may be partial — its entries need not sum to the
- * appliance's full draw — but a given {@link target} SHOULD appear at most once
- * per breakdown.
+ * Used in both directions, with the same shape and the same vocabulary so the
+ * two can be read against each other:
+ *
+ * - **Appliance → manager**, on a flexibility announcement: what the announced
+ *   flexibility would be spent on.
+ * - **Manager → appliance**, on an available-power command
+ *   (`EnyoAvailablePowerCommandData.targets`): what the granted envelope is
+ *   meant for.
+ *
+ * Informational in both cases — the carrying message's own energy or power
+ * figure stays authoritative, and this breakdown never acts as a second limit. A
+ * breakdown may be partial, and a given {@link target} SHOULD appear at most
+ * once per breakdown.
  *
  * @example
  * ```typescript

package/dist/types/enyo-flexibility-announcement.js

@@ -44,9 +44,10 @@ export var EnyoFlexibilityHeatpumpTargetTypeEnum;
     EnyoFlexibilityHeatpumpTargetTypeEnum["Dhw"] = "dhw";
 })(EnyoFlexibilityHeatpumpTargetTypeEnum || (EnyoFlexibilityHeatpumpTargetTypeEnum = {}));
 /**
- * What an announced share of flexibility is physically aimed at — the open
- * vocabulary behind the "how much watt for what" breakdown carried by
- * {@link EnyoFlexibilityTargetPower}.
+ * What a share of power is physically aimed at — the open vocabulary behind the
+ * "how much watt for what" breakdown carried by
+ * {@link EnyoFlexibilityTargetPower}, on flexibility announcements and on the
+ * available-power commands that answer them alike.
  *
  * The members present today all describe heat sinks, because thermal appliances
  * are the first ones to split their draw. The enum is deliberately **not**

package/dist/version.d.ts

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