@enyo-energy/energy-app-sdk 0.0.171 → 0.0.172
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-rtu.d.cts +15 -0
- package/dist/cjs/packages/energy-app-modbus.d.cts +14 -0
- package/dist/cjs/packages/energy-app-udp.d.cts +14 -0
- package/dist/cjs/version.cjs +1 -1
- package/dist/cjs/version.d.cts +1 -1
- package/dist/packages/energy-app-modbus-rtu.d.ts +15 -0
- package/dist/packages/energy-app-modbus.d.ts +14 -0
- package/dist/packages/energy-app-udp.d.ts +14 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
|
@@ -12,6 +12,21 @@ export interface ModbusRtuOptions {
|
|
|
12
12
|
parity?: 'none' | 'even' | 'odd';
|
|
13
13
|
/** Connection timeout in milliseconds */
|
|
14
14
|
timeout?: number;
|
|
15
|
+
/**
|
|
16
|
+
* When `true`, requests are not run in parallel on this connection: consecutive requests
|
|
17
|
+
* ({@link EnergyAppModbusRtuInstance.readRegisters} / {@link EnergyAppModbusRtuInstance.writeRegisters})
|
|
18
|
+
* are serialized through an internal operation chain and run sequentially in call order, so a
|
|
19
|
+
* chain of messages cannot be interleaved with requests from concurrent callers. This is
|
|
20
|
+
* especially relevant on RTU, where the serial line is half-duplex and shared across every
|
|
21
|
+
* slave ID on the bus. Defaults to `false` (requests may execute concurrently).
|
|
22
|
+
*/
|
|
23
|
+
noParallelRequests?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Optional delay, in milliseconds, to wait between two consecutive requests. Only applies when
|
|
26
|
+
* {@link noParallelRequests} is `true`; ignored otherwise. A short inter-message gap is often
|
|
27
|
+
* required by slower RTU slaves to avoid dropped frames. Defaults to `0` (no delay).
|
|
28
|
+
*/
|
|
29
|
+
waitBetweenMessagesMs?: number;
|
|
15
30
|
}
|
|
16
31
|
/**
|
|
17
32
|
* Request parameters for reading Modbus RTU registers.
|
|
@@ -33,6 +33,20 @@ export interface ModbusOptions {
|
|
|
33
33
|
* used when {@link useTls} is true.
|
|
34
34
|
*/
|
|
35
35
|
rejectUnauthorized?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* When `true`, requests are not run in parallel on this connection: consecutive Modbus
|
|
38
|
+
* requests (reads and writes) are serialized through an internal operation chain and run
|
|
39
|
+
* sequentially in call order, so a chain of messages cannot be interleaved with requests from
|
|
40
|
+
* concurrent callers. Use this when a sequence of register operations must be applied
|
|
41
|
+
* atomically relative to each other. Defaults to `false` (requests may execute concurrently).
|
|
42
|
+
*/
|
|
43
|
+
noParallelRequests?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* Optional delay, in milliseconds, to wait between two consecutive requests. Only applies when
|
|
46
|
+
* {@link noParallelRequests} is `true`; ignored otherwise. Useful for devices that need a short
|
|
47
|
+
* recovery gap between messages. Defaults to `0` (no delay).
|
|
48
|
+
*/
|
|
49
|
+
waitBetweenMessagesMs?: number;
|
|
36
50
|
}
|
|
37
51
|
/**
|
|
38
52
|
* Interface for Modbus TCP/IP communication in enyo packages.
|
|
@@ -40,6 +40,20 @@ export interface UdpBindOptions {
|
|
|
40
40
|
* callers should leave this `undefined`.
|
|
41
41
|
*/
|
|
42
42
|
multicastInterface?: string;
|
|
43
|
+
/**
|
|
44
|
+
* When `true`, sends are not run in parallel on this socket: consecutive
|
|
45
|
+
* {@link EnergyAppUdpSocket.send} calls are serialized through an internal operation chain and
|
|
46
|
+
* run sequentially in call order, so a chain of datagrams cannot be interleaved with sends
|
|
47
|
+
* from concurrent callers. Use this when a request/response exchange requires a strict send
|
|
48
|
+
* ordering. Defaults to `false` (sends may execute concurrently).
|
|
49
|
+
*/
|
|
50
|
+
noParallelRequests?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Optional delay, in milliseconds, to wait between two consecutive sends. Only applies when
|
|
53
|
+
* {@link noParallelRequests} is `true`; ignored otherwise. Useful for peers that need a short
|
|
54
|
+
* gap between datagrams. Defaults to `0` (no delay).
|
|
55
|
+
*/
|
|
56
|
+
waitBetweenMessagesMs?: number;
|
|
43
57
|
}
|
|
44
58
|
/**
|
|
45
59
|
* A single inbound datagram delivered to a handler registered with
|
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.172';
|
|
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,21 @@ export interface ModbusRtuOptions {
|
|
|
12
12
|
parity?: 'none' | 'even' | 'odd';
|
|
13
13
|
/** Connection timeout in milliseconds */
|
|
14
14
|
timeout?: number;
|
|
15
|
+
/**
|
|
16
|
+
* When `true`, requests are not run in parallel on this connection: consecutive requests
|
|
17
|
+
* ({@link EnergyAppModbusRtuInstance.readRegisters} / {@link EnergyAppModbusRtuInstance.writeRegisters})
|
|
18
|
+
* are serialized through an internal operation chain and run sequentially in call order, so a
|
|
19
|
+
* chain of messages cannot be interleaved with requests from concurrent callers. This is
|
|
20
|
+
* especially relevant on RTU, where the serial line is half-duplex and shared across every
|
|
21
|
+
* slave ID on the bus. Defaults to `false` (requests may execute concurrently).
|
|
22
|
+
*/
|
|
23
|
+
noParallelRequests?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Optional delay, in milliseconds, to wait between two consecutive requests. Only applies when
|
|
26
|
+
* {@link noParallelRequests} is `true`; ignored otherwise. A short inter-message gap is often
|
|
27
|
+
* required by slower RTU slaves to avoid dropped frames. Defaults to `0` (no delay).
|
|
28
|
+
*/
|
|
29
|
+
waitBetweenMessagesMs?: number;
|
|
15
30
|
}
|
|
16
31
|
/**
|
|
17
32
|
* Request parameters for reading Modbus RTU registers.
|
|
@@ -33,6 +33,20 @@ export interface ModbusOptions {
|
|
|
33
33
|
* used when {@link useTls} is true.
|
|
34
34
|
*/
|
|
35
35
|
rejectUnauthorized?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* When `true`, requests are not run in parallel on this connection: consecutive Modbus
|
|
38
|
+
* requests (reads and writes) are serialized through an internal operation chain and run
|
|
39
|
+
* sequentially in call order, so a chain of messages cannot be interleaved with requests from
|
|
40
|
+
* concurrent callers. Use this when a sequence of register operations must be applied
|
|
41
|
+
* atomically relative to each other. Defaults to `false` (requests may execute concurrently).
|
|
42
|
+
*/
|
|
43
|
+
noParallelRequests?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* Optional delay, in milliseconds, to wait between two consecutive requests. Only applies when
|
|
46
|
+
* {@link noParallelRequests} is `true`; ignored otherwise. Useful for devices that need a short
|
|
47
|
+
* recovery gap between messages. Defaults to `0` (no delay).
|
|
48
|
+
*/
|
|
49
|
+
waitBetweenMessagesMs?: number;
|
|
36
50
|
}
|
|
37
51
|
/**
|
|
38
52
|
* Interface for Modbus TCP/IP communication in enyo packages.
|
|
@@ -40,6 +40,20 @@ export interface UdpBindOptions {
|
|
|
40
40
|
* callers should leave this `undefined`.
|
|
41
41
|
*/
|
|
42
42
|
multicastInterface?: string;
|
|
43
|
+
/**
|
|
44
|
+
* When `true`, sends are not run in parallel on this socket: consecutive
|
|
45
|
+
* {@link EnergyAppUdpSocket.send} calls are serialized through an internal operation chain and
|
|
46
|
+
* run sequentially in call order, so a chain of datagrams cannot be interleaved with sends
|
|
47
|
+
* from concurrent callers. Use this when a request/response exchange requires a strict send
|
|
48
|
+
* ordering. Defaults to `false` (sends may execute concurrently).
|
|
49
|
+
*/
|
|
50
|
+
noParallelRequests?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Optional delay, in milliseconds, to wait between two consecutive sends. Only applies when
|
|
53
|
+
* {@link noParallelRequests} is `true`; ignored otherwise. Useful for peers that need a short
|
|
54
|
+
* gap between datagrams. Defaults to `0` (no delay).
|
|
55
|
+
*/
|
|
56
|
+
waitBetweenMessagesMs?: number;
|
|
43
57
|
}
|
|
44
58
|
/**
|
|
45
59
|
* A single inbound datagram delivered to a handler registered with
|
package/dist/version.d.ts
CHANGED
package/dist/version.js
CHANGED