Downlink — send data to a multicast group

According to the v0.17 description, the command queues a data frame for sending to a multicast group. In the current ONS version it does not: the server validates the request but does not queue the frame and does not respond to a valid request.

Request and response: multicast_data_req → no response; on error — a message with the same cmd: multicast_data_req.
Access: high access level token only. With a low access level token the server responds with error 1.

Current ONS version

Differences from the v0.17 description:

• The command is not executed: the frame is not queued and does not go on air.
• The server does not respond to a valid request. The multicast_data_resp message with dataId does not exist.
• On error the server sends a message with cmd: multicast_data_req, without operation_id and without error_text.

Request

Fields not marked as required may be omitted. The server only validates their format.

Field	Type	Description
cmd	string	multicast_data_req
operation_id	string	Any string; the server does not return it in the response
data	string	Required. Payload in hex
multicast_eui	string	Group EUI, 16 hex characters
multicast_addr	string	Group address, 8 hex characters
gatewayEui	string	Gateway EUI, 16 hex characters
fport	uint8	Application port, 0–255. Default 2
fcnt	uint16	Frame counter, 0–65535. Default 0

{
    "cmd": "multicast_data_req",
    "operation_id": "xyz",
    "multicast_eui": "7DA50BE8C74CE6DC",
    "fport": 2,
    "data": "FFFFFFFFFFFF"
}

Response

There is no response to a valid request. A message arrives only on error:

Field	Type	Description
cmd	string	multicast_data_req
status	uint8	2 — error
error_code	uint8	Error code, see below

{
    "cmd": "multicast_data_req",
    "status": 2,
    "error_code": 3
}

Errors

error_code	error_text	What happened
1	—	The request came with a low access level token
3	—	Invalid data: data is missing or is not hex; multicast_eui or gatewayEui is not 16 hex characters; multicast_addr is not 8; fport is not 0–255; fcnt is not 0–65535

See also

• Multicast groups — what a group is and which commands work.