@enyo-energy/energy-app-sdk 0.0.143 → 0.0.144

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.
@@ -132,7 +132,7 @@ class HomeConsumptionForecast {
132
132
  this.initialized = false;
133
133
  }
134
134
  onAggregatedState(message) {
135
- const power = message.data.totalHomeConsumptionW;
135
+ const power = message.data.homeConsumptionW;
136
136
  if (typeof power !== 'number' || Number.isNaN(power))
137
137
  return;
138
138
  const ts = new Date(message.timestampIso).getTime();
@@ -170,8 +170,6 @@ var EnyoDataBusMessageEnum;
170
170
  EnyoDataBusMessageEnum["StartAirConditioningV1"] = "StartAirConditioningV1";
171
171
  EnyoDataBusMessageEnum["StopAirConditioningV1"] = "StopAirConditioningV1";
172
172
  EnyoDataBusMessageEnum["VehicleSocUpdateV1"] = "VehicleSocUpdateV1";
173
- EnyoDataBusMessageEnum["StartCalibrationV1"] = "StartCalibrationV1";
174
- EnyoDataBusMessageEnum["StopCalibrationV1"] = "StopCalibrationV1";
175
173
  })(EnyoDataBusMessageEnum || (exports.EnyoDataBusMessageEnum = EnyoDataBusMessageEnum = {}));
176
174
  /**
177
175
  * Storage control mode carried by {@link EnyoDataBusSetStorageScheduleV1}.
@@ -126,27 +126,12 @@ export declare enum EnyoChargeModeEnum {
126
126
  PriceLimit = "price-limit"
127
127
  }
128
128
  export interface EnyoAggregatedStateApplianceValues {
129
- gridPowerW?: number;
130
- gridFeedInWh?: number;
131
- gridConsumptionWh?: number;
132
- selfConsumptionW?: number;
133
- selfConsumptionWh?: number;
134
- batteryPowerW?: number;
129
+ powerW?: number;
135
130
  batterySoC?: number;
136
- pvPowerW?: number;
137
131
  currentA?: number;
138
132
  voltageL1?: number;
139
133
  voltageL2?: number;
140
134
  voltageL3?: number;
141
- pvProductionWh?: number;
142
- powerConsumptionHeatingWh?: number;
143
- powerConsumptionDomesticHotWaterWh?: number;
144
- heatGenerationHeatingWh?: number;
145
- heatGenerationDomesticHotWaterWh?: number;
146
- flexibility?: {
147
- kWh?: number;
148
- availableUntilIsoTimestamp?: string;
149
- };
150
135
  }
151
136
  export declare enum EnyoDataBusMessageEnum {
152
137
  InverterValuesUpdateV1 = "InverterValuesUpdateV1",
@@ -209,9 +194,7 @@ export declare enum EnyoDataBusMessageEnum {
209
194
  AirConditioningTemperaturesUpdateV1 = "AirConditioningTemperaturesUpdateV1",
210
195
  StartAirConditioningV1 = "StartAirConditioningV1",
211
196
  StopAirConditioningV1 = "StopAirConditioningV1",
212
- VehicleSocUpdateV1 = "VehicleSocUpdateV1",
213
- StartCalibrationV1 = "StartCalibrationV1",
214
- StopCalibrationV1 = "StopCalibrationV1"
197
+ VehicleSocUpdateV1 = "VehicleSocUpdateV1"
215
198
  }
216
199
  export type EnyoDataBusMessageResolution = '1s' | '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
217
200
  /**
@@ -504,29 +487,17 @@ export interface EnyoDataBusAggregatedStateValuesV1 extends EnyoDataBusMessage {
504
487
  clockId: string;
505
488
  data: {
506
489
  /** Total grid power from all appliances (in Watt). Negative: grid feed in, positive: grid consumption */
507
- totalGridPowerW?: number;
508
- /** Total grid feed in from all appliances (in Watt hours) */
509
- totalGridFeedInWh?: number;
510
- /** Total grid consumption from all appliances (in Watt hours) */
511
- totalGridConsumptionWh?: number;
512
- /** Total Home consumption from all appliances (in Watt) */
513
- totalHomeConsumptionW?: number;
514
- /** Total Home consumed energy from all appliances (in Watt hours) */
515
- totalHomeConsumptionWh?: number;
516
- /** Total battery power from all appliances (in Watt). Positive = consumption, negative = charging */
517
- totalBatteryPowerW?: number;
490
+ gridPowerW?: number;
491
+ gridConsumptionW?: number;
492
+ gridFeedInW?: number;
493
+ homeConsumptionW?: number;
494
+ homeConsumptionWithAppliancesW?: number;
495
+ /** battery power from all appliances (in Watt). Positive = consumption, negative = charging */
496
+ batteryPowerW?: number;
518
497
  /** Total PV production from all appliances (in Watt) */
519
- totalPvPowerW?: number;
520
- /** Total PV production from all appliances (in Watt hours) */
521
- totalPvProductionWh?: number;
522
- /** Total power consumption for heating from all appliances (in Watt hours) */
523
- totalPowerConsumptionHeatingWh?: number;
524
- /** Total power consumption for domestic hot water from all appliances (in Watt hours) */
525
- totalPowerConsumptionDomesticHotWaterWh?: number;
526
- /** Total heat generation for heating from all appliances (in Watt hours) */
527
- totalHeatGenerationHeatingWh?: number;
528
- /** Total heat generation for domestic hot water from all appliances (in Watt hours) */
529
- totalHeatGenerationDomesticHotWaterWh?: number;
498
+ pvProductionPowerW?: number;
499
+ heatpumpPowerW?: number;
500
+ chargerPowerW?: number;
530
501
  autarkyPercentage?: number;
531
502
  /** Array of all appliances with their individual values and current state */
532
503
  appliances: Array<{
@@ -536,8 +507,6 @@ export interface EnyoDataBusAggregatedStateValuesV1 extends EnyoDataBusMessage {
536
507
  type: EnyoApplianceTypeEnum;
537
508
  /** Current connection state of the appliance */
538
509
  state: EnyoApplianceStateEnum;
539
- /** ISO timestamp of the last update from this appliance */
540
- lastUpdateIso?: string;
541
510
  /** the current state values of the appliance */
542
511
  values: EnyoAggregatedStateApplianceValues;
543
512
  }>;
@@ -1581,44 +1550,3 @@ export interface EnyoDataBusVehicleSocUpdateV1 extends EnyoDataBusMessage {
1581
1550
  batterySizeKwh?: number;
1582
1551
  };
1583
1552
  }
1584
- /**
1585
- * Command message to start a calibration routine on a specific appliance.
1586
- * Calibration is a vendor- and appliance-specific procedure (e.g. zeroing
1587
- * a meter, learning a power range, aligning sensors); the targeted
1588
- * integration decides what calibration entails for the given appliance.
1589
- *
1590
- * The receiving integration must answer with an
1591
- * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
1592
- * message's `id` to indicate whether the calibration was accepted,
1593
- * rejected, or is not supported by the appliance.
1594
- */
1595
- export interface EnyoDataBusStartCalibrationV1 extends EnyoDataBusMessage {
1596
- type: 'message';
1597
- message: EnyoDataBusMessageEnum.StartCalibrationV1;
1598
- /** ID of the appliance to start calibration on */
1599
- applianceId: string;
1600
- data: {
1601
- /** Optional reason why this command was issued */
1602
- reason?: EnyoDataBusCommandReason;
1603
- };
1604
- }
1605
- /**
1606
- * Command message to stop a calibration routine that is currently running
1607
- * on a specific appliance. The targeted integration is expected to abort
1608
- * any in-progress calibration for the addressed appliance.
1609
- *
1610
- * The receiving integration must answer with an
1611
- * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
1612
- * message's `id` to indicate whether the stop request was accepted,
1613
- * rejected, or is not supported by the appliance.
1614
- */
1615
- export interface EnyoDataBusStopCalibrationV1 extends EnyoDataBusMessage {
1616
- type: 'message';
1617
- message: EnyoDataBusMessageEnum.StopCalibrationV1;
1618
- /** ID of the appliance to stop calibration on */
1619
- applianceId: string;
1620
- data: {
1621
- /** Optional reason why this command was issued */
1622
- reason?: EnyoDataBusCommandReason;
1623
- };
1624
- }
@@ -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.143';
12
+ exports.SDK_VERSION = '0.0.144';
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.143";
8
+ export declare const SDK_VERSION = "0.0.144";
9
9
  /**
10
10
  * Gets the current SDK version.
11
11
  * @returns The semantic version string of the SDK
@@ -129,7 +129,7 @@ export class HomeConsumptionForecast {
129
129
  this.initialized = false;
130
130
  }
131
131
  onAggregatedState(message) {
132
- const power = message.data.totalHomeConsumptionW;
132
+ const power = message.data.homeConsumptionW;
133
133
  if (typeof power !== 'number' || Number.isNaN(power))
134
134
  return;
135
135
  const ts = new Date(message.timestampIso).getTime();
@@ -126,27 +126,12 @@ export declare enum EnyoChargeModeEnum {
126
126
  PriceLimit = "price-limit"
127
127
  }
128
128
  export interface EnyoAggregatedStateApplianceValues {
129
- gridPowerW?: number;
130
- gridFeedInWh?: number;
131
- gridConsumptionWh?: number;
132
- selfConsumptionW?: number;
133
- selfConsumptionWh?: number;
134
- batteryPowerW?: number;
129
+ powerW?: number;
135
130
  batterySoC?: number;
136
- pvPowerW?: number;
137
131
  currentA?: number;
138
132
  voltageL1?: number;
139
133
  voltageL2?: number;
140
134
  voltageL3?: number;
141
- pvProductionWh?: number;
142
- powerConsumptionHeatingWh?: number;
143
- powerConsumptionDomesticHotWaterWh?: number;
144
- heatGenerationHeatingWh?: number;
145
- heatGenerationDomesticHotWaterWh?: number;
146
- flexibility?: {
147
- kWh?: number;
148
- availableUntilIsoTimestamp?: string;
149
- };
150
135
  }
151
136
  export declare enum EnyoDataBusMessageEnum {
152
137
  InverterValuesUpdateV1 = "InverterValuesUpdateV1",
@@ -209,9 +194,7 @@ export declare enum EnyoDataBusMessageEnum {
209
194
  AirConditioningTemperaturesUpdateV1 = "AirConditioningTemperaturesUpdateV1",
210
195
  StartAirConditioningV1 = "StartAirConditioningV1",
211
196
  StopAirConditioningV1 = "StopAirConditioningV1",
212
- VehicleSocUpdateV1 = "VehicleSocUpdateV1",
213
- StartCalibrationV1 = "StartCalibrationV1",
214
- StopCalibrationV1 = "StopCalibrationV1"
197
+ VehicleSocUpdateV1 = "VehicleSocUpdateV1"
215
198
  }
216
199
  export type EnyoDataBusMessageResolution = '1s' | '10s' | '30s' | '1m' | '15m' | '1h' | '1d' | 'dynamic';
217
200
  /**
@@ -504,29 +487,17 @@ export interface EnyoDataBusAggregatedStateValuesV1 extends EnyoDataBusMessage {
504
487
  clockId: string;
505
488
  data: {
506
489
  /** Total grid power from all appliances (in Watt). Negative: grid feed in, positive: grid consumption */
507
- totalGridPowerW?: number;
508
- /** Total grid feed in from all appliances (in Watt hours) */
509
- totalGridFeedInWh?: number;
510
- /** Total grid consumption from all appliances (in Watt hours) */
511
- totalGridConsumptionWh?: number;
512
- /** Total Home consumption from all appliances (in Watt) */
513
- totalHomeConsumptionW?: number;
514
- /** Total Home consumed energy from all appliances (in Watt hours) */
515
- totalHomeConsumptionWh?: number;
516
- /** Total battery power from all appliances (in Watt). Positive = consumption, negative = charging */
517
- totalBatteryPowerW?: number;
490
+ gridPowerW?: number;
491
+ gridConsumptionW?: number;
492
+ gridFeedInW?: number;
493
+ homeConsumptionW?: number;
494
+ homeConsumptionWithAppliancesW?: number;
495
+ /** battery power from all appliances (in Watt). Positive = consumption, negative = charging */
496
+ batteryPowerW?: number;
518
497
  /** Total PV production from all appliances (in Watt) */
519
- totalPvPowerW?: number;
520
- /** Total PV production from all appliances (in Watt hours) */
521
- totalPvProductionWh?: number;
522
- /** Total power consumption for heating from all appliances (in Watt hours) */
523
- totalPowerConsumptionHeatingWh?: number;
524
- /** Total power consumption for domestic hot water from all appliances (in Watt hours) */
525
- totalPowerConsumptionDomesticHotWaterWh?: number;
526
- /** Total heat generation for heating from all appliances (in Watt hours) */
527
- totalHeatGenerationHeatingWh?: number;
528
- /** Total heat generation for domestic hot water from all appliances (in Watt hours) */
529
- totalHeatGenerationDomesticHotWaterWh?: number;
498
+ pvProductionPowerW?: number;
499
+ heatpumpPowerW?: number;
500
+ chargerPowerW?: number;
530
501
  autarkyPercentage?: number;
531
502
  /** Array of all appliances with their individual values and current state */
532
503
  appliances: Array<{
@@ -536,8 +507,6 @@ export interface EnyoDataBusAggregatedStateValuesV1 extends EnyoDataBusMessage {
536
507
  type: EnyoApplianceTypeEnum;
537
508
  /** Current connection state of the appliance */
538
509
  state: EnyoApplianceStateEnum;
539
- /** ISO timestamp of the last update from this appliance */
540
- lastUpdateIso?: string;
541
510
  /** the current state values of the appliance */
542
511
  values: EnyoAggregatedStateApplianceValues;
543
512
  }>;
@@ -1581,44 +1550,3 @@ export interface EnyoDataBusVehicleSocUpdateV1 extends EnyoDataBusMessage {
1581
1550
  batterySizeKwh?: number;
1582
1551
  };
1583
1552
  }
1584
- /**
1585
- * Command message to start a calibration routine on a specific appliance.
1586
- * Calibration is a vendor- and appliance-specific procedure (e.g. zeroing
1587
- * a meter, learning a power range, aligning sensors); the targeted
1588
- * integration decides what calibration entails for the given appliance.
1589
- *
1590
- * The receiving integration must answer with an
1591
- * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
1592
- * message's `id` to indicate whether the calibration was accepted,
1593
- * rejected, or is not supported by the appliance.
1594
- */
1595
- export interface EnyoDataBusStartCalibrationV1 extends EnyoDataBusMessage {
1596
- type: 'message';
1597
- message: EnyoDataBusMessageEnum.StartCalibrationV1;
1598
- /** ID of the appliance to start calibration on */
1599
- applianceId: string;
1600
- data: {
1601
- /** Optional reason why this command was issued */
1602
- reason?: EnyoDataBusCommandReason;
1603
- };
1604
- }
1605
- /**
1606
- * Command message to stop a calibration routine that is currently running
1607
- * on a specific appliance. The targeted integration is expected to abort
1608
- * any in-progress calibration for the addressed appliance.
1609
- *
1610
- * The receiving integration must answer with an
1611
- * {@link EnyoDataBusCommandAcknowledgeV1} message that references this
1612
- * message's `id` to indicate whether the stop request was accepted,
1613
- * rejected, or is not supported by the appliance.
1614
- */
1615
- export interface EnyoDataBusStopCalibrationV1 extends EnyoDataBusMessage {
1616
- type: 'message';
1617
- message: EnyoDataBusMessageEnum.StopCalibrationV1;
1618
- /** ID of the appliance to stop calibration on */
1619
- applianceId: string;
1620
- data: {
1621
- /** Optional reason why this command was issued */
1622
- reason?: EnyoDataBusCommandReason;
1623
- };
1624
- }
@@ -167,8 +167,6 @@ export var EnyoDataBusMessageEnum;
167
167
  EnyoDataBusMessageEnum["StartAirConditioningV1"] = "StartAirConditioningV1";
168
168
  EnyoDataBusMessageEnum["StopAirConditioningV1"] = "StopAirConditioningV1";
169
169
  EnyoDataBusMessageEnum["VehicleSocUpdateV1"] = "VehicleSocUpdateV1";
170
- EnyoDataBusMessageEnum["StartCalibrationV1"] = "StartCalibrationV1";
171
- EnyoDataBusMessageEnum["StopCalibrationV1"] = "StopCalibrationV1";
172
170
  })(EnyoDataBusMessageEnum || (EnyoDataBusMessageEnum = {}));
173
171
  /**
174
172
  * Storage control mode carried by {@link EnyoDataBusSetStorageScheduleV1}.
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.143";
8
+ export declare const SDK_VERSION = "0.0.144";
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.143';
8
+ export const SDK_VERSION = '0.0.144';
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.143",
3
+ "version": "0.0.144",
4
4
  "description": "enyo Energy App SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",