@enyo-energy/energy-app-sdk 0.0.101 → 0.0.103
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-diagnostics.d.cts +12 -0
- 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-diagnostics.d.ts +12 -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.
|
|
@@ -324,6 +324,10 @@ export interface EnyoDiagnosticsHeatpumpDhwBoostAction extends EnyoDiagnosticsCo
|
|
|
324
324
|
powerW: number;
|
|
325
325
|
/** Optional target temperature in Celsius. */
|
|
326
326
|
targetTempC?: number;
|
|
327
|
+
/** Optional current domestic hot water temperature in Celsius. */
|
|
328
|
+
currentTemperatureC?: number;
|
|
329
|
+
/** Optional current outdoor temperature in Celsius. */
|
|
330
|
+
outdoorTemperatureC?: number;
|
|
327
331
|
}
|
|
328
332
|
/** Heatpump action: address room overheating. */
|
|
329
333
|
export interface EnyoDiagnosticsHeatpumpRoomOverheatingAction extends EnyoDiagnosticsControlActionBase {
|
|
@@ -334,6 +338,10 @@ export interface EnyoDiagnosticsHeatpumpRoomOverheatingAction extends EnyoDiagno
|
|
|
334
338
|
powerW: number;
|
|
335
339
|
/** Optional target temperature in Celsius. */
|
|
336
340
|
targetTempC?: number;
|
|
341
|
+
/** Optional current room temperature in Celsius. */
|
|
342
|
+
currentTemperatureC?: number;
|
|
343
|
+
/** Optional current outdoor temperature in Celsius. */
|
|
344
|
+
outdoorTemperatureC?: number;
|
|
337
345
|
}
|
|
338
346
|
/** Heatpump action: boost buffer tank temperature. */
|
|
339
347
|
export interface EnyoDiagnosticsHeatpumpBufferTankBoostAction extends EnyoDiagnosticsControlActionBase {
|
|
@@ -344,6 +352,10 @@ export interface EnyoDiagnosticsHeatpumpBufferTankBoostAction extends EnyoDiagno
|
|
|
344
352
|
powerW: number;
|
|
345
353
|
/** Optional target temperature in Celsius. */
|
|
346
354
|
targetTempC?: number;
|
|
355
|
+
/** Optional current room temperature in Celsius. */
|
|
356
|
+
currentTemperatureC?: number;
|
|
357
|
+
/** Optional current outdoor temperature in Celsius. */
|
|
358
|
+
outdoorTemperatureC?: number;
|
|
347
359
|
}
|
|
348
360
|
/** Union of all control plan action types. */
|
|
349
361
|
export type EnyoDiagnosticsControlAction = EnyoDiagnosticsStorageBlockDischargeAction | EnyoDiagnosticsStorageChargeFromGridAction | EnyoDiagnosticsStorageForceDischargeAction | EnyoDiagnosticsStorageChargingFromPvAction | EnyoDiagnosticsStorageDischargingIntoHomeAction | EnyoDiagnosticsChargerStartChargeAction | EnyoDiagnosticsChargerPauseChargeAction | EnyoDiagnosticsHeatpumpDhwBoostAction | EnyoDiagnosticsHeatpumpRoomOverheatingAction | EnyoDiagnosticsHeatpumpBufferTankBoostAction;
|
|
@@ -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.103';
|
|
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.
|
|
@@ -324,6 +324,10 @@ export interface EnyoDiagnosticsHeatpumpDhwBoostAction extends EnyoDiagnosticsCo
|
|
|
324
324
|
powerW: number;
|
|
325
325
|
/** Optional target temperature in Celsius. */
|
|
326
326
|
targetTempC?: number;
|
|
327
|
+
/** Optional current domestic hot water temperature in Celsius. */
|
|
328
|
+
currentTemperatureC?: number;
|
|
329
|
+
/** Optional current outdoor temperature in Celsius. */
|
|
330
|
+
outdoorTemperatureC?: number;
|
|
327
331
|
}
|
|
328
332
|
/** Heatpump action: address room overheating. */
|
|
329
333
|
export interface EnyoDiagnosticsHeatpumpRoomOverheatingAction extends EnyoDiagnosticsControlActionBase {
|
|
@@ -334,6 +338,10 @@ export interface EnyoDiagnosticsHeatpumpRoomOverheatingAction extends EnyoDiagno
|
|
|
334
338
|
powerW: number;
|
|
335
339
|
/** Optional target temperature in Celsius. */
|
|
336
340
|
targetTempC?: number;
|
|
341
|
+
/** Optional current room temperature in Celsius. */
|
|
342
|
+
currentTemperatureC?: number;
|
|
343
|
+
/** Optional current outdoor temperature in Celsius. */
|
|
344
|
+
outdoorTemperatureC?: number;
|
|
337
345
|
}
|
|
338
346
|
/** Heatpump action: boost buffer tank temperature. */
|
|
339
347
|
export interface EnyoDiagnosticsHeatpumpBufferTankBoostAction extends EnyoDiagnosticsControlActionBase {
|
|
@@ -344,6 +352,10 @@ export interface EnyoDiagnosticsHeatpumpBufferTankBoostAction extends EnyoDiagno
|
|
|
344
352
|
powerW: number;
|
|
345
353
|
/** Optional target temperature in Celsius. */
|
|
346
354
|
targetTempC?: number;
|
|
355
|
+
/** Optional current room temperature in Celsius. */
|
|
356
|
+
currentTemperatureC?: number;
|
|
357
|
+
/** Optional current outdoor temperature in Celsius. */
|
|
358
|
+
outdoorTemperatureC?: number;
|
|
347
359
|
}
|
|
348
360
|
/** Union of all control plan action types. */
|
|
349
361
|
export type EnyoDiagnosticsControlAction = EnyoDiagnosticsStorageBlockDischargeAction | EnyoDiagnosticsStorageChargeFromGridAction | EnyoDiagnosticsStorageForceDischargeAction | EnyoDiagnosticsStorageChargingFromPvAction | EnyoDiagnosticsStorageDischargingIntoHomeAction | EnyoDiagnosticsChargerStartChargeAction | EnyoDiagnosticsChargerPauseChargeAction | EnyoDiagnosticsHeatpumpDhwBoostAction | EnyoDiagnosticsHeatpumpRoomOverheatingAction | EnyoDiagnosticsHeatpumpBufferTankBoostAction;
|
|
@@ -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