Downlink Claim
This type of message is used in the following two cases: 1. For devices with class C
: to immediately send a downlink message to the device. 2. For devices with class A
: to schedule a downlink message for the next available time slot.
Messages of type downlink_claim
allow you to notify the NS about the availability of downlink data on the AS side (the AS is ready to send some device). In other words, downlink_claim
initiates transmission of adownlink_request
message from the NS to the AS.
Let's walk through these sequence diagrams to understand better how the downlink_claim
message works:
For class A
The sequence is as follows:
- The AS sends a
downlink_claim
message to the NS. - The NS prepares a
downlink_request
and sends it to the AS. - The AS processes the
downlink_request
- The AS generates a downlink payload and sends a
downlink_response
to the NS. - The NS receives a downlink payload and saves it.
- The End device sends an uplink message to the NS.
- The NS gets saved a downlink payload and immediately generates a downlink message and sends it to the end device.
- The NS generates a
downlink
message to the AS and sends it.
For class C
The sequence looks like the following:
- The AS sends a
downlink_claim
message to the NS. - The NS prepares a
downlink_request
and sends it to the AS. - The AS processes the
downlink_request
- The AS generates a downlink payload and sends a
downlink_response
to the NS. - The NS generates a downlink message and sends it to the end device.
- The NS generates a
downlink
message to the AS and sends it.
Metadata
You should specify the following fields in downlink_claim
metadata in order to emit a message of this type:
device
- device identifier
It is possible to specify a gateway
and network
as an option to ask the NS downlink optimization engine to use a specific gateway to send downlink messages. If this gateway is not active, then a request will not be sent.
Params
Parameters list is empty.
Example
{
"meta": {
"network": "1a3f34a3",
"gateway": "",
"device": "ba27356cb8a25961"
},
"type": "downlink_claim"
}