@enyo-energy/energy-app-sdk 0.0.161 → 0.0.163

package/dist/cjs/energy-app-model-feature.enum.cjs

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnergyAppModelFeatureEnum = void 0;
+/**
+ * Important capabilities a specific device model can support.
+ *
+ * Declared per model inside an Energy App package's compatibility section
+ * (see {@link EnergyAppPackageCompatibilityModel}) so the enyo Store and
+ * onboarding flows can surface accurate, model-level feature information to
+ * users. Values are grouped by device category for readability.
+ */
+var EnergyAppModelFeatureEnum;
+(function (EnergyAppModelFeatureEnum) {
+    // Battery / Storage
+    /** The battery can be charged from the grid (not only from PV surplus) */
+    EnergyAppModelFeatureEnum["BatteryChargingFromGrid"] = "battery-charging-from-grid";
+    /** The maximum charge power or target state of charge can be limited */
+    EnergyAppModelFeatureEnum["BatteryChargeLimitation"] = "battery-charge-limitation";
+    /** The maximum discharge power or minimum state of charge can be limited */
+    EnergyAppModelFeatureEnum["BatteryDischargeLimitation"] = "battery-discharge-limitation";
+    // Inverter / PV
+    /** The PV feed-in power into the grid can be limited (curtailment) */
+    EnergyAppModelFeatureEnum["PvFeedInLimitation"] = "pv-feed-in-limitation";
+    /** The inverter active power output can be limited */
+    EnergyAppModelFeatureEnum["InverterPowerLimitation"] = "inverter-power-limitation";
+    // Wallbox / Charging
+    /** Charging can be started and stopped remotely */
+    EnergyAppModelFeatureEnum["ChargingStartStop"] = "charging-start-stop";
+    /** The charging power (in Ampere or Watt) can be limited */
+    EnergyAppModelFeatureEnum["ChargingPowerLimitation"] = "charging-power-limitation";
+    /** The model supports switching between single- and three-phase charging */
+    EnergyAppModelFeatureEnum["ChargingPhaseSwitching"] = "charging-phase-switching";
+    /** The model supports charging from PV surplus */
+    EnergyAppModelFeatureEnum["PvSurplusCharging"] = "pv-surplus-charging";
+    // Heat Pump
+    /** Domestic hot water heating can be forced on demand (DHW boost) */
+    EnergyAppModelFeatureEnum["HeatpumpDhwBoost"] = "heatpump-dhw-boost";
+    /** The target temperature setpoint can be controlled */
+    EnergyAppModelFeatureEnum["HeatpumpTemperatureSetpoint"] = "heatpump-temperature-setpoint";
+    /** The heat pump output power can be modulated */
+    EnergyAppModelFeatureEnum["HeatpumpPowerModulation"] = "heatpump-power-modulation";
+    /** The model supports the SG Ready interface for smart-grid signalling */
+    EnergyAppModelFeatureEnum["HeatpumpSgReady"] = "heatpump-sg-ready";
+    // Climate Control / Air Conditioning
+    /** The target temperature setpoint can be controlled */
+    EnergyAppModelFeatureEnum["ClimateTemperatureSetpoint"] = "climate-temperature-setpoint";
+    /** The operating mode (heat / cool / fan / off) can be controlled */
+    EnergyAppModelFeatureEnum["ClimateModeControl"] = "climate-mode-control";
+    // Meter
+    /** The grid power (import / export) can be read out */
+    EnergyAppModelFeatureEnum["GridPowerReadout"] = "grid-power-readout";
+    /** The accumulated energy consumption can be read out */
+    EnergyAppModelFeatureEnum["EnergyConsumptionReadout"] = "energy-consumption-readout";
+    // Smart Plug
+    /** The plug can be switched on and off */
+    EnergyAppModelFeatureEnum["SwitchOnOff"] = "switch-on-off";
+    /** The plug can measure the connected load's power */
+    EnergyAppModelFeatureEnum["PowerMeasurement"] = "power-measurement";
+})(EnergyAppModelFeatureEnum || (exports.EnergyAppModelFeatureEnum = EnergyAppModelFeatureEnum = {}));

package/dist/cjs/energy-app-model-feature.enum.d.cts

@@ -0,0 +1,48 @@
+/**
+ * Important capabilities a specific device model can support.
+ *
+ * Declared per model inside an Energy App package's compatibility section
+ * (see {@link EnergyAppPackageCompatibilityModel}) so the enyo Store and
+ * onboarding flows can surface accurate, model-level feature information to
+ * users. Values are grouped by device category for readability.
+ */
+export declare enum EnergyAppModelFeatureEnum {
+    /** The battery can be charged from the grid (not only from PV surplus) */
+    BatteryChargingFromGrid = "battery-charging-from-grid",
+    /** The maximum charge power or target state of charge can be limited */
+    BatteryChargeLimitation = "battery-charge-limitation",
+    /** The maximum discharge power or minimum state of charge can be limited */
+    BatteryDischargeLimitation = "battery-discharge-limitation",
+    /** The PV feed-in power into the grid can be limited (curtailment) */
+    PvFeedInLimitation = "pv-feed-in-limitation",
+    /** The inverter active power output can be limited */
+    InverterPowerLimitation = "inverter-power-limitation",
+    /** Charging can be started and stopped remotely */
+    ChargingStartStop = "charging-start-stop",
+    /** The charging power (in Ampere or Watt) can be limited */
+    ChargingPowerLimitation = "charging-power-limitation",
+    /** The model supports switching between single- and three-phase charging */
+    ChargingPhaseSwitching = "charging-phase-switching",
+    /** The model supports charging from PV surplus */
+    PvSurplusCharging = "pv-surplus-charging",
+    /** Domestic hot water heating can be forced on demand (DHW boost) */
+    HeatpumpDhwBoost = "heatpump-dhw-boost",
+    /** The target temperature setpoint can be controlled */
+    HeatpumpTemperatureSetpoint = "heatpump-temperature-setpoint",
+    /** The heat pump output power can be modulated */
+    HeatpumpPowerModulation = "heatpump-power-modulation",
+    /** The model supports the SG Ready interface for smart-grid signalling */
+    HeatpumpSgReady = "heatpump-sg-ready",
+    /** The target temperature setpoint can be controlled */
+    ClimateTemperatureSetpoint = "climate-temperature-setpoint",
+    /** The operating mode (heat / cool / fan / off) can be controlled */
+    ClimateModeControl = "climate-mode-control",
+    /** The grid power (import / export) can be read out */
+    GridPowerReadout = "grid-power-readout",
+    /** The accumulated energy consumption can be read out */
+    EnergyConsumptionReadout = "energy-consumption-readout",
+    /** The plug can be switched on and off */
+    SwitchOnOff = "switch-on-off",
+    /** The plug can measure the connected load's power */
+    PowerMeasurement = "power-measurement"
+}

package/dist/cjs/energy-app-package-definition.d.cts

@@ -1,4 +1,5 @@
 import { EnergyAppPermissionType } from "./energy-app-permission.type.cjs";
+import { EnergyAppModelFeatureEnum } from "./energy-app-model-feature.enum.cjs";
 export type EnergyAppPackageLanguage = 'de' | 'en';
 export declare enum EnergyAppPackageCategory {
     Inverter = "inverter",
@@ -144,7 +145,6 @@ export interface EnergyAppPackagePermission {
 }
 /**
  * A specific device model supported by an Energy App package.
- * Used inside {@link EnergyAppPackageCompatibilityVendor.models} to enumerate
  * the concrete models the package has been verified to work with.
  */
 export interface EnergyAppPackageCompatibilityModel {
@@ -162,6 +162,13 @@ export interface EnergyAppPackageCompatibilityModel {
     minimumFirmwareVersion?: string;
     /** Optional internal note explaining model-specific caveats or limitations */
     internalComment?: string;
+    /**
+     * Important capabilities this specific model supports (e.g. charging the
+     * battery from grid, limiting the charge, or forcing a heat pump DHW boost).
+     * Lets the enyo Store and onboarding flows surface accurate, model-level
+     * feature information.
+     */
+    features: EnergyAppModelFeatureEnum[];
 }
 /**
  * A vendor and the list of its models supported by an Energy App package.
@@ -171,11 +178,6 @@ export interface EnergyAppPackageCompatibilityModel {
 export interface EnergyAppPackageCompatibilityVendor {
     /** Human-readable vendor name (e.g. "SolarEdge", "Fronius") */
     vendorName: string;
-    /**
-     * Optional vendor logo path, mirroring the package-level `logo` field.
-     * Useful when the host wants to render a vendor list in the store.
-     */
-    logo?: string;
     /** Models from this vendor that the package supports */
     models: EnergyAppPackageCompatibilityModel[];
 }
@@ -206,13 +208,13 @@ export interface EnergyAppPackageDefinition {
     /** If the energy app should be visible in the enyo store. Default is true*/
     showInStore?: boolean;
     /**
-     * Optional declaration of vendors and models this package is compatible with.
+     * declaration of vendors and models this package is compatible with.
      * Each entry pairs a vendor with the concrete models the package supports,
      * allowing the enyo Store and onboarding flows to surface accurate
      * compatibility information to users. Omit when the package targets a
      * single vendor implicitly or has no fixed compatibility surface.
      */
-    compatibility?: EnergyAppPackageCompatibilityVendor[];
+    compatibility: EnergyAppPackageCompatibilityVendor[];
 }
 /**
  * Defines an Energy App package with automatic SDK version injection.

package/dist/cjs/index.cjs

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./energy-app.cjs"), exports);
 __exportStar(require("./energy-app-appliance-type.enum.cjs"), exports);
 __exportStar(require("./energy-app-package-definition.cjs"), exports);
+__exportStar(require("./energy-app-model-feature.enum.cjs"), exports);
 __exportStar(require("./version.cjs"), exports);
 __exportStar(require("./implementations/ocpp/ocpp16.cjs"), exports);
 __exportStar(require("./implementations/ocpp/ocpp201.cjs"), exports);

package/dist/cjs/index.d.cts

@@ -1,6 +1,7 @@
 export * from './energy-app.cjs';
 export * from './energy-app-appliance-type.enum.cjs';
 export * from './energy-app-package-definition.cjs';
+export * from './energy-app-model-feature.enum.cjs';
 export * from './version.cjs';
 export * from './implementations/ocpp/ocpp16.cjs';
 export * from './implementations/ocpp/ocpp201.cjs';

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

package/dist/energy-app-model-feature.enum.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Important capabilities a specific device model can support.
+ *
+ * Declared per model inside an Energy App package's compatibility section
+ * (see {@link EnergyAppPackageCompatibilityModel}) so the enyo Store and
+ * onboarding flows can surface accurate, model-level feature information to
+ * users. Values are grouped by device category for readability.
+ */
+export declare enum EnergyAppModelFeatureEnum {
+    /** The battery can be charged from the grid (not only from PV surplus) */
+    BatteryChargingFromGrid = "battery-charging-from-grid",
+    /** The maximum charge power or target state of charge can be limited */
+    BatteryChargeLimitation = "battery-charge-limitation",
+    /** The maximum discharge power or minimum state of charge can be limited */
+    BatteryDischargeLimitation = "battery-discharge-limitation",
+    /** The PV feed-in power into the grid can be limited (curtailment) */
+    PvFeedInLimitation = "pv-feed-in-limitation",
+    /** The inverter active power output can be limited */
+    InverterPowerLimitation = "inverter-power-limitation",
+    /** Charging can be started and stopped remotely */
+    ChargingStartStop = "charging-start-stop",
+    /** The charging power (in Ampere or Watt) can be limited */
+    ChargingPowerLimitation = "charging-power-limitation",
+    /** The model supports switching between single- and three-phase charging */
+    ChargingPhaseSwitching = "charging-phase-switching",
+    /** The model supports charging from PV surplus */
+    PvSurplusCharging = "pv-surplus-charging",
+    /** Domestic hot water heating can be forced on demand (DHW boost) */
+    HeatpumpDhwBoost = "heatpump-dhw-boost",
+    /** The target temperature setpoint can be controlled */
+    HeatpumpTemperatureSetpoint = "heatpump-temperature-setpoint",
+    /** The heat pump output power can be modulated */
+    HeatpumpPowerModulation = "heatpump-power-modulation",
+    /** The model supports the SG Ready interface for smart-grid signalling */
+    HeatpumpSgReady = "heatpump-sg-ready",
+    /** The target temperature setpoint can be controlled */
+    ClimateTemperatureSetpoint = "climate-temperature-setpoint",
+    /** The operating mode (heat / cool / fan / off) can be controlled */
+    ClimateModeControl = "climate-mode-control",
+    /** The grid power (import / export) can be read out */
+    GridPowerReadout = "grid-power-readout",
+    /** The accumulated energy consumption can be read out */
+    EnergyConsumptionReadout = "energy-consumption-readout",
+    /** The plug can be switched on and off */
+    SwitchOnOff = "switch-on-off",
+    /** The plug can measure the connected load's power */
+    PowerMeasurement = "power-measurement"
+}

package/dist/energy-app-model-feature.enum.js

@@ -0,0 +1,56 @@
+/**
+ * Important capabilities a specific device model can support.
+ *
+ * Declared per model inside an Energy App package's compatibility section
+ * (see {@link EnergyAppPackageCompatibilityModel}) so the enyo Store and
+ * onboarding flows can surface accurate, model-level feature information to
+ * users. Values are grouped by device category for readability.
+ */
+export var EnergyAppModelFeatureEnum;
+(function (EnergyAppModelFeatureEnum) {
+    // Battery / Storage
+    /** The battery can be charged from the grid (not only from PV surplus) */
+    EnergyAppModelFeatureEnum["BatteryChargingFromGrid"] = "battery-charging-from-grid";
+    /** The maximum charge power or target state of charge can be limited */
+    EnergyAppModelFeatureEnum["BatteryChargeLimitation"] = "battery-charge-limitation";
+    /** The maximum discharge power or minimum state of charge can be limited */
+    EnergyAppModelFeatureEnum["BatteryDischargeLimitation"] = "battery-discharge-limitation";
+    // Inverter / PV
+    /** The PV feed-in power into the grid can be limited (curtailment) */
+    EnergyAppModelFeatureEnum["PvFeedInLimitation"] = "pv-feed-in-limitation";
+    /** The inverter active power output can be limited */
+    EnergyAppModelFeatureEnum["InverterPowerLimitation"] = "inverter-power-limitation";
+    // Wallbox / Charging
+    /** Charging can be started and stopped remotely */
+    EnergyAppModelFeatureEnum["ChargingStartStop"] = "charging-start-stop";
+    /** The charging power (in Ampere or Watt) can be limited */
+    EnergyAppModelFeatureEnum["ChargingPowerLimitation"] = "charging-power-limitation";
+    /** The model supports switching between single- and three-phase charging */
+    EnergyAppModelFeatureEnum["ChargingPhaseSwitching"] = "charging-phase-switching";
+    /** The model supports charging from PV surplus */
+    EnergyAppModelFeatureEnum["PvSurplusCharging"] = "pv-surplus-charging";
+    // Heat Pump
+    /** Domestic hot water heating can be forced on demand (DHW boost) */
+    EnergyAppModelFeatureEnum["HeatpumpDhwBoost"] = "heatpump-dhw-boost";
+    /** The target temperature setpoint can be controlled */
+    EnergyAppModelFeatureEnum["HeatpumpTemperatureSetpoint"] = "heatpump-temperature-setpoint";
+    /** The heat pump output power can be modulated */
+    EnergyAppModelFeatureEnum["HeatpumpPowerModulation"] = "heatpump-power-modulation";
+    /** The model supports the SG Ready interface for smart-grid signalling */
+    EnergyAppModelFeatureEnum["HeatpumpSgReady"] = "heatpump-sg-ready";
+    // Climate Control / Air Conditioning
+    /** The target temperature setpoint can be controlled */
+    EnergyAppModelFeatureEnum["ClimateTemperatureSetpoint"] = "climate-temperature-setpoint";
+    /** The operating mode (heat / cool / fan / off) can be controlled */
+    EnergyAppModelFeatureEnum["ClimateModeControl"] = "climate-mode-control";
+    // Meter
+    /** The grid power (import / export) can be read out */
+    EnergyAppModelFeatureEnum["GridPowerReadout"] = "grid-power-readout";
+    /** The accumulated energy consumption can be read out */
+    EnergyAppModelFeatureEnum["EnergyConsumptionReadout"] = "energy-consumption-readout";
+    // Smart Plug
+    /** The plug can be switched on and off */
+    EnergyAppModelFeatureEnum["SwitchOnOff"] = "switch-on-off";
+    /** The plug can measure the connected load's power */
+    EnergyAppModelFeatureEnum["PowerMeasurement"] = "power-measurement";
+})(EnergyAppModelFeatureEnum || (EnergyAppModelFeatureEnum = {}));

package/dist/energy-app-package-definition.d.ts

@@ -1,4 +1,5 @@
 import { EnergyAppPermissionType } from "./energy-app-permission.type.js";
+import { EnergyAppModelFeatureEnum } from "./energy-app-model-feature.enum.js";
 export type EnergyAppPackageLanguage = 'de' | 'en';
 export declare enum EnergyAppPackageCategory {
     Inverter = "inverter",
@@ -144,7 +145,6 @@ export interface EnergyAppPackagePermission {
 }
 /**
  * A specific device model supported by an Energy App package.
- * Used inside {@link EnergyAppPackageCompatibilityVendor.models} to enumerate
  * the concrete models the package has been verified to work with.
  */
 export interface EnergyAppPackageCompatibilityModel {
@@ -162,6 +162,13 @@ export interface EnergyAppPackageCompatibilityModel {
     minimumFirmwareVersion?: string;
     /** Optional internal note explaining model-specific caveats or limitations */
     internalComment?: string;
+    /**
+     * Important capabilities this specific model supports (e.g. charging the
+     * battery from grid, limiting the charge, or forcing a heat pump DHW boost).
+     * Lets the enyo Store and onboarding flows surface accurate, model-level
+     * feature information.
+     */
+    features: EnergyAppModelFeatureEnum[];
 }
 /**
  * A vendor and the list of its models supported by an Energy App package.
@@ -171,11 +178,6 @@ export interface EnergyAppPackageCompatibilityModel {
 export interface EnergyAppPackageCompatibilityVendor {
     /** Human-readable vendor name (e.g. "SolarEdge", "Fronius") */
     vendorName: string;
-    /**
-     * Optional vendor logo path, mirroring the package-level `logo` field.
-     * Useful when the host wants to render a vendor list in the store.
-     */
-    logo?: string;
     /** Models from this vendor that the package supports */
     models: EnergyAppPackageCompatibilityModel[];
 }
@@ -206,13 +208,13 @@ export interface EnergyAppPackageDefinition {
     /** If the energy app should be visible in the enyo store. Default is true*/
     showInStore?: boolean;
     /**
-     * Optional declaration of vendors and models this package is compatible with.
+     * declaration of vendors and models this package is compatible with.
      * Each entry pairs a vendor with the concrete models the package supports,
      * allowing the enyo Store and onboarding flows to surface accurate
      * compatibility information to users. Omit when the package targets a
      * single vendor implicitly or has no fixed compatibility surface.
      */
-    compatibility?: EnergyAppPackageCompatibilityVendor[];
+    compatibility: EnergyAppPackageCompatibilityVendor[];
 }
 /**
  * Defines an Energy App package with automatic SDK version injection.

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './energy-app.js';
 export * from './energy-app-appliance-type.enum.js';
 export * from './energy-app-package-definition.js';
+export * from './energy-app-model-feature.enum.js';
 export * from './version.js';
 export * from './implementations/ocpp/ocpp16.js';
 export * from './implementations/ocpp/ocpp201.js';

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from './energy-app.js';
 export * from './energy-app-appliance-type.enum.js';
 export * from './energy-app-package-definition.js';
+export * from './energy-app-model-feature.enum.js';
 export * from './version.js';
 export * from './implementations/ocpp/ocpp16.js';
 export * from './implementations/ocpp/ocpp201.js';

package/dist/version.d.ts

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