@enyo-energy/energy-app-sdk 0.0.74 → 0.0.76

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +1,26 @@
1
+ /**
2
+ * Enum representing the reason type for why a data bus command was issued.
3
+ * Used to attach context to commands for logging, debugging, and UI display.
4
+ */
5
+ export var EnyoDataBusCommandReasonTypeEnum;
6
+ (function (EnyoDataBusCommandReasonTypeEnum) {
7
+ /** Command issued because the electricity price is below a configured threshold */
8
+ EnyoDataBusCommandReasonTypeEnum["ElectricityPriceBelowThreshold"] = "electricity-price-below-threshold";
9
+ /** Command issued because the electricity price is above a configured threshold */
10
+ EnyoDataBusCommandReasonTypeEnum["ElectricityPriceAboveThreshold"] = "electricity-price-above-threshold";
11
+ /** Command issued because PV surplus is available */
12
+ EnyoDataBusCommandReasonTypeEnum["PvSurplusAvailable"] = "pv-surplus-available";
13
+ /** Command issued because PV surplus is unavailable */
14
+ EnyoDataBusCommandReasonTypeEnum["PvSurplusUnavailable"] = "pv-surplus-unavailable";
15
+ /** Command issued because battery capacity is available */
16
+ EnyoDataBusCommandReasonTypeEnum["BatteryCapacityAvailable"] = "battery-capacity-available";
17
+ /** Command issued because battery capacity is unavailable */
18
+ EnyoDataBusCommandReasonTypeEnum["BatteryCapacityUnavailable"] = "battery-capacity-unavailable";
19
+ /** Command issued because a grid operator power limitation is active */
20
+ EnyoDataBusCommandReasonTypeEnum["GridOperatorPowerLimitationActive"] = "grid-operator-power-limitation-active";
21
+ /** Command issued because a grid operator power limitation is inactive */
22
+ EnyoDataBusCommandReasonTypeEnum["GridOperatorPowerLimitationInactive"] = "grid-operator-power-limitation-inactive";
23
+ })(EnyoDataBusCommandReasonTypeEnum || (EnyoDataBusCommandReasonTypeEnum = {}));
1
24
  export var EnyoBatteryStateEnum;
2
25
  (function (EnyoBatteryStateEnum) {
3
26
  EnyoBatteryStateEnum["Off"] = "off";
@@ -105,6 +128,11 @@ export var EnyoDataBusMessageEnum;
105
128
  EnyoDataBusMessageEnum["RequestPreviewChargingScheduleV1"] = "RequestPreviewChargingScheduleV1";
106
129
  EnyoDataBusMessageEnum["PreviewChargingScheduleResponseV1"] = "PreviewChargingScheduleResponseV1";
107
130
  EnyoDataBusMessageEnum["PvForecastV1"] = "PvForecastV1";
131
+ EnyoDataBusMessageEnum["BatteryForecastV1"] = "BatteryForecastV1";
132
+ EnyoDataBusMessageEnum["HomeConsumptionForecastV1"] = "HomeConsumptionForecastV1";
133
+ EnyoDataBusMessageEnum["EvChargingForecastV1"] = "EvChargingForecastV1";
134
+ EnyoDataBusMessageEnum["HeatpumpConsumptionForecastV1"] = "HeatpumpConsumptionForecastV1";
135
+ EnyoDataBusMessageEnum["HeatpumpDhwTemperatureForecastV1"] = "HeatpumpDhwTemperatureForecastV1";
108
136
  EnyoDataBusMessageEnum["StartStorageGridChargeV1"] = "StartStorageGridChargeV1";
109
137
  EnyoDataBusMessageEnum["StopStorageGridChargeV1"] = "StopStorageGridChargeV1";
110
138
  EnyoDataBusMessageEnum["SetStorageDischargeLimitV1"] = "SetStorageDischargeLimitV1";
@@ -112,6 +140,9 @@ export var EnyoDataBusMessageEnum;
112
140
  EnyoDataBusMessageEnum["CommandAcknowledgeV1"] = "CommandAcknowledgeV1";
113
141
  EnyoDataBusMessageEnum["TemperatureSensorValuesUpdateV1"] = "TemperatureSensorValuesUpdateV1";
114
142
  EnyoDataBusMessageEnum["HeatpumpTemperaturesUpdateV1"] = "HeatpumpTemperaturesUpdateV1";
143
+ EnyoDataBusMessageEnum["MaxChargingPowerChangedV1"] = "MaxChargingPowerChangedV1";
144
+ EnyoDataBusMessageEnum["MaxDischargePowerChangedV1"] = "MaxDischargePowerChangedV1";
145
+ EnyoDataBusMessageEnum["GridOperatorPowerLimitationV1"] = "GridOperatorPowerLimitationV1";
115
146
  })(EnyoDataBusMessageEnum || (EnyoDataBusMessageEnum = {}));
116
147
  /**
117
148
  * Possible answers an appliance can give when acknowledging a command.
@@ -234,3 +234,88 @@ export interface HomeConsumptionTimeseriesResponse extends TimeseriesResponseBas
234
234
  /** Total home consumption energy in Watt-hours across all buckets */
235
235
  totalHomeConsumptionWh: number;
236
236
  }
237
+ /**
238
+ * A single entry in the heatpump temperature timeseries.
239
+ * Contains average temperature readings for a 15-minute bucket.
240
+ * All fields are optional since not all heatpumps report all temperature types.
241
+ */
242
+ export interface HeatpumpTemperatureTimeseriesEntry extends TimeseriesEntryBase {
243
+ /** Average outdoor temperature in degrees Celsius for this bucket */
244
+ outdoorTemperatureC?: number;
245
+ /** Average heatpump flow temperature in degrees Celsius for this bucket */
246
+ heatpumpFlowTemperatureC?: number;
247
+ /** Average buffer tank temperature in degrees Celsius for this bucket */
248
+ bufferTankTemperatureC?: number;
249
+ /** Domestic hot water tank temperature readings, indexed per tank */
250
+ domesticHotWater?: {
251
+ /** Zero-based index identifying the DHW tank */
252
+ index: number;
253
+ /** Average temperature in degrees Celsius for this bucket */
254
+ averageTemperatureC: number;
255
+ /** Average target temperature in degrees Celsius for this bucket */
256
+ averageTargetTemperatureC: number;
257
+ }[];
258
+ /** Heating circuit temperature readings, indexed per circuit */
259
+ heatingCircuits?: {
260
+ /** Zero-based index identifying the heating circuit */
261
+ index: number;
262
+ /** Average temperature in degrees Celsius for this bucket */
263
+ averageTemperatureC: number;
264
+ /** Average target temperature in degrees Celsius for this bucket */
265
+ averageTargetTemperatureC: number;
266
+ }[];
267
+ }
268
+ /**
269
+ * Request parameters for querying heatpump temperature timeseries data.
270
+ */
271
+ export interface HeatpumpTemperatureTimeseriesRequest extends TimeseriesRequestBase {
272
+ }
273
+ /**
274
+ * Response containing heatpump temperature timeseries data.
275
+ */
276
+ export interface HeatpumpTemperatureTimeseriesResponse extends TimeseriesResponseBase {
277
+ /** Array of heatpump temperature entries, one per 15-minute bucket */
278
+ entries: HeatpumpTemperatureTimeseriesEntry[];
279
+ /** Average outdoor temperature in degrees Celsius across all buckets */
280
+ averageOutdoorTemperatureC?: number;
281
+ /** Average heatpump flow temperature in degrees Celsius across all buckets */
282
+ averageHeatpumpFlowTemperatureC?: number;
283
+ /** Average buffer tank temperature in degrees Celsius across all buckets */
284
+ averageBufferTankTemperatureC?: number;
285
+ }
286
+ /**
287
+ * A single entry in the temperature sensor timeseries.
288
+ * Contains per-sensor average temperature readings for a 15-minute bucket.
289
+ */
290
+ export interface TemperatureSensorTimeseriesEntry extends TimeseriesEntryBase {
291
+ /** Array of sensor readings for this bucket */
292
+ sensors: {
293
+ /** Unique identifier for the temperature sensor */
294
+ sensorId: string;
295
+ /** Average temperature in degrees Celsius for this bucket */
296
+ averageTemperatureC: number;
297
+ /** Average target temperature in degrees Celsius for this bucket, if applicable */
298
+ averageTargetTemperatureC?: number;
299
+ }[];
300
+ }
301
+ /**
302
+ * Request parameters for querying temperature sensor timeseries data.
303
+ */
304
+ export interface TemperatureSensorTimeseriesRequest extends TimeseriesRequestBase {
305
+ }
306
+ /**
307
+ * Response containing temperature sensor timeseries data.
308
+ */
309
+ export interface TemperatureSensorTimeseriesResponse extends TimeseriesResponseBase {
310
+ /** Array of temperature sensor entries, one per 15-minute bucket */
311
+ entries: TemperatureSensorTimeseriesEntry[];
312
+ /** Per-sensor average temperatures across the full queried period */
313
+ sensors: {
314
+ /** Unique identifier for the temperature sensor */
315
+ sensorId: string;
316
+ /** Average temperature in degrees Celsius across the full period */
317
+ averageTemperatureC: number;
318
+ /** Average target temperature in degrees Celsius across the full period, if applicable */
319
+ averageTargetTemperatureC?: number;
320
+ }[];
321
+ }
package/dist/version.d.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export declare const SDK_VERSION = "0.0.74";
8
+ export declare const SDK_VERSION = "0.0.76";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/dist/version.js CHANGED
@@ -5,7 +5,7 @@
5
5
  /**
6
6
  * Current version of the enyo Energy App SDK.
7
7
  */
8
- export const SDK_VERSION = '0.0.74';
8
+ export const SDK_VERSION = '0.0.76';
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@enyo-energy/energy-app-sdk",
3
- "version": "0.0.74",
3
+ "version": "0.0.76",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",