njs-modbus 3.1.1 → 3.2.0

package/README.md

@@ -152,6 +152,26 @@ const slave = new ModbusSlave({
 | `idleTimeout` | `number` | Idle timeout in ms before evicting a connection. Default `30000`. Pass `0` to disable. |
 | `socketOpts` / `serverOpts` | `object` | Forwarded to Node.js `createSocket()` / `createServer()`. |
 
+## Custom Physical Layer
+
+Any byte-oriented transport can be used by implementing `AbstractPhysicalLayer` and `AbstractPhysicalConnection`, then passing `{ type: 'CUSTOM', layer: yourLayer }`.
+
+```typescript
+import { AbstractPhysicalLayer, AbstractPhysicalConnection } from 'njs-modbus';
+
+class MyPhysicalLayer extends AbstractPhysicalLayer { /* open / close */ }
+class MyConnection extends AbstractPhysicalConnection { /* write / destroy, emit 'data' */ }
+
+const master = new ModbusMaster({
+  physical: { type: 'CUSTOM', layer: new MyPhysicalLayer() },
+  protocol: { type: 'TCP' },
+});
+```
+
+See [`examples/websocket`](./examples/websocket) for a complete **Modbus TCP over WebSocket** implementation — client/server physical layers with a working demo.
+
+See [`examples/bluetooth`](./examples/bluetooth) for a **Modbus TCP over BLE** implementation using the Nordic UART Service (NUS) — includes a loopback test that runs without real BLE hardware.
+
 ## Master API
 
 ```typescript

package/README.zh-CN.md

@@ -152,6 +152,26 @@ const slave = new ModbusSlave({
 | `idleTimeout` | `number` | 空闲超时（毫秒），超时后驱逐连接。默认 `30000`，传 `0` 禁用。 |
 | `socketOpts` / `serverOpts` | `object` | 透传给 Node.js `createSocket()` / `createServer()`。 |
 
+## 自定义物理层
+
+任何面向字节的传输层都可以通过实现 `AbstractPhysicalLayer` 和 `AbstractPhysicalConnection` 来使用，然后传入 `{ type: 'CUSTOM', layer: yourLayer }`。
+
+```typescript
+import { AbstractPhysicalLayer, AbstractPhysicalConnection } from 'njs-modbus';
+
+class MyPhysicalLayer extends AbstractPhysicalLayer { /* open / close */ }
+class MyConnection extends AbstractPhysicalConnection { /* write / destroy, emit 'data' */ }
+
+const master = new ModbusMaster({
+  physical: { type: 'CUSTOM', layer: new MyPhysicalLayer() },
+  protocol: { type: 'TCP' },
+});
+```
+
+查看 [`examples/websocket`](./examples/websocket) 获取完整的 **WebSocket 承载 Modbus TCP** 实现——包含客户端/服务端物理层及可运行的演示。
+
+查看 [`examples/bluetooth`](./examples/bluetooth) 获取 **BLE 承载 Modbus TCP** 实现（基于 Nordic UART Service），包含无需真实蓝牙硬件即可运行的回环测试。
+
 ## 主站 API
 
 ```typescript