@enyo-energy/energy-app-sdk 0.0.172 → 0.0.174
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/types/enyo-data-bus-value.d.cts +12 -1
- package/dist/cjs/types/enyo-heating-rod-appliance.d.cts +2 -0
- package/dist/cjs/types/enyo-onboarding.d.cts +10 -0
- package/dist/cjs/version.cjs +1 -1
- package/dist/cjs/version.d.cts +1 -1
- package/dist/types/enyo-data-bus-value.d.ts +12 -1
- package/dist/types/enyo-heating-rod-appliance.d.ts +2 -0
- package/dist/types/enyo-onboarding.d.ts +10 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -266,7 +266,9 @@ export type EnyoDataBusMessageResolution = '1s' | '10s' | '30s' | '1m' | '15m' |
|
|
|
266
266
|
/**
|
|
267
267
|
* Optional addressing information for a {@link EnyoDataBusMessage}. When omitted
|
|
268
268
|
* the message is broadcast to all subscribers; when set, the message is only
|
|
269
|
-
* delivered to packages that match the specified target.
|
|
269
|
+
* delivered to packages that match the specified target. Broadcasting of an
|
|
270
|
+
* untargeted message can additionally be suppressed by setting
|
|
271
|
+
* {@link EnyoDataBusMessage.broadcast} to `false`.
|
|
270
272
|
*
|
|
271
273
|
* Exactly one of {@link cloudPackageId} or {@link categories} should be provided.
|
|
272
274
|
* When both are set, consumers should treat them as an AND (the receiving package
|
|
@@ -303,6 +305,15 @@ export interface EnyoDataBusMessage {
|
|
|
303
305
|
* {@link EnyoDataBusMessageTarget} for matching semantics.
|
|
304
306
|
*/
|
|
305
307
|
target?: EnyoDataBusMessageTarget;
|
|
308
|
+
/**
|
|
309
|
+
* Whether this message may be broadcast to all subscribers on the bus.
|
|
310
|
+
* Defaults to `true` when omitted (the message is eligible for broadcast).
|
|
311
|
+
* Set to `false` to prevent the message from fanning out to all subscribers —
|
|
312
|
+
* for example when it should only reach the recipients named by {@link target}.
|
|
313
|
+
* This flag is independent of {@link target}: `target` narrows delivery, while
|
|
314
|
+
* `broadcast` controls whether an untargeted message reaches every subscriber.
|
|
315
|
+
*/
|
|
316
|
+
broadcast?: boolean;
|
|
306
317
|
data: object;
|
|
307
318
|
}
|
|
308
319
|
export interface EnyoDataBusMessageAnswer extends EnyoDataBusMessage {
|
|
@@ -29,6 +29,8 @@ export interface EnyoHeatingRodApplianceMetadata {
|
|
|
29
29
|
mode?: EnyoHeatingRodApplianceModeEnum;
|
|
30
30
|
/** Rated electrical power of the heating rod in watts */
|
|
31
31
|
ratedPowerW?: number;
|
|
32
|
+
/** the target temperature of this heating rod. Might be different than the target of the heatpump */
|
|
33
|
+
targetTemperatureC: number;
|
|
32
34
|
/**
|
|
33
35
|
* Optional identifier of the heat pump appliance this heating rod is
|
|
34
36
|
* associated with. References the `id` of an EnyoAppliance of type Heatpump.
|
|
@@ -259,6 +259,16 @@ export interface EnyoOnboardingStepResponse {
|
|
|
259
259
|
state: 'success' | 'error';
|
|
260
260
|
/** Optional translated error message if state is 'error' */
|
|
261
261
|
errorMessage?: EnyoOnboardingTranslatedContent[];
|
|
262
|
+
/**
|
|
263
|
+
* When true on a successful step response, instructs the host to route the user to the
|
|
264
|
+
* pending authentication request after this step completes. Typically set on the final step
|
|
265
|
+
* of a guide so the user is sent to authenticate (e.g. sign in to a cloud service) once
|
|
266
|
+
* onboarding finishes. The authentication request itself must have been created separately
|
|
267
|
+
* via `EnergyAppAuthentication.requestAuthentication`, and its result is handled through
|
|
268
|
+
* `listenForAuthenticationResponse`. This is fire-and-forget — the guide completes regardless
|
|
269
|
+
* of the authentication outcome. Ignored when `state` is 'error'.
|
|
270
|
+
*/
|
|
271
|
+
goToAuthentication?: boolean;
|
|
262
272
|
}
|
|
263
273
|
/**
|
|
264
274
|
* Callback function type for handling step submissions.
|
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.174';
|
|
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
|
@@ -266,7 +266,9 @@ export type EnyoDataBusMessageResolution = '1s' | '10s' | '30s' | '1m' | '15m' |
|
|
|
266
266
|
/**
|
|
267
267
|
* Optional addressing information for a {@link EnyoDataBusMessage}. When omitted
|
|
268
268
|
* the message is broadcast to all subscribers; when set, the message is only
|
|
269
|
-
* delivered to packages that match the specified target.
|
|
269
|
+
* delivered to packages that match the specified target. Broadcasting of an
|
|
270
|
+
* untargeted message can additionally be suppressed by setting
|
|
271
|
+
* {@link EnyoDataBusMessage.broadcast} to `false`.
|
|
270
272
|
*
|
|
271
273
|
* Exactly one of {@link cloudPackageId} or {@link categories} should be provided.
|
|
272
274
|
* When both are set, consumers should treat them as an AND (the receiving package
|
|
@@ -303,6 +305,15 @@ export interface EnyoDataBusMessage {
|
|
|
303
305
|
* {@link EnyoDataBusMessageTarget} for matching semantics.
|
|
304
306
|
*/
|
|
305
307
|
target?: EnyoDataBusMessageTarget;
|
|
308
|
+
/**
|
|
309
|
+
* Whether this message may be broadcast to all subscribers on the bus.
|
|
310
|
+
* Defaults to `true` when omitted (the message is eligible for broadcast).
|
|
311
|
+
* Set to `false` to prevent the message from fanning out to all subscribers —
|
|
312
|
+
* for example when it should only reach the recipients named by {@link target}.
|
|
313
|
+
* This flag is independent of {@link target}: `target` narrows delivery, while
|
|
314
|
+
* `broadcast` controls whether an untargeted message reaches every subscriber.
|
|
315
|
+
*/
|
|
316
|
+
broadcast?: boolean;
|
|
306
317
|
data: object;
|
|
307
318
|
}
|
|
308
319
|
export interface EnyoDataBusMessageAnswer extends EnyoDataBusMessage {
|
|
@@ -29,6 +29,8 @@ export interface EnyoHeatingRodApplianceMetadata {
|
|
|
29
29
|
mode?: EnyoHeatingRodApplianceModeEnum;
|
|
30
30
|
/** Rated electrical power of the heating rod in watts */
|
|
31
31
|
ratedPowerW?: number;
|
|
32
|
+
/** the target temperature of this heating rod. Might be different than the target of the heatpump */
|
|
33
|
+
targetTemperatureC: number;
|
|
32
34
|
/**
|
|
33
35
|
* Optional identifier of the heat pump appliance this heating rod is
|
|
34
36
|
* associated with. References the `id` of an EnyoAppliance of type Heatpump.
|
|
@@ -259,6 +259,16 @@ export interface EnyoOnboardingStepResponse {
|
|
|
259
259
|
state: 'success' | 'error';
|
|
260
260
|
/** Optional translated error message if state is 'error' */
|
|
261
261
|
errorMessage?: EnyoOnboardingTranslatedContent[];
|
|
262
|
+
/**
|
|
263
|
+
* When true on a successful step response, instructs the host to route the user to the
|
|
264
|
+
* pending authentication request after this step completes. Typically set on the final step
|
|
265
|
+
* of a guide so the user is sent to authenticate (e.g. sign in to a cloud service) once
|
|
266
|
+
* onboarding finishes. The authentication request itself must have been created separately
|
|
267
|
+
* via `EnergyAppAuthentication.requestAuthentication`, and its result is handled through
|
|
268
|
+
* `listenForAuthenticationResponse`. This is fire-and-forget — the guide completes regardless
|
|
269
|
+
* of the authentication outcome. Ignored when `state` is 'error'.
|
|
270
|
+
*/
|
|
271
|
+
goToAuthentication?: boolean;
|
|
262
272
|
}
|
|
263
273
|
/**
|
|
264
274
|
* Callback function type for handling step submissions.
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED