@enyo-energy/energy-app-sdk 0.0.102 → 0.0.104
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.
- package/dist/cjs/energy-app-package-definition.d.cts +13 -0
- package/dist/cjs/types/enyo-battery-appliance.cjs +2 -0
- package/dist/cjs/types/enyo-battery-appliance.d.cts +3 -1
- package/dist/cjs/types/enyo-data-bus-value.cjs +1 -0
- package/dist/cjs/types/enyo-data-bus-value.d.cts +20 -1
- package/dist/cjs/types/enyo-heatpump-appliance.cjs +2 -0
- package/dist/cjs/types/enyo-heatpump-appliance.d.cts +3 -1
- package/dist/cjs/types/enyo-network-device.cjs +1 -0
- package/dist/cjs/types/enyo-network-device.d.cts +2 -1
- package/dist/cjs/version.cjs +1 -1
- package/dist/cjs/version.d.cts +1 -1
- package/dist/energy-app-package-definition.d.ts +13 -0
- package/dist/types/enyo-battery-appliance.d.ts +3 -1
- package/dist/types/enyo-battery-appliance.js +2 -0
- package/dist/types/enyo-data-bus-value.d.ts +20 -1
- package/dist/types/enyo-data-bus-value.js +1 -0
- package/dist/types/enyo-heatpump-appliance.d.ts +3 -1
- package/dist/types/enyo-heatpump-appliance.js +2 -0
- package/dist/types/enyo-network-device.d.ts +2 -1
- package/dist/types/enyo-network-device.js +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -65,6 +65,18 @@ export interface EnergyAppPackageOptionsDeviceDetectionEebus {
|
|
|
65
65
|
/** matching values, for example the vendor names or model names */
|
|
66
66
|
matchingValues: string[];
|
|
67
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Optional device detection configuration for mDNS TXT record matching.
|
|
70
|
+
* Matches against TXT record key-value pairs advertised by devices via mDNS.
|
|
71
|
+
*/
|
|
72
|
+
export interface EnergyAppPackageOptionsDeviceDetectionMdns {
|
|
73
|
+
/** The TXT record key to match against */
|
|
74
|
+
key: 'model' | 'brand' | 'uuid' | 'serial' | string;
|
|
75
|
+
/** The matching operation to perform on the TXT record value */
|
|
76
|
+
operation: 'eq' | 'startsWith';
|
|
77
|
+
/** Values to match the TXT record value against */
|
|
78
|
+
matchingValues: string[];
|
|
79
|
+
}
|
|
68
80
|
/**
|
|
69
81
|
* Optional device detection configuration for MQTT-based detection.
|
|
70
82
|
* Subscribes to a topic on the internal broker and matches messages against expected values.
|
|
@@ -87,6 +99,7 @@ export interface EnergyAppPackageOptionsDeviceDetection {
|
|
|
87
99
|
ocpp?: EnergyAppPackageOptionsDeviceDetectionOcpp[];
|
|
88
100
|
eebus?: EnergyAppPackageOptionsDeviceDetectionEebus[];
|
|
89
101
|
mqtt?: EnergyAppPackageOptionsDeviceDetectionMqtt[];
|
|
102
|
+
mdns?: EnergyAppPackageOptionsDeviceDetectionMdns[];
|
|
90
103
|
}
|
|
91
104
|
/**
|
|
92
105
|
* Optional configuration settings for an Energy App package.
|
|
@@ -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
|
+
}
|
|
@@ -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",
|
|
@@ -8,4 +8,5 @@ var EnyoNetworkDeviceDetectedAtEnum;
|
|
|
8
8
|
EnyoNetworkDeviceDetectedAtEnum["Hostname"] = "hostname";
|
|
9
9
|
EnyoNetworkDeviceDetectedAtEnum["Modbus"] = "modbus";
|
|
10
10
|
EnyoNetworkDeviceDetectedAtEnum["Http"] = "http";
|
|
11
|
+
EnyoNetworkDeviceDetectedAtEnum["Mdns"] = "mdns";
|
|
11
12
|
})(EnyoNetworkDeviceDetectedAtEnum || (exports.EnyoNetworkDeviceDetectedAtEnum = EnyoNetworkDeviceDetectedAtEnum = {}));
|
package/dist/cjs/version.cjs
CHANGED
|
@@ -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.
|
|
12
|
+
exports.SDK_VERSION = '0.0.104';
|
|
13
13
|
/**
|
|
14
14
|
* Gets the current SDK version.
|
|
15
15
|
* @returns The semantic version string of the SDK
|
package/dist/cjs/version.d.cts
CHANGED
|
@@ -65,6 +65,18 @@ export interface EnergyAppPackageOptionsDeviceDetectionEebus {
|
|
|
65
65
|
/** matching values, for example the vendor names or model names */
|
|
66
66
|
matchingValues: string[];
|
|
67
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Optional device detection configuration for mDNS TXT record matching.
|
|
70
|
+
* Matches against TXT record key-value pairs advertised by devices via mDNS.
|
|
71
|
+
*/
|
|
72
|
+
export interface EnergyAppPackageOptionsDeviceDetectionMdns {
|
|
73
|
+
/** The TXT record key to match against */
|
|
74
|
+
key: 'model' | 'brand' | 'uuid' | 'serial' | string;
|
|
75
|
+
/** The matching operation to perform on the TXT record value */
|
|
76
|
+
operation: 'eq' | 'startsWith';
|
|
77
|
+
/** Values to match the TXT record value against */
|
|
78
|
+
matchingValues: string[];
|
|
79
|
+
}
|
|
68
80
|
/**
|
|
69
81
|
* Optional device detection configuration for MQTT-based detection.
|
|
70
82
|
* Subscribes to a topic on the internal broker and matches messages against expected values.
|
|
@@ -87,6 +99,7 @@ export interface EnergyAppPackageOptionsDeviceDetection {
|
|
|
87
99
|
ocpp?: EnergyAppPackageOptionsDeviceDetectionOcpp[];
|
|
88
100
|
eebus?: EnergyAppPackageOptionsDeviceDetectionEebus[];
|
|
89
101
|
mqtt?: EnergyAppPackageOptionsDeviceDetectionMqtt[];
|
|
102
|
+
mdns?: EnergyAppPackageOptionsDeviceDetectionMdns[];
|
|
90
103
|
}
|
|
91
104
|
/**
|
|
92
105
|
* Optional configuration settings for an Energy App package.
|
|
@@ -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.
|
|
@@ -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) {
|
|
@@ -5,4 +5,5 @@ export var EnyoNetworkDeviceDetectedAtEnum;
|
|
|
5
5
|
EnyoNetworkDeviceDetectedAtEnum["Hostname"] = "hostname";
|
|
6
6
|
EnyoNetworkDeviceDetectedAtEnum["Modbus"] = "modbus";
|
|
7
7
|
EnyoNetworkDeviceDetectedAtEnum["Http"] = "http";
|
|
8
|
+
EnyoNetworkDeviceDetectedAtEnum["Mdns"] = "mdns";
|
|
8
9
|
})(EnyoNetworkDeviceDetectedAtEnum || (EnyoNetworkDeviceDetectedAtEnum = {}));
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED