Skip to content

MIGRATION_GUIDE.md

Latest commit

 

History

History
35 lines (27 loc) · 2.15 KB

MIGRATION_GUIDE.md

File metadata and controls

35 lines (27 loc) · 2.15 KB
Raw

Modbus-rs Migration Guides Index

This index redirects you to the specific versioned migration guides for modbus-rs releases. Use these guides sequentially when upgrading your applications or integrations.

1. Versioned Migration Guides

v0.15.4 Migration Guide (from v0.15.3)

  • Target Platform: Node.js FFI & WebAssembly (WASM) Bindings
  • Topic: Unified dist/ package directory layout, strict typed array (Uint16Array) signatures, readFifoQueue response model alignment, isConnected() connection parity, and typed NodeJS server handlers.

v0.15.0 Migration Guide (from v0.14.0)

  • Target Platform: Node.js FFI Bindings
  • Topic: Consistent naming, async server bind, retry configurations, error code constants, and expanded server request handlers.
  • Key Changes:
    • timeoutMs renamed to requestTimeoutMs.
    • Server bind(), bindRtu(), and bindAscii() methods are now asynchronous.
    • Stable error code constants and getModbusErrorCode() helper.
    • Support for FC07, FC20, FC21, and FC23 server-side handlers.
    • Redundant count property removed from FIFO queue responses.

v0.14.0 Migration Guide (from v0.13.0)

  • Target Platform: Node.js, Python, Wasm Bindings
  • Topic: Upgrading to the Transport + Client Factory API.
  • Key Changes:
    • Separation of physical socket/port management (AsyncTcpTransport / AsyncRtuTransport) from logical client endpoints.
    • Relocation of connection lifecycles (close, reconnect, timeouts) to the transport.
    • Native support for Multi-drop configurations.

2. General Upgrade Guidelines

  1. Confirm Platform Alignment: Multi-language bindings (Python, Go, .NET, WASM, C/C++ FFI) follow the Rust Core paradigm but may align on different release intervals. Check individual migration guides for exact version compatibility details.
  2. Apply Sequentially: If upgrading across multiple breaking releases, apply each migration guide step-by-step and run the respective validation checklists at every stage.