WebSocket API

This guide describes the exchange protocol between the Orion Network Server (NS) and the application server (AppServer). The transport is WebSocket and messages are JSON; a request and its response are matched by the operation_id field.

The description follows the «Websocket API» document, version 0.17 of 10.09.2024.

📄️Quick start

Quick start with the Orion Network Server WebSocket API: connect, subscribe to device data and receive the first uplink — ready-made Python and Node.js examples.

📄️Basics

Orion Network Server WebSocket API basics: message format, tokens and access levels, operation_id, status, error_code and error_text, field formats.

📄️Terms and definitions

Orion Network Server WebSocket API terms and definitions: ABP, OTAA, AppEUI, AppKey, DevEUI, DevAddr, operation_id, Multicast and more.

📄️Abbreviations

Abbreviations used in the Orion Network Server WebSocket API description: ABP, NwkID, OTAA, LoRaWAN.

📄️Connection

Connecting to the Orion Network Server WebSocket API: address, app_id and token check, the connected message, errors, connection timeout and ping.

🗃Commands

Requests and responses by group: clients, applications, devices, multicast, downlink, data, coordinates.

📄️Change log

Change history of the Orion Network Server WebSocket API description, versions 1–17.