Downlink

This page describes the specifications for downlinks

When using emit('downlink', object) to send data to a device, there are certain specifications to follow. Invoking the emit('string', object) function in this manner is generally only done in downlink encoders of a device type. It has no effect in uplink scripts and will be ignored and not further processed.

Generally, Downlinks can only be created for LoRa and MQTT Devices. Downlinks for HTTP devices are not supported.

LoRa Downlinks

The object needs to have a pre-defined structure as shown below.

{
    "port": 1, // needs to 0 or any other positive integer
    "confirmed": true, // used for confirmed downlinks and is optional, default false
    "payloadHex": "hex-string" // has to be a hex-string
}

If this specification is not followed, an error will be thrown during the forwarding of the downlink object to the carrier.

MQTT Downlinks

The object needs to have a pre-defined structure as shown below.

{
    "topic": "string", // the MQTT topic
    "payload": {
        // object with any properties
    }
}

If this specification is not followed, an error will be thrown during the publishing of the downlink to the MQTT device.