@enyo-energy/energy-app-sdk 0.0.149 → 0.0.151
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/implementations/appliance-command-forecast/appliance-command-forecast-validators.cjs +1 -0
- package/dist/cjs/packages/eebus/eebus-mpc-client.d.cts +0 -9
- package/dist/cjs/packages/eebus/eebus-use-case-registry.d.cts +1 -6
- package/dist/cjs/packages/energy-app-udp.d.cts +8 -0
- package/dist/cjs/types/enyo-appliance-command-forecast.d.cts +12 -0
- package/dist/cjs/version.cjs +1 -1
- package/dist/cjs/version.d.cts +1 -1
- package/dist/implementations/appliance-command-forecast/appliance-command-forecast-validators.js +1 -0
- package/dist/packages/eebus/eebus-mpc-client.d.ts +0 -9
- package/dist/packages/eebus/eebus-use-case-registry.d.ts +1 -6
- package/dist/packages/energy-app-udp.d.ts +8 -0
- package/dist/types/enyo-appliance-command-forecast.d.ts +12 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -170,6 +170,7 @@ function validateHeatpumpScheduleEntry(entry, fieldName) {
|
|
|
170
170
|
validateBooleanField(entry.dhwBoostActive, `${fieldName}.dhwBoostActive`);
|
|
171
171
|
validateBooleanField(entry.roomPreHeatingActive, `${fieldName}.roomPreHeatingActive`);
|
|
172
172
|
validateBooleanField(entry.bufferTankBoostActive, `${fieldName}.bufferTankBoostActive`);
|
|
173
|
+
validateBooleanField(entry.availablePowerActive, `${fieldName}.availablePowerActive`);
|
|
173
174
|
}
|
|
174
175
|
function validateMetadata(forecast) {
|
|
175
176
|
if (!(forecast.resolution in RESOLUTION_SECONDS)) {
|
|
@@ -51,15 +51,6 @@ export interface MpcClientOptions {
|
|
|
51
51
|
* sluggish but functional — extend rather than disable.
|
|
52
52
|
*/
|
|
53
53
|
descriptionReadTimeoutMs?: number;
|
|
54
|
-
/**
|
|
55
|
-
* When the internal description read fails (timeout or
|
|
56
|
-
* not-supported), fall back to extracting `scopeType` from each
|
|
57
|
-
* inbound notify (`acPowerTotal` → {@link EebusMpcReading.activePowerW},
|
|
58
|
-
* `acEnergyConsumed` → {@link EebusMpcReading.totalEnergyConsumedWh})
|
|
59
|
-
* so the client keeps emitting readings instead of going silent.
|
|
60
|
-
* Defaults to `true`.
|
|
61
|
-
*/
|
|
62
|
-
fallbackToInlineScope?: boolean;
|
|
63
54
|
}
|
|
64
55
|
/**
|
|
65
56
|
* Client for the EEBUS **Monitoring of Power Consumption (MPC)** use case.
|
|
@@ -85,13 +85,8 @@ export interface EebusUseCaseRegistry {
|
|
|
85
85
|
* known). Without a hint the client picks the first server match the
|
|
86
86
|
* SDK resolves.
|
|
87
87
|
*
|
|
88
|
-
* The default options enable `fallbackToInlineScope`, so a single
|
|
89
|
-
* slow `measurementDescriptionListData` read on a flaky peer no
|
|
90
|
-
* longer silences the client — it falls back to extracting scope
|
|
91
|
-
* from inbound notifies.
|
|
92
|
-
*
|
|
93
88
|
* @param ski Subject Key Identifier of the remote node
|
|
94
|
-
* @param options Optional address/timeout
|
|
89
|
+
* @param options Optional address/timeout configuration
|
|
95
90
|
*/
|
|
96
91
|
mpc: (ski: string, options?: MpcClientOptions) => EebusMpcClient;
|
|
97
92
|
/**
|
|
@@ -4,6 +4,14 @@
|
|
|
4
4
|
export interface UdpBindOptions {
|
|
5
5
|
/** Bind port. 0 selects an ephemeral port. */
|
|
6
6
|
port: number;
|
|
7
|
+
/**
|
|
8
|
+
* When `true`, sets `SO_REUSEADDR` on the underlying socket so multiple
|
|
9
|
+
* sockets may bind to the same address/port. Maps to the `reuseAddr`
|
|
10
|
+
* option of `node:dgram`'s `createSocket`.
|
|
11
|
+
*
|
|
12
|
+
* Defaults to `false`.
|
|
13
|
+
*/
|
|
14
|
+
reuseAddr?: boolean;
|
|
7
15
|
}
|
|
8
16
|
/**
|
|
9
17
|
* A single inbound datagram delivered to a handler registered with
|
|
@@ -318,6 +318,18 @@ export interface HeatpumpForecastScheduleEntry {
|
|
|
318
318
|
* tank up, `false` (or omitted) otherwise.
|
|
319
319
|
*/
|
|
320
320
|
bufferTankBoostActive?: boolean;
|
|
321
|
+
/**
|
|
322
|
+
* Whether the publisher is announcing available power for this slot
|
|
323
|
+
* — `true` when the energy-manager decision for the slot is
|
|
324
|
+
* "available power", meaning {@link powerW} doubles as the
|
|
325
|
+
* available-power offer to the heatpump (the heatpump is free to
|
|
326
|
+
* consume up to that value), `false` (or omitted) otherwise.
|
|
327
|
+
*
|
|
328
|
+
* This flag is independent of the other `*Active` flags and may
|
|
329
|
+
* coexist with them when the publisher offers available power while
|
|
330
|
+
* a boost / pre-heating window is also planned.
|
|
331
|
+
*/
|
|
332
|
+
availablePowerActive?: boolean;
|
|
321
333
|
}
|
|
322
334
|
/**
|
|
323
335
|
* Forecasted command plan for a heatpump appliance, published via
|
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.151';
|
|
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
package/dist/implementations/appliance-command-forecast/appliance-command-forecast-validators.js
CHANGED
|
@@ -159,6 +159,7 @@ export function validateHeatpumpScheduleEntry(entry, fieldName) {
|
|
|
159
159
|
validateBooleanField(entry.dhwBoostActive, `${fieldName}.dhwBoostActive`);
|
|
160
160
|
validateBooleanField(entry.roomPreHeatingActive, `${fieldName}.roomPreHeatingActive`);
|
|
161
161
|
validateBooleanField(entry.bufferTankBoostActive, `${fieldName}.bufferTankBoostActive`);
|
|
162
|
+
validateBooleanField(entry.availablePowerActive, `${fieldName}.availablePowerActive`);
|
|
162
163
|
}
|
|
163
164
|
function validateMetadata(forecast) {
|
|
164
165
|
if (!(forecast.resolution in RESOLUTION_SECONDS)) {
|
|
@@ -51,15 +51,6 @@ export interface MpcClientOptions {
|
|
|
51
51
|
* sluggish but functional — extend rather than disable.
|
|
52
52
|
*/
|
|
53
53
|
descriptionReadTimeoutMs?: number;
|
|
54
|
-
/**
|
|
55
|
-
* When the internal description read fails (timeout or
|
|
56
|
-
* not-supported), fall back to extracting `scopeType` from each
|
|
57
|
-
* inbound notify (`acPowerTotal` → {@link EebusMpcReading.activePowerW},
|
|
58
|
-
* `acEnergyConsumed` → {@link EebusMpcReading.totalEnergyConsumedWh})
|
|
59
|
-
* so the client keeps emitting readings instead of going silent.
|
|
60
|
-
* Defaults to `true`.
|
|
61
|
-
*/
|
|
62
|
-
fallbackToInlineScope?: boolean;
|
|
63
54
|
}
|
|
64
55
|
/**
|
|
65
56
|
* Client for the EEBUS **Monitoring of Power Consumption (MPC)** use case.
|
|
@@ -85,13 +85,8 @@ export interface EebusUseCaseRegistry {
|
|
|
85
85
|
* known). Without a hint the client picks the first server match the
|
|
86
86
|
* SDK resolves.
|
|
87
87
|
*
|
|
88
|
-
* The default options enable `fallbackToInlineScope`, so a single
|
|
89
|
-
* slow `measurementDescriptionListData` read on a flaky peer no
|
|
90
|
-
* longer silences the client — it falls back to extracting scope
|
|
91
|
-
* from inbound notifies.
|
|
92
|
-
*
|
|
93
88
|
* @param ski Subject Key Identifier of the remote node
|
|
94
|
-
* @param options Optional address/timeout
|
|
89
|
+
* @param options Optional address/timeout configuration
|
|
95
90
|
*/
|
|
96
91
|
mpc: (ski: string, options?: MpcClientOptions) => EebusMpcClient;
|
|
97
92
|
/**
|
|
@@ -4,6 +4,14 @@
|
|
|
4
4
|
export interface UdpBindOptions {
|
|
5
5
|
/** Bind port. 0 selects an ephemeral port. */
|
|
6
6
|
port: number;
|
|
7
|
+
/**
|
|
8
|
+
* When `true`, sets `SO_REUSEADDR` on the underlying socket so multiple
|
|
9
|
+
* sockets may bind to the same address/port. Maps to the `reuseAddr`
|
|
10
|
+
* option of `node:dgram`'s `createSocket`.
|
|
11
|
+
*
|
|
12
|
+
* Defaults to `false`.
|
|
13
|
+
*/
|
|
14
|
+
reuseAddr?: boolean;
|
|
7
15
|
}
|
|
8
16
|
/**
|
|
9
17
|
* A single inbound datagram delivered to a handler registered with
|
|
@@ -318,6 +318,18 @@ export interface HeatpumpForecastScheduleEntry {
|
|
|
318
318
|
* tank up, `false` (or omitted) otherwise.
|
|
319
319
|
*/
|
|
320
320
|
bufferTankBoostActive?: boolean;
|
|
321
|
+
/**
|
|
322
|
+
* Whether the publisher is announcing available power for this slot
|
|
323
|
+
* — `true` when the energy-manager decision for the slot is
|
|
324
|
+
* "available power", meaning {@link powerW} doubles as the
|
|
325
|
+
* available-power offer to the heatpump (the heatpump is free to
|
|
326
|
+
* consume up to that value), `false` (or omitted) otherwise.
|
|
327
|
+
*
|
|
328
|
+
* This flag is independent of the other `*Active` flags and may
|
|
329
|
+
* coexist with them when the publisher offers available power while
|
|
330
|
+
* a boost / pre-heating window is also planned.
|
|
331
|
+
*/
|
|
332
|
+
availablePowerActive?: boolean;
|
|
321
333
|
}
|
|
322
334
|
/**
|
|
323
335
|
* Forecasted command plan for a heatpump appliance, published via
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED