This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

Modbus TCP to serial line gateway sample

Overview

This is a simple application demonstrating a gateway implementations between an Ethernet TCP-IP network and a Modbus serial line.

Requirements

This sample has been tested with FRDM-K64F board, but it should work with any board or shield that has a network interface.

Gateway example is running on an evaluation board and communicates with another board that has been prepared according to the description Modbus RTU Server Sample. Client is running on a PC or laptop.

The description of this sample uses PyModbus (Pymodbus REPL). The user can of course try out other client implementations with this sample.

In addition to the evaluation boards RS-485 shields may be used. The A+, B- lines of the RS-485 shields should be connected together. Alternatively UART RX,TX signals of two boards can be connected crosswise.

Building and Running

This sample can be found under samples/subsys/modbus/tcp_gateway in the Zephyr tree.

The following commands build and flash gateway sample.

west build -b frdm_k64f samples/subsys/modbus/tcp_gateway
west flash

On the client side, PC or laptop, the following command connects PyModbus to the gateway.

# pymodbus.console tcp --host 192.0.2.1 --port 502

The LEDs on the server board are controlled by Modbus commands FC01, FC05, FC15. For example, to set LED0 on use FC01 command (write_coil).

> client.connect
> client.write_coil address=0 value=1 unit=1

Client should confirm successful communication and LED0 should light.

{
    "address": 0,
    "value": true
}

To set LED0 off but LED1 and LED2 on use FC15 command (write_coils).

> client.write_coils address=0 values=0,1,1 unit=1

To read LED0, LED1, LED2 state FC05 command (read_coils) can be used.

> client.read_coils address=0 count=3 unit=1
{
    "bits": [
        false,
        true,
        true,
        false,
        false,
        false,
        false,
        false
    ]
}

It is also possible to write and read the holding registers. This however does not involve any special interaction with the peripherals on the board yet.

To write single holding registers use FC06 command (write_register),

> client.write_register address=0 value=42 unit=1

or FC16 command (write_registers).

> client.write_registers address=0 values=42,42,42 unit=1

To read holding registers use FC03 command (read_holding_registers).

> client.read_holding_registers address=0 count=3 unit=1
{
    "registers": [
        42,
        42,
        42
    ]
}