WebSocket API

Это руководство описывает протокол обмена между сетевым сервером Orion Network Server (NS) и сервером приложений (AppServer). Транспорт — WebSocket, сообщения — JSON; запрос и ответ сопоставляются по полю operation_id.

Описание соответствует документу «Websocket API» версии 0.17 от 10.09.2024.

📄️Быстрый старт

Быстрый старт с WebSocket API Orion Network Server: подключиться, подписаться на данные устройств и получить первый uplink — готовые примеры на Python и Node.js.

📄️Общие понятия

Общие понятия WebSocket API Orion Network Server: формат сообщений, токены и уровни доступа, operation_id, status, error_code и error_text, форматы полей.

📄️Термины и определения

Термины и определения WebSocket API Orion Network Server: ABP, OTAA, AppEUI, AppKey, DevEUI, DevAddr, operation_id, Multicast и другие.

📄️Сокращения

Сокращения, используемые в описании WebSocket API Orion Network Server: ABP, NwkID, OTAA, LoRaWAN.

📄️Подключение

Подключение к WebSocket API Orion Network Server: адрес, проверка app_id и токена, сообщение connected, ошибки, тайм-аут соединения и ping.

🗃Команды

Запросы и ответы по группам: клиенты, приложения, устройства, multicast, downlink, данные, координаты.

📄️Лист изменений

История изменений описания WebSocket API Orion Network Server, версии 1–17.