Alpha.Community

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

Обмен данными с брокером

Объектная модель настройки обмена данными с брокером:

Настройка брокера

Чтобы настроить брокер, с которым требуется обмениваться данными:

  1. Перейдите в Alpha.Domain и добавьте Устройство.

  2. Перейдите в Устройство и добавьте Адаптер Ethernet.

  3. В настройках адаптера укажите:

    Свойство Значение
    Адрес IP-адрес, соответствующий адресу брокера.

  4. Добавьте Приложение.

  5. Перейдите в добавленное Приложение и добавьте два экземпляра логического типа брокера. Задайте имена Temperature и Pressure.

  6. Добавьте Карту адресов MQTT.

  7. На элементе Карта адресов MQTT:

    1. Нажмите кнопку .
    2. Укажите место хранения карты адресов на диске.
    3. Задайте имя карты адресов.
    4. Нажмите кнопку Открыть.

    Карта адресов будет создана. Если требуется открыть существующую карту адресов, то выберите файл карты адресов на диске и нажмите кнопку Открыть.

  8. В свойствах Карты адресов MQTT укажите:

    Свойство Значение
    Таблица описания топиков подписки Созданная ранее таблица описания топиков подписки.

    Если для Карты адресов MQTT не указана Таблица описания топиков подписки, то при подписке на топики для каждого топика будет указан одинаковый для всех QoS, равный значению свойства Качество обслуживания (QoS).

    Если для Карты адресов MQTT указана Таблица описания топиков подписки, то при подписке на топики для каждого топика будет указан свой QoS, заданный в столбце Качество обслуживания таблицы описания топиков подписки.

    Если все топики брокера имеют постоянную часть, то её можно указать в свойстве Префикс топика, а не прописывать в таблице описания топиков подписки. При указании Префикса топика данная строка будет добавлена ко всем топикам, которые определены в карте адресов.

    Например, Префикса топика имеет значение Sensors. Тогда подписка будет выполнена на топики брокера Sensors/Temperature.Cmd, Sensors/Pressure.Cmd и т.д.

  9. Перейдите в Карту адресов MQTT и настройте параметры адресов сигналов:

    Параметр Значение
    Привязка непосредственно.
    Идентификатор топика подписки Идентификатор топика из таблицы описания топиков подписки.
    Топик Переменная часть топика подписки.
    Протокольный тип

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

    • binaryTunneling - для значений всех типов;
    • json - для значений типа String.

    Для сигналов, которым были заданы атрибуты Топик MQTT и Протокольный тип MQTT в логическом типе брокера, значения параметров Топик и Протокольный тип будут подставлены в карту адресов из соответствующих атрибутов.

    Заполненная Карта адресов MQTT:

    Если для Карты адресов MQTT не указана Таблица описания топиков подписки, то в Топике требуется прописать полный топик брокера.

    При заданной таблице описания топиков подписки:

    при заданном для карты адресов Префиксе топика - Sensor и заполненной карте адресов:

    для сигналов будут выполняться подписки на следующие топики:

    Сигнал Топик
    Pressure.Value SensorPressure/SensorValue
    Pressure.Cmd SensorPressure/SensorCmd
    Pressure.Setpoint SensorPressure/SensorSetpoint
    Pressure.SetpointOut SensorPressure/SensorSetpointOut
    Temperature.Value SensorTemperature/SensorValue
    Temperature.Cmd SensorTemperature/SensorCmd
    Temperature.Setpoint SensorTemperature/SensorSetpoint
    Temperature.SetpointOut SensorTemperature/SensorSetpointOut

    Для исходящих сигналов с заданным топиком, например, Temperature, при передаче (публикации) значения сигнала:

    • будет сформировано сообщение с топиком Temperature и заданом в таблице описания топиков подписки Качестве обслуживания;
    • если брокеру известен топик Temperature, то брокер разошлет сообщение всем клиентам, подписанным на топик Temperature.

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

    • в значение - для протокольного типа binaryTunneling;
    • без преобразования - для протокольного типа json;

    и при условии совпадения типов входящего сигнала и полученного значения, это значение будет присвоено входящему сигналу:

    • для binaryTunneling сообщение получит конкретный сигнал (будет учтен идентификатор узла в конфигурации);
    • для json сообщение получат все сигналы с топиком Temperature.
  10. Вернитесь в Устройство и добавьте Брокер MQTT.

  11. В свойствах Брокера MQTT укажите:

    Свойство Значение
    Карта адресов Карта адресов, добавленная в Приложение устройства.
    Номер TCP порта Порт брокера.

  12. Вернитесь в Alpha.Domain и соедините Адаптер Ethernet брокера с Сетью Ethernet.

Настройка клиента MQTT

Чтобы настроить MQTT Клиент для обмена данными с брокером:

  1. Перейдите в Alpha.Domain → Узел Alpha.Domain → Alpha.Server, и из папки Коммуникационные модули добавьте MQTT Клиент.

  2. На MQTT Клиенте нажмите кнопку и укажите ранее добавленный Брокер MQTT.

  3. Чтобы настроить параметры взаимодействия MQTT Клиента и Брокера MQTT, выделите добавленный Брокер.

  4. Настройте параметры взаимодействия:

    Свойство Значение
    Версия протокола Используемая брокером версия протокола. Значение по умолчанию 3.1.
    Имя пользователя Имя пользователя для подключения к брокеру.
    Пароль Пароль для подключения к брокеру.

    Значения остальных параметров можно оставить по умолчанию.

    Свойство Значение
    Общие
    Таймаут потери связи, с

    Максимальный период времени, который проходит между моментом отправки брокеру пакета данных до момента отправки следующего пакета данных.

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

    Значение по умолчанию 5 секунд.

    Качество обслуживания (QoS)

    Качество обслуживания, устанавливаемое публикациям:

    • Без гарантии доставки (QoS = 0) - брокер получит сообщение максимум один раз - доставка сообщения не гарантируется.
    • Гарантированная доставка (QoS = 1) - брокер получит сообщение минимум один раз - сообщения будут посылаться брокеру, пока MQTT Клиент не получит подтверждения доставки.
    • Гарантированная доставка, без дубликатов (QoS = 2) - брокер получит сообщение гарантировано один раз.
    Флаг отчистки сессии

    Очистка сессии при каждом подключении у брокеру:

    • Да - клиент и брокер должны отменить все предыдущие сессии и начать новую;
    • Нет - брокер должен возобновить связь с клиентом в рамках текущей сессии, учитывая ClientId. При этом брокер должен сохранить все неподтвержденные сообщения с QoS = 1 и QoS = 2, а также может сохранить сообщения с QoS = 0, и отправить их после восстановления соединения.
    Таймаут ожидания ответа на запрос, с Время в секундах, в течение которого модуль ожидает ответ на отправленный запрос. По истечении указанного времени ответ считается просроченным.
    Таймаут установки соединения, с Время в секундах, в течение которого модуль ожидает установления соединения.
    Размер пакета данных принудительной отправки, байт

    (Значение параметра учитывается только при туннелировании через MQTT).

    Размер данных в байтах, при достижении которого выполняется немедленная отправка пакета:

    • 0 - отправка каждого изменения;
    • 33 ... 429496295 - отправка при достижении указанного размера.

    Таймаут накопления изменений, мс

    (Значение параметра учитывается только при туннелировании через MQTT).

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

    • 0 - контроль не выполняется, каждое изменение значения публикуется;
    • 1 ... 429496295 - отправка выполняется по истечению указанного таймаута.

    Параметры очереди
    Максимальный размер очереди приёма данных, шт Максимальное значение размера очереди данных, при достижении которого старые данные перезаписываются.
    Максимальный размер очереди данных на отправку, шт Максимальное значение размера очереди данных, при достижении которого старые данные перезаписываются и до подписчика могут дойти не все сообщения, даже с QoS = 1 и QoS = 2.

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

Настройка объектной модели уровня Alpha.Server

Чтобы настроить объектную модель Alpha.Server:

  1. Перейдите в Alpha.Server и добавьте Приложение.

  2. Перейдите в добавленное Приложение и добавьтеЛогический объект. Задайте Имя объекта.

  3. Перейдите в добавленный Логический объект и добавьте Объектную ссылку.

  4. В свойстве Объект укажите логический объект приложения устройства, на который будет указывать данная Объектная ссылка.

    После этого в Объектной ссылке отобразится логическая структура указанного объекта.

  5. В контекстном меню Объектной ссылки выполните команду Экспонировать входы и выходы, после чего в логическом объекте Alpha.Server будут созданы сигналы с теми же именами и типами, что и в устройстве, а также прорисованы связи.

  6. Аналогичным способом добавьте в Приложение логический объект Pressure.