@ya-modbus/transport 0.13.0 → 0.14.1
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/CHANGELOG.md +12 -0
- package/README.md +16 -0
- package/dist/cjs/src/answer-length.d.ts +7 -0
- package/dist/cjs/src/answer-length.d.ts.map +1 -0
- package/dist/cjs/src/answer-length.js +15 -0
- package/dist/cjs/src/answer-length.js.map +1 -0
- package/dist/cjs/src/create-modbus-transport.d.ts.map +1 -1
- package/dist/cjs/src/create-modbus-transport.js +5 -4
- package/dist/cjs/src/create-modbus-transport.js.map +1 -1
- package/dist/cjs/src/index.d.ts +1 -0
- package/dist/cjs/src/index.d.ts.map +1 -1
- package/dist/cjs/src/index.js +3 -1
- package/dist/cjs/src/index.js.map +1 -1
- package/dist/cjs/src/last-request.d.ts +29 -0
- package/dist/cjs/src/last-request.d.ts.map +1 -0
- package/dist/cjs/src/last-request.js +44 -0
- package/dist/cjs/src/last-request.js.map +1 -0
- package/dist/cjs/src/manager.d.ts +2 -0
- package/dist/cjs/src/manager.d.ts.map +1 -1
- package/dist/cjs/src/manager.js +5 -1
- package/dist/cjs/src/manager.js.map +1 -1
- package/dist/cjs/src/retry.d.ts +7 -0
- package/dist/cjs/src/retry.d.ts.map +1 -1
- package/dist/cjs/src/retry.js +1 -0
- package/dist/cjs/src/retry.js.map +1 -1
- package/dist/cjs/src/rtu-transport.d.ts +7 -0
- package/dist/cjs/src/rtu-transport.d.ts.map +1 -1
- package/dist/cjs/src/rtu-transport.js.map +1 -1
- package/dist/cjs/src/slave-transport.d.ts +18 -1
- package/dist/cjs/src/slave-transport.d.ts.map +1 -1
- package/dist/cjs/src/slave-transport.js +60 -53
- package/dist/cjs/src/slave-transport.js.map +1 -1
- package/dist/cjs/tsconfig.cjs.tsbuildinfo +1 -1
- package/dist/esm/src/answer-length.d.ts +7 -0
- package/dist/esm/src/answer-length.d.ts.map +1 -0
- package/dist/esm/src/answer-length.js +12 -0
- package/dist/esm/src/answer-length.js.map +1 -0
- package/dist/esm/src/create-modbus-transport.d.ts.map +1 -1
- package/dist/esm/src/create-modbus-transport.js +5 -4
- package/dist/esm/src/create-modbus-transport.js.map +1 -1
- package/dist/esm/src/index.d.ts +1 -0
- package/dist/esm/src/index.d.ts.map +1 -1
- package/dist/esm/src/index.js +1 -0
- package/dist/esm/src/index.js.map +1 -1
- package/dist/esm/src/last-request.d.ts +29 -0
- package/dist/esm/src/last-request.d.ts.map +1 -0
- package/dist/esm/src/last-request.js +40 -0
- package/dist/esm/src/last-request.js.map +1 -0
- package/dist/esm/src/manager.d.ts +2 -0
- package/dist/esm/src/manager.d.ts.map +1 -1
- package/dist/esm/src/manager.js +5 -1
- package/dist/esm/src/manager.js.map +1 -1
- package/dist/esm/src/retry.d.ts +7 -0
- package/dist/esm/src/retry.d.ts.map +1 -1
- package/dist/esm/src/retry.js +1 -1
- package/dist/esm/src/retry.js.map +1 -1
- package/dist/esm/src/rtu-transport.d.ts +7 -0
- package/dist/esm/src/rtu-transport.d.ts.map +1 -1
- package/dist/esm/src/rtu-transport.js.map +1 -1
- package/dist/esm/src/slave-transport.d.ts +18 -1
- package/dist/esm/src/slave-transport.d.ts.map +1 -1
- package/dist/esm/src/slave-transport.js +60 -53
- package/dist/esm/src/slave-transport.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/package.json +2 -2
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.SlaveTransport = void 0;
|
|
4
|
+
const answer_length_js_1 = require("./answer-length.js");
|
|
4
5
|
const connection_js_1 = require("./connection.js");
|
|
6
|
+
const last_request_js_1 = require("./last-request.js");
|
|
5
7
|
const retry_js_1 = require("./retry.js");
|
|
6
8
|
/**
|
|
7
9
|
* SlaveTransport wraps a shared ModbusRTU client with slave-specific addressing.
|
|
@@ -13,6 +15,10 @@ const retry_js_1 = require("./retry.js");
|
|
|
13
15
|
* Requests on a lost connection reject with a ConnectionLostError. When the shared
|
|
14
16
|
* ModbusConnection can reopen its client, all devices on the connection use the new client.
|
|
15
17
|
*
|
|
18
|
+
* With an `interDeviceDelay` and a LastRequest shared by the transports on the connection, a
|
|
19
|
+
* request waits after a request to another slave. Some meters do not answer a request that
|
|
20
|
+
* comes too soon after another meter's reply.
|
|
21
|
+
*
|
|
16
22
|
* @example
|
|
17
23
|
* ```typescript
|
|
18
24
|
* const client = new ModbusRTU()
|
|
@@ -36,88 +42,71 @@ class SlaveTransport {
|
|
|
36
42
|
* @param mutex - Shared mutex for serializing operations on the bus
|
|
37
43
|
* @param maxRetries - Maximum retry attempts for failed operations (default: 3)
|
|
38
44
|
* @param logger - Optional callback to log retry attempts
|
|
45
|
+
* @param interDeviceDelay - Pause in milliseconds before a request to this slave when the
|
|
46
|
+
* previous request on the connection went to another slave, counted from the end of that
|
|
47
|
+
* request (default: 0, no pause)
|
|
48
|
+
* @param lastRequest - Last request on the connection, the same for all transports that share
|
|
49
|
+
* the mutex. interDeviceDelay needs it.
|
|
39
50
|
*/
|
|
40
|
-
constructor(slaveId, client, mutex, maxRetries = 3, logger) {
|
|
51
|
+
constructor(slaveId, client, mutex, maxRetries = 3, logger, interDeviceDelay = 0, lastRequest = new last_request_js_1.LastRequest()) {
|
|
41
52
|
this.slaveId = slaveId;
|
|
42
53
|
this.mutex = mutex;
|
|
43
54
|
this.maxRetries = maxRetries;
|
|
44
55
|
this.logger = logger;
|
|
56
|
+
this.interDeviceDelay = interDeviceDelay;
|
|
57
|
+
this.lastRequest = lastRequest;
|
|
45
58
|
this.connection = (0, connection_js_1.toConnection)(client);
|
|
46
59
|
}
|
|
47
60
|
async readHoldingRegisters(address, count) {
|
|
48
|
-
return this.
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
const result = await client.readHoldingRegisters(address, count);
|
|
52
|
-
return result.buffer;
|
|
53
|
-
}), this.maxRetries, this.logger);
|
|
61
|
+
return this.request(async (client) => {
|
|
62
|
+
const result = await client.readHoldingRegisters(address, count);
|
|
63
|
+
return (0, answer_length_js_1.checkLength)(result.buffer, count * 2);
|
|
54
64
|
});
|
|
55
65
|
}
|
|
56
66
|
async readInputRegisters(address, count) {
|
|
57
|
-
return this.
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
const result = await client.readInputRegisters(address, count);
|
|
61
|
-
return result.buffer;
|
|
62
|
-
}), this.maxRetries, this.logger);
|
|
67
|
+
return this.request(async (client) => {
|
|
68
|
+
const result = await client.readInputRegisters(address, count);
|
|
69
|
+
return (0, answer_length_js_1.checkLength)(result.buffer, count * 2);
|
|
63
70
|
});
|
|
64
71
|
}
|
|
65
72
|
async readCoils(address, count) {
|
|
66
|
-
return this.
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
const result = await client.readCoils(address, count);
|
|
70
|
-
return result.buffer;
|
|
71
|
-
}), this.maxRetries, this.logger);
|
|
73
|
+
return this.request(async (client) => {
|
|
74
|
+
const result = await client.readCoils(address, count);
|
|
75
|
+
return (0, answer_length_js_1.checkLength)(result.buffer, Math.ceil(count / 8));
|
|
72
76
|
});
|
|
73
77
|
}
|
|
74
78
|
async readDiscreteInputs(address, count) {
|
|
75
|
-
return this.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
const result = await client.readDiscreteInputs(address, count);
|
|
79
|
-
return result.buffer;
|
|
80
|
-
}), this.maxRetries, this.logger);
|
|
79
|
+
return this.request(async (client) => {
|
|
80
|
+
const result = await client.readDiscreteInputs(address, count);
|
|
81
|
+
return (0, answer_length_js_1.checkLength)(result.buffer, Math.ceil(count / 8));
|
|
81
82
|
});
|
|
82
83
|
}
|
|
83
84
|
async writeSingleRegister(address, value) {
|
|
84
|
-
return this.
|
|
85
|
-
|
|
86
|
-
client.setID(this.slaveId);
|
|
87
|
-
await client.writeRegister(address, value);
|
|
88
|
-
}), this.maxRetries, this.logger);
|
|
85
|
+
return this.request(async (client) => {
|
|
86
|
+
await client.writeRegister(address, value);
|
|
89
87
|
});
|
|
90
88
|
}
|
|
91
89
|
async writeMultipleRegisters(address, values) {
|
|
92
|
-
return this.
|
|
93
|
-
|
|
94
|
-
client.setID(this.slaveId);
|
|
95
|
-
await client.writeRegisters(address, values);
|
|
96
|
-
}), this.maxRetries, this.logger);
|
|
90
|
+
return this.request(async (client) => {
|
|
91
|
+
await client.writeRegisters(address, values);
|
|
97
92
|
});
|
|
98
93
|
}
|
|
99
94
|
async writeSingleCoil(address, value) {
|
|
100
|
-
return this.
|
|
101
|
-
|
|
102
|
-
client.setID(this.slaveId);
|
|
103
|
-
await client.writeCoil(address, value);
|
|
104
|
-
}), this.maxRetries, this.logger);
|
|
95
|
+
return this.request(async (client) => {
|
|
96
|
+
await client.writeCoil(address, value);
|
|
105
97
|
});
|
|
106
98
|
}
|
|
107
99
|
async writeMultipleCoils(address, values) {
|
|
108
|
-
return this.
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
const
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
}
|
|
119
|
-
await client.writeCoils(address, bools);
|
|
120
|
-
}), this.maxRetries, this.logger);
|
|
100
|
+
return this.request(async (client) => {
|
|
101
|
+
// Convert Buffer to boolean array
|
|
102
|
+
const bools = [];
|
|
103
|
+
for (let i = 0; i < values.length * 8; i++) {
|
|
104
|
+
const byteIndex = Math.floor(i / 8);
|
|
105
|
+
const bitIndex = i % 8;
|
|
106
|
+
const byte = values[byteIndex];
|
|
107
|
+
bools.push((byte & (1 << bitIndex)) !== 0);
|
|
108
|
+
}
|
|
109
|
+
await client.writeCoils(address, bools);
|
|
121
110
|
});
|
|
122
111
|
}
|
|
123
112
|
/**
|
|
@@ -135,6 +124,24 @@ class SlaveTransport {
|
|
|
135
124
|
// Don't use mutex for close operation
|
|
136
125
|
return this.connection.close();
|
|
137
126
|
}
|
|
127
|
+
/**
|
|
128
|
+
* Run a request to this slave while no other request uses the bus: wait for the pause after
|
|
129
|
+
* a request to another slave, then send it with retries
|
|
130
|
+
*/
|
|
131
|
+
request(send) {
|
|
132
|
+
return this.mutex.runExclusive(async () => {
|
|
133
|
+
await this.lastRequest.waitBefore(this.slaveId, this.interDeviceDelay);
|
|
134
|
+
try {
|
|
135
|
+
return await (0, retry_js_1.withRetry)(() => this.connection.run(async (client) => {
|
|
136
|
+
client.setID(this.slaveId);
|
|
137
|
+
return send(client);
|
|
138
|
+
}), this.maxRetries, this.logger);
|
|
139
|
+
}
|
|
140
|
+
finally {
|
|
141
|
+
this.lastRequest.ended(this.slaveId);
|
|
142
|
+
}
|
|
143
|
+
});
|
|
144
|
+
}
|
|
138
145
|
}
|
|
139
146
|
exports.SlaveTransport = SlaveTransport;
|
|
140
147
|
//# sourceMappingURL=slave-transport.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"slave-transport.js","sourceRoot":"","sources":["../../../src/slave-transport.ts"],"names":[],"mappings":";;;AAIA,mDAAqE;AACrE,yCAAwD;AAExD
|
|
1
|
+
{"version":3,"file":"slave-transport.js","sourceRoot":"","sources":["../../../src/slave-transport.ts"],"names":[],"mappings":";;;AAIA,yDAAgD;AAChD,mDAAqE;AACrE,uDAA+C;AAC/C,yCAAwD;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,cAAc;IAGzB;;;;;;;;;;;OAWG;IACH,YACmB,OAAe,EAChC,MAAoC,EACnB,KAAY,EACZ,aAAqB,CAAC,EACtB,MAAoB,EACpB,mBAA2B,CAAC,EAC5B,cAA2B,IAAI,6BAAW,EAAE;QAN5C,YAAO,GAAP,OAAO,CAAQ;QAEf,UAAK,GAAL,KAAK,CAAO;QACZ,eAAU,GAAV,UAAU,CAAY;QACtB,WAAM,GAAN,MAAM,CAAc;QACpB,qBAAgB,GAAhB,gBAAgB,CAAY;QAC5B,gBAAW,GAAX,WAAW,CAAiC;QAE7D,IAAI,CAAC,UAAU,GAAG,IAAA,4BAAY,EAAC,MAAM,CAAC,CAAA;IACxC,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,OAAe,EAAE,KAAa;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YAChE,OAAO,IAAA,8BAAW,EAAC,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAe,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YAC9D,OAAO,IAAA,8BAAW,EAAC,MAAM,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,KAAa;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YACrD,OAAO,IAAA,8BAAW,EAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAA;QACzD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAe,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;YAC9D,OAAO,IAAA,8BAAW,EAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAA;QACzD,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,OAAe,EAAE,KAAa;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC5C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,OAAe,EAAE,MAAc;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,KAAc;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,MAAM,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAe,EAAE,MAAc;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACnC,kCAAkC;YAClC,MAAM,KAAK,GAAc,EAAE,CAAA;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;gBACnC,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,CAAA;gBACtB,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAW,CAAA;gBACxC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;YAC5C,CAAC;YACD,MAAM,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACzC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK;QACT,sCAAsC;QACtC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;IAChC,CAAC;IAED;;;OAGG;IACK,OAAO,CAAI,IAAuC;QACxD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE;YACxC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAA;YACtE,IAAI,CAAC;gBACH,OAAO,MAAM,IAAA,oBAAS,EACpB,GAAG,EAAE,CACH,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;oBACnC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;oBAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,CAAA;gBACrB,CAAC,CAAC,EACJ,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,MAAM,CACZ,CAAA;YACH,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACtC,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AA7HD,wCA6HC"}
|