Создать триггер, который отправляет сообщения в WebSocket-соединения из топика реестра или устройства Yandex IoT Core
Создайте триггер для топика устройства или реестра Yandex IoT Core и отправляйте копии сообщений в WebSocket-соединения.
Важно
Триггер должен находиться в одном облаке с реестром или устройством, из топика которого он читает сообщения.
Перед началом работы
Для создания триггера вам понадобятся:
-
API-шлюз. Сообщения будут отправляться в WebSocket-соединения, подключенные к API-шлюзу. Если у вас нет API-шлюза, создайте его.
-
Сервисный аккаунт с ролью
api-gateway.websocketBroadcaster. Если у вас нет сервисного аккаунта, создайте его.
-
Реестр или устройство, из топиков которых триггер будет принимать копии сообщений. Если у вас их нет:
Создать триггер
Примечание
Триггер начинает работать в течение 5 минут после создания.
-
В консоли управления перейдите в каталог, в котором хотите создать триггер.
-
Откройте сервис API Gateway.
-
На панели слева выберите Триггеры.
-
Нажмите кнопку Создать триггер.
-
В блоке Базовые параметры:
- Введите имя и описание триггера.
- В поле Тип выберите
IoT Core (устройство). - В поле Запускаемый ресурс выберите
API-шлюз.
-
В блоке Настройки сообщений IoT Core укажите реестр, устройство и MQTT-топик, для которого хотите создать триггер. Если вы создаете триггер для топика реестра, устройство и MQTT-топик можно не указывать. Если MQTT-топик не указан, триггер срабатывает для всех топиков реестра или устройства.
-
В блоке Настройки группирования сообщений укажите:
- размер группы сообщений. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
- максимальное время ожидания. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда.
Триггер группирует сообщения не дольше указанного времени ожидания и отправляет их в WebSocket-соединения. Число сообщений при этом не превышает указанный размер группы.
-
В блоке Настройки API-шлюза:
- В поле API-шлюз выберите API-шлюз.
- В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
- В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.
-
Нажмите кнопку Создать триггер.
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.
Чтобы создать триггер, который отправляет сообщения в WebSocket-соединения, выполните команду:
yc serverless trigger create internet-of-things \
--name <имя_триггера> \
--registry-id <идентификатор_реестра> \
--device-id <идентификатор_устройства> \
--mqtt-topic '$devices/<идентификатор_устройства>/events' \
--batch-size <размер_группы_сообщений> \
--batch-cutoff <максимальное_время_ожидания> \
--gateway-id <идентификатор_API-шлюза> \
--gateway-websocket-broadcast-path <путь> \
--gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>
Где:
--name— имя триггера.--registry-id— идентификатор реестра.--device-id— идентификатор устройства. Если вы создаете триггер для топика реестра, этот параметр можно не указывать.--mqtt-topic— MQTT-топик, для которого вы хотите создать триггер. Необязательный параметр. Если параметр не указан, триггер срабатывает для всех топиков реестра или устройства.
--batch-size— размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 10, значение по умолчанию — 1.--batch-cutoff— максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер группирует сообщения не дольшеbatch-cutoffи отправляет их в WebSocket-соединения. Число сообщений при этом не превышаетbatch-size.
--gateway-id— идентификатор API-шлюза.--gateway-websocket-broadcast-path— путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.--gateway-websocket-broadcast-account-id— идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.
Результат:
id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2022-10-24T15:19:15.353909857Z"
name: iot-trigger
rule:
iot_message:
registry_id: arenou2oj4h2********
device_id: areqjd6un3h2********
mqtt_topic: $devices/areqjd6unh2********/events
batch_settings:
size: "1"
cutoff: 0s
gateway_websocket_broadcast:
gateway_id: d4eofc7n0mh2********
path: /
service_account_id: aje3932acdh2********
status: ACTIVE
Чтобы создать триггер для Yandex IoT Core, воспользуйтесь методом REST API create для ресурса Trigger или вызовом gRPC API TriggerService/Create.
Проверить результат
Проверьте, что триггер работает корректно. Для этого посмотрите логи API-шлюза, в них отображается информация об обращениях к нему.