Sign in

v1

latestOpenAPI 3.0.12026-07-178146159.6 KB
LoRa WAN

Gets the specified device.

get/api/lorawan/devices/{deviceID}

Path parameters

deviceIDstring required

The device identifier.

Response

Success

classType'A' | 'C'

The LoRa device class. Default is A.

preferredWindowinteger

Allows setting the device preferred receive window (RX1 or RX2). The default preferred receive window is 1.

deduplication'None' | 'Drop' | 'Mark'

Allows controlling the handling of duplicate messages received by multiple gateways. The default is Drop.

rX1DROffsetinteger nullable

Allows setting an offset between received Datarate and retransmit datarate as specified in the LoRa Specifiations. Valid for OTAA devices. If an invalid value is provided the network server will use default value 0.

rX2DataRateinteger nullable

Allows setting a custom Datarate for second receive windows. Valid for OTAA devices. If an invalid value is provided the network server will use default value 0 (DR0).

rxDelayinteger nullable

Allows setting a custom wait time between receiving and transmission as specified in the specification.

abpRelaxModeboolean nullable

Allows to disable the relax mode when using ABP. By default relaxed mode is enabled.

fCntUpStartinteger nullable

Allows to explicitly specify a frame counter up start value. If the device joins, this value will be used to validate the first frame and initialize the server state for the device. Default is 0.

fCntDownStartinteger nullable

Allows to explicitly specify a frame counter down start value. Default is 0.

fCntResetCounterinteger nullable

Allows to reset the frame counters to the FCntUpStart/FCntDownStart values respectively. Default is 0.

supports32BitFCntboolean nullable

Allow the usage of 32bit counters on your device.

keepAliveTimeoutinteger nullable

Allows defining a sliding expiration to the connection between the leaf device and IoT/Edge Hub. The default is none, which causes the connection to not be dropped.

sensorDecoderstring nullable

The sensor decoder API Url.

deviceNamestring required

The name of the device.

modelIdstring required

The model identifier.

modelNamestring nullable

The model name.

imageUrlstring uri nullable

The device model image Url.

isConnectedboolean

true if this instance is connected; otherwise, false.

isEnabledboolean

true if this instance is enabled; otherwise, false.

statusUpdatedTimestring date-time

The status updated time.

tagsobject nullable

List of custom device tags and their values.

deviceIDstring required

The device identifier.

useOTAAboolean

A value indicating whether the device uses OTAA to authenticate to LoRaWAN Network, otherwise ABP

appKeystring nullable

The OTAA App Key.

appEUIstring nullable

The device OTAA Application EUI.

appSKeystring nullable

The ABP AppSKey.

nwkSKeystring nullable

The ABP NwkSKey.

devAddrstring nullable

Unique identifier that allows the device to be recognized.

alreadyLoggedInOnceboolean

A value indicating whether the device has already joined the platform.

dataRatestring nullable

The Device Current Datarate, This value will be only reported if you are using Adaptive Data Rate.

txPowerstring nullable

The Device Current Transmit Power, This value will be only reported if you are using Adaptive Data Rate.

nbRepstring nullable

The Device Current repetition when transmitting. E.g. if set to two, the device will transmit twice his upstream messages. This value will be only reported if you are using Adaptive Data Rate.

reportedRX2DataRatestring nullable

The Device Current Rx2Datarate.

reportedRX1DROffsetstring nullable

The Device Current RX1DROffset.

reportedRXDelaystring nullable

The Device Current RXDelay.

gatewayIDstring nullable

The GatewayID of the device.

downlinkboolean nullable

A value indicating whether the downlinks are enabled (True if not provided)