Many modbus devices support only one or very few clients

Last update: Aug 10, 2022

Overview

Modbus TCP proxy

Many modbus devices support only one or very few clients. This proxy acts as a bridge between the client and the modbus device. It can be seen as a layer 7 reverse proxy. This allows multiple clients to communicate with the same modbus device.

When multiple clients are connected, cross messages are avoided by serializing communication on a first come first served REQ/REP basis.

This project is the Rust version of the Python based modbus-proxy project.

I did it because it fitted my personal goal of exercising with the Rust programming language and it's async based tokio library.

The goal was to produce a robust, highly concurrent server with a low memory footprint.

Installation

$ cargo install modbus-proxy-rs

Running the server

First, you will need write a configuration file where you specify for each modbus device you which to control:

modbus connection (the modbus device url)
listen interface (to which url your clients should connect)

Configuration files can be written in YAML (.yml or .yaml) or TOML (.toml).

Suppose you have a PLC modbus device listening on plc1.acme.org:502 and you want your clients to connect to your machine on port 9000. A YAML configuration would look like this:

devices:
- modbus:
    url: plc1.acme.org:502     # device url (mandatory)
  listen:
    bind: 0:9000               # listening address (mandatory)

Assuming you saved this file as modbus-config.yml, start the server with:

$ modbus-proxy-rs -c ./modbus-config.yml

Now, instead of connecting your client(s) to plc1.acme.org:502 you just need to tell them to connect to *machine*:9000 (where machine is the host where modbus-proxy is running).

Note that the server is capable of handling multiple modbus devices. Here is a configuration example for 2 devices:

devices:
- modbus:
    url: plc1.acme.org:502
  listen:
    bind: 0:9000
- modbus:
    url: plc2.acme.org:502
  listen:
    bind: 0:9001

Logging

Log levels can be adjusted by setting the RUST_LOG environment variable (default is warn):

$ RUST_LOG=debug modbus-proxy-rs -c ./modbus-config.yml

Docker

This project ships with a Dockerfile which you can use as a base to launch modbus-proxy inside a docker container.

First, build the docker image with:

$ docker build -t modbus-proxy .

Assuming you have prepared a config.yml in the current directory:

devices:
- modbus:
    url: plc1.acme.org:502
  listen:
    bind: 0:502

The supplied docker image by default runs the command /modbus-proxy-rs -c /etc/modbus-proxy.yml. Therefore, running launching a container is as simple as:

docker run --init --rm -p 5020:502 -v $PWD/config.yml:/etc/modbus-proxy.yml modbus-proxy

You can supply a different configuration path (ex: /config.yml):

docker run --init --rm -p 5020:502 -v $PWD/config.yml:/config.yml modbus-proxy -c /config.yml

Now you should be able to access your modbus device through the modbus-proxy by connecting your client(s) to :5020.

Note that for each modbus device you add in the configuration file you need to publish the corresponding bind port on the host (-p : argument).

Credits

Development Lead

Tiago Coutinho [email protected]

Contributors

None yet. Why not be the first?

A high performence Socks5 proxy server with bind/reverse support implementation by Rust.

rsocx A high performence Socks5 proxy server with bind/reverse support implementation by Rust Features Async-std No unsafe code Single executable Linu

259 Jan 6, 2023

Interactive bind/reverse PTY shell with Windows&Linux support implementation by Rust.

Cliws Lightweight interactive bind/reverse PTY shell with Windows&Linux support implementation by Rust. Features WebSocket Full pty support: VIM, SSH,

215 Dec 3, 2021

A Rust compiler plugin and support library to annotate overflow behavior

overflower This project contains a compiler plugin and supporting library to allow the programmer to annotate their code to declare how integer overfl

104 Nov 28, 2022

Lightweight p2p library. Support build robust stable connection on p2p/distributed network.

Chamomile Build a robust stable connection on p2p network features Support build a robust stable connection between two peers on the p2p network. Supp

94 Jan 6, 2023

UDP proxy with Proxy Protocol and mmproxy support

udppp UDP proxy with Proxy Protocol and mmproxy support. Features Async Support Proxy Protocol V2 SOCKET preserve client IP addresses in L7 proxies(mm

10 Dec 18, 2022

Asynchronous Linux SocketCAN - Broadcast Manager support (BCM) with tokio

tokio-socketcan-bcm The Broadcast Manager protocol provides a command based configuration interface to filter and send (e.g. cyclic) CAN messages in k

4 Nov 8, 2022

A rust implementation of websock/socket proxy. Support noVNC

websockify-rs: WebSockets support for any application/server This is a rust implement of the websockify-js, which is part of the noVNC project. At the

3 Jan 10, 2023

🚀Memory safe, blazing fast, configurable, minimal hello world written in rust(🚀) in a few lines of code with few(1092🚀) dependencies🚀

🚀 hello-world.rs 🚀 🚀 Memory safe, blazing fast, minimal and configurable hello world project written in the rust( 🚀 ) programming language 🚀 🚀 W

2.7k Jan 7, 2023

Const equivalents of many [`bytemuck`] functions, and a few additional const functions.

Const equivalents of many bytemuck functions, and a few additional const functions. constmuck uses bytemuck's traits, so any type that implements thos

6 Nov 4, 2021

A super simple /sbin/init for Linux which allows running one and only one program

Summary High-performance /sbin/init program for Linux This is designed to do literally nothing but accept binaries over the network and run them as a

19 Dec 4, 2023

A minimal file exchange server designed for clients with browsers only.

XIAO-Files Xiao-Files is a minimal file exchange server designed for clients with browsers only. Example Let's say we have a host with IP 10.8.20.1, a

3 Apr 2, 2024

A framework that allows anyone to create an Urbit Chatbot with only a few lines of code.

Urbit Chatbot Framework A framework that allows anyone to create an Urbit Chatbot with only a few lines of code. The Urbit Chatbot Framework takes car

24 Oct 15, 2022

A tokio-based modbus library

tokio-modbus A tokio-based modbus library. Features pure Rust library async (non-blocking) sync (blocking) Modbus TCP Modbus RTU Client & Server Open

225 Jan 3, 2023

The Modbus IIoT Library

The Modbus IIoT Library A pure Rust library for working with Modbus in IoT/IIoT projects. It is based on the Modbus protocol specification with the fo

13 Mar 14, 2022

A very-very simple url shortener for Rust

urlshortener-rs A very simple urlshortener for Rust. This library aims to implement as much URL shortener services as possible and to provide an inter

39 Nov 20, 2022

This crate does only one thing: format a Unix timestamp.

time-format This crate does only one thing: format a Unix timestamp. Splitting a timestamp into its components The components_utc() function returns t

6 Mar 3, 2022

This library implements a type macro for a zero-sized type that is Serde deserializable only from one specific value.

Monostate This library implements a type macro for a zero-sized type that is Serde deserializable only from one specific value. [dependencies] monosta

125 Dec 26, 2022

SixtyFPS is a toolkit to efficiently develop fluid graphical user interfaces for any display: embedded devices and desktop applications. We support multiple programming languages, such as Rust, C++ or JavaScript.

SixtyFPS is a toolkit to efficiently develop fluid graphical user interfaces for any display: embedded devices and desktop applications. We support multiple programming languages, such as Rust, C++ or JavaScript.

5.5k Jan 1, 2023

Rust Library for controlling divoom devices that support REST APIs, such as pixoo-64.

Divoom Rust Library for controlling divoom devices that support REST APIs, such as pixoo-64 (and from how divoom's api/doc organizes, maybe more in th

16 Dec 23, 2022

Comments

License not yet defined

First of all, congratulations on this great project. Flawlessly solves a very common problem with Modbus/TCP connections. Thanks a lot for this.

One thing is missing: Could you please specify a license for your project?

Not completely altruistic I would wish for a very free one à la MIT ;) of course it is up to you

opened by fox2k06 0

Many modbus devices support only one or very few clients

Related tags

Overview

Modbus TCP proxy

Installation

Running the server

Logging

Docker

Credits

Development Lead

Contributors

You might also like...

A high performence Socks5 proxy server with bind/reverse support implementation by Rust.

Interactive bind/reverse PTY shell with Windows&Linux support implementation by Rust.

A Rust compiler plugin and support library to annotate overflow behavior

Lightweight p2p library. Support build robust stable connection on p2p/distributed network.

UDP proxy with Proxy Protocol and mmproxy support

Asynchronous Linux SocketCAN - Broadcast Manager support (BCM) with tokio

A rust implementation of websock/socket proxy. Support noVNC

🚀Memory safe, blazing fast, configurable, minimal hello world written in rust(🚀) in a few lines of code with few(1092🚀) dependencies🚀

Const equivalents of many [`bytemuck`] functions, and a few additional const functions.

A super simple /sbin/init for Linux which allows running one and only one program

A minimal file exchange server designed for clients with browsers only.

A framework that allows anyone to create an Urbit Chatbot with only a few lines of code.

A tokio-based modbus library

The Modbus IIoT Library

A very-very simple url shortener for Rust

This crate does only one thing: format a Unix timestamp.

This library implements a type macro for a zero-sized type that is Serde deserializable only from one specific value.

SixtyFPS is a toolkit to efficiently develop fluid graphical user interfaces for any display: embedded devices and desktop applications. We support multiple programming languages, such as Rust, C++ or JavaScript.

Rust Library for controlling divoom devices that support REST APIs, such as pixoo-64.

Comments

License not yet defined

Owner

Tiago Coutinho

Multiplex server for rust-analyzer, allows multiple LSP clients (editor windows) to share a single rust-analyzer instance per cargo workspace

Fake rest is a fake API generator using a config file to help you develop clients.

Hotwire allows you to study network traffic of a few popular protocols in a simple way

Tiny CLI application in rust to scan ports from a given IP and find how many are open. You can also pass the amount of threads for that scan

SpringQL: Open-source stream processor for IoT devices and in-vehicle computers

A copy of ziad87 "very stupid thing" (rip). Now in v2: Electric Boogaloo

Imagine your SSH server only listens on an IPv6 address, and where the last 6 digits are changing every 30 seconds as a TOTP code...

🤖 brwrs is a new protocol running over TCP/IP that is intended to be a suitable candidate for terminal-only servers

Listen to bluetooth headphone keys (Linux only)

wireguard tool to manage / generate configuration. Maintain one yaml configuration file to quickly build wireguard network.