Skip to content

Latest commit

 

History

History
398 lines (271 loc) · 10.7 KB

CHANGELOG.md

File metadata and controls

398 lines (271 loc) · 10.7 KB
Raw

Changelog

v0.16.0 (Unreleased)

  • Encoding of requests: Less allocations
  • Decoding of requests/responses: More strict validation

Breaking Changes

  • Increased MSRV from 1.65 to 1.76
  • Limit request/response PDU size to 253 bytes (encoding/decoding)

v0.15.0 (2024-10-10)

  • Implement Report Server ID (function code 17).
  • Added ExceptionCode::new.

Breaking Changes

  • Added all FunctionCodes defined in the protocol specification.
  • Renamed Exception to ExceptionCode to be more consistent with FunctionCode.
  • Added ExceptionCode::Custom.
  • Removed TryFrom<u8> and #[repr(u8)] for Exception.
  • Removed FunctionCode::Disconnect.
  • Client: Added new disconnect() method to trait that returns std::io::Result.

v0.14.1 (2024-09-10)

  • Yanked: Adding FunctionCode::ReportServerId is a breaking change.

v0.14.0 (2024-07-21)

Breaking Changes

  • Server: Added associated types Response and Exception to Service trait.

v0.13.1 (2024-06-25)

  • Fix: Do not panic on disconnect.

Breaking Changes

  • Added FunctionCode::Disconnect.

v0.13.0 (2024-06-23, yanked)

  • Fix: Do not panic on mismatching request/response function codes.

Breaking Changes

  • Client: Replace std::io::Error with a custom error type that handles both protocol and transport errors.

v0.12.0 (2024-03-21, yanked)

  • Client: Support handling of Modbus exceptions by using nested Results.

Breaking Changes

  • Client: All methods in the Client, Reader and Writer traits now return nested Result values that both need to be handled explicitly.

    async fn read_coils(&mut self, _: Address, _: Quantity)
- -> Result<Vec<Coil>, std::io::Error>;
+ -> Result<Result<Vec<Coil>, Exception>, std::io::Error>;

The type alias tokio_modbus::Result<T> facilitates referencing the new return types.

pub type Result<T> = Result<Result<T, Exception>, std::io::Error>

v0.11.0 (2024-01-28)

  • Server: Remove Sync and Unpin trait bounds from Service::call() future result.
  • Feature: Add Exception to the public API.
  • Example: Update examples with new Service trait for the Server.
  • Tests: Add Exception integration tests for tcp-server, rtu-server and rtu-over-tcp-server.

Breaking Changes

  • Server: Update Service::Future generic associated type.
  • Server: Remove Service::Response and Service::Error generic associated type.

v0.10.0 (2024-01-03)

  • Feature: Retrieve the FunctionCode of a Request/Response.
  • Feature: Add rtu-over-tcp-server for RTU over TCP server skeleton.

Breaking Changes

  • Exclude rtu-server/tcp-server from default features.
  • FunctionCode: Replace type alias with enum.

v0.9.0 (2023-07-26)

  • Optimization: Avoid allocations when writing multiple coils/registers.
  • Optimization: Avoid allocations when receiving custom responses.

Breaking Changes

  • Request: Requires a lifetime and stores multiple coils/registers wrapped into Cow to avoid allocations.
  • Response::Custom: The payload is returned as Bytes instead of Vec to avoid allocations.

v0.8.2 (2023-06-15)

  • Clear rx buffer before sending to help with error recovery on unreliable physical connections #198

v0.8.1 (2023-05-22)

  • Fix rtu-sync build

v0.8.0 (2023-04-24)

  • TCP Server: Replace NewService trait with closures and never panic
  • TCP Server: Stabilize "tcp-server" feature
  • TCP Client: Allow to attach a generic transport layer, e.g. for TLS support
  • RTU Server: Remove NewService trait and pass instance directly
  • Fix (sync): No timeout while establishing serial RTU connections
  • Add: TLS client and server examples
  • Fix: Limit retrying Modbus RTU communication to 20 times instead of looping infinitely
  • Increase Minimum Supported Rust Version to 1.65

Breaking Changes

  • RTU: Replaced the async and fallible connect() and connect_slave() functions with synchronous and infallible variants named attach() and attach_slave() in correspondence to their TCP counterparts.

v0.7.1 (2023-02-28)

  • Fix (sync): Panic when using client-side timeouts #155
  • tcp-server: Upgrade socket2 dependency

v0.7.0 (2023-02-14)

  • Added: Optional timeout for synchronous RTU/TCP operations #125.

Breaking Changes

  • Features: Added "rtu-sync" as a replacement and superset of "rtu" and "sync"
  • Features: Added "tcp-sync" as a replacement and superset of "tcp" and "sync"
  • Features: Added "rtu-server" as a replacement and superset of "rtu" and "server"
  • Server: Removed inconsistent server::* re-exports from prelude::tcp

v0.6.1 (2023-02-13)

  • Server: Provide access to SlaveId in request
  • Server: Allow requests without a response

v0.6.0 (2023-01-30)

  • Added support for the MaskWriteRegister function code.

Breaking Changes

  • Masked write register requests and responses are now handled by the new MaskWriteRegister variant, not under the Custom variant.

v0.5.4 (2023-01-18)

  • Fix (Windows): Upgrade dependencies to fix build failures on Windows for Tokio 1.23.0 and later.

v0.5.3 (2022-06-22)

  • Fix (RTU/sync): Execute SerialStream::open within an async runtime #116

v0.5.2 (2021-12-05)

  • Fix (RTU): Wrong byte count offset when writing multiple coils/registers

v0.5.1 (2021-11-21)

  • Fix: require tokio/rt for sync feature
  • Changed: Update methods on TCP server to be async (only concerns tcp-server feature)

v0.5.0 (2021-08-20)

  • Removed sync from default features
  • Derived Debug for client-side RTU/TCP Context
  • Removed client-side SharedContext
  • Upgraded tokio version from 0.2 to 1
  • Switched from deprecated net2 to socket2

v0.4.2 (2021-12-05)

  • Fix (RTU): Wrong byte count offset when writing multiple coils/registers

v0.4.1 (2021-08-13)

  • Fixed handling of broken pipe errors in RTU service
  • Fixed multiplication overflow for function 1 and 2 #87

v0.4.0 (2020-03-13)

  • New public API: moved to async/await and tokio v0.2.x
  • Removed unmaintained dependency tokio-proto
  • Make Exception and ExceptionResponse public
  • Fixed WriteSingleCoil response to include data
  • Hide server traits Service/NewService traits behind server feature
  • Hide TCP server implementation behind tcp-server feature
  • Improved documentation

Breaking Changes

Due to the move to async/await and tokio v0.2.x you'll need to adjust your current code. Here are some lines as example:

-let mut core = Core::new().unwrap();
-let handle = core.handle();
 let socket_addr = "127.0.0.1:5502".parse().unwrap();
-let task = tcp::connect(&handle, socket_addr).and_then(move |ctx|
-    ctx.read_input_registers(0x1000, 7).and_then(move |data|
-        // ...
-    )
-);
+let mut ctx = tcp::connect(socket_addr).await?;
+let data = ctx.read_input_registers(0x1000, 7).await?;

v0.3.5 (2019-09-17)

  • Added missing implementation of disconnect() for TCP clients
  • Upgraded tokio-serial to version 3.3

v0.3.4 (2019-05-21)

  • Disabled the default features of tokio-serial to exclude an unused dependency on libudev inherited from mio-serial

v0.3.3 (2019-05-16)

  • Fixed reading coils: Truncate response payload to match the requested number of coils or discrete inputs.

v0.3.2 (2019-04-15)

  • Client: Added a Disconnect request as poison pill for stopping the client service and to release the underlying transport
  • Added utilities to share a single Modbus context within a thread for communicating with multiple devices
  • Added utility functions to disconnect and reconnect stale connections after errors
  • Minimal Rust version: 1.34.0

Potential breaking change

Extending the Request enum with the new variant Disconnect might break existing code. This variant is only used internally within the client and will never be sent across the wire and can safely be ignored by both clients and servers!

v0.3.1 (2019-04-08)

  • RTU client: Use a generic async transport instead of Serial

v0.3.0 (2019-04-02)

  • New public API
  • Client: Change devices while connected
  • TCP Client: Connect to RTU devices via gateway (unit identifier)
  • RTU Client: Try to recover from frame errors

Breaking Changes

  • Make all public crate exports accessible in the new prelude module

    -  use tokio_modbus::*;
+  use tokio_modbus::prelude::*;

  • Rename and relocate client traits

    -  client::ModbusClient
+  client::Client
    -  client::SyncModbusClient
+  client::sync::Client

  • Rename and relocate Client structs into Context

    -  client::Client
+  client::Context
    -  client::SyncClient
+  client::sync::Context

  • Split Client trait into Client + Reader + Writer traits

  • Use free functions in (nested) submodules for creating/connecting a client context

    -  Client::connect_tcp(...);
+  tcp::connect(...) or tcp::connect_device(...);
    -  Client::connect_rtu(...);
+  rtu::connect_device(...);
    -  SyncClient::connect_tcp(...);
+  sync::tcp::connect(...) or sync::tcp::connect_device(...);
    -  SyncClient::connect_rtu(...);
+  sync::rtu::connect_device(...);

  • Reorder parameters of asynchronous connect() functions, i.e. the Tokio handle is always the first parameter

  • Move TCP server into submodule

    -  Server::new_tcp(socket_addr).serve(...);
+  tcp::Server::new(socket_addr).serve(...);

v0.2.3 (2018-12-03)

  • fix decoding of incomplete RTU frames

v0.2.2 (2018-12-01)

  • fix compilation with features = ["rtu"]
  • refactor: use tokio-codec
  • refactor: use put_u16_be instead of put_u16::<BigEndian>
  • refactor: prepare for compilation with edition = "2018"

v0.2.1 (2018-04-04)

  • fix codec: create buffers with correct capacity

v0.2.0 (2018-03-30)

  • add simple tcp server implementation
  • add sync clients
  • use tokio-serial v0.6.x

Breaking Changes

  • Changed Client API

    -  use tokio_modbus::{Client, TcpClient};
+  use tokio_modbus::*;
    -  RtuClient::connect(port, server_addr, &handle)
+  Client::connect_rtu(port, server_addr, &handle)
    -  TcpClient::connect(&addr, &handle)
+  Client::connect_tcp(&addr, &handle)

v0.1.0 (2018-01-21)

  • initial implementation