@enyo-energy/energy-app-sdk 0.0.110 → 0.0.111

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

@@ -1,4 +1,4 @@
-import { DataBusMessageQueryRequest, DataBusMessageQueryResponse, PvProductionTimeseriesRequest, PvProductionTimeseriesResponse, BatterySocTimeseriesRequest, BatterySocTimeseriesResponse, BatteryPowerTimeseriesRequest, BatteryPowerTimeseriesResponse, MeterValuesTimeseriesRequest, MeterValuesTimeseriesResponse, GridPowerTimeseriesRequest, GridPowerTimeseriesResponse, HomeConsumptionTimeseriesRequest, HomeConsumptionTimeseriesResponse, HeatpumpTemperatureTimeseriesRequest, HeatpumpTemperatureTimeseriesResponse, TemperatureSensorTimeseriesRequest, TemperatureSensorTimeseriesResponse, AirConditioningPowerTimeseriesRequest, AirConditioningPowerTimeseriesResponse, AirConditioningTemperatureTimeseriesRequest, AirConditioningTemperatureTimeseriesResponse } from "../types/enyo-timeseries.cjs";
+import { DataBusMessageQueryRequest, DataBusMessageQueryResponse, PvProductionTimeseriesRequest, PvProductionTimeseriesResponse, BatterySocTimeseriesRequest, BatterySocTimeseriesResponse, BatteryPowerTimeseriesRequest, BatteryPowerTimeseriesResponse, MeterValuesTimeseriesRequest, MeterValuesTimeseriesResponse, GridPowerTimeseriesRequest, GridPowerTimeseriesResponse, HomeConsumptionTimeseriesRequest, HomeConsumptionTimeseriesResponse, HeatpumpTemperatureTimeseriesRequest, HeatpumpTemperatureTimeseriesResponse, HeatpumpPowerTimeseriesRequest, HeatpumpPowerTimeseriesResponse, TemperatureSensorTimeseriesRequest, TemperatureSensorTimeseriesResponse, AirConditioningPowerTimeseriesRequest, AirConditioningPowerTimeseriesResponse, AirConditioningTemperatureTimeseriesRequest, AirConditioningTemperatureTimeseriesResponse } from "../types/enyo-timeseries.cjs";
 /**
  * Interface for querying historical energy data with configurable bucket granularity.
  * Provides methods to retrieve aggregated timeseries data for various energy metrics
@@ -159,6 +159,33 @@ export interface EnergyAppTimeseries {
      * ```
      */
     getHeatpumpTemperatureTimeseries(request: HeatpumpTemperatureTimeseriesRequest): Promise<HeatpumpTemperatureTimeseriesResponse>;
+    /**
+     * Retrieves heatpump power timeseries data aggregated in time buckets.
+     * Returns time-weighted average electrical power (W) and cumulative
+     * electrical energy (Wh) for each bucket. When the heatpump reports them,
+     * also returns the split between space heating and domestic hot water for
+     * both electrical consumption and thermal energy delivered.
+     *
+     * Split fields are optional because not all heatpumps report meter values
+     * for the heating / domestic-hot-water categories.
+     *
+     * @param request - The query parameters including date range and optional appliance filter
+     * @returns Promise resolving to heatpump power entries with total electrical consumption
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.getHeatpumpPowerTimeseries({
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z'
+     * });
+     * console.log(`Total heatpump consumption: ${response.totalHeatpumpPowerWh} Wh`);
+     * if (response.totalHeatGenerationHeatingWh && response.totalPowerConsumptionHeatingWh) {
+     *     const cop = response.totalHeatGenerationHeatingWh / response.totalPowerConsumptionHeatingWh;
+     *     console.log(`Heating COP: ${cop.toFixed(2)}`);
+     * }
+     * ```
+     */
+    getHeatpumpPowerTimeseries(request: HeatpumpPowerTimeseriesRequest): Promise<HeatpumpPowerTimeseriesResponse>;
     /**
      * Retrieves temperature sensor timeseries data aggregated in time buckets.
      * Returns per-sensor average temperature readings for each bucket, along with

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

@@ -342,6 +342,51 @@ export interface HeatpumpTemperatureTimeseriesResponse extends TimeseriesRespons
     /** Average buffer tank temperature in degrees Celsius across all buckets */
     averageBufferTankTemperatureC?: number;
 }
+/**
+ * A single entry in the heatpump power timeseries.
+ * Contains electrical power and energy values, optional split between space
+ * heating and domestic hot water consumption, and optional thermal energy
+ * delivered (heat generation) for the same split, for a single time bucket.
+ */
+export interface HeatpumpPowerTimeseriesEntry extends TimeseriesEntryBase {
+    /** Time-weighted average heatpump electrical power consumption in Watts for this bucket */
+    heatpumpPowerW: number;
+    /** Cumulative heatpump electrical energy consumption in Watt-hours for this bucket */
+    heatpumpPowerWh: number;
+    /** Electrical energy consumed for space heating in Watt-hours for this bucket */
+    powerConsumptionHeatingWh?: number;
+    /** Electrical energy consumed for domestic hot water in Watt-hours for this bucket */
+    powerConsumptionDomesticHotWaterWh?: number;
+    /** Thermal energy delivered for space heating in Watt-hours for this bucket */
+    heatGenerationHeatingWh?: number;
+    /** Thermal energy delivered for domestic hot water in Watt-hours for this bucket */
+    heatGenerationDomesticHotWaterWh?: number;
+}
+/**
+ * Request parameters for querying heatpump power timeseries data.
+ */
+export interface HeatpumpPowerTimeseriesRequest extends TimeseriesRequestBase {
+}
+/**
+ * Response containing heatpump power timeseries data.
+ * Aggregated totals for the heating / domestic-hot-water splits and for
+ * heat generation are optional because not all heatpumps report meter values
+ * for every category.
+ */
+export interface HeatpumpPowerTimeseriesResponse extends TimeseriesResponseBase {
+    /** Array of heatpump power entries, one per time bucket */
+    entries: HeatpumpPowerTimeseriesEntry[];
+    /** Total heatpump electrical energy consumption in Watt-hours across all buckets */
+    totalHeatpumpPowerWh: number;
+    /** Total electrical energy consumed for space heating in Watt-hours across all buckets */
+    totalPowerConsumptionHeatingWh?: number;
+    /** Total electrical energy consumed for domestic hot water in Watt-hours across all buckets */
+    totalPowerConsumptionDomesticHotWaterWh?: number;
+    /** Total thermal energy delivered for space heating in Watt-hours across all buckets */
+    totalHeatGenerationHeatingWh?: number;
+    /** Total thermal energy delivered for domestic hot water in Watt-hours across all buckets */
+    totalHeatGenerationDomesticHotWaterWh?: number;
+}
 /**
  * A single entry in the temperature sensor timeseries.
  * Contains per-sensor average temperature readings for a single time bucket.

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

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

@@ -1,4 +1,4 @@
-import { DataBusMessageQueryRequest, DataBusMessageQueryResponse, PvProductionTimeseriesRequest, PvProductionTimeseriesResponse, BatterySocTimeseriesRequest, BatterySocTimeseriesResponse, BatteryPowerTimeseriesRequest, BatteryPowerTimeseriesResponse, MeterValuesTimeseriesRequest, MeterValuesTimeseriesResponse, GridPowerTimeseriesRequest, GridPowerTimeseriesResponse, HomeConsumptionTimeseriesRequest, HomeConsumptionTimeseriesResponse, HeatpumpTemperatureTimeseriesRequest, HeatpumpTemperatureTimeseriesResponse, TemperatureSensorTimeseriesRequest, TemperatureSensorTimeseriesResponse, AirConditioningPowerTimeseriesRequest, AirConditioningPowerTimeseriesResponse, AirConditioningTemperatureTimeseriesRequest, AirConditioningTemperatureTimeseriesResponse } from "../types/enyo-timeseries.js";
+import { DataBusMessageQueryRequest, DataBusMessageQueryResponse, PvProductionTimeseriesRequest, PvProductionTimeseriesResponse, BatterySocTimeseriesRequest, BatterySocTimeseriesResponse, BatteryPowerTimeseriesRequest, BatteryPowerTimeseriesResponse, MeterValuesTimeseriesRequest, MeterValuesTimeseriesResponse, GridPowerTimeseriesRequest, GridPowerTimeseriesResponse, HomeConsumptionTimeseriesRequest, HomeConsumptionTimeseriesResponse, HeatpumpTemperatureTimeseriesRequest, HeatpumpTemperatureTimeseriesResponse, HeatpumpPowerTimeseriesRequest, HeatpumpPowerTimeseriesResponse, TemperatureSensorTimeseriesRequest, TemperatureSensorTimeseriesResponse, AirConditioningPowerTimeseriesRequest, AirConditioningPowerTimeseriesResponse, AirConditioningTemperatureTimeseriesRequest, AirConditioningTemperatureTimeseriesResponse } from "../types/enyo-timeseries.js";
 /**
  * Interface for querying historical energy data with configurable bucket granularity.
  * Provides methods to retrieve aggregated timeseries data for various energy metrics
@@ -159,6 +159,33 @@ export interface EnergyAppTimeseries {
      * ```
      */
     getHeatpumpTemperatureTimeseries(request: HeatpumpTemperatureTimeseriesRequest): Promise<HeatpumpTemperatureTimeseriesResponse>;
+    /**
+     * Retrieves heatpump power timeseries data aggregated in time buckets.
+     * Returns time-weighted average electrical power (W) and cumulative
+     * electrical energy (Wh) for each bucket. When the heatpump reports them,
+     * also returns the split between space heating and domestic hot water for
+     * both electrical consumption and thermal energy delivered.
+     *
+     * Split fields are optional because not all heatpumps report meter values
+     * for the heating / domestic-hot-water categories.
+     *
+     * @param request - The query parameters including date range and optional appliance filter
+     * @returns Promise resolving to heatpump power entries with total electrical consumption
+     *
+     * @example
+     * ```typescript
+     * const response = await timeseries.getHeatpumpPowerTimeseries({
+     *     startDateIso: '2024-01-01T00:00:00Z',
+     *     endDateIso: '2024-01-02T00:00:00Z'
+     * });
+     * console.log(`Total heatpump consumption: ${response.totalHeatpumpPowerWh} Wh`);
+     * if (response.totalHeatGenerationHeatingWh && response.totalPowerConsumptionHeatingWh) {
+     *     const cop = response.totalHeatGenerationHeatingWh / response.totalPowerConsumptionHeatingWh;
+     *     console.log(`Heating COP: ${cop.toFixed(2)}`);
+     * }
+     * ```
+     */
+    getHeatpumpPowerTimeseries(request: HeatpumpPowerTimeseriesRequest): Promise<HeatpumpPowerTimeseriesResponse>;
     /**
      * Retrieves temperature sensor timeseries data aggregated in time buckets.
      * Returns per-sensor average temperature readings for each bucket, along with

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

@@ -342,6 +342,51 @@ export interface HeatpumpTemperatureTimeseriesResponse extends TimeseriesRespons
     /** Average buffer tank temperature in degrees Celsius across all buckets */
     averageBufferTankTemperatureC?: number;
 }
+/**
+ * A single entry in the heatpump power timeseries.
+ * Contains electrical power and energy values, optional split between space
+ * heating and domestic hot water consumption, and optional thermal energy
+ * delivered (heat generation) for the same split, for a single time bucket.
+ */
+export interface HeatpumpPowerTimeseriesEntry extends TimeseriesEntryBase {
+    /** Time-weighted average heatpump electrical power consumption in Watts for this bucket */
+    heatpumpPowerW: number;
+    /** Cumulative heatpump electrical energy consumption in Watt-hours for this bucket */
+    heatpumpPowerWh: number;
+    /** Electrical energy consumed for space heating in Watt-hours for this bucket */
+    powerConsumptionHeatingWh?: number;
+    /** Electrical energy consumed for domestic hot water in Watt-hours for this bucket */
+    powerConsumptionDomesticHotWaterWh?: number;
+    /** Thermal energy delivered for space heating in Watt-hours for this bucket */
+    heatGenerationHeatingWh?: number;
+    /** Thermal energy delivered for domestic hot water in Watt-hours for this bucket */
+    heatGenerationDomesticHotWaterWh?: number;
+}
+/**
+ * Request parameters for querying heatpump power timeseries data.
+ */
+export interface HeatpumpPowerTimeseriesRequest extends TimeseriesRequestBase {
+}
+/**
+ * Response containing heatpump power timeseries data.
+ * Aggregated totals for the heating / domestic-hot-water splits and for
+ * heat generation are optional because not all heatpumps report meter values
+ * for every category.
+ */
+export interface HeatpumpPowerTimeseriesResponse extends TimeseriesResponseBase {
+    /** Array of heatpump power entries, one per time bucket */
+    entries: HeatpumpPowerTimeseriesEntry[];
+    /** Total heatpump electrical energy consumption in Watt-hours across all buckets */
+    totalHeatpumpPowerWh: number;
+    /** Total electrical energy consumed for space heating in Watt-hours across all buckets */
+    totalPowerConsumptionHeatingWh?: number;
+    /** Total electrical energy consumed for domestic hot water in Watt-hours across all buckets */
+    totalPowerConsumptionDomesticHotWaterWh?: number;
+    /** Total thermal energy delivered for space heating in Watt-hours across all buckets */
+    totalHeatGenerationHeatingWh?: number;
+    /** Total thermal energy delivered for domestic hot water in Watt-hours across all buckets */
+    totalHeatGenerationDomesticHotWaterWh?: number;
+}
 /**
  * A single entry in the temperature sensor timeseries.
  * Contains per-sensor average temperature readings for a single time bucket.

package/dist/version.d.ts

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