@enyo-energy/energy-app-sdk 0.0.134 → 0.0.135
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.
|
@@ -98,6 +98,67 @@ export interface EnyoApplianceModbusMetadata {
|
|
|
98
98
|
/** Optional base address for the appliance's Modbus registers */
|
|
99
99
|
baseAddress?: number;
|
|
100
100
|
}
|
|
101
|
+
/**
|
|
102
|
+
* EEBUS connection metadata for the appliance.
|
|
103
|
+
*
|
|
104
|
+
* Holds EEBUS-/SPINE-specific identifiers that identify the underlying
|
|
105
|
+
* remote node and entity. Vendor-neutral fields such as `vendorName`,
|
|
106
|
+
* `serialNumber`, `firmwareVersion` and `modelName` are already exposed on
|
|
107
|
+
* the top-level {@link EnyoApplianceMetadata} and should not be duplicated
|
|
108
|
+
* here — this interface only carries identifiers that have no meaningful
|
|
109
|
+
* equivalent outside of EEBUS.
|
|
110
|
+
*/
|
|
111
|
+
export interface EnyoApplianceEebusMetadata {
|
|
112
|
+
/**
|
|
113
|
+
* Subject Key Identifier — the unique cryptographic identifier of the
|
|
114
|
+
* remote EEBUS node this appliance is bound to. Stable across firmware
|
|
115
|
+
* upgrades and the primary key for EEBUS pairing/trust.
|
|
116
|
+
*/
|
|
117
|
+
ski: string;
|
|
118
|
+
/**
|
|
119
|
+
* SPINE entity type of the appliance within the remote node (e.g.
|
|
120
|
+
* `'EVSE'`, `'EV'`, `'HeatPumpAppliance'`). Comes from
|
|
121
|
+
* `NodeManagement.DetailedDiscoveryData` and identifies which sub-entity
|
|
122
|
+
* of the node represents this appliance when a node exposes multiple.
|
|
123
|
+
*/
|
|
124
|
+
deviceType?: string;
|
|
125
|
+
/**
|
|
126
|
+
* SPINE entity address of the appliance within the remote node — a
|
|
127
|
+
* sequence of integers identifying the entity. Useful when the node
|
|
128
|
+
* exposes multiple entities of the same {@link deviceType}.
|
|
129
|
+
*/
|
|
130
|
+
entityAddress?: number[];
|
|
131
|
+
/**
|
|
132
|
+
* Vendor company code as reported via SPINE
|
|
133
|
+
* `DeviceClassification.ManufacturerData.VendorCode`. EEBUS-specific
|
|
134
|
+
* counterpart to the human-readable `vendorName` on the parent
|
|
135
|
+
* metadata.
|
|
136
|
+
*/
|
|
137
|
+
vendorCode?: string;
|
|
138
|
+
/**
|
|
139
|
+
* Brand name under which the device is sold, as reported via SPINE
|
|
140
|
+
* `DeviceClassification.ManufacturerData.BrandName`.
|
|
141
|
+
*/
|
|
142
|
+
brandName?: string;
|
|
143
|
+
/**
|
|
144
|
+
* Manufacturer-assigned device code (model identifier) as reported via
|
|
145
|
+
* SPINE `DeviceClassification.ManufacturerData.DeviceCode`.
|
|
146
|
+
*/
|
|
147
|
+
deviceCode?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Manufacturer-assigned node identifier — the literal
|
|
150
|
+
* `ManufacturerNodeIdentification` field from SPINE
|
|
151
|
+
* `DeviceClassificationManufacturerDataType`. Often used by vendors as
|
|
152
|
+
* a stable identifier across firmware upgrades.
|
|
153
|
+
*/
|
|
154
|
+
manufacturerNodeIdentification?: string;
|
|
155
|
+
/**
|
|
156
|
+
* User-assigned node identifier — the literal `UserNodeIdentification`
|
|
157
|
+
* field from SPINE `DeviceClassificationUserDataType`. May be changed
|
|
158
|
+
* by the end user via the device's UI at any time.
|
|
159
|
+
*/
|
|
160
|
+
userNodeIdentification?: string;
|
|
161
|
+
}
|
|
101
162
|
export declare enum EnyoApplianceConnectionType {
|
|
102
163
|
Connector = "Connector",
|
|
103
164
|
Cloud = "Cloud"
|
|
@@ -114,6 +175,8 @@ export interface EnyoApplianceMetadata {
|
|
|
114
175
|
status?: EnyoApplianceStatusEnum;
|
|
115
176
|
network?: EnyoApplianceNetworkMetadata;
|
|
116
177
|
modbus?: EnyoApplianceModbusMetadata;
|
|
178
|
+
/** Optional EEBUS connection metadata (SKI, SPINE entity type, vendor code, …) */
|
|
179
|
+
eebus?: EnyoApplianceEebusMetadata;
|
|
117
180
|
/** Optional MQTT configuration */
|
|
118
181
|
mqtt?: EnyoApplianceMqttConfig;
|
|
119
182
|
connectionType: EnyoApplianceConnectionType;
|
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.135';
|
|
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
|
@@ -98,6 +98,67 @@ export interface EnyoApplianceModbusMetadata {
|
|
|
98
98
|
/** Optional base address for the appliance's Modbus registers */
|
|
99
99
|
baseAddress?: number;
|
|
100
100
|
}
|
|
101
|
+
/**
|
|
102
|
+
* EEBUS connection metadata for the appliance.
|
|
103
|
+
*
|
|
104
|
+
* Holds EEBUS-/SPINE-specific identifiers that identify the underlying
|
|
105
|
+
* remote node and entity. Vendor-neutral fields such as `vendorName`,
|
|
106
|
+
* `serialNumber`, `firmwareVersion` and `modelName` are already exposed on
|
|
107
|
+
* the top-level {@link EnyoApplianceMetadata} and should not be duplicated
|
|
108
|
+
* here — this interface only carries identifiers that have no meaningful
|
|
109
|
+
* equivalent outside of EEBUS.
|
|
110
|
+
*/
|
|
111
|
+
export interface EnyoApplianceEebusMetadata {
|
|
112
|
+
/**
|
|
113
|
+
* Subject Key Identifier — the unique cryptographic identifier of the
|
|
114
|
+
* remote EEBUS node this appliance is bound to. Stable across firmware
|
|
115
|
+
* upgrades and the primary key for EEBUS pairing/trust.
|
|
116
|
+
*/
|
|
117
|
+
ski: string;
|
|
118
|
+
/**
|
|
119
|
+
* SPINE entity type of the appliance within the remote node (e.g.
|
|
120
|
+
* `'EVSE'`, `'EV'`, `'HeatPumpAppliance'`). Comes from
|
|
121
|
+
* `NodeManagement.DetailedDiscoveryData` and identifies which sub-entity
|
|
122
|
+
* of the node represents this appliance when a node exposes multiple.
|
|
123
|
+
*/
|
|
124
|
+
deviceType?: string;
|
|
125
|
+
/**
|
|
126
|
+
* SPINE entity address of the appliance within the remote node — a
|
|
127
|
+
* sequence of integers identifying the entity. Useful when the node
|
|
128
|
+
* exposes multiple entities of the same {@link deviceType}.
|
|
129
|
+
*/
|
|
130
|
+
entityAddress?: number[];
|
|
131
|
+
/**
|
|
132
|
+
* Vendor company code as reported via SPINE
|
|
133
|
+
* `DeviceClassification.ManufacturerData.VendorCode`. EEBUS-specific
|
|
134
|
+
* counterpart to the human-readable `vendorName` on the parent
|
|
135
|
+
* metadata.
|
|
136
|
+
*/
|
|
137
|
+
vendorCode?: string;
|
|
138
|
+
/**
|
|
139
|
+
* Brand name under which the device is sold, as reported via SPINE
|
|
140
|
+
* `DeviceClassification.ManufacturerData.BrandName`.
|
|
141
|
+
*/
|
|
142
|
+
brandName?: string;
|
|
143
|
+
/**
|
|
144
|
+
* Manufacturer-assigned device code (model identifier) as reported via
|
|
145
|
+
* SPINE `DeviceClassification.ManufacturerData.DeviceCode`.
|
|
146
|
+
*/
|
|
147
|
+
deviceCode?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Manufacturer-assigned node identifier — the literal
|
|
150
|
+
* `ManufacturerNodeIdentification` field from SPINE
|
|
151
|
+
* `DeviceClassificationManufacturerDataType`. Often used by vendors as
|
|
152
|
+
* a stable identifier across firmware upgrades.
|
|
153
|
+
*/
|
|
154
|
+
manufacturerNodeIdentification?: string;
|
|
155
|
+
/**
|
|
156
|
+
* User-assigned node identifier — the literal `UserNodeIdentification`
|
|
157
|
+
* field from SPINE `DeviceClassificationUserDataType`. May be changed
|
|
158
|
+
* by the end user via the device's UI at any time.
|
|
159
|
+
*/
|
|
160
|
+
userNodeIdentification?: string;
|
|
161
|
+
}
|
|
101
162
|
export declare enum EnyoApplianceConnectionType {
|
|
102
163
|
Connector = "Connector",
|
|
103
164
|
Cloud = "Cloud"
|
|
@@ -114,6 +175,8 @@ export interface EnyoApplianceMetadata {
|
|
|
114
175
|
status?: EnyoApplianceStatusEnum;
|
|
115
176
|
network?: EnyoApplianceNetworkMetadata;
|
|
116
177
|
modbus?: EnyoApplianceModbusMetadata;
|
|
178
|
+
/** Optional EEBUS connection metadata (SKI, SPINE entity type, vendor code, …) */
|
|
179
|
+
eebus?: EnyoApplianceEebusMetadata;
|
|
117
180
|
/** Optional MQTT configuration */
|
|
118
181
|
mqtt?: EnyoApplianceMqttConfig;
|
|
119
182
|
connectionType: EnyoApplianceConnectionType;
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED