@totemsdk/edge-modbus 0.2.0 → 0.2.2
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/LICENSE +202 -21
- package/NOTICE +60 -0
- package/README.md +76 -6
- package/dist/cjs/gateway.d.ts +35 -0
- package/dist/cjs/gateway.js +235 -0
- package/dist/cjs/index.d.ts +7 -0
- package/dist/cjs/index.js +9 -0
- package/dist/cjs/native-transport.d.ts +36 -0
- package/dist/cjs/native-transport.js +166 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/sensor-bridge.d.ts +30 -0
- package/dist/cjs/sensor-bridge.js +64 -0
- package/dist/cjs/transport.d.ts +38 -0
- package/dist/cjs/transport.js +8 -0
- package/dist/gateway.d.ts +2 -3
- package/dist/gateway.js +71 -30
- package/dist/index.js +3 -9
- package/dist/native-transport.js +1 -5
- package/dist/sensor-bridge.d.ts +1 -1
- package/dist/sensor-bridge.js +12 -41
- package/dist/transport.d.ts +7 -1
- package/dist/transport.js +1 -2
- package/package.json +25 -15
- package/sidecar.json +34 -0
package/LICENSE
CHANGED
|
@@ -1,21 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
Totem SDK
|
|
2
|
+
Copyright 2024-2026 Totem SDK Contributors
|
|
3
|
+
|
|
4
|
+
This product includes software and material derived from the projects listed
|
|
5
|
+
below. The notices are provided for attribution and do not modify the Apache
|
|
6
|
+
License, Version 2.0.
|
|
7
|
+
|
|
8
|
+
Minima
|
|
9
|
+
------
|
|
10
|
+
Minima protocol and application
|
|
11
|
+
https://github.com/minima-global/Minima
|
|
12
|
+
Licensed under the Apache License, Version 2.0.
|
|
13
|
+
|
|
14
|
+
Portions of the Totem SDK core, KISSVM, serialization, transaction and wallet
|
|
15
|
+
surfaces are translated or adapted from Minima's Java implementation. Those
|
|
16
|
+
portions remain subject to the Apache License, Version 2.0 and retain the
|
|
17
|
+
applicable copyright and attribution notices.
|
|
18
|
+
|
|
19
|
+
Bouncy Castle
|
|
20
|
+
-------------
|
|
21
|
+
Legion of the Bouncy Castle Inc.
|
|
22
|
+
https://www.bouncycastle.org/
|
|
23
|
+
Licensed under the Bouncy Castle License (MIT-style).
|
|
24
|
+
|
|
25
|
+
The Winternitz/GMSS-compatible WOTS implementation follows the algorithms and
|
|
26
|
+
behaviour of Bouncy Castle's WinternitzOTSignature, WinternitzOTSVerify and
|
|
27
|
+
GMSSRandom classes.
|
|
28
|
+
|
|
29
|
+
QVAC
|
|
30
|
+
----
|
|
31
|
+
QVAC SDK
|
|
32
|
+
https://www.npmjs.com/package/@qvac/sdk
|
|
33
|
+
Licensed under the Apache License, Version 2.0.
|
|
34
|
+
|
|
35
|
+
The vendored type surface in packages/qvac/src/vendor/qvac-sdk.d.ts is
|
|
36
|
+
reconstructed from the @qvac/sdk type declarations for build-time use.
|
|
37
|
+
|
|
38
|
+
Protocol Buffers
|
|
39
|
+
----------------
|
|
40
|
+
Protocol Buffers - Google's data interchange format
|
|
41
|
+
Copyright 2008 Google Inc. All rights reserved.
|
|
42
|
+
https://developers.google.com/protocol-buffers/
|
|
43
|
+
Licensed under the BSD 3-Clause License.
|
|
44
|
+
|
|
45
|
+
The generated file packages/agent-policy/src/generated/google/protobuf/struct.ts
|
|
46
|
+
retains its original BSD 3-Clause header.
|
|
47
|
+
|
|
48
|
+
BIP39
|
|
49
|
+
-----
|
|
50
|
+
BIP39 English word list
|
|
51
|
+
https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt
|
|
52
|
+
Licensed under the MIT License.
|
|
53
|
+
|
|
54
|
+
Contributor Covenant
|
|
55
|
+
--------------------
|
|
56
|
+
Contributor Covenant, version 2.1
|
|
57
|
+
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
58
|
+
Licensed under the Creative Commons Attribution 4.0 International License.
|
|
59
|
+
|
|
60
|
+
The Totem SDK Code of Conduct is adapted from Contributor Covenant 2.1.
|
package/README.md
CHANGED
|
@@ -12,6 +12,66 @@ npm install @totemsdk/edge-modbus
|
|
|
12
12
|
|
|
13
13
|
This package does **not** import `modbus-serial`, `net`, or `serialport`. All network/serial behaviour is injected via `ModbusTransportPort`. You provide the transport; the package handles framing, polling, and proof generation.
|
|
14
14
|
|
|
15
|
+
### Transport contract and recovery
|
|
16
|
+
|
|
17
|
+
`sendFrame` exchanges a **unit-prefixed PDU**, not a wire RTU/TCP frame:
|
|
18
|
+
|
|
19
|
+
- Request: `[unit, function, ...data]`; no MBAP header, CRC, or CRC placeholders.
|
|
20
|
+
- Read response: `[unit, function, byteCount, ...data]`.
|
|
21
|
+
- Write acknowledgement: `[unit, function, addressHi, addressLo, valueOrCountHi, valueOrCountLo]`.
|
|
22
|
+
- Exception response: `[unit, function | 0x80, exceptionCode]`.
|
|
23
|
+
|
|
24
|
+
Bindings own TCP transaction/protocol validation or RTU CRC validation. The Go
|
|
25
|
+
sidecar applies the requested unit ID under an exchange-wide lock, retains the
|
|
26
|
+
read byte count, validates actual device write echoes and applies configured
|
|
27
|
+
timeouts in both TCP and RTU modes. Broadcast unit zero is unsupported because
|
|
28
|
+
these APIs require a response. Update older bindings that append placeholder
|
|
29
|
+
CRC bytes when adopting this contract.
|
|
30
|
+
|
|
31
|
+
Invalid requests fail before I/O. Wrong-unit/function/length/echo responses fail.
|
|
32
|
+
Writes with a lost, malformed or mismatched acknowledgement return
|
|
33
|
+
`MODBUS_WRITE_OUTCOME_UNKNOWN`; they are sent once and never retried by the
|
|
34
|
+
gateway. Reconcile the device's actual state before authorizing another write.
|
|
35
|
+
A matching acknowledgement confirms the protocol exchange, not a physical
|
|
36
|
+
sensor's observed effect or RFC-022 policy approval.
|
|
37
|
+
|
|
38
|
+
Verification (build TypeScript before integration):
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
pnpm --filter @totemsdk/edge-modbus build
|
|
42
|
+
pnpm --filter @totemsdk/edge-modbus test --runInBand
|
|
43
|
+
pnpm --filter @totemsdk/edge-modbus test:go
|
|
44
|
+
pnpm --filter @totemsdk/edge-modbus test:integration
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The integration test builds and launches the real Go process, connects ESM/CJS
|
|
48
|
+
gateways through JSON lines and exercises a loopback Modbus TCP simulator. The
|
|
49
|
+
packed-consumer test installs local Edge/Modbus tarballs and calls the gateway in
|
|
50
|
+
ESM/CJS plus strict NodeNext type consumers.
|
|
51
|
+
Go tests include concurrent unit routing under the race detector and independent
|
|
52
|
+
RTU CRC/framing vectors, including corruption, wrong-unit, truncation and size
|
|
53
|
+
bounds.
|
|
54
|
+
|
|
55
|
+
## Native sidecar distribution
|
|
56
|
+
|
|
57
|
+
The npm package does **not** bundle platform binaries or auto-download one.
|
|
58
|
+
`sidecar.json` is the machine-readable contract; the sidecar must be built from
|
|
59
|
+
the matching package source:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
pnpm --filter @totemsdk/edge-modbus build:go
|
|
63
|
+
./packages/edge-modbus/bin/edge-modbus --version # edge-modbus protocol=1
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Set `MODBUS_MODE`, `MODBUS_LISTEN_ADDR`, `MODBUS_TCP_ADDR` or serial settings,
|
|
67
|
+
and `MODBUS_TIMEOUT_MS`. A protocol-major mismatch or unavailable binary must
|
|
68
|
+
block startup; there is no fallback transport.
|
|
69
|
+
|
|
70
|
+
Qualified evidence currently covers a macOS arm64 source build and loopback TCP
|
|
71
|
+
simulator, plus RTU codec/CRC unit tests. Serial hardware, Windows/Linux prebuilt
|
|
72
|
+
binaries, a vendor PLC matrix, and hot upgrade/rolling replacement remain
|
|
73
|
+
unqualified and must not be claimed as production-supported.
|
|
74
|
+
|
|
15
75
|
## Quick start
|
|
16
76
|
|
|
17
77
|
```ts
|
|
@@ -23,7 +83,7 @@ import type { ModbusTransportPort } from '@totemsdk/edge-modbus';
|
|
|
23
83
|
const transport: ModbusTransportPort = {
|
|
24
84
|
async connect() { /* open TCP socket or serial port */ },
|
|
25
85
|
async disconnect() { /* close */ },
|
|
26
|
-
async sendFrame(frame) { /*
|
|
86
|
+
async sendFrame(frame) { /* exchange unit-prefixed PDU, return validated response */ },
|
|
27
87
|
onFrame(handler) { /* register inbound frame handler */ return () => {}; },
|
|
28
88
|
onError(handler) { /* register error handler */ return () => {}; },
|
|
29
89
|
};
|
|
@@ -40,7 +100,7 @@ const gateway = createModbusGateway({ runtime, transport });
|
|
|
40
100
|
await gateway.start();
|
|
41
101
|
|
|
42
102
|
// 4. Read registers
|
|
43
|
-
const result = await gateway.
|
|
103
|
+
const result = await gateway.readHoldingRegisters(1, 0, 10);
|
|
44
104
|
console.log(result.data?.values); // [123, 456, ...]
|
|
45
105
|
|
|
46
106
|
// 5. Or use the sensor bridge for automated polling + proof generation
|
|
@@ -64,7 +124,7 @@ You must implement `ModbusTransportPort`:
|
|
|
64
124
|
|--------|-------------|
|
|
65
125
|
| `connect()` | Open TCP socket (port 502) or serial port |
|
|
66
126
|
| `disconnect()` | Close the connection |
|
|
67
|
-
| `sendFrame(frame)` |
|
|
127
|
+
| `sendFrame(frame)` | Exchange unit-prefixed PDU bytes as specified above |
|
|
68
128
|
| `onFrame(handler)` | Register handler for unsolicited/inbound frames |
|
|
69
129
|
| `onError(handler)` | Register handler for connection errors |
|
|
70
130
|
|
|
@@ -73,8 +133,13 @@ You must implement `ModbusTransportPort`:
|
|
|
73
133
|
| Code | Name | Gateway method |
|
|
74
134
|
|------|------|---------------|
|
|
75
135
|
| 1 | Read Coils | `readCoils(unitId, address, count)` |
|
|
76
|
-
|
|
|
77
|
-
|
|
|
136
|
+
| 2 | Read Discrete Inputs | `readDiscreteInputs(unitId, address, count)` |
|
|
137
|
+
| 3 | Read Holding Registers | `readHoldingRegisters(unitId, address, count)` |
|
|
138
|
+
| 4 | Read Input Registers | `readInputRegisters(unitId, address, count)` |
|
|
139
|
+
| 5 | Write Single Coil | `writeSingleCoil(unitId, address, value)` |
|
|
140
|
+
| 6 | Write Single Register | `writeSingleRegister(unitId, address, value)` |
|
|
141
|
+
| 15 | Write Multiple Coils | `writeMultipleCoils(unitId, address, values)` |
|
|
142
|
+
| 16 | Write Multiple Registers | `writeMultipleRegisters(unitId, address, values)` |
|
|
78
143
|
|
|
79
144
|
## Capabilities
|
|
80
145
|
|
|
@@ -82,4 +147,9 @@ You must implement `ModbusTransportPort`:
|
|
|
82
147
|
|
|
83
148
|
## License
|
|
84
149
|
|
|
85
|
-
|
|
150
|
+
Apache-2.0 — see [LICENSE](./LICENSE) and [NOTICE](./NOTICE).
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
## Testing
|
|
154
|
+
|
|
155
|
+
Unit tests: `tests/unit/edge-modbus/`; qualification: `tests/qualification/edge-modbus/`. Package scripts delegate to these central suites.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Modbus Edge Gateway — wires a ModbusTransportPort into an EdgeRuntime.
|
|
3
|
+
*
|
|
4
|
+
* Uses a unit-prefixed PDU (no CRC or MBAP header) at the transport boundary.
|
|
5
|
+
* The binding owns TCP transaction framing or RTU CRC validation.
|
|
6
|
+
*/
|
|
7
|
+
import type { EdgeRuntime, EdgeOperationResult } from '@totemsdk/edge';
|
|
8
|
+
import type { ModbusTransportPort } from './transport.js';
|
|
9
|
+
export interface ModbusGatewayConfig {
|
|
10
|
+
runtime: EdgeRuntime;
|
|
11
|
+
transport: ModbusTransportPort;
|
|
12
|
+
unitMap?: Record<number, string>;
|
|
13
|
+
}
|
|
14
|
+
export interface ModbusGateway {
|
|
15
|
+
start(): Promise<void>;
|
|
16
|
+
stop(): Promise<void>;
|
|
17
|
+
readonly status: 'stopped' | 'running' | 'error';
|
|
18
|
+
readCoils(unitId: number, address: number, count: number): Promise<EdgeOperationResult<{
|
|
19
|
+
values: boolean[];
|
|
20
|
+
}>>;
|
|
21
|
+
readDiscreteInputs(unitId: number, address: number, count: number): Promise<EdgeOperationResult<{
|
|
22
|
+
values: boolean[];
|
|
23
|
+
}>>;
|
|
24
|
+
readHoldingRegisters(unitId: number, address: number, count: number): Promise<EdgeOperationResult<{
|
|
25
|
+
values: number[];
|
|
26
|
+
}>>;
|
|
27
|
+
readInputRegisters(unitId: number, address: number, count: number): Promise<EdgeOperationResult<{
|
|
28
|
+
values: number[];
|
|
29
|
+
}>>;
|
|
30
|
+
writeSingleCoil(unitId: number, address: number, value: boolean): Promise<EdgeOperationResult<void>>;
|
|
31
|
+
writeSingleRegister(unitId: number, address: number, value: number): Promise<EdgeOperationResult<void>>;
|
|
32
|
+
writeMultipleCoils(unitId: number, address: number, values: boolean[]): Promise<EdgeOperationResult<void>>;
|
|
33
|
+
writeMultipleRegisters(unitId: number, address: number, values: number[]): Promise<EdgeOperationResult<void>>;
|
|
34
|
+
}
|
|
35
|
+
export declare function createModbusGateway(config: ModbusGatewayConfig): ModbusGateway;
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Modbus Edge Gateway — wires a ModbusTransportPort into an EdgeRuntime.
|
|
4
|
+
*
|
|
5
|
+
* Uses a unit-prefixed PDU (no CRC or MBAP header) at the transport boundary.
|
|
6
|
+
* The binding owns TCP transaction framing or RTU CRC validation.
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.createModbusGateway = createModbusGateway;
|
|
10
|
+
function createModbusGateway(config) {
|
|
11
|
+
let status = 'stopped';
|
|
12
|
+
let unsubFrame;
|
|
13
|
+
let unsubError;
|
|
14
|
+
return {
|
|
15
|
+
get status() { return status; },
|
|
16
|
+
async start() {
|
|
17
|
+
if (status === 'running')
|
|
18
|
+
return;
|
|
19
|
+
await config.transport.connect();
|
|
20
|
+
unsubFrame = config.transport.onFrame((_frame) => {
|
|
21
|
+
// Unsolicited frames are not expected in Modbus request/response model
|
|
22
|
+
});
|
|
23
|
+
unsubError = config.transport.onError(() => {
|
|
24
|
+
status = 'error';
|
|
25
|
+
});
|
|
26
|
+
status = 'running';
|
|
27
|
+
},
|
|
28
|
+
async stop() {
|
|
29
|
+
unsubFrame?.();
|
|
30
|
+
unsubError?.();
|
|
31
|
+
await config.transport.disconnect();
|
|
32
|
+
status = 'stopped';
|
|
33
|
+
},
|
|
34
|
+
async readCoils(unitId, address, count) {
|
|
35
|
+
return readBits(config.transport, unitId, 1, address, count);
|
|
36
|
+
},
|
|
37
|
+
async readDiscreteInputs(unitId, address, count) {
|
|
38
|
+
return readBits(config.transport, unitId, 2, address, count);
|
|
39
|
+
},
|
|
40
|
+
async readHoldingRegisters(unitId, address, count) {
|
|
41
|
+
return readRegisters(config.transport, unitId, 3, address, count);
|
|
42
|
+
},
|
|
43
|
+
async readInputRegisters(unitId, address, count) {
|
|
44
|
+
return readRegisters(config.transport, unitId, 4, address, count);
|
|
45
|
+
},
|
|
46
|
+
async writeSingleCoil(unitId, address, value) {
|
|
47
|
+
if (typeof value !== 'boolean')
|
|
48
|
+
return { ok: false, error: 'Coil value must be boolean', errorCode: 'MODBUS_INVALID_REQUEST' };
|
|
49
|
+
return writeSingle(config.transport, unitId, 5, address, value ? 0xFF00 : 0x0000);
|
|
50
|
+
},
|
|
51
|
+
async writeSingleRegister(unitId, address, value) {
|
|
52
|
+
return writeSingle(config.transport, unitId, 6, address, value);
|
|
53
|
+
},
|
|
54
|
+
async writeMultipleCoils(unitId, address, values) {
|
|
55
|
+
return writeMultipleCoilsImpl(config.transport, unitId, address, values);
|
|
56
|
+
},
|
|
57
|
+
async writeMultipleRegisters(unitId, address, values) {
|
|
58
|
+
return writeMultipleRegistersImpl(config.transport, unitId, address, values);
|
|
59
|
+
},
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
// ── Unit-prefixed PDU builders (no CRC or MBAP header) ───────────────────
|
|
63
|
+
class ModbusRequestError extends Error {
|
|
64
|
+
}
|
|
65
|
+
class ModbusExceptionError extends Error {
|
|
66
|
+
}
|
|
67
|
+
function validateRange(unitId, address, count, maximum) {
|
|
68
|
+
if (!Number.isInteger(unitId) || unitId < 1 || unitId > 247 ||
|
|
69
|
+
!Number.isInteger(address) || address < 0 || address > 0xffff ||
|
|
70
|
+
!Number.isInteger(count) || count < 1 || count > maximum || address + count > 0x10000) {
|
|
71
|
+
throw new ModbusRequestError('Invalid Modbus unit, address or quantity');
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
function validateRegister(value) {
|
|
75
|
+
if (!Number.isInteger(value) || value < 0 || value > 0xffff) {
|
|
76
|
+
throw new ModbusRequestError('Register value must be an unsigned 16-bit integer');
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
function buildReadFrame(unitId, fc, address, count) {
|
|
80
|
+
validateRange(unitId, address, count, fc <= 2 ? 2000 : 125);
|
|
81
|
+
const buf = new Uint8Array(6);
|
|
82
|
+
buf[0] = unitId;
|
|
83
|
+
buf[1] = fc;
|
|
84
|
+
new DataView(buf.buffer).setUint16(2, address, false);
|
|
85
|
+
new DataView(buf.buffer).setUint16(4, count, false);
|
|
86
|
+
return buf;
|
|
87
|
+
}
|
|
88
|
+
function buildWriteSingleFrame(unitId, fc, address, value) {
|
|
89
|
+
validateRange(unitId, address, 1, 1);
|
|
90
|
+
validateRegister(value);
|
|
91
|
+
const buf = new Uint8Array(6);
|
|
92
|
+
buf[0] = unitId;
|
|
93
|
+
buf[1] = fc;
|
|
94
|
+
new DataView(buf.buffer).setUint16(2, address, false);
|
|
95
|
+
new DataView(buf.buffer).setUint16(4, value, false);
|
|
96
|
+
return buf;
|
|
97
|
+
}
|
|
98
|
+
function buildWriteMultipleCoilsFrame(unitId, address, values) {
|
|
99
|
+
validateRange(unitId, address, values.length, 1968);
|
|
100
|
+
for (const value of values) {
|
|
101
|
+
if (typeof value !== 'boolean')
|
|
102
|
+
throw new ModbusRequestError('Coil values must be boolean');
|
|
103
|
+
}
|
|
104
|
+
const byteCount = Math.ceil(values.length / 8);
|
|
105
|
+
const buf = new Uint8Array(7 + byteCount);
|
|
106
|
+
buf[0] = unitId;
|
|
107
|
+
buf[1] = 15; // FC 15
|
|
108
|
+
new DataView(buf.buffer).setUint16(2, address, false);
|
|
109
|
+
new DataView(buf.buffer).setUint16(4, values.length, false);
|
|
110
|
+
buf[6] = byteCount;
|
|
111
|
+
for (let i = 0; i < values.length; i++) {
|
|
112
|
+
if (values[i]) {
|
|
113
|
+
buf[7 + Math.floor(i / 8)] |= (1 << (i % 8));
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
return buf;
|
|
117
|
+
}
|
|
118
|
+
function buildWriteMultipleRegistersFrame(unitId, address, values) {
|
|
119
|
+
validateRange(unitId, address, values.length, 123);
|
|
120
|
+
for (const value of values)
|
|
121
|
+
validateRegister(value);
|
|
122
|
+
const byteCount = values.length * 2;
|
|
123
|
+
const buf = new Uint8Array(7 + byteCount);
|
|
124
|
+
buf[0] = unitId;
|
|
125
|
+
buf[1] = 16; // FC 16
|
|
126
|
+
new DataView(buf.buffer).setUint16(2, address, false);
|
|
127
|
+
new DataView(buf.buffer).setUint16(4, values.length, false);
|
|
128
|
+
buf[6] = byteCount;
|
|
129
|
+
for (let i = 0; i < values.length; i++) {
|
|
130
|
+
new DataView(buf.buffer).setUint16(7 + i * 2, values[i], false);
|
|
131
|
+
}
|
|
132
|
+
return buf;
|
|
133
|
+
}
|
|
134
|
+
// ── Response parsers (RTU format — no MBAP header) ────────────────────────
|
|
135
|
+
function checkResponse(response, unitId, expectedFunction) {
|
|
136
|
+
if (response.length < 2 || response[0] !== unitId)
|
|
137
|
+
throw new Error('Modbus response unit/length mismatch');
|
|
138
|
+
const fc = response[1];
|
|
139
|
+
if (fc === (expectedFunction | 0x80)) {
|
|
140
|
+
if (response.length !== 3 || response[2] === 0)
|
|
141
|
+
throw new Error('Malformed Modbus exception response');
|
|
142
|
+
throw new ModbusExceptionError(`Modbus exception: function=${expectedFunction} code=${response[2]}`);
|
|
143
|
+
}
|
|
144
|
+
if (fc !== expectedFunction)
|
|
145
|
+
throw new Error('Modbus response function mismatch');
|
|
146
|
+
}
|
|
147
|
+
function checkReadLength(response, byteCount) {
|
|
148
|
+
if (response.length !== 3 + byteCount || response[2] !== byteCount) {
|
|
149
|
+
throw new Error('Modbus response byte count/length mismatch');
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
function checkWriteResponse(response, request) {
|
|
153
|
+
checkResponse(response, request[0], request[1]);
|
|
154
|
+
if (response.length !== 6 || response.some((byte, index) => byte !== request[index])) {
|
|
155
|
+
throw new Error('Modbus write acknowledgement mismatch');
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
function writeFailure(error) {
|
|
159
|
+
return { ok: false, error: String(error), errorCode: error instanceof ModbusRequestError
|
|
160
|
+
? 'MODBUS_INVALID_REQUEST' : error instanceof ModbusExceptionError
|
|
161
|
+
? 'MODBUS_EXCEPTION' : 'MODBUS_WRITE_OUTCOME_UNKNOWN' };
|
|
162
|
+
}
|
|
163
|
+
function parseBitResponse(response, count) {
|
|
164
|
+
checkReadLength(response, Math.ceil(count / 8));
|
|
165
|
+
const values = [];
|
|
166
|
+
for (let i = 0; i < count; i++) {
|
|
167
|
+
const byte = response[3 + Math.floor(i / 8)];
|
|
168
|
+
values.push(((byte >> (i % 8)) & 1) === 1);
|
|
169
|
+
}
|
|
170
|
+
return values;
|
|
171
|
+
}
|
|
172
|
+
function parseRegisterResponse(response, count) {
|
|
173
|
+
checkReadLength(response, count * 2);
|
|
174
|
+
const values = [];
|
|
175
|
+
for (let i = 0; i < count; i++) {
|
|
176
|
+
values.push(new DataView(response.buffer, response.byteOffset + 3 + i * 2, 2).getUint16(0, false));
|
|
177
|
+
}
|
|
178
|
+
return values;
|
|
179
|
+
}
|
|
180
|
+
// ── Operation implementations ─────────────────────────────────────────────
|
|
181
|
+
async function readBits(transport, unitId, fc, address, count) {
|
|
182
|
+
try {
|
|
183
|
+
const request = buildReadFrame(unitId, fc, address, count);
|
|
184
|
+
const response = await transport.sendFrame(request);
|
|
185
|
+
checkResponse(response, unitId, fc);
|
|
186
|
+
return { ok: true, data: { values: parseBitResponse(response, count) } };
|
|
187
|
+
}
|
|
188
|
+
catch (e) {
|
|
189
|
+
return { ok: false, error: String(e) };
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
async function readRegisters(transport, unitId, fc, address, count) {
|
|
193
|
+
try {
|
|
194
|
+
const request = buildReadFrame(unitId, fc, address, count);
|
|
195
|
+
const response = await transport.sendFrame(request);
|
|
196
|
+
checkResponse(response, unitId, fc);
|
|
197
|
+
return { ok: true, data: { values: parseRegisterResponse(response, count) } };
|
|
198
|
+
}
|
|
199
|
+
catch (e) {
|
|
200
|
+
return { ok: false, error: String(e) };
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
async function writeSingle(transport, unitId, fc, address, value) {
|
|
204
|
+
try {
|
|
205
|
+
const request = buildWriteSingleFrame(unitId, fc, address, value);
|
|
206
|
+
const response = await transport.sendFrame(request);
|
|
207
|
+
checkWriteResponse(response, request);
|
|
208
|
+
return { ok: true };
|
|
209
|
+
}
|
|
210
|
+
catch (e) {
|
|
211
|
+
return writeFailure(e);
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
async function writeMultipleCoilsImpl(transport, unitId, address, values) {
|
|
215
|
+
try {
|
|
216
|
+
const request = buildWriteMultipleCoilsFrame(unitId, address, values);
|
|
217
|
+
const response = await transport.sendFrame(request);
|
|
218
|
+
checkWriteResponse(response, request);
|
|
219
|
+
return { ok: true };
|
|
220
|
+
}
|
|
221
|
+
catch (e) {
|
|
222
|
+
return writeFailure(e);
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
async function writeMultipleRegistersImpl(transport, unitId, address, values) {
|
|
226
|
+
try {
|
|
227
|
+
const request = buildWriteMultipleRegistersFrame(unitId, address, values);
|
|
228
|
+
const response = await transport.sendFrame(request);
|
|
229
|
+
checkWriteResponse(response, request);
|
|
230
|
+
return { ok: true };
|
|
231
|
+
}
|
|
232
|
+
catch (e) {
|
|
233
|
+
return writeFailure(e);
|
|
234
|
+
}
|
|
235
|
+
}
|