@enyo-energy/energy-app-sdk 0.0.103 → 0.0.105

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.
@@ -14,4 +14,6 @@ var EnyoBatteryFeature;
14
14
  EnyoBatteryFeature["GridCharging"] = "grid-charging";
15
15
  /** If the battery supports discharge power limitation */
16
16
  EnyoBatteryFeature["DischargeLimitation"] = "discharge-limitation";
17
+ /** If the battery is connected between DC strings and the inverter */
18
+ EnyoBatteryFeature["BetweenDcStringAndInverter"] = "between-dc-string-and-inverter";
17
19
  })(EnyoBatteryFeature || (exports.EnyoBatteryFeature = EnyoBatteryFeature = {}));
@@ -8,7 +8,9 @@ export declare enum EnyoBatteryStorageMode {
8
8
  export declare enum EnyoBatteryFeature {
9
9
  GridCharging = "grid-charging",
10
10
  /** If the battery supports discharge power limitation */
11
- DischargeLimitation = "discharge-limitation"
11
+ DischargeLimitation = "discharge-limitation",
12
+ /** If the battery is connected between DC strings and the inverter */
13
+ BetweenDcStringAndInverter = "between-dc-string-and-inverter"
12
14
  }
13
15
  export interface EnyoBatteryApplianceMetadata {
14
16
  connectedToApplianceId?: string;
@@ -151,6 +151,7 @@ var EnyoDataBusMessageEnum;
151
151
  EnyoDataBusMessageEnum["RequestChargerLogsV1"] = "RequestChargerLogsV1";
152
152
  EnyoDataBusMessageEnum["ClearChargingProfilesV1"] = "ClearChargingProfilesV1";
153
153
  EnyoDataBusMessageEnum["HeatpumpOverheatingV1"] = "HeatpumpOverheatingV1";
154
+ EnyoDataBusMessageEnum["HeatpumpAvailablePowerAnnouncementV1"] = "HeatpumpAvailablePowerAnnouncementV1";
154
155
  })(EnyoDataBusMessageEnum || (exports.EnyoDataBusMessageEnum = EnyoDataBusMessageEnum = {}));
155
156
  /**
156
157
  * Possible answers an appliance can give when acknowledging a command.
@@ -188,7 +188,8 @@ export declare enum EnyoDataBusMessageEnum {
188
188
  RebootChargerV1 = "RebootChargerV1",
189
189
  RequestChargerLogsV1 = "RequestChargerLogsV1",
190
190
  ClearChargingProfilesV1 = "ClearChargingProfilesV1",
191
- HeatpumpOverheatingV1 = "HeatpumpOverheatingV1"
191
+ HeatpumpOverheatingV1 = "HeatpumpOverheatingV1",
192
+ HeatpumpAvailablePowerAnnouncementV1 = "HeatpumpAvailablePowerAnnouncementV1"
192
193
  }
193
194
  export type EnyoDataBusMessageResolution = '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
194
195
  export interface EnyoDataBusMessage {
@@ -257,6 +258,8 @@ export interface EnyoDataBusBatteryValuesUpdateV1 extends EnyoDataBusMessage {
257
258
  state?: EnyoBatteryStateEnum;
258
259
  /** Current Battery Power (in Watt). Positive = charging of the battery, Negative = Consumption from the Battery. */
259
260
  batteryPowerW?: number;
261
+ /** DC String input power (in Watt) */
262
+ dcStringInputPowerW?: number;
260
263
  /** Battery State of Charge. Value between 0 and 100 */
261
264
  batterySoC: number;
262
265
  };
@@ -1132,3 +1135,19 @@ export interface EnyoDataBusHeatpumpOverheatingV1 extends EnyoDataBusMessage {
1132
1135
  reason?: EnyoDataBusCommandReason;
1133
1136
  };
1134
1137
  }
1138
+ /**
1139
+ * Data bus message announcing available power for a heatpump appliance.
1140
+ * Used to inform the heatpump about how much power is available for consumption.
1141
+ */
1142
+ export interface EnyoDataBusHeatpumpAvailablePowerAnnouncementV1 extends EnyoDataBusMessage {
1143
+ type: 'message';
1144
+ message: EnyoDataBusMessageEnum.HeatpumpAvailablePowerAnnouncementV1;
1145
+ /** ID of the heatpump appliance */
1146
+ applianceId: string;
1147
+ data: {
1148
+ /** Available power for the heatpump to use (in Watt) */
1149
+ powerW: number;
1150
+ /** Optional reason why this announcement was issued */
1151
+ reason?: EnyoDataBusCommandReason;
1152
+ };
1153
+ }
@@ -36,6 +36,8 @@ var EnyoDiagnosticsControlActionEnum;
36
36
  EnyoDiagnosticsControlActionEnum["HeatpumpRoomOverheating"] = "heatpump_room_overheating";
37
37
  /** Boost buffer tank temperature via heat pump. */
38
38
  EnyoDiagnosticsControlActionEnum["HeatpumpBufferTankBoost"] = "heatpump_buffer_tank_boost";
39
+ /** Announce available power to the heat pump. */
40
+ EnyoDiagnosticsControlActionEnum["HeatpumpAvailablePowerAnnouncement"] = "heatpump_available_power_announcement";
39
41
  })(EnyoDiagnosticsControlActionEnum || (exports.EnyoDiagnosticsControlActionEnum = EnyoDiagnosticsControlActionEnum = {}));
40
42
  /**
41
43
  * Enum of reason types explaining why an action was planned.
@@ -173,7 +173,9 @@ export declare enum EnyoDiagnosticsControlActionEnum {
173
173
  /** Address room overheating via heat pump. */
174
174
  HeatpumpRoomOverheating = "heatpump_room_overheating",
175
175
  /** Boost buffer tank temperature via heat pump. */
176
- HeatpumpBufferTankBoost = "heatpump_buffer_tank_boost"
176
+ HeatpumpBufferTankBoost = "heatpump_buffer_tank_boost",
177
+ /** Announce available power to the heat pump. */
178
+ HeatpumpAvailablePowerAnnouncement = "heatpump_available_power_announcement"
177
179
  }
178
180
  /**
179
181
  * Enum of reason types explaining why an action was planned.
@@ -357,8 +359,16 @@ export interface EnyoDiagnosticsHeatpumpBufferTankBoostAction extends EnyoDiagno
357
359
  /** Optional current outdoor temperature in Celsius. */
358
360
  outdoorTemperatureC?: number;
359
361
  }
362
+ /** Heatpump action: announce available power to the heat pump. */
363
+ export interface EnyoDiagnosticsHeatpumpAvailablePowerAnnouncementAction extends EnyoDiagnosticsControlActionBase {
364
+ action: EnyoDiagnosticsControlActionEnum.HeatpumpAvailablePowerAnnouncement;
365
+ type: EnyoApplianceTypeEnum.Heatpump;
366
+ isCommand: true;
367
+ /** Available power in Watts. */
368
+ powerW: number;
369
+ }
360
370
  /** Union of all control plan action types. */
361
- export type EnyoDiagnosticsControlAction = EnyoDiagnosticsStorageBlockDischargeAction | EnyoDiagnosticsStorageChargeFromGridAction | EnyoDiagnosticsStorageForceDischargeAction | EnyoDiagnosticsStorageChargingFromPvAction | EnyoDiagnosticsStorageDischargingIntoHomeAction | EnyoDiagnosticsChargerStartChargeAction | EnyoDiagnosticsChargerPauseChargeAction | EnyoDiagnosticsHeatpumpDhwBoostAction | EnyoDiagnosticsHeatpumpRoomOverheatingAction | EnyoDiagnosticsHeatpumpBufferTankBoostAction;
371
+ export type EnyoDiagnosticsControlAction = EnyoDiagnosticsStorageBlockDischargeAction | EnyoDiagnosticsStorageChargeFromGridAction | EnyoDiagnosticsStorageForceDischargeAction | EnyoDiagnosticsStorageChargingFromPvAction | EnyoDiagnosticsStorageDischargingIntoHomeAction | EnyoDiagnosticsChargerStartChargeAction | EnyoDiagnosticsChargerPauseChargeAction | EnyoDiagnosticsHeatpumpDhwBoostAction | EnyoDiagnosticsHeatpumpRoomOverheatingAction | EnyoDiagnosticsHeatpumpBufferTankBoostAction | EnyoDiagnosticsHeatpumpAvailablePowerAnnouncementAction;
362
372
  /** Complete control plan with duration-based actions and cost estimates. */
363
373
  export interface EnyoDiagnosticsControlPlan {
364
374
  /** Sequence of planned actions, each with its own duration. */
@@ -13,6 +13,8 @@ var EnyoHeatpumpApplianceAvailableFeaturesEnum;
13
13
  EnyoHeatpumpApplianceAvailableFeaturesEnum["BufferTankOverheating"] = "BufferTankOverheating";
14
14
  /** If the heatpump supports domestic hot water overheating */
15
15
  EnyoHeatpumpApplianceAvailableFeaturesEnum["DomesticHotWaterOverheating"] = "DomesticHotWaterOverheating";
16
+ /** If the heatpump supports available power announcements */
17
+ EnyoHeatpumpApplianceAvailableFeaturesEnum["AvailablePowerAnnouncement"] = "AvailablePowerAnnouncement";
16
18
  })(EnyoHeatpumpApplianceAvailableFeaturesEnum || (exports.EnyoHeatpumpApplianceAvailableFeaturesEnum = EnyoHeatpumpApplianceAvailableFeaturesEnum = {}));
17
19
  var EnyoHeatpumpApplianceModeEnum;
18
20
  (function (EnyoHeatpumpApplianceModeEnum) {
@@ -8,7 +8,9 @@ export declare enum EnyoHeatpumpApplianceAvailableFeaturesEnum {
8
8
  /** If the heatpump supports buffer tank overheating */
9
9
  BufferTankOverheating = "BufferTankOverheating",
10
10
  /** If the heatpump supports domestic hot water overheating */
11
- DomesticHotWaterOverheating = "DomesticHotWaterOverheating"
11
+ DomesticHotWaterOverheating = "DomesticHotWaterOverheating",
12
+ /** If the heatpump supports available power announcements */
13
+ AvailablePowerAnnouncement = "AvailablePowerAnnouncement"
12
14
  }
13
15
  export declare enum EnyoHeatpumpApplianceModeEnum {
14
16
  Idle = "Idle",
@@ -9,7 +9,7 @@ exports.getSdkVersion = getSdkVersion;
9
9
  /**
10
10
  * Current version of the enyo Energy App SDK.
11
11
  */
12
- exports.SDK_VERSION = '0.0.103';
12
+ exports.SDK_VERSION = '0.0.105';
13
13
  /**
14
14
  * Gets the current SDK version.
15
15
  * @returns The semantic version string of the SDK
@@ -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.103";
8
+ export declare const SDK_VERSION = "0.0.105";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
@@ -8,7 +8,9 @@ export declare enum EnyoBatteryStorageMode {
8
8
  export declare enum EnyoBatteryFeature {
9
9
  GridCharging = "grid-charging",
10
10
  /** If the battery supports discharge power limitation */
11
- DischargeLimitation = "discharge-limitation"
11
+ DischargeLimitation = "discharge-limitation",
12
+ /** If the battery is connected between DC strings and the inverter */
13
+ BetweenDcStringAndInverter = "between-dc-string-and-inverter"
12
14
  }
13
15
  export interface EnyoBatteryApplianceMetadata {
14
16
  connectedToApplianceId?: string;
@@ -11,4 +11,6 @@ export var EnyoBatteryFeature;
11
11
  EnyoBatteryFeature["GridCharging"] = "grid-charging";
12
12
  /** If the battery supports discharge power limitation */
13
13
  EnyoBatteryFeature["DischargeLimitation"] = "discharge-limitation";
14
+ /** If the battery is connected between DC strings and the inverter */
15
+ EnyoBatteryFeature["BetweenDcStringAndInverter"] = "between-dc-string-and-inverter";
14
16
  })(EnyoBatteryFeature || (EnyoBatteryFeature = {}));
@@ -188,7 +188,8 @@ export declare enum EnyoDataBusMessageEnum {
188
188
  RebootChargerV1 = "RebootChargerV1",
189
189
  RequestChargerLogsV1 = "RequestChargerLogsV1",
190
190
  ClearChargingProfilesV1 = "ClearChargingProfilesV1",
191
- HeatpumpOverheatingV1 = "HeatpumpOverheatingV1"
191
+ HeatpumpOverheatingV1 = "HeatpumpOverheatingV1",
192
+ HeatpumpAvailablePowerAnnouncementV1 = "HeatpumpAvailablePowerAnnouncementV1"
192
193
  }
193
194
  export type EnyoDataBusMessageResolution = '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
194
195
  export interface EnyoDataBusMessage {
@@ -257,6 +258,8 @@ export interface EnyoDataBusBatteryValuesUpdateV1 extends EnyoDataBusMessage {
257
258
  state?: EnyoBatteryStateEnum;
258
259
  /** Current Battery Power (in Watt). Positive = charging of the battery, Negative = Consumption from the Battery. */
259
260
  batteryPowerW?: number;
261
+ /** DC String input power (in Watt) */
262
+ dcStringInputPowerW?: number;
260
263
  /** Battery State of Charge. Value between 0 and 100 */
261
264
  batterySoC: number;
262
265
  };
@@ -1132,3 +1135,19 @@ export interface EnyoDataBusHeatpumpOverheatingV1 extends EnyoDataBusMessage {
1132
1135
  reason?: EnyoDataBusCommandReason;
1133
1136
  };
1134
1137
  }
1138
+ /**
1139
+ * Data bus message announcing available power for a heatpump appliance.
1140
+ * Used to inform the heatpump about how much power is available for consumption.
1141
+ */
1142
+ export interface EnyoDataBusHeatpumpAvailablePowerAnnouncementV1 extends EnyoDataBusMessage {
1143
+ type: 'message';
1144
+ message: EnyoDataBusMessageEnum.HeatpumpAvailablePowerAnnouncementV1;
1145
+ /** ID of the heatpump appliance */
1146
+ applianceId: string;
1147
+ data: {
1148
+ /** Available power for the heatpump to use (in Watt) */
1149
+ powerW: number;
1150
+ /** Optional reason why this announcement was issued */
1151
+ reason?: EnyoDataBusCommandReason;
1152
+ };
1153
+ }
@@ -148,6 +148,7 @@ export var EnyoDataBusMessageEnum;
148
148
  EnyoDataBusMessageEnum["RequestChargerLogsV1"] = "RequestChargerLogsV1";
149
149
  EnyoDataBusMessageEnum["ClearChargingProfilesV1"] = "ClearChargingProfilesV1";
150
150
  EnyoDataBusMessageEnum["HeatpumpOverheatingV1"] = "HeatpumpOverheatingV1";
151
+ EnyoDataBusMessageEnum["HeatpumpAvailablePowerAnnouncementV1"] = "HeatpumpAvailablePowerAnnouncementV1";
151
152
  })(EnyoDataBusMessageEnum || (EnyoDataBusMessageEnum = {}));
152
153
  /**
153
154
  * Possible answers an appliance can give when acknowledging a command.
@@ -173,7 +173,9 @@ export declare enum EnyoDiagnosticsControlActionEnum {
173
173
  /** Address room overheating via heat pump. */
174
174
  HeatpumpRoomOverheating = "heatpump_room_overheating",
175
175
  /** Boost buffer tank temperature via heat pump. */
176
- HeatpumpBufferTankBoost = "heatpump_buffer_tank_boost"
176
+ HeatpumpBufferTankBoost = "heatpump_buffer_tank_boost",
177
+ /** Announce available power to the heat pump. */
178
+ HeatpumpAvailablePowerAnnouncement = "heatpump_available_power_announcement"
177
179
  }
178
180
  /**
179
181
  * Enum of reason types explaining why an action was planned.
@@ -357,8 +359,16 @@ export interface EnyoDiagnosticsHeatpumpBufferTankBoostAction extends EnyoDiagno
357
359
  /** Optional current outdoor temperature in Celsius. */
358
360
  outdoorTemperatureC?: number;
359
361
  }
362
+ /** Heatpump action: announce available power to the heat pump. */
363
+ export interface EnyoDiagnosticsHeatpumpAvailablePowerAnnouncementAction extends EnyoDiagnosticsControlActionBase {
364
+ action: EnyoDiagnosticsControlActionEnum.HeatpumpAvailablePowerAnnouncement;
365
+ type: EnyoApplianceTypeEnum.Heatpump;
366
+ isCommand: true;
367
+ /** Available power in Watts. */
368
+ powerW: number;
369
+ }
360
370
  /** Union of all control plan action types. */
361
- export type EnyoDiagnosticsControlAction = EnyoDiagnosticsStorageBlockDischargeAction | EnyoDiagnosticsStorageChargeFromGridAction | EnyoDiagnosticsStorageForceDischargeAction | EnyoDiagnosticsStorageChargingFromPvAction | EnyoDiagnosticsStorageDischargingIntoHomeAction | EnyoDiagnosticsChargerStartChargeAction | EnyoDiagnosticsChargerPauseChargeAction | EnyoDiagnosticsHeatpumpDhwBoostAction | EnyoDiagnosticsHeatpumpRoomOverheatingAction | EnyoDiagnosticsHeatpumpBufferTankBoostAction;
371
+ export type EnyoDiagnosticsControlAction = EnyoDiagnosticsStorageBlockDischargeAction | EnyoDiagnosticsStorageChargeFromGridAction | EnyoDiagnosticsStorageForceDischargeAction | EnyoDiagnosticsStorageChargingFromPvAction | EnyoDiagnosticsStorageDischargingIntoHomeAction | EnyoDiagnosticsChargerStartChargeAction | EnyoDiagnosticsChargerPauseChargeAction | EnyoDiagnosticsHeatpumpDhwBoostAction | EnyoDiagnosticsHeatpumpRoomOverheatingAction | EnyoDiagnosticsHeatpumpBufferTankBoostAction | EnyoDiagnosticsHeatpumpAvailablePowerAnnouncementAction;
362
372
  /** Complete control plan with duration-based actions and cost estimates. */
363
373
  export interface EnyoDiagnosticsControlPlan {
364
374
  /** Sequence of planned actions, each with its own duration. */
@@ -33,6 +33,8 @@ export var EnyoDiagnosticsControlActionEnum;
33
33
  EnyoDiagnosticsControlActionEnum["HeatpumpRoomOverheating"] = "heatpump_room_overheating";
34
34
  /** Boost buffer tank temperature via heat pump. */
35
35
  EnyoDiagnosticsControlActionEnum["HeatpumpBufferTankBoost"] = "heatpump_buffer_tank_boost";
36
+ /** Announce available power to the heat pump. */
37
+ EnyoDiagnosticsControlActionEnum["HeatpumpAvailablePowerAnnouncement"] = "heatpump_available_power_announcement";
36
38
  })(EnyoDiagnosticsControlActionEnum || (EnyoDiagnosticsControlActionEnum = {}));
37
39
  /**
38
40
  * Enum of reason types explaining why an action was planned.
@@ -8,7 +8,9 @@ export declare enum EnyoHeatpumpApplianceAvailableFeaturesEnum {
8
8
  /** If the heatpump supports buffer tank overheating */
9
9
  BufferTankOverheating = "BufferTankOverheating",
10
10
  /** If the heatpump supports domestic hot water overheating */
11
- DomesticHotWaterOverheating = "DomesticHotWaterOverheating"
11
+ DomesticHotWaterOverheating = "DomesticHotWaterOverheating",
12
+ /** If the heatpump supports available power announcements */
13
+ AvailablePowerAnnouncement = "AvailablePowerAnnouncement"
12
14
  }
13
15
  export declare enum EnyoHeatpumpApplianceModeEnum {
14
16
  Idle = "Idle",
@@ -10,6 +10,8 @@ export var EnyoHeatpumpApplianceAvailableFeaturesEnum;
10
10
  EnyoHeatpumpApplianceAvailableFeaturesEnum["BufferTankOverheating"] = "BufferTankOverheating";
11
11
  /** If the heatpump supports domestic hot water overheating */
12
12
  EnyoHeatpumpApplianceAvailableFeaturesEnum["DomesticHotWaterOverheating"] = "DomesticHotWaterOverheating";
13
+ /** If the heatpump supports available power announcements */
14
+ EnyoHeatpumpApplianceAvailableFeaturesEnum["AvailablePowerAnnouncement"] = "AvailablePowerAnnouncement";
13
15
  })(EnyoHeatpumpApplianceAvailableFeaturesEnum || (EnyoHeatpumpApplianceAvailableFeaturesEnum = {}));
14
16
  export var EnyoHeatpumpApplianceModeEnum;
15
17
  (function (EnyoHeatpumpApplianceModeEnum) {
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.103";
8
+ export declare const SDK_VERSION = "0.0.105";
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.103';
8
+ export const SDK_VERSION = '0.0.105';
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.103",
3
+ "version": "0.0.105",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",