Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Назначение и принцип работы

Модуль MQTT Клиент – коммуникационный модуль, предназначенный для обмена данными между Alpha.Server и брокером по протоколу MQTT. MQTT - это протокол обмена сообщениями между клиентами через брокер-сервер, использующий модель публикаций и подписок.

Функции модуля MQTT Клиент:

  • получение данных от брокера и сохранение полученных данных в сигналы Alpha.Server;
  • подача команд управления - отправка значений сигналов Alpha.Server на брокер.

Обмен данными

Обмен данными между модулем MQTT Клиент и брокером основан на архитектуре Клиент - Сервер. Модуль MQTT Клиент является клиентом, а брокер - сервером, в качестве которого может выступать устройство или программный брокер-сервер.

Модуль MQTT Клиент может выступать в роли:

  • издателя (Publisher) - предоставлять имеющиеся у него данные брокеру;
  • подписчика (Subscriber) - получать данные брокера.

Обмен данными выполняется по сети Ethernet. Модуль MQTT Клиент может подключаться к нескольким брокерам одновременно.

Для подключения к брокеру используется уникальный идентификатор ClientId, генерируемый модулем, а также имя пользователя и пароль (опционально).

ClientId модуля MQTT Клиент отображается в статистике канала, а также в служебном сигнале ClientId.

Топики

Для предоставления данных брокеру и получения данных от брокера выполняется подписка на топики. Топик - это метка (тема), прикрепленная к сообщению. Если топик известен брокеру, то брокер получит сообщение с указанным топиком и разошлет копию сообщения всем клиентам, подписанным на топик.

Топики могут быть одноуровневыми и многоуровневыми.

Одноуровневый топик содержит либо одно слово, либо несколько слов, разделенных точками. Примеры одноуровневых топиков:

Value
Sensors.Temperature.Cmd

Многоуровневые топики имеют разделить уровней - символ /. Примеры многоуровневых топиков:

Sensors/Pressure
Sensors/Temperature/Cmd

Для получения данных определенного уровня ипользуется символ #. Пример топика для получения данных со всех датчиков:

Sensors/#

Подписка на такой топик позволит получать данные с датчиков, например:

Sensors/Temperature
Sensors/Pressure
Sensors/Level

Туннелирование

Модуль MQTT Клиент поддерживает туннелирование через MQTT. При туннелировании значения любого типа преобразуются к сообщениям с помощью протокольного типа binaryTunneling с возможностью объединения пакетов при передаче сообщений.

Туннелирование используется для обмена сообщениями между множеством клиентов-издателей и множеством клиентов-подписчиков через брокер-сервер. В том числе туннелирование позволяет передавать данные от одного Alpha.Server с модулем MQTT Клиент к другому, расположенными в разных сетях, через диод данных (data diode), который передаёт поток данных только в одном направлении. При туннелировании передающий Alpha.Server преобразует данные в протокольный тип binaryTunneling и передаёт через диод данных в принимающий Alpha.Server, который преобразует binaryTunneling обратно к типу Alpha.Server.

На приведенной схеме модуль MQTT Клиент в составе Alpha.Server 1 выступает в ролях:

  • издателя: предоставляет данные через диод данных модулю MQTT Клиент в составе Alpha.Server 2;
  • подписчика: получает данные через диод данных от модуля MQTT Клиент в составе Alpha.Server 3.

Содержимое пакета данных

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

Содержимое пакета данных:

Заголовок Кортеж данных 1 Кортеж данных 2 ... Кортеж данных N
1 байт от 32 байтов от 32 байтов ... от 32 байтов
  • Заголовок - заголовок пакета, содержащий версию пакета. Версия пакета всегда равна 0. При последующих изменениях состава пакета в будущих версиях, версия пакета будет инкрементироваться.
  • Кортежи данных - кортежи данных по сигналам. Минимальный размер каждого кортежа данных 32 байта. Содержимое кортежа данных:

    Тег Значение Качество Метка времени
    4 байта N байт 4 байта 8 байт
    • Тег - тег сигнала.
    • Значение - для числовых значений и значений типа Bool размер 16 байт. Для строковых значений количество байтов равно длине строки.
    • Качество - качество передаваемых данных.
    • Метка времени - метка времени передаваемых данных.

Минимальный размер одного пакета данных составляет 33 байта - заголовок пакета + 1 кортеж данных.

Разделение данных по пакетам

Если при добавлении нового кортежа общий размер пакета данных превысит значение параметра Размер пакета данных принудительной отправки, байт, то данные, добавленные ранее, будут отправлены немедленно, а новый кортеж будет целиком помещён в новый пакет данных.

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

Режимы взаимодействия

Модуль MQTT Клиент поддерживает два режима взаимодействия клиентов MQTT использованием протокольного типа binaryTunneling для конкретного сигнала:

  • Поточечное взаимодействие: один тег = один топик.
  • Взаимодействие по нескольким тегам через один топик.

При поточечном взаимодействии для сигнала в адресе указан уникальный топик или топик подписки+переменная часть. В этом случае изменение значения сигнала будет отправляться по конкретному топику.

При множественном взаимодействии в адресе у нескольких сигналов совпадает топик или топик подписки+переменная часть. В этом случае изменения значения сигналов отправляются в рамках одного топика, при этом в одном сообщении может быть:

  • изменение одного сигнала;
  • изменение нескольких сигналов.

Протокольные типы

Каждый тип сигнала Alpha.Server преобразуется модулем MQTT Клиент к определенному протокольному типу. В таблице приведены типы сигналов Alpha.Server и допустимые для них протокольные типы, используемые модулем MQTT Клиент для передачи данных:

Протокольный тип Тип в Alpha.Server

int1

uint1

int2

uint2

int4

uint4

int8

uint8

float

double

string

bool

binaryTunneling + + + + + + + + + + + +
json                     +  

Качество сигналов

Качества сигналов, выставляемые модулем MQTT Клиент, приведены в таблице:

Значение качества Идентификатор качества Расшифровка
20 LAST_KNOWN Неудачное преобразование данных.
24 COMM_FAILURE Связь с брокером потеряна.
28 OUT_OF_SERVICE Сигналы не обслуживаются модулем.
64 UNCERTAIN Связь установлена, но значения еще не получены.

Работа модуля в резерве

В режиме РЕЗЕРВ модуль MQTT Клиент в роли издателя (Publisher) не предоставляет имеющиеся у него данные брокеру.