@enyo-energy/energy-app-sdk 1.4.0 → 1.5.0

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnyoPowerSourceEnum = exports.EnyoHeatpumpControlPurposeEnum = exports.EnyoChargingProfileTypeEnum = exports.EnyoCommandAcknowledgeAnswerEnum = exports.EnyoStorageControlDirectionEnum = exports.EnyoStorageControlModeEnum = exports.EnyoStorageScheduleDirectionEnum = exports.EnyoStorageScheduleModeEnum = exports.EnyoChargingLimitRequestResultEnum = exports.EnyoDataBusMessageEnum = exports.EnyoChargeInitiatorEnum = exports.EnyoChargeModeEnum = exports.EnyoChargingStopReason = exports.EnyoChargingMeterValueContext = exports.EnyoStringStateEnum = exports.EnyoHeatingRodStateEnum = exports.EnyoInverterStateEnum = exports.EnyoBatteryStateEnum = exports.EnyoGridOperatorLimitTypeEnum = exports.EnyoDataBusCommandReasonCategoryEnum = exports.EnyoDataBusCommandReasonTypeEnum = void 0;
+exports.EnyoPowerSourceEnum = exports.EnyoHeatpumpHeatSourceEnum = exports.EnyoHeatpumpControlPurposeEnum = exports.EnyoChargingProfileTypeEnum = exports.EnyoCommandAcknowledgeAnswerEnum = exports.EnyoStorageControlDirectionEnum = exports.EnyoStorageControlModeEnum = exports.EnyoStorageScheduleDirectionEnum = exports.EnyoStorageScheduleModeEnum = exports.EnyoChargingLimitRequestResultEnum = exports.EnyoDataBusMessageEnum = exports.EnyoChargeInitiatorEnum = exports.EnyoChargeModeEnum = exports.EnyoChargingStopReason = exports.EnyoChargingMeterValueContext = exports.EnyoStringStateEnum = exports.EnyoHeatingRodStateEnum = exports.EnyoInverterStateEnum = exports.EnyoBatteryStateEnum = exports.EnyoGridOperatorLimitTypeEnum = exports.EnyoDataBusCommandReasonCategoryEnum = exports.EnyoDataBusCommandReasonTypeEnum = void 0;
 /**
  * Enum representing the reason type for why a data bus command was issued.
  * Used to attach context to commands for logging, debugging, and UI display.
@@ -417,6 +417,40 @@ var EnyoHeatpumpControlPurposeEnum;
     /** Use the power for space cooling (reversible heatpumps) */
     EnyoHeatpumpControlPurposeEnum["Cooling"] = "cooling";
 })(EnyoHeatpumpControlPurposeEnum || (exports.EnyoHeatpumpControlPurposeEnum = EnyoHeatpumpControlPurposeEnum = {}));
+/**
+ * Which heat source an announced available-power envelope is meant to be spent
+ * on.
+ *
+ * The two sources are not interchangeable: a compressor moves several units of
+ * heat per unit of electricity and its draw is worth shifting in time, while a
+ * heating rod is resistive and returns roughly one. Granting PV surplus without
+ * saying which to use lets an appliance dump it into the rod, which is the
+ * worst available answer for the same Watts.
+ *
+ * Reported back through {@link EnyoDataBusHeatpumpValuesV1}'s
+ * `compressorRunning` / `heatingRodRunning`, so a sender can see whether the
+ * target was honoured.
+ */
+var EnyoHeatpumpHeatSourceEnum;
+(function (EnyoHeatpumpHeatSourceEnum) {
+    /**
+     * Spend the power on the compressor. The integrated heating rod should stay
+     * off for the duration of this envelope.
+     */
+    EnyoHeatpumpHeatSourceEnum["Compressor"] = "compressor";
+    /**
+     * Spend the power on the integrated heating rod — for example to absorb a
+     * surplus the compressor's modulation band cannot take, or when the
+     * compressor is unavailable.
+     */
+    EnyoHeatpumpHeatSourceEnum["HeatingRod"] = "heating-rod";
+    /**
+     * Either source, or both at once. Explicitly permits bivalent operation,
+     * where the rod runs alongside the compressor to meet demand the compressor
+     * alone cannot.
+     */
+    EnyoHeatpumpHeatSourceEnum["Both"] = "both";
+})(EnyoHeatpumpHeatSourceEnum || (exports.EnyoHeatpumpHeatSourceEnum = EnyoHeatpumpHeatSourceEnum = {}));
 /**
  * Where an announced available-power envelope is expected to originate from.
  * Used to give appliances (and analytics) insight into whether the granted

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

@@ -450,6 +450,36 @@ export interface EnyoDataBusHeatpumpValuesV1 extends EnyoDataBusMessage {
             heatGenerationHeatingWh?: number;
             /** Power generation for domestic hot water in Wh (meter value)*/
             heatGenerationDomesticHotWaterWh?: number;
+            /**
+             * Whether the compressor is drawing power at this moment.
+             *
+             * Optional context for {@link powerW}: the same 4 kW draw means
+             * something different depending on which heat source produced it,
+             * and only the appliance knows which. A compressor's consumption
+             * moves with its modulation band and is worth shifting in time; a
+             * heating rod's does not.
+             *
+             * Omit when the appliance does not report it — `undefined` means
+             * "not known", which is not the same as `false`.
+             */
+            compressorRunning?: boolean;
+            /**
+             * Whether the heat pump's integrated heating rod (backup /
+             * auxiliary resistive element) is energized at this moment.
+             *
+             * May be `true` at the same time as {@link compressorRunning}:
+             * bivalent operation runs the rod alongside the compressor when the
+             * compressor alone cannot meet demand, and that combination is
+             * usually the most expensive state the appliance can be in.
+             *
+             * This is the rod built into the heat pump. A heating rod that is a
+             * separate appliance reports its own state through
+             * {@link EnyoDataBusHeatingRodValuesV1} instead.
+             *
+             * Omit when the appliance does not report it — `undefined` means
+             * "not known", which is not the same as `false`.
+             */
+            heatingRodRunning?: boolean;
         };
         /** Grid operator power limitation currently applied by the heatpump, if any */
         gridOperatorLimit?: EnyoGridOperatorLimit;
@@ -2139,6 +2169,39 @@ export declare enum EnyoHeatpumpControlPurposeEnum {
     /** Use the power for space cooling (reversible heatpumps) */
     Cooling = "cooling"
 }
+/**
+ * Which heat source an announced available-power envelope is meant to be spent
+ * on.
+ *
+ * The two sources are not interchangeable: a compressor moves several units of
+ * heat per unit of electricity and its draw is worth shifting in time, while a
+ * heating rod is resistive and returns roughly one. Granting PV surplus without
+ * saying which to use lets an appliance dump it into the rod, which is the
+ * worst available answer for the same Watts.
+ *
+ * Reported back through {@link EnyoDataBusHeatpumpValuesV1}'s
+ * `compressorRunning` / `heatingRodRunning`, so a sender can see whether the
+ * target was honoured.
+ */
+export declare enum EnyoHeatpumpHeatSourceEnum {
+    /**
+     * Spend the power on the compressor. The integrated heating rod should stay
+     * off for the duration of this envelope.
+     */
+    Compressor = "compressor",
+    /**
+     * Spend the power on the integrated heating rod — for example to absorb a
+     * surplus the compressor's modulation band cannot take, or when the
+     * compressor is unavailable.
+     */
+    HeatingRod = "heating-rod",
+    /**
+     * Either source, or both at once. Explicitly permits bivalent operation,
+     * where the rod runs alongside the compressor to meet demand the compressor
+     * alone cannot.
+     */
+    Both = "both"
+}
 /**
  * Where an announced available-power envelope is expected to originate from.
  * Used to give appliances (and analytics) insight into whether the granted
@@ -2184,6 +2247,24 @@ export interface EnyoDataBusSetHeatpumpAvailablePowerV2 extends EnyoDataBusMessa
          * pre-heating). Advisory — the appliance may still apply its own logic.
          */
         purpose?: EnyoHeatpumpControlPurposeEnum;
+        /**
+         * Which heat source the announced power should be spent on — the
+         * compressor, the integrated heating rod, or either.
+         *
+         * Where {@link purpose} says *what for*, this says *with what*. Set it
+         * when the distinction matters to the sender: PV surplus is normally
+         * worth far more through the compressor, while a rod is the right sink
+         * for a surplus the compressor cannot absorb.
+         *
+         * Omit to leave the choice to the appliance — omission is not the same
+         * as {@link EnyoHeatpumpHeatSourceEnum.Both}, which actively permits
+         * running the rod alongside the compressor.
+         *
+         * Advisory, like {@link purpose}: the appliance may override it when
+         * safety or comfort requires, for example to run a legionella cycle or
+         * a defrost that needs the rod.
+         */
+        desiredTarget?: EnyoHeatpumpHeatSourceEnum;
         /**
          * Optional breakdown of the announced envelope by source (PV / battery /
          * grid). When present, the shares should sum to {@link data.powerW}.

package/dist/cjs/version.cjs

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

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

@@ -450,6 +450,36 @@ export interface EnyoDataBusHeatpumpValuesV1 extends EnyoDataBusMessage {
             heatGenerationHeatingWh?: number;
             /** Power generation for domestic hot water in Wh (meter value)*/
             heatGenerationDomesticHotWaterWh?: number;
+            /**
+             * Whether the compressor is drawing power at this moment.
+             *
+             * Optional context for {@link powerW}: the same 4 kW draw means
+             * something different depending on which heat source produced it,
+             * and only the appliance knows which. A compressor's consumption
+             * moves with its modulation band and is worth shifting in time; a
+             * heating rod's does not.
+             *
+             * Omit when the appliance does not report it — `undefined` means
+             * "not known", which is not the same as `false`.
+             */
+            compressorRunning?: boolean;
+            /**
+             * Whether the heat pump's integrated heating rod (backup /
+             * auxiliary resistive element) is energized at this moment.
+             *
+             * May be `true` at the same time as {@link compressorRunning}:
+             * bivalent operation runs the rod alongside the compressor when the
+             * compressor alone cannot meet demand, and that combination is
+             * usually the most expensive state the appliance can be in.
+             *
+             * This is the rod built into the heat pump. A heating rod that is a
+             * separate appliance reports its own state through
+             * {@link EnyoDataBusHeatingRodValuesV1} instead.
+             *
+             * Omit when the appliance does not report it — `undefined` means
+             * "not known", which is not the same as `false`.
+             */
+            heatingRodRunning?: boolean;
         };
         /** Grid operator power limitation currently applied by the heatpump, if any */
         gridOperatorLimit?: EnyoGridOperatorLimit;
@@ -2139,6 +2169,39 @@ export declare enum EnyoHeatpumpControlPurposeEnum {
     /** Use the power for space cooling (reversible heatpumps) */
     Cooling = "cooling"
 }
+/**
+ * Which heat source an announced available-power envelope is meant to be spent
+ * on.
+ *
+ * The two sources are not interchangeable: a compressor moves several units of
+ * heat per unit of electricity and its draw is worth shifting in time, while a
+ * heating rod is resistive and returns roughly one. Granting PV surplus without
+ * saying which to use lets an appliance dump it into the rod, which is the
+ * worst available answer for the same Watts.
+ *
+ * Reported back through {@link EnyoDataBusHeatpumpValuesV1}'s
+ * `compressorRunning` / `heatingRodRunning`, so a sender can see whether the
+ * target was honoured.
+ */
+export declare enum EnyoHeatpumpHeatSourceEnum {
+    /**
+     * Spend the power on the compressor. The integrated heating rod should stay
+     * off for the duration of this envelope.
+     */
+    Compressor = "compressor",
+    /**
+     * Spend the power on the integrated heating rod — for example to absorb a
+     * surplus the compressor's modulation band cannot take, or when the
+     * compressor is unavailable.
+     */
+    HeatingRod = "heating-rod",
+    /**
+     * Either source, or both at once. Explicitly permits bivalent operation,
+     * where the rod runs alongside the compressor to meet demand the compressor
+     * alone cannot.
+     */
+    Both = "both"
+}
 /**
  * Where an announced available-power envelope is expected to originate from.
  * Used to give appliances (and analytics) insight into whether the granted
@@ -2184,6 +2247,24 @@ export interface EnyoDataBusSetHeatpumpAvailablePowerV2 extends EnyoDataBusMessa
          * pre-heating). Advisory — the appliance may still apply its own logic.
          */
         purpose?: EnyoHeatpumpControlPurposeEnum;
+        /**
+         * Which heat source the announced power should be spent on — the
+         * compressor, the integrated heating rod, or either.
+         *
+         * Where {@link purpose} says *what for*, this says *with what*. Set it
+         * when the distinction matters to the sender: PV surplus is normally
+         * worth far more through the compressor, while a rod is the right sink
+         * for a surplus the compressor cannot absorb.
+         *
+         * Omit to leave the choice to the appliance — omission is not the same
+         * as {@link EnyoHeatpumpHeatSourceEnum.Both}, which actively permits
+         * running the rod alongside the compressor.
+         *
+         * Advisory, like {@link purpose}: the appliance may override it when
+         * safety or comfort requires, for example to run a legionella cycle or
+         * a defrost that needs the rod.
+         */
+        desiredTarget?: EnyoHeatpumpHeatSourceEnum;
         /**
          * Optional breakdown of the announced envelope by source (PV / battery /
          * grid). When present, the shares should sum to {@link data.powerW}.

package/dist/types/enyo-data-bus-value.js

@@ -414,6 +414,40 @@ export var EnyoHeatpumpControlPurposeEnum;
     /** Use the power for space cooling (reversible heatpumps) */
     EnyoHeatpumpControlPurposeEnum["Cooling"] = "cooling";
 })(EnyoHeatpumpControlPurposeEnum || (EnyoHeatpumpControlPurposeEnum = {}));
+/**
+ * Which heat source an announced available-power envelope is meant to be spent
+ * on.
+ *
+ * The two sources are not interchangeable: a compressor moves several units of
+ * heat per unit of electricity and its draw is worth shifting in time, while a
+ * heating rod is resistive and returns roughly one. Granting PV surplus without
+ * saying which to use lets an appliance dump it into the rod, which is the
+ * worst available answer for the same Watts.
+ *
+ * Reported back through {@link EnyoDataBusHeatpumpValuesV1}'s
+ * `compressorRunning` / `heatingRodRunning`, so a sender can see whether the
+ * target was honoured.
+ */
+export var EnyoHeatpumpHeatSourceEnum;
+(function (EnyoHeatpumpHeatSourceEnum) {
+    /**
+     * Spend the power on the compressor. The integrated heating rod should stay
+     * off for the duration of this envelope.
+     */
+    EnyoHeatpumpHeatSourceEnum["Compressor"] = "compressor";
+    /**
+     * Spend the power on the integrated heating rod — for example to absorb a
+     * surplus the compressor's modulation band cannot take, or when the
+     * compressor is unavailable.
+     */
+    EnyoHeatpumpHeatSourceEnum["HeatingRod"] = "heating-rod";
+    /**
+     * Either source, or both at once. Explicitly permits bivalent operation,
+     * where the rod runs alongside the compressor to meet demand the compressor
+     * alone cannot.
+     */
+    EnyoHeatpumpHeatSourceEnum["Both"] = "both";
+})(EnyoHeatpumpHeatSourceEnum || (EnyoHeatpumpHeatSourceEnum = {}));
 /**
  * Where an announced available-power envelope is expected to originate from.
  * Used to give appliances (and analytics) insight into whether the granted

package/dist/version.d.ts

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