¶ Руководство пользователя. Автоконфигуратор YAML
Каждый драйвер в системе использует для настройки специализированные YAML-файлы, структура которых уникальна для каждого типа драйвера. Объем и сложность конфигурации напрямую зависят от количества опрашиваемых сигналов: чем их больше, тем сложнее становится файл. Для упрощения процесса конфигурации разработано ПО «Автоконфигуратор YAML». Данное ПО принимает на вход тип драйвера и Excel-файл установленного формата, и генерирует на выходе соответствующие валидные YAML-файлы.
На данный момент реализована поддержка следующих драйверов:
- Modbus2mqtt;
- Bacnet2mqtt.
¶ Запуск и работа с интерфейсом
Конфигуратор поставляется в виде бинарника под WINDOWS, Linux Debian и Mac OS который запускает GUI-приложение.
Описание кнопок:
- Выбрать файл таблицы для modbus2mqtt
Открывает менеджер файлов и позволяет выбрать файл таблицы с расширениями *.xlsx. При выборе проверяет, что в файле присутствуют определенные листы, в соответствии с типом драйвера. Так же проверяет, что листы не пустые. После это подгружает данные из таблицы в память. - Выбрать файл таблицы для bacnet2mqtt
Открывает менеджер файлов и позволяет выбрать файл таблицы с расширениями *.xlsx. При выборе проверяет, что в файле присутствуют определенные листы, в соответствии с типом драйвера. Так же проверяет, что листы не пустые. После это подгружает данные из таблицы в память. - Сгенерировать YAML файлы
Сначала выполняется проверка на наличие возможных ошибок по типу отсутствия устройств из которых опрашиваются сигналы со страницы Read на странице Devices, наличия нескольких одинаковых выходных топиков, несоответствие типа данных и функции записи параметров (например, будет ошибка, если вы укажите тип данных float, а код функции 5(write single coil)). Все ошибки выводятся во всплывающем сообщении, с достаточным количеством информации, чтобы найти и исправить их в исходном файле таблицы. Затем, если ошибок нет, всплывает окно выбора директории сохранения YAML-файлов (при нажатии на кнопку "Отмена" в окне выбора директории — файлы сохранятся на рабочий стол). После этого файлы генерируются и сохраняются в выбранной директории. Имена сгенерированных файлов можно увидеть в логах работы Автоконфигуратора, которые находятся в части под всеми кнопками. - Очистить
Очищает данные таблицы из памяти приложения, очищает записи с логами, которые выводятся в части под кнопками. - Скачать документацию
Открывает менеджер файлов и позволяет сохранить pdf-документацию на данное приложение. По умолчанию это директория, из которой запущено приложение.
¶ Modbus2mqtt
Подробное описание драйвера в документе «Руководство пользователя. Драйвер Modbus2mqtt».
Шаблон таблицы для автоконфигурирования тут.
Таблица должна состоять из следующих листов:
- Devices: здесь описаны устройства, которые будут опрашиваться драйвером;
- COM-VCOM-ports: здесь описываются com-порты и виртуальные com-порты для опроса устройств по modbus-rtu и modbus-rtu-over-tcp;
- Read: здесь описываются сигналы, которые будут считываться из устройств, приведенных на странице Devices;
- Write: здесь описываются сигналы, которые будут записываться в устройства, приведенные на странице Device.
¶ Лист «Device»
| number | device_name | device_type | enable | address | unit_id | use_shared_connection | root_topic_mqtt | frame_timeout_ms | response_timeout_ms | idle_timeout_ms | retries | time_retries_s | time_reconnect_s | global_publish_interval |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Номер | Имя устройства | Тип устройства | Статус | IP:Port/com/vcom | Unit ID Устройства | Общее сетевое подключение | Корневой топик | Время между командами на чтение, мс | Тайм-аут ответа, мс | Тайм-аут простоя TCP, с | Попыток повтора | Тайм-аут между попытками повтора, с | Тайм-аут на переподключение, с | Период гарантированной отправки, c |
ВАЖНО!
Наличие приведенных столбцов - обязательно! Наличие в их ячейках значений - указано в описании столбцов (Обязательный - должно быть явно указано значение. Необязательный - значение можно не указывать, будет применено значение по умолчанию.
Описание столбцов:
| Имя столбца | Обязательный / Не обязательный параметр | Описание | Допустимые значения | Значения по умолчанию |
|---|---|---|---|---|
| number | Обязательный | Номер устройства. Используется для логирования и вывода информации об ошибках в таблице | Уникальное целое число больше нуля | — |
| device_name | Обязательный | Уникальный идентификатор устройства, используется как ссылка, на которую ссылаются сигналы из листа Read, Write | Любое уникальное значение | — |
| device_type | Обязательный | Описывает протокол, по которому будет опрашиваться устройство | TCP, RTU, RTU-over-TCP | — |
| enabled | Необязательный | Опция активации и деактивации работы устройства | true, false | true |
| address/IP:Port | Обязательный | Адрес устройства | Если в поле device_type/Тип устройства указано значение TCP, то допустимые значения в этом поле ip-адрес:port, например 192.168.1.2:502. Если в поле device_type/Тип устройства указано значение RTU или RTU-over-TCP, то в этом поле должно быть указана ссылка на порт на листе COM-VCOM-ports. | — |
| unit_id | Обязательный | ID сервера Modbus | 1-255 | — |
| use_shared_connection | Необязательный | Использование одного tcp-соединения для группы устройств | true, false | false |
| root_topic_mqtt | Обязательный | Часть всего топика в структуре `/devices/{parameter_name}`. Подробнее про правила именования топиков читай "Новый стандарт топиков". Примечание: если на листе Read или Write в поле parameter_name/Имя параметра значение начинается с /devices/, то значение, указанное в root_topic_mqtt/Корневой топик не используется и на выходе или входе будет топик структуры `{*parameter\_name}\` или \`{parameter_name}/${command_topic}`* | Не допускается использование символов '#' и '+' | — |
| frame_timeout_ms | Необязательный | Время в мс, между командами на чтение, при ошибке типа serial timeout увеличиваем время между запросами | 0-10000 | Для TCP - 0, для RTU и RTU-over-TCP - 100 |
| response_timeout_ms | Необязательный | Время в мс, максимальное время ответа устройств | 0-10000. Только для TCP и RTU-over-TCP. |
500 |
| idle_timeout_s | Необязательный | Время в секундах, как долго TCP соединение может оставаться открытым без передачи данных | 10-120. Только для TCP и RTU-over-TCP. |
60 |
| retries | Необязательный | Кол-во попыток для повторов соединения с тайм-аутом time_retries_s/Тайм-аут между попытками повтора | 0-500 | 3 |
| time_retries_s | Необязательный | Время в секундах, тайм-аут на повтор соединения с сервером | 0-3600 | 10 |
| time_reconnect_s | Необязательный | Время в секундах, тайм-аут на повтор соединения с сервером после retries/Попыток повтора | 0-3600 | 300 |
| global_publish_interval | Необязательный | Время в секундах, период гарантированной отправки для параметров в которых указан параметр апертура | 0-3600 | 0 |
¶ Лист «COM-VCOM-ports»
На данном листе первые две строки должны содержать:
| number | port_name | type | port | settings | timeout |
|---|---|---|---|---|---|
| Номер | Пользовательское имя порта | Тип порта | Путь к порту | Настройки порта | Тайм-аут ответа, мс |
ВАЖНО!
Наличие приведенных столбцов - обязательно! Наличие в их ячейках значений - указано в описании столбцов (Обязательный - должно быть явно указано значение. Необязательный - значение можно не указывать, будет применено значение по умолчанию
| Имя столбца | Обязательный / Не обязательный параметр | Описание | Допустимые значения | Значения по умолчанию |
|---|---|---|---|---|
| number | Обязательный | Номер порта. Используется для логирования и вывода информации об ошибках в таблице | Уникальное целое число больше нуля | — |
| port_name | Обязательный | Уникальный идентификатор порта, используется как ссылка, на которую ссылаются устройства из листа Devices | Любое уникальное значение | — |
| type | Обязательный | Тип порта для устройств типа RTU и RTU-over-TCP | COM, VCOM. COM - для RTU устройств, VCOM - для RTU-over-TCP устройств | — |
| port | Обязательный | Если тип порта COM, то указывается путь к последовательному порту на устройстве, например для WB /dev/ttyRS485-1. Если тип порта VCOM, то указывается ip-адрес:port, например 192.168.1.2:502 | — | — |
| settings | Обязательный | Настройки последовательного порта. Пример настроек и допустимые значения смотри в инструкции по работе с драйвером modbus2mqtt | Только для COM | — |
| timeout | Необязательный | Время в мс, максимальное время ответа устройств | 500-5000. Только для COM |
500 |
¶ Лист «Read»
| number | link_to_device | parameter_name | aperture | transform | precision | address | reg_type | data_type | byteorder | wordorder | read_period_ms | enable_group |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Апертура | Формула | Точность | Адрес регистра | Код функции | Тип данных | Порядок следования байт | Порядок следования слов | Период чтения, мс | Групповой запрос |
ВАЖНО!
Наличие приведенных столбцов - обязательно! Наличие в их ячейках значений - указано в описании столбцов (Обязательный - должно быть явно указано значение. Необязательный - значение можно не указывать, будет применено значение по умолчанию.
Описание столбцов:
| Имя столбца | Обязательный / Не обязательный параметр | Описание | Допустимые значения | Значения по умолчанию |
|---|---|---|---|---|
| number | Обязательный | Номер параметра. Используется для логирования и вывода информации об ошибках в таблице. | Уникальное целое число больше нуля | — |
| link_to_device | Обязательный | Указывается device_name/Имя устройства со страницы Devices, из которого будет вычитываться данный параметр. | — | — |
| parameter_name | Обязательный | часть всего топика в структуре `/devices/{parameter_name}`. Подробнее про правила именования топиков читай "Новый стандарт топиков". Примечание: если на листе Read в поле parameter_name/Имя параметра значение начинается с /devices/, то значение указанное в root_topic_mqtt/Корневой топик не используется и на выходе будет топик структуры `${parameter_name}`. | Не допускается использование символов '#' и '+' | — |
| aperture | Необязательный | Абсолютная апертура для параметра. При указании обязательно задавать global_publish_interval | 0.01–1000 | 0 |
| transform | Необязательный | Формула для преобразования значения: y = (a*x + b); где x - исходное значение, y - преобразованное значение, а - множитель, b - смещение. Шаблон значения a:b. Пример: 1:0. Даже если смещение не используется, необходимо указывать оба параметра | Формат a:b | 1:0 |
| precision | Необязательный | Количество знаков после запятой. | 0–6 | 0 |
| address | Обязательный | Modbus адрес регистра в десятичной системе счисления, если указан с разделителем ":", то чтение бита. | При указании номера бита проверяется соответствие указанному типу данных в столбце data_type/Тип данных. Нельзя указывать номер бита больший, чем количество бит в используемом типе данных. Например, для int16 нельзя указать номер бита больший 15 (нумерация битов начинается с 0). Так же для введенного адреса проверяется код функции: - для функций 1, 2 адрес должен быть целочисленным значением большим, либо равным нулю, без указания бита - для функции 3, 4 адрес должен быть целочисленным значением большим, либо равным нулю или включать в себя номер бита в регистре, если сигнал читается по битовой маске. |
— |
| reg_type | Обязательный | Modbus функции чтения. | 1, coil, 2, discrete, 3, holding, 4, input Подробнее смотри таблицу Modbus функции чтения/записи в инструкции по работе с драйвером modbus2mqtt. |
— |
| data_type | Обязательный | В зависимости от указанного типа данных будет вычитываться определенное количество регистров и приводиться к этому типу вычитанные сырые байты. | Смотри таблицу Modbus Типы данных в документе РП. Драйвер Modbus2mqtt | — |
| byteorder | Необязательный | Порядок следования байт в слове. | big, little, bigswap, littleswap | big |
| wordorder | Необязательный | Порядок следования слов. | high, low | high |
| read_period_ms | Обязательный | Период опроса параметра из устройства. Учитывать тип соединения и число параметров. | 10–60000 | — |
| enabled_group | Обязательный | Опция включения/отключения группового запроса. Если не включать эту функцию, драйвер будет запрашивать каждый параметр из устройства отдельно.Работает с кодами функции 1, 2, 3 и 4. Драйвер самостоятельно собирает приведенные параметры в группы для группового опроса. Параметры объединяются в группы на основе указанных периодов чтения, кодов функции, их типов данных и адресов. Для 3 и 4 функций максимум можно вычитать до 125 регистров в одной группе, Для функций 1 и 2 - 2000 регистров. При инициализации и первом чтении, даже если групповое чтение включено - драйвер прочитает все регистры по одному запросу. | true, false | — |
| number | Обязательный | Номер параметра. Используется для логирования и вывода информации об ошибках в таблице. | Уникальное целое число больше нуля | — |
¶ Лист «Write»
| number | link_to_device | parampara_name | command_topic | address | func_code | data_type | byteorder | wordorder |
|---|---|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Постфикс топика для управления | Адрес регистра | Код функции | Тип данных | Порядок следования байт | Порядок следования слов |
Описание столбцов:
| Имя столбца | Обязательный / Не обязательный параметр | Описание | Допустимые значения | Значения по умолчанию |
|---|---|---|---|---|
| number | Обязательный | Номер параметра. Используется для логирования и вывода информации об ошибках в таблице. | Уникальное целое число больше нуля | — |
| link_to_device | Обязательный | Указывается device_name/Имя устройства со страницы Devices, из которого будет вычитываться данный параметр. | — | — |
| parameter_name | Обязательный | часть всего топика в структуре управляющего топика `/devices/{parameter_name}/{command\_topic}\`*. Подробнее про правила именования топиков читай *_"Новый стандарт топиков"_*. Примечание: если на листе *Write* в поле *_parameter\_name/Имя параметра_* значение начинается с */devices/*, то значение указанное в *_root\_topic\_mqtt/Корневой топик_* не используется и на выходе будет топик структуры *\`{parameter_name}/${command_topic}` | Не допускается использование символов '#' и '+' | — |
| command_topic | Необязательный | Значение, которое используется в структуре управляющих топиков`/devices/{parameter_name}/${command_topic}` | Не допускается использование символов '#' и '+'. | on |
| address | Обязательный | Modbus адрес регистра в десятичной системе счисления, в который будет производиться запись. Может быть указан конкретный бит регистра, который следует изменить, например "10:1". При указании номера бита проверяется соответствие указанному типу данных в столбце data_type/Тип данных. | Нельзя указывать номер бита больший, чем количество бит в используемом типе данных. Например, для int16 нельзя указать номер бита больший 15 (нумерация битов начинается с 0). Так же для введенного адреса проверяется код функции: - для функций 5, 6 ,16 адрес должен быть целочисленным значением большим, либо равным нулю, без указания бита - для функции 22 адрес должен обязательно включать в себя номер бита в регистре. |
— |
| func_code | Обязательный | Modbus функции записи | Допустимые значения: 5, 6, 16, 22. Подробнее смотри таблицу Modbus функции чтения/записи в инструкции по работе с драйвером modbus2mqtt | — |
| data_type | Обязательный | Тип данных записываемого значения. В зависимости от указанного типа данных будет записываться определенное количество регистров | Подробнее смотри таблицу Modbus Типы данных в документе РП. Драйвер Modbus2mqtt | — |
| byteorder | Необязательный | Порядок следования байт в слове. | big, little, bigswap, littleswap | big |
| wordorder | Необязательный | Порядок следования слов. | high, low | high |
¶ Шаблон-пример таблицы для автоконфигурирования modbus2mqtt
¶ Лист «Device»
| number | device _name |
device _type |
enable | address | unit_id | use_shared _connection |
root_topic_mqtt | frame_timeout_ms | response _timeout_ms |
idle _timeout_ms |
retries | time _retries_s |
time _reconnect_s |
global _publish_interval |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Номер | Имя устройства | Тип устройства | Статус | IP:Port/com/vcom | Unit ID Устройства | Общее сетевое подключение | Корневой топик | Время между командами на чтение, мс | Тайм-аут ответа, мс | Тайм-аут простоя TCP, с | Попыток повтора | Тайм-аут между попытками повтора, с | Тайм-аут на переподключение, с | Период гарантированной отправки, c |
| 1 | device_tcp_1 | TCP | 192.168.1.2:502 | 1 | Test |
¶ Лист «COM-VCOM-ports»
| number | port_name | type | port | settings | timeout |
|---|---|---|---|---|---|
| Номер | Пользовательское имя порта | Тип порта | Путь к порту | Настройки порта | Тайм-аут ответа, мс |
| 1 | Com1 | com | /dev/ttyRS485-1 | 9600:8:N:1 | 500 |
| 2 | Vcom1 | vcom | 192.168.1.2:502 |
¶ Лист «Read»
| number | link_to_device | parameter_name | aperture | transform | precision | address | reg_type | data_type | byteorder | wordorder | read_period_ms | enable_group |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Апертура | Формула | Точность | Адрес регистра | Код функции | Тип данных | Порядок следования байт | Порядок следования слов | Период чтения, мс | Групповой запрос |
| 1 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n100_sensor-pressure/controls/pressure | 1:0 | 1 | 2 | 4006 | 3 | float | big | low | 5000 | true |
| 2 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n101_sensor-pressure/controls/pressure | 0.01:0 | 10 | 2 | 4000 | 3 | float | big | low | 5000 | true |
| 3 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n100_sensor-pressure/controls/ps_1 | 1:0 | 10 | 2 | 51:0 | 3 | u32 | big | high | 5000 | true |
| 4 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n100_sensor-pressure/controls/ps_2 | 1:0 | 10 | 2 | 51:1 | 3 | u32 | big | high | 5000 | true |
| 5 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n101_valve/controls/position | 1:0 | 10 | 2 | 51:2 | 3 | u32 | big | high | 5000 | true |
| 6 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n101_IDD/controls/alarm_input_1 | 1:0 | 10 | 2 | 51:3 | 3 | u32 | big | high | 5000 | true |
¶ Лист «Write»
| number | link_to_device | parampara_name | command_topic | address | func_code | data_type | byteorder | wordorder |
|---|---|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Постфикс топика для управления | Адрес регистра | Код функции | Тип данных | Порядок следования байт | Порядок следования слов |
| 1 | device_tcp_1 | param_name1 | set | 100:1 | 22 | int16 | ||
| 2 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n100_sensor-pressure/controls/pressure/12 | set | 101 | 16 | int32 | ||
| 3 | device_tcp_1 | /devices/b1f11r1_b1f11r1_78_n101_sensor-pressure/controls/pressure | on | 2 | 6 | int16 |
¶ Bacnet2mqtt
Подробное описание драйвера в документе «Руководство пользователя. Драйвер Bacnet2mqtt».
Таблица должна состоять из следующих листов:
- Devices: описывает устройства опрашиваемые драйвером;
- Read: описывает сигналы, считываемые из устройств, приведенных на странице Devices;
- Write: описывает сигналы, записываемые в устройства, приведенные на странице Devices.
¶ Лист «Device»
На листе первые две строки должны содержать следующие столбцы:
| number | device_name | address | root_topic_mqtt | max_quantity | max_apdu | timeout_s |
|---|---|---|---|---|---|---|
| Номер | Имя устройства | IP:Port | Корневой топик | Максимальное количество объектов в запросе | Максимальный размер APDU | Таймаут ответа, c |
ВАЖНО!
Наличие приведенных столбцов - обязательно! Наличие в их ячейках значений - указано в описании столбцов (Обязательный - должно быть явно указано значение. Необязательный - значение можно не указывать, будет применено значение по умолчанию.
Описание столбцов:
| Имя столбца | Обязательный / Не обязательный параметр | Описание | Допустимые значения | Значения по умолчанию |
|---|---|---|---|---|
| number | Обязательный | Номер устройства. Используется для логирования и вывода информации об ошибках в таблице | Уникальное целое число больше нуля | — |
| device_name | Обязательный | Уникальный идентификатор устройства, используется как ссылка, на которую ссылаются сигналы из листа Read, Write | Любое уникальное значение | — |
| address/IP:Port | Обязательный | IP-адрес и порт устройства. Шаблон значения в этом поле ip-адрес:port, например 192.168.1.2:47808 | — | — |
| root_topic_mqtt | Обязательный | Часть всего топика в структуре `/devices/{parameter_name}`. Подробнее про правила именования топиков читай "Новый стандарт топиков". Примечание: если на листе Read или Write в поле parameter_name/Имя параметра значение начинается с /devices/, то значение указанное в root_topic_mqtt/Корневой топик не используется и на выходе или входе будет топик структуры `{*parameter\_name}\` или \`{parameter_name}/${command_topic}`* | Не допускается использование символов '#' и '+' | — |
| max_quantity | Необязательный | В соответствии с протоколом bacnet для описания того или иного источника данных применяются физические или логическое сущности, называемые объектами (OBJECT_ANALOG_INPUT, OBJECT_ANALOG_OUTPUT, OBJECT_BINARY_INPUT, и т.д.). У этих объектов есть свойства, которые специфичны для каждого объекта и частично приведены в документации на драйвер bacnet2mqtt и детально описаны в стандарте The BACnet Standart (PROP_PRESENT_VALUE, PROP_OBJECT_NAME, PROP_OBJECT_TYPE и т.д.). Драйвер считывает непосредственно свойства этих объектов, которые прописываются на странице Read. Свойства запрашиваются не по одному, а сразу все, которые указаны для этого устройства. Исходя из опыта, некоторые конечные устройства, работающие по bacnet, не готовы обрабатывать запросы на чтение большого количества объектов. Либо, если количество объектов не умещается в max_apdu, этот запрос разбивается на сегменты и некоторые устройства могут не поддерживать сегментированные запросы, в таком случае нужно ограничивать, количество объектов в одном запросу, чтобы обойти данные ограничения опрашиваемых серверов. Значение должно быть целым числом больше нуля | 1-150 | 100 |
| max_apdu | Необязательный | Это ограничение максимального размера APDU-части пакета. Т.е. драйвер будет формировать запросы с длиной APDU не больше указанного. Размер указывается в байтах | 1-1476 | 1476 |
| timeout_s | Необязательный | Время в секундах, максимальное время ответа устройств | 1-5 | 5 |
¶ Лист «Read»
На листе первые две строки должны содержать следующие столбцы:
| number | link_to_device | parameter_name | transform | precision | object_type | object_instance | property_id | read_period_ms |
|---|---|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Формула | Точность | Тип объекта | Номер экземпляра | id свойства | Период чтения, мс |
Описание столбцов:
| Имя столбца | Обязательный / Не обязательный параметр | Описание | Допустимые значения | Значения по умолчанию |
|---|---|---|---|---|
| number | Обязательный | Номер устройства. Используется для логирования и вывода информации об ошибках в таблице | Уникальное целое число больше нуля | — |
| link_to_device | Обязательный | Указывается device_name/Имя устройства со страницы Devices, из которого будет вычитываться данный параметр. | Любое уникальное значение | — |
| parameter_name | Обязательный | часть всего топика в структуре `/devices/{parameter_name}`. Подробнее про правила именования топиков читай "Новый стандарт топиков". Примечание: если на листе Read в поле parameter_name/Имя параметра значение начинается с /devices/, то значение указанное в root_topic_mqtt/Корневой топик не используется и на выходе будет топик структуры `${parameter_name}`. | Не допускается использование символов '#' и '+' | — |
| transform | Необязательный | Формула для преобразования значения: y = (a*x + b); где x - исходное значение, y - преобразованное значение, а - множитель, b - смещение. Шаблон значения a:b. Пример: 1:0. Даже если смещение не используется, необходимо указывать оба параметра | Формат a:b | 1:0 |
| precision | Необязательный | Количество знаков после запятой. | 0–6 | 0 |
| object_type | Обязательный | Строковое представление типа объекта bacnet-устройства | Допустимые значения смотри в документации на драйвер bacnet2mqtt | — |
| object_instance | Обязательный | Номер экземпляра объекта | Целое число больше или равное нулю | — |
| property_id | Обязательный | Строковое представление идентификатора свойства объекта bacnet-устройства. | Допустимые значения смотри в документации на драйвер bacnet2mqtt | — |
| read_period_ms | Обязательный | Период опроса данного параметра из устройства, на которое ссылается данный параметр. | Целое число больше нуля | — |
¶ Лист «Write»
На листе первые две строки должны содержать следующие столбцы:
| number | link_to_device | parameter_name | command_topic | object_type | object_instance | property_id |
|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Постфикс топика для управления | Тип объекта | Номер экземпляра | id свойства |
Описание столбцов:
| Имя столбца | Обязательный / Не обязательный параметр | Описание | Допустимые значения | Значения по умолчанию |
|---|---|---|---|---|
| number | Обязательный | Номер устройства. Используется для логирования и вывода информации об ошибках в таблице | Уникальное целое число больше нуля | — |
| link_to_device | Обязательный | Указывается device_name/Имя устройства со страницы Devices, из которого будет вычитываться данный параметр. | Любое уникальное значение | — |
| parameter_name | Обязательный | Часть всего топика в структуре `/devices/{parameter_name}/{command\_topic}\`*. Подробнее про правила именования топиков читай *_"Новый стандарт топиков"_*. Примечание: если на листе *Write* в поле *_parameter\_name/Имя параметра_* значение начинается с */devices/*, то значение, указанное в *_root\_topic\_mqtt/Корневой топик,_* не используется и на входе будет обрабатываться топик структуры *\`{parameter_name}/${command_topic}` | Не допускается использование символов '#' и '+' | — |
| command_topic | Необязательный | Значение, которое используется в структуре управляющих топиков `/devices/{parameter_name}/${command_topic}` | Не допускается использование символов '#' и '+'. | on |
| object_type | Обязательный | Строковое представление типа объекта bacnet-устройства | Допустимые значения смотри в документации на драйвер bacnet2mqtt | — |
| object_instance | Обязательный | Номер экземпляра объекта | Целое число больше или равное нулю | — |
| property_id | Обязательный | Строковое представление идентификатора свойства объекта bacnet-устройства. | Допустимые значения смотри в документации на драйвер bacnet2mqtt | — |
¶ Шаблон-пример таблицы автоконфигурирования bacnet2mqtt
¶ Лист «Device»
| number | device_name | enabled | address | root_topic_mqtt | max_quantity | max_apdu | timeout_s |
|---|---|---|---|---|---|---|---|
| Номер | Имя устройства | Статус | IP:Port | Корневой топик | Максимальное количество объектов в запросе | Максимальный размер APDU | Таймаут ответа, c |
| 1 | RoomController.Simulator | true | 127.0.0.1:47808 | i_am_RoomController.Simulator | 100 | 1476 | 5 |
¶ Лист «Read»
| number | link_to_device | parameter_name | aperture | transform | precision | object_type | object_instance | property_id | read_period_ms |
|---|---|---|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Апертура | Формула | Точность | Тип объекта | Номер экземпляра | id свойства | Период чтения, мс |
| 1 | RoomController.Simulator | Temperature.Indoor | 0 | 1:0 | -1 | AnalogInput | 0 | PresentValue | 1000 |
| 2 | RoomController.Simulator | Temperature.Water | 0 | 1:0 | -1 | AnalogInput | 1 | PresentValue | 1000 |
| 3 | RoomController.Simulator | Temperature.Outdoor | 0 | 1:0 | -1 | AnalogInput | 2 | PresentValue | 1000 |
| 4 | RoomController.Simulator | SetPoint.Value | 0 | 1:0 | -1 | AnalogValue | 0 | PresentValue | 1000 |
| 5 | RoomController.Simulator | Setpoint.1 | 0 | 1:0 | -1 | AnalogValue | 1 | PresentValue | 1000 |
| 6 | RoomController.Simulator | Setpoint.2 | 0 | 1:0 | -1 | AnalogValue | 2 | PresentValue | 1000 |
| 7 | RoomController.Simulator | Setpoint.3 | 0 | 1:0 | -1 | AnalogValue | 3 | PresentValue | 1000 |
| 8 | RoomController.Simulator | TextsSetpointsCSV | 0 | 1:0 | -1 | CharacterString | 1 | PresentValue | 1000 |
| 9 | RoomController.Simulator | State.Heater | 0 | 1:0 | -1 | BinaryValue | 0 | PresentValue | 1000 |
| 10 | RoomController.Simulator | State.Chiller | 0 | 1:0 | -1 | BinaryValue | 1 | PresentValue | 1000 |
| 11 | RoomController.Simulator | State | 0 | 1:0 | -1 | MultiStateValue | 0 | PresentValue | 1000 |
| 12 | RoomController.Simulator | State.VentilationLevel | 0 | 1:0 | -1 | MultiStateValue | 1 | PresentValue | 1000 |
¶ Лист «Write»
| number | link_to_device | parameter_name | command_topic | object_type | object_instance | property_id |
|---|---|---|---|---|---|---|
| Номер | Ссылка на устройство из таблицы Devices | Имя параметра | Постфикс топика для управления | Тип объекта | Номер экземпляра | id свойства |
| 1 | RoomController.Simulator | SetPoint.Value | on | AnalogValue | 0 | PresentValue |
| 2 | RoomController.Simulator | Setpoint.1 | on | AnalogValue | 1 | PresentValue |
| 3 | RoomController.Simulator | Setpoint.2 | on | AnalogValue | 2 | PresentValue |
| 4 | RoomController.Simulator | Setpoint.3 | on | AnalogValue | 3 | PresentValue |
| 5 | RoomController.Simulator | TextsSetpointsCSV | on | CharacterString | 1 | PresentValue |
| 6 | RoomController.Simulator | State.Heater | on | BinaryValue | 0 | PresentValue |
| 7 | RoomController.Simulator | State.Chiller | on | BinaryValue | 1 | PresentValue |
| 8 | RoomController.Simulator | State | on | MultiStateValue | 0 | PresentValue |
| 9 | RoomController.Simulator | State.VentilationLevel | on | MultiStateValue | 1 | PresentValue |
¶ Приложение. PDF версия документа
PDF-версия данного руководства пользователя доступна для скачивания и печати. Документ содержит полную информацию по установке, настройке и эксплуатации автоконфигуратора YAML, включая все разделы, представленные в данной HTML-версии.