tokio-modbus

A tokio-based modbus library.

Crates.io Docs.rs Security audit Continuous integration

Features

Installation

Add this to your Cargo.toml:

toml [dependencies] tokio-modbus = "*"

If you like to use Modbus TCP only:

toml [dependencies] tokio-modbus = { version = "*", default-features = false, features = ["tcp"] }

If you like to use Modbus RTU only:

toml [dependencies] tokio-modbus = { version = "*", default-features = false, features = ["rtu"] }

If you like to build a TCP server:

toml [dependencies] tokio-modbus = { version = "*", default-features = false, features = ["tcp", "server"] }

Examples

Various examples for Modbus RTU and TCP using either the asynchronous or synchronous API can be found in the examples folder.

Testing

The workspace contains documentation, tests, and examples for all available features. Running the tests for the whole workspace only succeeds with all features enabled:

sh cargo test --workspace --all-features

Otherwise some doctests that require non-default features like sync are expected to fail.

Protocol-Specification

License

Copyright 2017 - 2022 slowtec GmbH

MIT/Apache-2.0