@enyo-energy/energy-app-sdk 0.0.169 → 0.0.170
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/packages/energy-app-modbus.d.cts +21 -0
- package/dist/cjs/packages/energy-app-settings.d.cts +3 -1
- package/dist/cjs/version.cjs +1 -1
- package/dist/cjs/version.d.cts +1 -1
- package/dist/packages/energy-app-modbus.d.ts +21 -0
- package/dist/packages/energy-app-settings.d.ts +3 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -12,6 +12,27 @@ export interface ModbusOptions {
|
|
|
12
12
|
unitId?: number;
|
|
13
13
|
/** Whether to use TLS/SSL for the Modbus connection. Defaults to false (plain Modbus TCP). Set to true to enable Modbus Security (TLS, typically port 802). */
|
|
14
14
|
useTls?: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* PEM-encoded client certificate (or Buffer) presented for mutual-TLS Modbus Security
|
|
17
|
+
* connections. Only used when {@link useTls} is true.
|
|
18
|
+
*/
|
|
19
|
+
cert?: string | Buffer;
|
|
20
|
+
/**
|
|
21
|
+
* PEM-encoded private key (or Buffer) matching {@link cert} for mutual-TLS connections.
|
|
22
|
+
* Only used when {@link useTls} is true.
|
|
23
|
+
*/
|
|
24
|
+
key?: string | Buffer;
|
|
25
|
+
/**
|
|
26
|
+
* Trusted CA certificate(s) — a PEM string/Buffer, or an array of them — used to verify the
|
|
27
|
+
* server's certificate. Only used when {@link useTls} is true.
|
|
28
|
+
*/
|
|
29
|
+
ca?: string | Buffer | Array<string | Buffer>;
|
|
30
|
+
/**
|
|
31
|
+
* Whether to reject a TLS connection whose server certificate cannot be verified against
|
|
32
|
+
* {@link ca}. When omitted, the transport's default verification behaviour is used. Only
|
|
33
|
+
* used when {@link useTls} is true.
|
|
34
|
+
*/
|
|
35
|
+
rejectUnauthorized?: boolean;
|
|
15
36
|
}
|
|
16
37
|
/**
|
|
17
38
|
* Interface for Modbus TCP/IP communication in enyo packages.
|
|
@@ -18,9 +18,11 @@ export interface EnergyAppSettings {
|
|
|
18
18
|
* This will remove the setting regardless of whether it's for an appliance or the package.
|
|
19
19
|
*
|
|
20
20
|
* @param settingName - The unique name of the setting to remove
|
|
21
|
+
* @param applianceId - Optional appliance ID. If provided, only the setting scoped to that
|
|
22
|
+
* specific appliance is removed. If omitted, the setting is removed regardless of scope.
|
|
21
23
|
* @returns Promise that resolves when the setting is successfully removed
|
|
22
24
|
*/
|
|
23
|
-
removeSettingConfig(settingName: string): Promise<void>;
|
|
25
|
+
removeSettingConfig(settingName: string, applianceId?: string): Promise<void>;
|
|
24
26
|
/**
|
|
25
27
|
* Updates the value of an existing setting.
|
|
26
28
|
* The setting is identified by its unique name across all appliances and package settings.
|
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.170';
|
|
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
|
@@ -12,6 +12,27 @@ export interface ModbusOptions {
|
|
|
12
12
|
unitId?: number;
|
|
13
13
|
/** Whether to use TLS/SSL for the Modbus connection. Defaults to false (plain Modbus TCP). Set to true to enable Modbus Security (TLS, typically port 802). */
|
|
14
14
|
useTls?: boolean;
|
|
15
|
+
/**
|
|
16
|
+
* PEM-encoded client certificate (or Buffer) presented for mutual-TLS Modbus Security
|
|
17
|
+
* connections. Only used when {@link useTls} is true.
|
|
18
|
+
*/
|
|
19
|
+
cert?: string | Buffer;
|
|
20
|
+
/**
|
|
21
|
+
* PEM-encoded private key (or Buffer) matching {@link cert} for mutual-TLS connections.
|
|
22
|
+
* Only used when {@link useTls} is true.
|
|
23
|
+
*/
|
|
24
|
+
key?: string | Buffer;
|
|
25
|
+
/**
|
|
26
|
+
* Trusted CA certificate(s) — a PEM string/Buffer, or an array of them — used to verify the
|
|
27
|
+
* server's certificate. Only used when {@link useTls} is true.
|
|
28
|
+
*/
|
|
29
|
+
ca?: string | Buffer | Array<string | Buffer>;
|
|
30
|
+
/**
|
|
31
|
+
* Whether to reject a TLS connection whose server certificate cannot be verified against
|
|
32
|
+
* {@link ca}. When omitted, the transport's default verification behaviour is used. Only
|
|
33
|
+
* used when {@link useTls} is true.
|
|
34
|
+
*/
|
|
35
|
+
rejectUnauthorized?: boolean;
|
|
15
36
|
}
|
|
16
37
|
/**
|
|
17
38
|
* Interface for Modbus TCP/IP communication in enyo packages.
|
|
@@ -18,9 +18,11 @@ export interface EnergyAppSettings {
|
|
|
18
18
|
* This will remove the setting regardless of whether it's for an appliance or the package.
|
|
19
19
|
*
|
|
20
20
|
* @param settingName - The unique name of the setting to remove
|
|
21
|
+
* @param applianceId - Optional appliance ID. If provided, only the setting scoped to that
|
|
22
|
+
* specific appliance is removed. If omitted, the setting is removed regardless of scope.
|
|
21
23
|
* @returns Promise that resolves when the setting is successfully removed
|
|
22
24
|
*/
|
|
23
|
-
removeSettingConfig(settingName: string): Promise<void>;
|
|
25
|
+
removeSettingConfig(settingName: string, applianceId?: string): Promise<void>;
|
|
24
26
|
/**
|
|
25
27
|
* Updates the value of an existing setting.
|
|
26
28
|
* The setting is identified by its unique name across all appliances and package settings.
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED