@enyo-energy/energy-app-sdk 0.0.136 → 0.0.138

package/dist/cjs/packages/eebus/eebus-hvac-client.d.cts

@@ -11,7 +11,8 @@ import { EebusHvacOperationMode, EebusHvacZoneState } from '../../types/enyo-eeb
  * The client exposes both actor roles on a single interface:
  * - **EMS role (outbound):** {@link getOperationMode}, {@link setOperationMode},
  *   {@link getZoneStates}, {@link onZoneStateChanged}
- * - **CS role (inbound):** {@link provideOperationMode}, {@link provideZoneStates}
+ * - **CS role (inbound):** {@link provideOperationMode}, {@link provideZoneStates},
+ *   {@link onOperationModeReceived}
  *
  * Consumers that only act in one role simply never call the other half — there
  * is no `asManager` / `asAppliance` split.
@@ -54,7 +55,17 @@ export interface EebusHvacClient {
      */
     provideZoneStates: (provider: () => Promise<EebusHvacZoneState[]>) => void;
     /**
-     * Remove a listener previously registered via {@link onZoneStateChanged}.
+     * Register a handler invoked when a remote EMS writes the operation mode
+     * to this device. Implementations should apply the mode to the local
+     * controller. Mirrors {@link EebusSetpointClient.onSetpointReceived} so
+     * package authors see a consistent write-handler shape across features.
+     * @param handler Callback invoked with the incoming operation mode
+     * @returns Listener ID that can be passed to {@link removeListener} to deregister
+     */
+    onOperationModeReceived: (handler: (mode: EebusHvacOperationMode) => Promise<void>) => string;
+    /**
+     * Remove a listener previously registered via {@link onZoneStateChanged}
+     * or {@link onOperationModeReceived}.
      * @param listenerId The ID returned by the registration method
      */
     removeListener: (listenerId: string) => void;

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

@@ -122,6 +122,7 @@ var EnyoDataBusMessageEnum;
     EnyoDataBusMessageEnum["PauseChargingV1"] = "PauseChargingV1";
     EnyoDataBusMessageEnum["ResumeChargingV1"] = "ResumeChargingV1";
     EnyoDataBusMessageEnum["ChangeChargingPowerV1"] = "ChangeChargingPowerV1";
+    EnyoDataBusMessageEnum["ChangeChargeModeV1"] = "ChangeChargeModeV1";
     EnyoDataBusMessageEnum["SetChargingScheduleV1"] = "SetChargingScheduleV1";
     EnyoDataBusMessageEnum["StartChargeV1"] = "StartChargeV1";
     EnyoDataBusMessageEnum["StopChargeV1"] = "StopChargeV1";
@@ -162,6 +163,8 @@ var EnyoDataBusMessageEnum;
     EnyoDataBusMessageEnum["StartAirConditioningV1"] = "StartAirConditioningV1";
     EnyoDataBusMessageEnum["StopAirConditioningV1"] = "StopAirConditioningV1";
     EnyoDataBusMessageEnum["VehicleSocUpdateV1"] = "VehicleSocUpdateV1";
+    EnyoDataBusMessageEnum["StartCalibrationV1"] = "StartCalibrationV1";
+    EnyoDataBusMessageEnum["StopCalibrationV1"] = "StopCalibrationV1";
 })(EnyoDataBusMessageEnum || (exports.EnyoDataBusMessageEnum = EnyoDataBusMessageEnum = {}));
 /**
  * Possible answers an appliance can give when acknowledging a command.

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

@@ -162,6 +162,7 @@ export declare enum EnyoDataBusMessageEnum {
     PauseChargingV1 = "PauseChargingV1",
     ResumeChargingV1 = "ResumeChargingV1",
     ChangeChargingPowerV1 = "ChangeChargingPowerV1",
+    ChangeChargeModeV1 = "ChangeChargeModeV1",
     SetChargingScheduleV1 = "SetChargingScheduleV1",
     StartChargeV1 = "StartChargeV1",
     StopChargeV1 = "StopChargeV1",
@@ -201,7 +202,9 @@ export declare enum EnyoDataBusMessageEnum {
     AirConditioningTemperaturesUpdateV1 = "AirConditioningTemperaturesUpdateV1",
     StartAirConditioningV1 = "StartAirConditioningV1",
     StopAirConditioningV1 = "StopAirConditioningV1",
-    VehicleSocUpdateV1 = "VehicleSocUpdateV1"
+    VehicleSocUpdateV1 = "VehicleSocUpdateV1",
+    StartCalibrationV1 = "StartCalibrationV1",
+    StopCalibrationV1 = "StopCalibrationV1"
 }
 export type EnyoDataBusMessageResolution = '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
 /**
@@ -562,6 +565,36 @@ export interface EnyoDataBusChangeChargingPowerV1 extends EnyoDataBusMessage {
         reason?: EnyoDataBusCommandReason;
     };
 }
+/**
+ * Command message to change the charge mode of an active or upcoming
+ * charging session on a specific charger. Allows switching between e.g.
+ * immediate, cost-optimized, or price-limit charging without stopping
+ * and restarting the session.
+ *
+ * The receiving integration should answer with an
+ * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
+ * message's `id` to indicate whether the mode change was accepted,
+ * rejected, or is not supported.
+ */
+export interface EnyoDataBusChangeChargeModeV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.ChangeChargeModeV1;
+    /** ID of the charger appliance whose charge mode should be changed */
+    applianceId: string;
+    data: {
+        /** The new charge mode to apply to the session */
+        chargeMode: EnyoChargeModeEnum;
+        /**
+         * Optional ISO timestamp for target completion time. Relevant for
+         * modes such as {@link EnyoChargeModeEnum.CostOptimized} or
+         * {@link EnyoChargeModeEnum.PriceLimit} that need a deadline to
+         * plan against.
+         */
+        completeChargeAtIso?: string;
+        /** Optional reason why this command was issued */
+        reason?: EnyoDataBusCommandReason;
+    };
+}
 export interface EnyoDataBusSetChargingScheduleV1 extends EnyoDataBusMessage {
     type: 'message';
     message: EnyoDataBusMessageEnum.SetChargingScheduleV1;
@@ -1399,3 +1432,44 @@ export interface EnyoDataBusVehicleSocUpdateV1 extends EnyoDataBusMessage {
         batterySizeKwh?: number;
     };
 }
+/**
+ * Command message to start a calibration routine on a specific appliance.
+ * Calibration is a vendor- and appliance-specific procedure (e.g. zeroing
+ * a meter, learning a power range, aligning sensors); the targeted
+ * integration decides what calibration entails for the given appliance.
+ *
+ * The receiving integration must answer with an
+ * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
+ * message's `id` to indicate whether the calibration was accepted,
+ * rejected, or is not supported by the appliance.
+ */
+export interface EnyoDataBusStartCalibrationV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.StartCalibrationV1;
+    /** ID of the appliance to start calibration on */
+    applianceId: string;
+    data: {
+        /** Optional reason why this command was issued */
+        reason?: EnyoDataBusCommandReason;
+    };
+}
+/**
+ * Command message to stop a calibration routine that is currently running
+ * on a specific appliance. The targeted integration is expected to abort
+ * any in-progress calibration for the addressed appliance.
+ *
+ * The receiving integration must answer with an
+ * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
+ * message's `id` to indicate whether the stop request was accepted,
+ * rejected, or is not supported by the appliance.
+ */
+export interface EnyoDataBusStopCalibrationV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.StopCalibrationV1;
+    /** ID of the appliance to stop calibration on */
+    applianceId: string;
+    data: {
+        /** Optional reason why this command was issued */
+        reason?: EnyoDataBusCommandReason;
+    };
+}

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

package/dist/packages/eebus/eebus-hvac-client.d.ts

@@ -11,7 +11,8 @@ import { EebusHvacOperationMode, EebusHvacZoneState } from '../../types/enyo-eeb
  * The client exposes both actor roles on a single interface:
  * - **EMS role (outbound):** {@link getOperationMode}, {@link setOperationMode},
  *   {@link getZoneStates}, {@link onZoneStateChanged}
- * - **CS role (inbound):** {@link provideOperationMode}, {@link provideZoneStates}
+ * - **CS role (inbound):** {@link provideOperationMode}, {@link provideZoneStates},
+ *   {@link onOperationModeReceived}
  *
  * Consumers that only act in one role simply never call the other half — there
  * is no `asManager` / `asAppliance` split.
@@ -54,7 +55,17 @@ export interface EebusHvacClient {
      */
     provideZoneStates: (provider: () => Promise<EebusHvacZoneState[]>) => void;
     /**
-     * Remove a listener previously registered via {@link onZoneStateChanged}.
+     * Register a handler invoked when a remote EMS writes the operation mode
+     * to this device. Implementations should apply the mode to the local
+     * controller. Mirrors {@link EebusSetpointClient.onSetpointReceived} so
+     * package authors see a consistent write-handler shape across features.
+     * @param handler Callback invoked with the incoming operation mode
+     * @returns Listener ID that can be passed to {@link removeListener} to deregister
+     */
+    onOperationModeReceived: (handler: (mode: EebusHvacOperationMode) => Promise<void>) => string;
+    /**
+     * Remove a listener previously registered via {@link onZoneStateChanged}
+     * or {@link onOperationModeReceived}.
      * @param listenerId The ID returned by the registration method
      */
     removeListener: (listenerId: string) => void;

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

@@ -162,6 +162,7 @@ export declare enum EnyoDataBusMessageEnum {
     PauseChargingV1 = "PauseChargingV1",
     ResumeChargingV1 = "ResumeChargingV1",
     ChangeChargingPowerV1 = "ChangeChargingPowerV1",
+    ChangeChargeModeV1 = "ChangeChargeModeV1",
     SetChargingScheduleV1 = "SetChargingScheduleV1",
     StartChargeV1 = "StartChargeV1",
     StopChargeV1 = "StopChargeV1",
@@ -201,7 +202,9 @@ export declare enum EnyoDataBusMessageEnum {
     AirConditioningTemperaturesUpdateV1 = "AirConditioningTemperaturesUpdateV1",
     StartAirConditioningV1 = "StartAirConditioningV1",
     StopAirConditioningV1 = "StopAirConditioningV1",
-    VehicleSocUpdateV1 = "VehicleSocUpdateV1"
+    VehicleSocUpdateV1 = "VehicleSocUpdateV1",
+    StartCalibrationV1 = "StartCalibrationV1",
+    StopCalibrationV1 = "StopCalibrationV1"
 }
 export type EnyoDataBusMessageResolution = '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
 /**
@@ -562,6 +565,36 @@ export interface EnyoDataBusChangeChargingPowerV1 extends EnyoDataBusMessage {
         reason?: EnyoDataBusCommandReason;
     };
 }
+/**
+ * Command message to change the charge mode of an active or upcoming
+ * charging session on a specific charger. Allows switching between e.g.
+ * immediate, cost-optimized, or price-limit charging without stopping
+ * and restarting the session.
+ *
+ * The receiving integration should answer with an
+ * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
+ * message's `id` to indicate whether the mode change was accepted,
+ * rejected, or is not supported.
+ */
+export interface EnyoDataBusChangeChargeModeV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.ChangeChargeModeV1;
+    /** ID of the charger appliance whose charge mode should be changed */
+    applianceId: string;
+    data: {
+        /** The new charge mode to apply to the session */
+        chargeMode: EnyoChargeModeEnum;
+        /**
+         * Optional ISO timestamp for target completion time. Relevant for
+         * modes such as {@link EnyoChargeModeEnum.CostOptimized} or
+         * {@link EnyoChargeModeEnum.PriceLimit} that need a deadline to
+         * plan against.
+         */
+        completeChargeAtIso?: string;
+        /** Optional reason why this command was issued */
+        reason?: EnyoDataBusCommandReason;
+    };
+}
 export interface EnyoDataBusSetChargingScheduleV1 extends EnyoDataBusMessage {
     type: 'message';
     message: EnyoDataBusMessageEnum.SetChargingScheduleV1;
@@ -1399,3 +1432,44 @@ export interface EnyoDataBusVehicleSocUpdateV1 extends EnyoDataBusMessage {
         batterySizeKwh?: number;
     };
 }
+/**
+ * Command message to start a calibration routine on a specific appliance.
+ * Calibration is a vendor- and appliance-specific procedure (e.g. zeroing
+ * a meter, learning a power range, aligning sensors); the targeted
+ * integration decides what calibration entails for the given appliance.
+ *
+ * The receiving integration must answer with an
+ * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
+ * message's `id` to indicate whether the calibration was accepted,
+ * rejected, or is not supported by the appliance.
+ */
+export interface EnyoDataBusStartCalibrationV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.StartCalibrationV1;
+    /** ID of the appliance to start calibration on */
+    applianceId: string;
+    data: {
+        /** Optional reason why this command was issued */
+        reason?: EnyoDataBusCommandReason;
+    };
+}
+/**
+ * Command message to stop a calibration routine that is currently running
+ * on a specific appliance. The targeted integration is expected to abort
+ * any in-progress calibration for the addressed appliance.
+ *
+ * The receiving integration must answer with an
+ * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
+ * message's `id` to indicate whether the stop request was accepted,
+ * rejected, or is not supported by the appliance.
+ */
+export interface EnyoDataBusStopCalibrationV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.StopCalibrationV1;
+    /** ID of the appliance to stop calibration on */
+    applianceId: string;
+    data: {
+        /** Optional reason why this command was issued */
+        reason?: EnyoDataBusCommandReason;
+    };
+}

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

@@ -119,6 +119,7 @@ export var EnyoDataBusMessageEnum;
     EnyoDataBusMessageEnum["PauseChargingV1"] = "PauseChargingV1";
     EnyoDataBusMessageEnum["ResumeChargingV1"] = "ResumeChargingV1";
     EnyoDataBusMessageEnum["ChangeChargingPowerV1"] = "ChangeChargingPowerV1";
+    EnyoDataBusMessageEnum["ChangeChargeModeV1"] = "ChangeChargeModeV1";
     EnyoDataBusMessageEnum["SetChargingScheduleV1"] = "SetChargingScheduleV1";
     EnyoDataBusMessageEnum["StartChargeV1"] = "StartChargeV1";
     EnyoDataBusMessageEnum["StopChargeV1"] = "StopChargeV1";
@@ -159,6 +160,8 @@ export var EnyoDataBusMessageEnum;
     EnyoDataBusMessageEnum["StartAirConditioningV1"] = "StartAirConditioningV1";
     EnyoDataBusMessageEnum["StopAirConditioningV1"] = "StopAirConditioningV1";
     EnyoDataBusMessageEnum["VehicleSocUpdateV1"] = "VehicleSocUpdateV1";
+    EnyoDataBusMessageEnum["StartCalibrationV1"] = "StartCalibrationV1";
+    EnyoDataBusMessageEnum["StopCalibrationV1"] = "StopCalibrationV1";
 })(EnyoDataBusMessageEnum || (EnyoDataBusMessageEnum = {}));
 /**
  * Possible answers an appliance can give when acknowledging a command.

package/dist/version.d.ts

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