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

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

@@ -139,6 +139,11 @@ export interface EnergyAppBluetooth {
      * @returns Promise resolving with an active {@link EnergyAppBluetoothSession}.
      */
     connect(address: string, options?: EnergyAppBluetoothConnectOptions): Promise<EnergyAppBluetoothSession>;
+    /**
+     * Force-bond (SMP pairing) with a peripheral. Only required for devices that
+     * refuse GATT operations until bonded. Most BLE accessories do not need this.
+     */
+    pair(address: string, options?: EnergyAppBluetoothConnectOptions): Promise<void>;
     /**
      * Convenience scope: connects to the peripheral, runs `fn`, and always
      * disconnects (even if `fn` throws). Strongly preferred over manual

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnyoApplianceTopologyFeatureEnum = exports.EnyoApplianceConnectionType = exports.EnyoApplianceStatusEnum = exports.EnyoApplianceStateEnum = exports.EnyoApplianceTypeEnum = void 0;
+exports.EnyoApplianceTopologyFeatureEnum = exports.EnyoApplianceAvailableFeaturesEnum = exports.EnyoApplianceConnectionType = exports.EnyoApplianceStatusEnum = exports.EnyoApplianceStateEnum = exports.EnyoApplianceTypeEnum = void 0;
 var EnyoApplianceTypeEnum;
 (function (EnyoApplianceTypeEnum) {
     EnyoApplianceTypeEnum["Inverter"] = "Inverter";
@@ -40,6 +40,19 @@ var EnyoApplianceConnectionType;
     EnyoApplianceConnectionType["Connector"] = "Connector";
     EnyoApplianceConnectionType["Cloud"] = "Cloud";
 })(EnyoApplianceConnectionType || (exports.EnyoApplianceConnectionType = EnyoApplianceConnectionType = {}));
+/**
+ * General-purpose capability flags that apply to any {@link EnyoAppliance}
+ * regardless of its {@link EnyoApplianceTypeEnum}. Appliance-type-specific
+ * capabilities (e.g. charger or heatpump features) are expressed via the
+ * dedicated `availableFeatures` enums on the respective metadata interfaces.
+ */
+var EnyoApplianceAvailableFeaturesEnum;
+(function (EnyoApplianceAvailableFeaturesEnum) {
+    /** If the appliance can limit its power consumption (active power drawn from the grid/site) */
+    EnyoApplianceAvailableFeaturesEnum["LimitPowerConsumption"] = "LimitPowerConsumption";
+    /** If the appliance can limit its power production (active power fed into the grid/site) */
+    EnyoApplianceAvailableFeaturesEnum["LimitPowerProduction"] = "LimitPowerProduction";
+})(EnyoApplianceAvailableFeaturesEnum || (exports.EnyoApplianceAvailableFeaturesEnum = EnyoApplianceAvailableFeaturesEnum = {}));
 var EnyoApplianceTopologyFeatureEnum;
 (function (EnyoApplianceTopologyFeatureEnum) {
     /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */

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

@@ -118,6 +118,18 @@ export interface EnyoApplianceMetadata {
     mqtt?: EnyoApplianceMqttConfig;
     connectionType: EnyoApplianceConnectionType;
 }
+/**
+ * General-purpose capability flags that apply to any {@link EnyoAppliance}
+ * regardless of its {@link EnyoApplianceTypeEnum}. Appliance-type-specific
+ * capabilities (e.g. charger or heatpump features) are expressed via the
+ * dedicated `availableFeatures` enums on the respective metadata interfaces.
+ */
+export declare enum EnyoApplianceAvailableFeaturesEnum {
+    /** If the appliance can limit its power consumption (active power drawn from the grid/site) */
+    LimitPowerConsumption = "LimitPowerConsumption",
+    /** If the appliance can limit its power production (active power fed into the grid/site) */
+    LimitPowerProduction = "LimitPowerProduction"
+}
 export declare enum EnyoApplianceTopologyFeatureEnum {
     /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */
     PrimaryMeter = "PrimaryMeter",
@@ -145,6 +157,13 @@ export interface EnyoAppliance {
     type: EnyoApplianceTypeEnum;
     /** network device IDs associated with the appliance */
     networkDeviceIds: string[];
+    /**
+     * General-purpose capabilities supported by the appliance, independent of
+     * its {@link EnyoApplianceTypeEnum}. Appliance-type-specific capabilities
+     * are exposed via the `availableFeatures` field on the type-specific
+     * metadata (e.g. `charger.availableFeatures`).
+     */
+    availableFeatures?: EnyoApplianceAvailableFeaturesEnum[];
     /** Optional Metadata of the Appliance */
     metadata?: EnyoApplianceMetadata;
     /** Topology Information of the appliance */

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

@@ -147,6 +147,7 @@ var EnyoDataBusMessageEnum;
     EnyoDataBusMessageEnum["MaxChargingPowerChangedV1"] = "MaxChargingPowerChangedV1";
     EnyoDataBusMessageEnum["MaxDischargePowerChangedV1"] = "MaxDischargePowerChangedV1";
     EnyoDataBusMessageEnum["GridOperatorPowerLimitationV1"] = "GridOperatorPowerLimitationV1";
+    EnyoDataBusMessageEnum["GridOperatorPowerProductionLimitationV1"] = "GridOperatorPowerProductionLimitationV1";
     EnyoDataBusMessageEnum["ResetChargerV1"] = "ResetChargerV1";
     EnyoDataBusMessageEnum["RebootChargerV1"] = "RebootChargerV1";
     EnyoDataBusMessageEnum["RequestChargerLogsV1"] = "RequestChargerLogsV1";

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

@@ -7,6 +7,7 @@ import { EnyoEnergyPrices } from "./enyo-energy-prices.cjs";
 import { EnyoCurrencyEnum } from "./enyo-currency.cjs";
 import { EnyoHeatpumpApplianceModeEnum } from "./enyo-heatpump-appliance.cjs";
 import { EnyoAirConditioningApplianceModeEnum } from "./enyo-air-conditioning-appliance.cjs";
+import { EnergyAppPackageCategory } from "../energy-app-package-definition.cjs";
 /**
  * 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.
@@ -186,6 +187,7 @@ export declare enum EnyoDataBusMessageEnum {
     MaxChargingPowerChangedV1 = "MaxChargingPowerChangedV1",
     MaxDischargePowerChangedV1 = "MaxDischargePowerChangedV1",
     GridOperatorPowerLimitationV1 = "GridOperatorPowerLimitationV1",
+    GridOperatorPowerProductionLimitationV1 = "GridOperatorPowerProductionLimitationV1",
     ResetChargerV1 = "ResetChargerV1",
     RebootChargerV1 = "RebootChargerV1",
     RequestChargerLogsV1 = "RequestChargerLogsV1",
@@ -198,6 +200,29 @@ export declare enum EnyoDataBusMessageEnum {
     StopAirConditioningV1 = "StopAirConditioningV1"
 }
 export type EnyoDataBusMessageResolution = '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
+/**
+ * Optional addressing information for a {@link EnyoDataBusMessage}. When omitted
+ * the message is broadcast to all subscribers; when set, the message is only
+ * delivered to packages that match the specified target.
+ *
+ * Exactly one of {@link cloudPackageId} or {@link categories} should be provided.
+ * When both are set, consumers should treat them as an AND (the receiving package
+ * must match the cloud package id **and** belong to at least one of the listed
+ * categories). When neither is set, the target is treated as "all packages".
+ */
+export interface EnyoDataBusMessageTarget {
+    /**
+     * Target a single cloud-deployed energy app package by its package identifier.
+     * Use this when a message is intended for one specific package instance.
+     */
+    cloudPackageId?: string;
+    /**
+     * Target every energy app package whose definition declares at least one of
+     * the listed categories. Use this for category-scoped fan-out (e.g. send a
+     * grid operator limitation only to inverter and battery-storage packages).
+     */
+    categories?: EnergyAppPackageCategory[];
+}
 export interface EnyoDataBusMessage {
     id: string;
     message: EnyoDataBusMessageEnum;
@@ -208,6 +233,13 @@ export interface EnyoDataBusMessage {
     timestampIso: string;
     /** If you just forward events that occur, use dynamic as resolution */
     resolution?: EnyoDataBusMessageResolution;
+    /**
+     * Optional delivery target. When omitted the message is broadcast to all
+     * subscribers. Use this to restrict delivery to a specific cloud package or
+     * to packages matching one or more energy app categories. See
+     * {@link EnyoDataBusMessageTarget} for matching semantics.
+     */
+    target?: EnyoDataBusMessageTarget;
     data: object;
 }
 export interface EnyoDataBusMessageAnswer extends EnyoDataBusMessage {
@@ -1068,6 +1100,25 @@ export interface EnyoDataBusGridOperatorPowerLimitationV1 extends EnyoDataBusMes
         endTimestampIso: string;
     };
 }
+/**
+ * Command message for grid operator power production limitations directed at the energy manager.
+ * Communicates whether a production-side power limitation (i.e. how much power may be fed into
+ * the grid) is active, the power limit, and when it ends. The energy manager should adjust its
+ * optimization strategy accordingly (e.g. curtail PV feed-in, prefer self-consumption, charge
+ * batteries from surplus).
+ */
+export interface EnyoDataBusGridOperatorPowerProductionLimitationV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.GridOperatorPowerProductionLimitationV1;
+    data: {
+        /** Whether the grid operator power production limitation is currently active */
+        active: boolean;
+        /** The power production limitation in watts (maximum allowed feed-in power) */
+        powerLimitationW: number;
+        /** ISO 8601 timestamp when the limitation ends */
+        endTimestampIso: string;
+    };
+}
 /**
  * Command message to reset a charger appliance.
  * Sends a reset command to the specified charger, which performs a soft reset

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

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

@@ -139,6 +139,11 @@ export interface EnergyAppBluetooth {
      * @returns Promise resolving with an active {@link EnergyAppBluetoothSession}.
      */
     connect(address: string, options?: EnergyAppBluetoothConnectOptions): Promise<EnergyAppBluetoothSession>;
+    /**
+     * Force-bond (SMP pairing) with a peripheral. Only required for devices that
+     * refuse GATT operations until bonded. Most BLE accessories do not need this.
+     */
+    pair(address: string, options?: EnergyAppBluetoothConnectOptions): Promise<void>;
     /**
      * Convenience scope: connects to the peripheral, runs `fn`, and always
      * disconnects (even if `fn` throws). Strongly preferred over manual

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

@@ -118,6 +118,18 @@ export interface EnyoApplianceMetadata {
     mqtt?: EnyoApplianceMqttConfig;
     connectionType: EnyoApplianceConnectionType;
 }
+/**
+ * General-purpose capability flags that apply to any {@link EnyoAppliance}
+ * regardless of its {@link EnyoApplianceTypeEnum}. Appliance-type-specific
+ * capabilities (e.g. charger or heatpump features) are expressed via the
+ * dedicated `availableFeatures` enums on the respective metadata interfaces.
+ */
+export declare enum EnyoApplianceAvailableFeaturesEnum {
+    /** If the appliance can limit its power consumption (active power drawn from the grid/site) */
+    LimitPowerConsumption = "LimitPowerConsumption",
+    /** If the appliance can limit its power production (active power fed into the grid/site) */
+    LimitPowerProduction = "LimitPowerProduction"
+}
 export declare enum EnyoApplianceTopologyFeatureEnum {
     /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */
     PrimaryMeter = "PrimaryMeter",
@@ -145,6 +157,13 @@ export interface EnyoAppliance {
     type: EnyoApplianceTypeEnum;
     /** network device IDs associated with the appliance */
     networkDeviceIds: string[];
+    /**
+     * General-purpose capabilities supported by the appliance, independent of
+     * its {@link EnyoApplianceTypeEnum}. Appliance-type-specific capabilities
+     * are exposed via the `availableFeatures` field on the type-specific
+     * metadata (e.g. `charger.availableFeatures`).
+     */
+    availableFeatures?: EnyoApplianceAvailableFeaturesEnum[];
     /** Optional Metadata of the Appliance */
     metadata?: EnyoApplianceMetadata;
     /** Topology Information of the appliance */

package/dist/types/enyo-appliance.js

@@ -37,6 +37,19 @@ export var EnyoApplianceConnectionType;
     EnyoApplianceConnectionType["Connector"] = "Connector";
     EnyoApplianceConnectionType["Cloud"] = "Cloud";
 })(EnyoApplianceConnectionType || (EnyoApplianceConnectionType = {}));
+/**
+ * General-purpose capability flags that apply to any {@link EnyoAppliance}
+ * regardless of its {@link EnyoApplianceTypeEnum}. Appliance-type-specific
+ * capabilities (e.g. charger or heatpump features) are expressed via the
+ * dedicated `availableFeatures` enums on the respective metadata interfaces.
+ */
+export var EnyoApplianceAvailableFeaturesEnum;
+(function (EnyoApplianceAvailableFeaturesEnum) {
+    /** If the appliance can limit its power consumption (active power drawn from the grid/site) */
+    EnyoApplianceAvailableFeaturesEnum["LimitPowerConsumption"] = "LimitPowerConsumption";
+    /** If the appliance can limit its power production (active power fed into the grid/site) */
+    EnyoApplianceAvailableFeaturesEnum["LimitPowerProduction"] = "LimitPowerProduction";
+})(EnyoApplianceAvailableFeaturesEnum || (EnyoApplianceAvailableFeaturesEnum = {}));
 export var EnyoApplianceTopologyFeatureEnum;
 (function (EnyoApplianceTopologyFeatureEnum) {
     /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */

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

@@ -7,6 +7,7 @@ import { EnyoEnergyPrices } from "./enyo-energy-prices.js";
 import { EnyoCurrencyEnum } from "./enyo-currency.js";
 import { EnyoHeatpumpApplianceModeEnum } from "./enyo-heatpump-appliance.js";
 import { EnyoAirConditioningApplianceModeEnum } from "./enyo-air-conditioning-appliance.js";
+import { EnergyAppPackageCategory } from "../energy-app-package-definition.js";
 /**
  * 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.
@@ -186,6 +187,7 @@ export declare enum EnyoDataBusMessageEnum {
     MaxChargingPowerChangedV1 = "MaxChargingPowerChangedV1",
     MaxDischargePowerChangedV1 = "MaxDischargePowerChangedV1",
     GridOperatorPowerLimitationV1 = "GridOperatorPowerLimitationV1",
+    GridOperatorPowerProductionLimitationV1 = "GridOperatorPowerProductionLimitationV1",
     ResetChargerV1 = "ResetChargerV1",
     RebootChargerV1 = "RebootChargerV1",
     RequestChargerLogsV1 = "RequestChargerLogsV1",
@@ -198,6 +200,29 @@ export declare enum EnyoDataBusMessageEnum {
     StopAirConditioningV1 = "StopAirConditioningV1"
 }
 export type EnyoDataBusMessageResolution = '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
+/**
+ * Optional addressing information for a {@link EnyoDataBusMessage}. When omitted
+ * the message is broadcast to all subscribers; when set, the message is only
+ * delivered to packages that match the specified target.
+ *
+ * Exactly one of {@link cloudPackageId} or {@link categories} should be provided.
+ * When both are set, consumers should treat them as an AND (the receiving package
+ * must match the cloud package id **and** belong to at least one of the listed
+ * categories). When neither is set, the target is treated as "all packages".
+ */
+export interface EnyoDataBusMessageTarget {
+    /**
+     * Target a single cloud-deployed energy app package by its package identifier.
+     * Use this when a message is intended for one specific package instance.
+     */
+    cloudPackageId?: string;
+    /**
+     * Target every energy app package whose definition declares at least one of
+     * the listed categories. Use this for category-scoped fan-out (e.g. send a
+     * grid operator limitation only to inverter and battery-storage packages).
+     */
+    categories?: EnergyAppPackageCategory[];
+}
 export interface EnyoDataBusMessage {
     id: string;
     message: EnyoDataBusMessageEnum;
@@ -208,6 +233,13 @@ export interface EnyoDataBusMessage {
     timestampIso: string;
     /** If you just forward events that occur, use dynamic as resolution */
     resolution?: EnyoDataBusMessageResolution;
+    /**
+     * Optional delivery target. When omitted the message is broadcast to all
+     * subscribers. Use this to restrict delivery to a specific cloud package or
+     * to packages matching one or more energy app categories. See
+     * {@link EnyoDataBusMessageTarget} for matching semantics.
+     */
+    target?: EnyoDataBusMessageTarget;
     data: object;
 }
 export interface EnyoDataBusMessageAnswer extends EnyoDataBusMessage {
@@ -1068,6 +1100,25 @@ export interface EnyoDataBusGridOperatorPowerLimitationV1 extends EnyoDataBusMes
         endTimestampIso: string;
     };
 }
+/**
+ * Command message for grid operator power production limitations directed at the energy manager.
+ * Communicates whether a production-side power limitation (i.e. how much power may be fed into
+ * the grid) is active, the power limit, and when it ends. The energy manager should adjust its
+ * optimization strategy accordingly (e.g. curtail PV feed-in, prefer self-consumption, charge
+ * batteries from surplus).
+ */
+export interface EnyoDataBusGridOperatorPowerProductionLimitationV1 extends EnyoDataBusMessage {
+    type: 'message';
+    message: EnyoDataBusMessageEnum.GridOperatorPowerProductionLimitationV1;
+    data: {
+        /** Whether the grid operator power production limitation is currently active */
+        active: boolean;
+        /** The power production limitation in watts (maximum allowed feed-in power) */
+        powerLimitationW: number;
+        /** ISO 8601 timestamp when the limitation ends */
+        endTimestampIso: string;
+    };
+}
 /**
  * Command message to reset a charger appliance.
  * Sends a reset command to the specified charger, which performs a soft reset

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

@@ -144,6 +144,7 @@ export var EnyoDataBusMessageEnum;
     EnyoDataBusMessageEnum["MaxChargingPowerChangedV1"] = "MaxChargingPowerChangedV1";
     EnyoDataBusMessageEnum["MaxDischargePowerChangedV1"] = "MaxDischargePowerChangedV1";
     EnyoDataBusMessageEnum["GridOperatorPowerLimitationV1"] = "GridOperatorPowerLimitationV1";
+    EnyoDataBusMessageEnum["GridOperatorPowerProductionLimitationV1"] = "GridOperatorPowerProductionLimitationV1";
     EnyoDataBusMessageEnum["ResetChargerV1"] = "ResetChargerV1";
     EnyoDataBusMessageEnum["RebootChargerV1"] = "RebootChargerV1";
     EnyoDataBusMessageEnum["RequestChargerLogsV1"] = "RequestChargerLogsV1";

package/dist/version.d.ts

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