Wb-mqtt-serial templates

Описание

Использование шаблонов позволяет один раз описать устройство и использовать созданное описание для любого числа устройств на одном или нескольких serial-портах.

Предустановленные шаблоны находятся в папке /usr/share/wb-mqtt-serial/templates.

Пользовательские шаблоны для wb-mqtt-serial версии 2.6.3 и выше рекомендуем хранить в папке /etc/wb-mqtt-serial.conf.d/templates, более ранних версий используйте путь по умолчанию. В каждом файле, размещенном в папке templates находится описание одного типа устройств.

Подготовка

Перед написанием шаблона рекомендуем проверить правильность подключения с помощью прямого обмена данными с устройствами.

Подключите устройство к контроллеру и прочитайте значение одного из его modbus-регистров. Описание адресов modbus-регистров и параметры подключения можно найти в документации на подключаемое устройство, а для чтения информации из устройства можно использовать утилиту modbus_client.

Базовая структура шаблона

{ 
"device": {
    "Параметр 1 устройства":"значение", 
    "Параметр 2 устройства":"значение", 
    ...

    "setup": [
        // секция инициализации устройства
        ...
    ]
    "channels": [ 
        {
            Параметры канала 1
            }, 
        {
            Параметры канала 2
            },
         ...
        ]
    }
}

В наших шаблонах мы используем отступы по 4 пробела на уровень, что обеспечивает хорошую читаемость кода. Новые шаблоны мы рекомендуем создавать с такими же отступами.

Параметры устройства (device)

В начале шаблона задаются параметры устройства в виде набора пар ключ:значение.

• device_type — тип устройства, строка.
• name — отображаемое имя устройства. Публикуется как .../meta/name в MQTT.
• id — уникальный идентификатор устройства в MQTT. Каждый элемент в devices должен иметь уникальный id.
• slave_id — идентификатор устройства. Если не задан — используется широковещательный запрос.
• enabled — включает или выключает опрос устройства. Доступные значения: true, false. По умолчанию — true.
• protocol — протокол передачи данных, если не указан — используется modbus. Возможные варианты:
  • modbus,
  • uniel,
  • milur,
  • mercury230,
  • ivtm,
  • s2k,
  • modbus_io,
  • pulsar,
  • mercury200,
  • lls,
  • neva,
  • energomera_iec.
• max_reg_hole — максимальное количество считываемых «пустых» регистров. Параметр поддерживается только modbus-устройствами.
• max_bit_hole — аналог max_reg_hole для битовых регистров: coils и discrete inputs.
• max_read_registers — максимальное количество регистров в одной пакетной операции чтения.
• poll_interval — минимальный интервал опроса регистров данного устройства в миллисекундах.
• response_timeout_ms — максимальное время ответа устройства в миллисекундах
• frame_timeout_ms — минимально необходимая задержка между посылками в миллисекундах.
• guard_interval_us — дополнительная задержка перед каждой отправкой данных в порт в микросекундах.
• device_timeout_ms — интервал, по истечении которого (а также device_max_fail_cycles) устройство будет помечено отключенным и будет опрашиваться в ограниченном режиме.
• device_max_fail_cycles — количество неудачных циклов опроса устройства.
• password — пароль для доступа к устройству, массив байт.
• access_level — уровень доступа при опросе устройства.
• channels — список каналов устройств, задается в виде массива [...], каждый из элементов которого — это описание отдельного канала. Подробнее читайте ниже.

Обязательно нужно указать параметры device_type и device. Остальные параметры можно опустить, в этом случае будут подставлены значения по умолчанию.

Изменять параметры устройства можно и в веб-интерфейсе, для этого найдите нужное устройство и откройте свойства объекта Device → Properties.

Каналы устройства (channels)

Структура:

"channels": [
        {
            "name": "Имя канала 1",
            ...
        },
        {
            "name": "Имя канала 2",
            ...
        },
        ...
    ]

Структура содержит набор полей:

• name — уникальное для устройства имя канала.
• id — имя MQTT контрола для канала, публикуется как /devices/<идентификатор устройства>/controls/<ID канала> Если не задан, то используется значение name.
• enabled — включает или выключает опрос канала. Доступные значения: true, false. По умолчанию — true.
• reg_type — тип modbus-регистра. Возможные значения:
  • coil,
  • discrete,
  • holding,
  • holding_single,
  • holding_multi,
  • input,
  • direct.
• address — адрес регистра.
• type — тип контрола: виртуального элемента для представления данных в веб-интерфейсе контроллера.
• format — тип переменной, описывающей значение.
• word_order — порядок 16-битных слов для каналов, имеющих размер больше 16 бит. Доступные значения:
  • big_endian — [0xAA 0xBB] [0xCC 0xDD] => 0xAABBCCDD. Значение по умолчанию.
  • little_endian — [0xAA 0xBB] [0xCC 0xDD] => 0xCCDDAABB.
• poll_interval — минимальный интервал опроса регистра в миллисекундах.
• unsupported_value — значение, получаемое при последовательном чтении диапазона регистров, если устройство не поддерживает запрашиваемый регистр. Используется некоторыми протоколами для определения доступности регистров устройства.
• max — максимальное значение регистра, используется для построения. Используется в веб-интерфейсе.
• scale — коэффициент, на который умножается значение регистра перед публикацией в MQTT.
• offset — значение, которое прибавляется к значению регистра перед публикацией в MQTT.
• round_to — порядок, до которого будет округляться значение после всех преобразований. Например, 0.1 — округлять до десятых.
• readonly — установка флага запрешает изменение значения в веб-интерфейсе или по MQTT. Возможные значения: true, false. По умолчанию — false.
• on_value — значение, которое будет записано в регистр, при записи единицы в mqtt-топик канала.
• error_value — полученное из устройства значение регистра, обозначающее ошибку.

Обязательно нужно указать поля name, reg_type, address и type. Остальные параметры можно опустить, в этом случае будут подставлены значения по умолчанию.

Доступные типы контролов (type)

• atmospheric_pressure — атмосферное давление, millibar (100 Pa).
• concentration — концентрация, ppm.
• current — ток, отображается как value.
• dimmer — диммер, отображается как value.
• heat_energy — тепловая энергия, Gcal.
• heat_power — расход тепловой энергии, Gcal/h.
• lux — освещенность.
• power — мощность, W.
• power_consumption — энергопотребление, kWh.
• pressure — давление, bar
• pushbutton — кнопка.
• rainfall — осадки, mm/h.
• range — ползунок.
• rel_humidity — влажность, %, RH.
• resistance — сопротивление, Ohm.
• rgb — rgb.
• sound_level — уровень звука.
• switch — переключатель положений ON/OFF.
• temperature — температура, °C.
• text — текстовая строка.
• value — неформатированное значение.
• voltage — напряжение, V.
• water_consumption — потребление воды, m³.
• water_flow — поток воды m³/h
• wind_speed — скорость ветра, m/s.
• wo-switch — переключатель положений ON/OFF.

Доступные типы переменных (format)

• s16 — Signed 16-bit integer.
• u16 — Unsigned 16-bit integer.
• s8 — Signed 8-bit integer.
• u8 — Unsigned 8-bit integer.
• s24 — Signed 24-bit integer.
• u24 — Unsigned 24-bit integer.
• s32 — Signed 32-bit integer.
• u32 — Unsigned 32-bit integer.
• s64 — Signed 64-bit integer.
• u64 — Unsigned 64-bit integer.
• bcd8 — 8-bit BCD.
• bcd16 — 16-bit BCD.
• bcd24 — 24-bit BCD.
• bcd32 — 32-bit BCD.
• float — IEEE754 32-bit float.
• double — IEEE754 64-bit float (double).
• char8 — 8-bit ASCII char.

Секция инициализации (setup-секция)

Секция инициализации содержит перечень параметров, которые передаются устройству при перезапуске wb-mqtt-serial или при восстановлении связи с устройством.

В шаблоне можно перечислить параметры и задать их значения по умолчанию. Пользователь может изменять значения параметров в веб-интерфейсе.

Важно! Чтение параметров из устройства не предусмотрено.

В секции доступны параметры:

• title — наименование параметра, будет отображен в веб-интерфейсе.
• address — адрес регистра, в который нужно записать параметр.
• enum — массив числовых значений, которые можно записать в регистр.
• enum_titles — массив текстовых описаний значений, указанных в enum.
• default — значение по умолчанию. Записывается в регистр, если пользователь не выбрал свое.
• value — фиксированное значение. Если у регистра указать фиксированное значение, то пользователь не сможет его изменить через веб-интерфейс.

Значения address, enum, value и default можно указывать в десятичной или шестнадцатеричной системе счисления.

Пример setup-секции:

"setup": [
    {
        "title": "s12",
        "address": 20000,
        "value": "0xfff2"
    },    
    {
        "title": "Sound value",
        "address": 0x00,
        "default": 0x0a,
        "min": 0,
        "max": 100         
    },
    {
        "title": "Fan mode",
        "address": 3,
        "enum": [ 0, 1, 2, 4 ],          
        "enum_titles": [ 
          "off", 
          "slow", 
          "middle", 
          "fast"
        ],               
        "default": 1
    }
]

Вложенные устройства (subdevices)

В секции subdevices можно описать вложенные устройства, которые могут иметь свои setup-секции и каналы.

Для каждого канала можно указать, что это вложенное устройство и задать список вложенных устройств, которые поддерживает канал.

Адреса регистров вложенных устройств расчитываются как base + shift + address + stride * register_size, где:

• base — адрес начала секции регистров родительского канала;
• shift — смещение относительно родительсокго канала;
• address — адрес, заданный в описании регистра;
• stride — номер шага, заданный в настройках канала;
• register_size — размер регистра.

Пример описания вложенных устройств:

{
    // Название типа устройства, оно указывается в поле device_type в файле настроек
    "device_type": "Device type name",

    // Название типа устройства, которое будет отображаться в онлайн-конфигураторе.
    // Необязательный параметр. Если не указан, используется device_type.
    "title": "Device",

    "device": {
        // отображаемое имя устройства. Публикуется как
        // .../meta/name в MQTT
        "name": "New device",
        
        // Остальные параметры устройства описанные ранее, кроме slave_id
        ...

        // список каналов устройства
        "channels": [
            // Пример канала, описывающий данные одного регистра
            {
                "name": "Temperature",
                "reg_type": "input",
                "format": "s32",
                "address": "0x0504"
            },

            // Канал - вложенное устройство
            {
                "name": "Sub",
                "device_type": "subdevice1"
            },

            // Канал - вложенное устройство.
            // В интерфейсе веб-интерфейса будет предложен выбор конкретного типа
            {
                "name": "Sub2",
                
                // Список типов вложенных устройств, которые можно выбрать для канала
                "oneOf": [ "subdevice1", "subdevice2" ],

                // Устройство, выбранное по умолчанию
                "device_type": "subdevice1",

                // Смещение регистров канала относительно родительского канала
                "shift": 100,

                // Номер шага регистров
                "stride": 1
            }
        ],
        // Список вложенных устройств
        "subdevices": [
            {
                // Имя вложенного устройства,
                // которое будет использоваться в поле device_type канала
                "device_type": "subdevice1",

                // Название вложенного устройства,
                // которое будет отображаться в онлайн-конфигураторе.
                // Необязательный параметр. Если не указан, используется device_type.
                "title": "Sub1",

                "device": {
                    "channels": [
                        // Вложенные устройства могут иметь свои каналы
                        {
                            "name": "c11",
                            "reg_type": "input",
                            "format": "s32",
                            "address": "0x0501"
                        },

                        // Вложенные устройства также могут иметь
                        // каналы с вложенными устройствами
                        {
                            "name": "c2",
                            "device_type": "subdevice2"
                        }
                    ]
                }
            },
            {
                "device_type": "subdevice2",
                "device": {
                    // Вложенные устройства могут иметь
                    // собственную секцию с настройками
                    "setup": [
                        {
                            "title": "s12",
                            "address": 20000,
                            "value": "0xfff2"
                        },

                        // Если конкретное значение настройки не задано, то его можно
                        // задать в файле конфигурации или через веб-интерфейс
                        {
                            "title": "s22",
                            "address": 9992,

                            // Список возможных значений
                            "enum": [1, 2, 3],

                            // Надписи в списке выбора в веб-интерфейсе
                            "enum_titles": ["one", "two", "three" ],

                            // Минимально возможное значение
                            "min": 1,

                            // Максимально возможное значение
                            "max": 3
                        }
                    ],
                    "channels": [
                        {
                            "name": "c2",
                            "device_type": "subdevice2"
                        }
                    ]
                }
            }
        ]
    }
}

Примеры шаблонов

Хорошим источником примеров могут служить предустановленные шаблоны драйвера wb-mqtt-serial.

Ниже мы рассмотрим несколько примеров подробнее.

WB-MSW3

Датчик WB-MSW3 в базовой комплектации может измерять температуру и влажность. Еще мы можем получить из датчика величину напряжения питания, серийный номер и управлять встроенной пищалкой.

Пример шаблона:

{
    "device_type": "WB-MSW v.3 (base)",
    "device": {
        "name": "WB-MSW v.3",
        "id": "wb-msw-v3",
        "max_read_registers": 0,
        "response_timeout_ms": 1,
        "frame_timeout_ms": 12,
        "channels": [
            {
                "name": "Temperature",
                "reg_type": "input",
                "address": 0,
                "type": "temperature",
                "format": "s16",
                "scale": 0.1,
                "error_value": "0x7FFF"
            },
            {
                "name": "Humidity",
                "reg_type": "input",
                "address": 1,
                "type": "rel_humidity",
                "scale": 0.1,
                "error_value": "0xFFFF"
            },
            {
                "name": "Input Voltage",
                "reg_type": "input",
                "address": 121,
                "scale": 0.001,
                "type": "voltage"
            },
            {
                "name": "Serial",
                "type": "text",
                "reg_type": "input",
                "address": 270,
                "format": "u32"
            },
            {
                "name": "Buzzer",
                "type": "switch",
                "reg_type": "coil",
                "address": 0
            }
        ]
    }
}

Описание параметров смотрите в описании базовой структуры шаблона.

WB-MRGBW-D

Устройство WB-MRGBW-D — четырехканальный диммер для управления светодиодными лентами. Может управлять лентой RGB+W либо независимо четырьмя одноцветными лентами. Настройки яркости хранятся в holding-регистрах. Шаблон описывает, какие регистры можно менять для получения нужной яркости каналов, отслеживать нажатия на кнопки диммера и получать значения количества нажатий.

{
    "device_type": "WB-MRGBW-D", 
    "device": {
        "name": "WB-MRGBW-D", 
        "id": "wb-mrgbw-d", 
        "max_read_registers": 0, 
        "channels": [
            {
                "name": "RGB", 
                "type": "rgb", 
                "consists_of": [
                    {
                        "reg_type": "holding", 
                        "address": 1
                    }, 
                    {
                        "reg_type": "holding", 
                        "address": 0
                    }, 
                    {
                        "reg_type": "holding", 
                        "address": 2
                    }
                ]
            }, 
            {
                "name": "White", 
                "reg_type": "holding", 
                "address": 3, 
                "type": "range", 
                "max": 255
            }, 
            {
                "name": "Button 1", 
                "reg_type": "holding", 
                "readonly": true, 
                "address": 6, 
                "type": "switch"
            }, 
            {
                "name": "Button 2", 
                "reg_type": "holding", 
                "readonly": true, 
                "address": 7, 
                "type": "switch"
            }, 
            {
                "name": "Button 3", 
                "reg_type": "holding", 
                "readonly": true, 
                "address": 8, 
                "type": "switch"
            }, 
            {
                "name": "Button 1 counter", 
                "reg_type": "holding", 
                "readonly": true, 
                "address": 32, 
                "type": "value"
            }, 
            {
                "name": "Button 2 counter", 
                "reg_type": "holding", 
                "readonly": true, 
                "address": 33, 
                "type": "value"
            }, 
            {
                "name": "Button 3 counter", 
                "reg_type": "holding", 
                "readonly": true, 
                "address": 34, 
                "type": "value"
            }, 
            {
                "name": "Serial NO", 
                "type": "text", 
                "reg_type": "holding", 
                "address": 270, 
                "format": "u32"
            }
        ]
    }
}

В этом шаблоне составной канал RGB задает одновременно яркости трех цветовых компонентов ленты, хранящихся в трех holding-регистрах и описывается следующим образом:

    {
        "name": "RGB", 
        "type": "rgb", 
        "consists_of": [
            {
                "reg_type": "holding", 
                "address": 1
            }, 
            {
                "reg_type": "holding", 
                "address": 0
            }, 
            {
                "reg_type": "holding", 
                "address": 2
            }
        ]
    },

Канал белого цвета управляется отдельно,

    {
        "name": "White", 
        "reg_type": "holding", 
        "address": 3, 
        "type": "range", 
        "max": 255
    },

Здесь указано максимальное значение, которое можно установить для ползунка яркости белого — 255:

"max": 255

Серийный номер устройства (канал «Serial NO») считывается как беззнаковое 32-битное целое:

"format": "u32"

WBIO-DO-R10A-8

Устройство WBIO-DO-R10A-8 — релейный боковой модуль, который подключается непосредственно к WBIO-разъему контроллера, и не управляется по Modbus. Но при подключении его через устройство расширения WB-MIO или WB-MIO-E становится полноценным modbus-устройством, для которого есть соответствующий шаблон.

{
    "device_type": "WBIO-DO-R10A-8",
    "device": {
        "name": "WBIO-DO-R10A-8",
        "id": "wb-mio-gpio",
        "protocol": "modbus_io",
        "stride": 1000,
        "shift": 500,
        "max_read_registers": 0,
        "setup": [
            {
                "title": "IODIR",
                "address": 10000,
                "value": "0x0000"
            },
            {
                "title": "IPOL",
                "address": 10001,
                "value": "0x0000"
            },
            {
                "title": "GPINTEN",
                "address": 10002,
                "value": "0xffff"
            },
            {
                "title": "DEFVAL",
                "address": 10003,
                "value": "0x0000"
            },
            {
                "title": "INTCON",
                "address": 10004,
                "value": "0x0000"
            },
            {
                "title": "IOCON",
                "address": 10005,
                "value": "0x4444"
            },
            {
                "title": "FLAG",
                "address": 9999,
                "value": 1
            }
        ],
        "channels": [
            {
                "name": "K1",
                "reg_type": "coil",
                "address": 0,
                "type": "switch"
            },
            {
                "name": "K2",
                "reg_type": "coil",
                "address": 1,
                "type": "switch"
            },
            {
                "name": "K3",
                "reg_type": "coil",
                "address": 2,
                "type": "switch"
            },
            {
                "name": "K4",
                "reg_type": "coil",
                "address": 3,
                "type": "switch"
            },
            {
                "name": "K5",
                "reg_type": "coil",
                "address": 4,
                "type": "switch"
            },
            {
                "name": "K6",
                "reg_type": "coil",
                "address": 5,
                "type": "switch"
            },
            {
                "name": "K7",
                "reg_type": "coil",
                "address": 6,
                "type": "switch"
            },
            {
                "name": "K8",
                "reg_type": "coil",
                "address": 7,
                "type": "switch"
            }
        ]
    }
}

В этом шаблоне следует обратить внимание на следующие параметры устройства.

    "protocol": "modbus_io",
    "stride": 1000,
    "shift": 500,
    "max_read_registers": 0,
    "setup": [

Параметр "protocol": "modbus_io" указывает, что устройство подключается оп специальному протоколу к модулю расширения. Параметры "stride": 1000 и "shift": 500 задают сдвиг регистров в зависимости от того, в каком порядке подключены модули к модулю расширения.

Сдвиг регистров (число, которое нужно добавить к базовому номеру регистра) вычисляется по формуле:

Shift = (((SlaveId.Secondary - 1) % 4) + 1) * DeviceConfig()->Stride + DeviceConfig()->Shift;

Здесь stride — DeviceConfig()->Stride, a shift — DeviceConfig()->Shift. Каждое подключенное устройство имеет порядковый номер (SlaveId.Secondary), начинающийся с 1 для первого устройства. (Здесь знаком "%" обозначается деление по модулю.) Например, подставляя значения shift и stride в формулу, получаем:

Shift = ((( 1 - 1) % 4) + 1) * 500 + 1000 = (0 + 1) * 500 + 1000 = 1500

То есть ко всем регистрам, указанным в шаблоне, надо добавить 1500.

Еще один важный параметр — setup-секция, массив

     "setup": [    {
             "title": "IODIR",
             "address": 10000,
             "value": "0x0000"
         },
     {},
     ...]

Он описывает регистры и значения, которые однократно заносятся в эти регистры при инициализации устройства (при запуске или перезапуске wb-mqtt-serial). Его можно использовать для конфигурирования устройств для работы в каком-то определенном режиме, задавать изначальные значения яркости, положения сервоприводов, состояния реле, режима работы с входами релейных модулей и т. п.

WB-MAP3H

Устройство WB-MAP3H — трехканальный счетчик электроэнергии. Он измеряет большое количество параметров электрической сети. Поскольку опрос всех регистров такого устройства может занять достаточно много времени, есть несколько шаблонов, содержащих оптимальный набор параметров для решения текущей задачи. Мы рассмотрим базовый шаблон.

{
 "device_type": "WB-MAP3H (basic)", 
 "device": {
  "name": "WB-MAP3H (basic)", 
  "id": "wb-map3h", 
  "max_read_registers": 60, 
  "channels": [
   {
    "name": "Urms L1", 
    "reg_type": "input", 
    "address": "0x10d9", 
    "type": "voltage", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "THDN U L1", 
    "reg_type": "input", 
    "address": "0x10f1", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "Urms L2", 
    "reg_type": "input", 
    "address": "0x10da", 
    "type": "voltage", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "THDN U L2", 
    "reg_type": "input", 
    "address": "0x10f2", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "Urms L3", 
    "reg_type": "input", 
    "address": "0x10db", 
    "type": "voltage", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "THDN U L3", 
    "reg_type": "input", 
    "address": "0x10f3", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "Frequency", 
    "reg_type": "input", 
    "address": "0x10f8", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "Voltage angle L1", 
    "reg_type": "input", 
    "address": "0x10fd", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.1, 
    "round_to": 0.01
   }, 
   {
    "name": "Voltage angle L2", 
    "reg_type": "input", 
    "address": "0x10fe", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.1, 
    "round_to": 0.01
   }, 
   {
    "name": "Voltage angle L3", 
    "reg_type": "input", 
    "address": "0x10ff", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.1, 
    "round_to": 0.01
   }, 
   {
    "name": "Irms L1", 
    "reg_type": "input", 
    "address": "0x10dd", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.001, 
    "round_to": 0.01
   }, 
   {
    "name": "THDN I L1", 
    "reg_type": "input", 
    "address": "0x10f5", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "P L1", 
    "reg_type": "input", 
    "address": "0x1302", 
    "type": "power", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "Q L1", 
    "reg_type": "input", 
    "address": "0x130a", 
    "type": "value", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "S L1", 
    "reg_type": "input", 
    "address": "0x1312", 
    "type": "value", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "PF L1", 
    "reg_type": "input", 
    "address": "0x10bd", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.001, 
    "round_to": 0.01
   }, 
   {
    "name": "AP energy L1", 
    "reg_type": "input", 
    "address": "0x1204", 
    "type": "power_consumption", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "RP energy L1", 
    "reg_type": "input", 
    "address": "0x1224", 
    "type": "value", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "Irms L2", 
    "reg_type": "input", 
    "address": "0x10de", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.001, 
    "round_to": 0.01
   }, 
   {
    "name": "THDN I L2", 
    "reg_type": "input", 
    "address": "0x10f6", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "P L2", 
    "reg_type": "input", 
    "address": "0x1304", 
    "type": "power", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "Q L2", 
    "reg_type": "input", 
    "address": "0x130c", 
    "type": "value", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "S L2", 
    "reg_type": "input", 
    "address": "0x1314", 
    "type": "value", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "PF L2", 
    "reg_type": "input", 
    "address": "0x10be", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.001, 
    "round_to": 0.01
   }, 
   {
    "name": "AP energy L2", 
    "reg_type": "input", 
    "address": "0x1208", 
    "type": "power_consumption", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "RP energy L2", 
    "reg_type": "input", 
    "address": "0x1228", 
    "type": "value", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "Irms L3", 
    "reg_type": "input", 
    "address": "0x10df", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.001, 
    "round_to": 0.01
   }, 
   {
    "name": "THDN I L3", 
    "reg_type": "input", 
    "address": "0x10f7", 
    "type": "value", 
    "format": "u16", 
    "scale": 0.01, 
    "round_to": 0.01
   }, 
   {
    "name": "P L3", 
    "reg_type": "input", 
    "address": "0x1306", 
    "type": "power", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "Q L3", 
    "reg_type": "input", 
    "address": "0x130e", 
    "type": "value", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "S L3", 
    "reg_type": "input", 
    "address": "0x1316", 
    "type": "value", 
    "format": "s32", 
    "scale": 1.52588e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "PF L3", 
    "reg_type": "input", 
    "address": "0x10bf", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.001, 
    "round_to": 0.01
   }, 
   {
    "name": "AP energy L3", 
    "reg_type": "input", 
    "address": "0x120c", 
    "type": "power_consumption", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "RP energy L3", 
    "reg_type": "input", 
    "address": "0x122c", 
    "type": "value", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "Total P", 
    "reg_type": "input", 
    "address": "0x1300", 
    "type": "power", 
    "format": "s32", 
    "scale": 6.10352e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "Total Q", 
    "reg_type": "input", 
    "address": "0x1308", 
    "type": "value", 
    "format": "s32", 
    "scale": 6.10352e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "Total S", 
    "reg_type": "input", 
    "address": "0x1310", 
    "type": "value", 
    "format": "s32", 
    "scale": 6.10352e-05, 
    "round_to": 0.01
   }, 
   {
    "name": "Total PF", 
    "reg_type": "input", 
    "address": "0x10bc", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.001, 
    "round_to": 0.01
   }, 
   {
    "name": "Total AP energy", 
    "reg_type": "input", 
    "address": "0x1200", 
    "type": "power_consumption", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "Total RP energy", 
    "reg_type": "input", 
    "address": "0x1220", 
    "type": "value", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   }, 
   {
    "name": "Phase angle L1", 
    "reg_type": "input", 
    "address": "0x10f9", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.1, 
    "round_to": 0.01
   }, 
   {
    "name": "Phase angle L2", 
    "reg_type": "input", 
    "address": "0x10fa", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.1, 
    "round_to": 0.01
   }, 
   {
    "name": "Phase angle L3", 
    "reg_type": "input", 
    "address": "0x10fb", 
    "type": "value", 
    "format": "s16", 
    "scale": 0.1, 
    "round_to": 0.01
   }
  ]
 }
}

На что следует обратить внимание в этом шаблоне? В первую очередь в параметрах устройства мы указываем, что одновременно следует считывать не более 60 регистров, чтобы не останавливать надолго опрос остальных устройств: "max_read_registers": 60. Также показательным является параметр, описывающий накопленную реактивную энергию по фазе L1:

   {
    "name": "RP energy L1", 
    "reg_type": "input", 
    "address": "0x1224", 
    "type": "value", 
    "format": "u64", 
    "scale": 3.125e-05, 
    "round_to": 0.0001, 
    "word_order": "little_endian"
   },

Здесь стоит обратить внимание на то, что адрес регистра может задаваться и в шестнадцатеричном виде: "address": "0x1224", вещественный коэффициент масштабирования можно задавать в экспоненциальной записи: "scale": 3.125e-05, при считывании значения округлять его до нужного порядка: "round_to": 0.0001, а также учитывать, что число в modbus-регистрах хранится в порядке от младшего к старшему: "word_order": "little_endian". Форматы хранения для 16-битных Modbus регистров описываются следующим образом:

        big-endian    : ( [0xAA 0xBB] [0xCC 0xDD] => 0xAABBCCDD ) 
        little-endian : ( [0xAA 0xBB] [0xCC 0xDD] => 0xCCDDAABB )

По умолчанию предполагается формат big-endian.

Полезные ссылки

• Описание драйвера wb-mqtt-serial в нашей вики
• Описание драйвера в репозитории на Github
• Шаблоны из стандартной поставки драйвера
• Описание файла wb-mqtt-serial.schema.json