Modbus TCP gateway

Материал из Wiren Board
Версия от 12:44, 12 июня 2019; RomanKulibaba (обсуждение | вклад) (Новая страница: «The channels are divided into 4 groups - register types in Modbus: *'''Discrete inputs'''- binary values (1/0) that are read-only (for example, GPIO input States…»)

Wiren Board allows to display messages from specific topics in the MQTT message queue in Modbus TCP registers. This can be useful for setting up simple interaction between the Wiren Board and SCADA systems with Modbus TCP support.


Installation and configuration on the controller

Installation

First you need to install the wb-mqtt-mbgate package. In the device console, enter 

root@wirenboard:~# apt-get update && apt-get install wb-mqtt-mbgate

Settings

Gateway configuration page

After installation, you need to specify the topics that will be displayed on the Modbus TCP registers, specify their addresses and specify the format of the registers. To do this, go to the Configs section in the web interface and open the /etc/wb-mqtt-mbgate.conf configuration file.

Modbus binding

Here you can configure the port and address to which the Modbus TCP server will be available.

Required parameters:

  • Bind address - the address to which the Modbus TCP server will be available. The default value is * , which means that you can connect to any address the controller is available (for example, an IP address or a domain name).
  • Server TCP port - the port number on which the Modbus TCP server will be available. The default value is 502, the standard port for Modbus TCP.

MQTT connection

Here you can configure the parameters to connect to the MQTT message broker. By default, the gateway uses the controller's MQTT broker. It is possible to configure authentication.

Required parameters:

  • Address - the address of the message broker. By default - localhost - connection to the controller broker.
  • Port - the port number on which the broker is available. By default it is 1883.

Advanced settings:

  • Keep-alive interval
  • Enable username+password authentication - set this flag if the broker requires login and password authentication.
  • Login - user name to connect to the broker. Required if the Enable username+password authentication flag is set.
  • Password - password to connect to the broker. Required if the Enable username+password authentication flag is set.

Register bindings

In this section, you can configure topic and register matches.

This section contains a list of all found channels in the MQTT message queue, distributed by type. Channels are identified by the name of a topic: made a list of all the topics that match the pattern /devices/+/controls/+, while in the list they are shown as +/+. For example, if a message with the /devices/alarms/controls/alarm_test topic is found in the message broker, the channel will be recorded as alarms/alarm_test in this list.

If new channels appear in the message broker (for example, when a new device is connected), they will be added to the list when the service is restarted (this happens when the configuration file is saved or when the controller is restarted).

The channels are divided into 4 groups - register types in Modbus:

  • Discrete inputs- binary values (1/0) that are read-only (for example, GPIO input States);
  • Coils - registers flags - binary values available for reading and writing (for example, switches state relay);
  • Input registers - read-only numeric values (e.g. value from temperature sensor);
  • Holding registers - storage registers - numeric values available for reading and writing (for example, brightness).

Распределение происходит автоматически на основании описания канала (в топиках /devices/+/controls/+/meta/+).

Для дискретных и числовых регистров доступны следующие параметры:

  • Enabled - флаг, включающий привязку канала к регистру. По умолчанию, все каналы отключены.
  • MQTT channel - имя канала в формате +/+ (как соответствие /devices/+/controls/+)
  • Meta-type - тип канала, полученный из очереди MQTT. Параметр внесён только "для пользователя", не влияет на работу службы.
  • Unit ID и Start address - адресные поля Modbus TCP. Определяются хешированием от имени канала; таким образом, одинаковые каналы на разных контроллерах с большой вероятностью будут иметь одинаковые адресные поля. Замечание: Unit ID 1 и 2 зарезервированы за пользователем - никакие каналы не будут автоматически назначены на эти адреса.

Важно: Поскольку контроллер является шлюзом, он назначает разным устройствам, подключенным к нему, свои разные Unit ID. Некоторое программное обеспечение рассчитано на работу с одним Unit ID (например 1) на одном IP-адресе. В некоторых программах стартовый адрес считается начинающимся с 1, а не с 0. В таком случае к стартовому адресу из конфигурации шлюза надо добавлять 1 при задании его в вашем ПО.

Для числовых регистров, помимо вышеописанных, доступны также параметры:

  • Register format - тип хранимых данных:
    • Signed integer - знаковое целое;
    • Unsigned integer - беззнаковое целое;
    • BCD - двоично-десятичное беззнаковое целое. (Например, десятичное значение 123 будет кодироваться как 0x123 == 291);
    • IEEE 754 float - число с плавающей точкой;
    • Varchar - текстовое поле фиксированного размера (1 символ на регистр).
  • Size - размер данных в байтах. Нужно учитывать, что для всех типов, кроме текстового, в один регистр укладывается два байта.
    • для целочисленных типов - 2, 4 и 8 байт (соответственно, в регистрах это будет 1, 2 и 4 регистра);
    • для чисел с плавающей точкой - 4 и 8 байт (2 и 4 регистра);
    • для текстовых полей - любое неотрицательное значение.
  • Maximum value - максимальное значение поля. Требуется для каналов типа range. Все значения больше максимума будут заменены на максимальное.
  • Value scale - множитель значения. Например, если множитель равен 2 и в канале появилось значение 10, значение регистра будет 20. И наоборот, если в регистр было записано значение 30, в брокер уйдёт сообщение со значением 15.
  • Byte swap - поменять порядок байт в регистрах Modbus. По умолчанию, значения записываются в регистры в формате big-endian. Если установить этот флаг, регистр будет интерпретироваться как little-endian. Важно: флаг действует только на отдельные регистры; в случае составных значений (размером больше 2 байт), меняется порядок только в каждом двухбайтном слове. Например, значение 0x12345678 будет записываться как 0x34127856,
  • Word swap - поменять порядок слов для составных значений. Например, значение 0x12345678 будет записываться как 0x56781234.

Таким образом, чтобы записать значение в формате little-endian, нужно установить оба последних флага.

Общие параметры:

  • Remap addresses after edit - обновить адреса устройств в случае, если произошло наложение адресов. Полезно, если требуется изменить размер данных в сторону увеличения. При установке этого флага после сохранения конфигурационного файла он будет проанализирован на наложения адресов; если таковые будут обнаружены, сервис попытается их устранить, после чего флаг будет снят. (Для того, чтобы получить обновлённый конфигурационный файл, после сохранения требуется перезагрузить страницу). Внимание! Использовать этот флаг можно только на настраиваемой системе, так как могут измениться адреса любых каналов, в том числе и уже настроенных.
Источник — https://wirenboard.com/wiki/index.php?title=Modbus_RTU/TCP_Slave/en&oldid=25683