jmri-client 4.2.0-beta.1 → 5.0.0

package/README.md

@@ -19,6 +19,7 @@ WebSocket client for [JMRI](http://jmri.sourceforge.net/) with real-time updates
 - ✅ **Heartbeat monitoring** - Automatic ping/pong keepalive
 - ✅ **TypeScript** - Full type definitions included
 - ✅ **Dual module support** - ESM and CommonJS
+- ✅ **Multi-connection** - Target specific hardware connections by prefix when multiple are configured
 - ✅ **Extensible** - Subclass `JmriClient` to add support for additional JMRI object types
 
 ## Installation
@@ -27,7 +28,9 @@ WebSocket client for [JMRI](http://jmri.sourceforge.net/) with real-time updates
 npm install jmri-client
 ```
 
-**Requirements:** Node.js 18+
+**Requirements:** Node.js 22+ · JMRI 5.0 or later
+
+> `getSystemConnections()` and per-connection power/throttle prefix support require JMRI 5.15.7+. All other features work with any JMRI 5.x release.
 
 ## Quick Start
 
@@ -106,6 +109,20 @@ client.on('reconnecting', (attempt, delay) => {
 });
 ```
 
+### Multi-Connection Support
+
+When JMRI has multiple hardware connections configured, use `getSystemConnections()` to discover their prefixes and pass them to power and throttle commands:
+
+```typescript
+const connections = await client.getSystemConnections();
+// [{ name: 'LocoNet', prefix: 'L' }, { name: 'DCC++', prefix: 'D' }]
+
+await client.powerOn('L');                             // LocoNet only
+const throttle = await client.acquireThrottle({ address: 3, prefix: 'L' });
+```
+
+When no prefix is supplied the command routes to JMRI's default connection manager, which is the correct behaviour for single-connection layouts.
+
 ### Extending JmriClient
 
 `JmriClient` exposes its `wsClient` as `protected`, so you can subclass it to add support for JMRI object types not yet built in (e.g., sensors, lights, routes, blocks):