Skip to main content

Device Settings

Authentication: every request needs an IdToken — see Authentication. Errors follow the shared error format.

Device settings control each antenna: whether it is enabled, its transmit power, inventory session, RSSI filter, and reader mode.

MethodPathPurpose
GET/devices/{deviceId}/details/device-settingsCurrent antenna settings
GET/devices/{deviceId}/details/device-settings/supportsSettings the reader supports and their allowed values
POST/devices/{deviceId}/operations/device-settingsChange antenna settings

Get Device Settings​

Endpoint Details​

  • URL: https://rest.api.xemelgo.com/edge/devices/{deviceId}/details/device-settings
  • Method: GET

Query Parameters​

ParameterTypeDescriptionRequired
refreshStringtrue to ask the reader now. Omit to return the cached valueNo

StatusCode — 200 on success

Response Body​

{
"antennaSettings": {
"1": { "enabled": true, "powerValue": 3000, "readerMode": 0, "rssiFilter": -90, "session": 1 },
"2": { "enabled": true, "powerValue": 3000, "readerMode": 0, "rssiFilter": -90, "session": 1 },
"3": { "enabled": true, "powerValue": 3000, "readerMode": 0, "rssiFilter": -90, "session": 1 },
"4": { "enabled": true, "powerValue": 3000, "readerMode": 0, "rssiFilter": -90, "session": 1 }
}
}

antennaSettings is keyed by antenna number. Each antenna has:

PropertyTypeDescription
enabledBooleanWhether the antenna is in use
powerValueNumberTransmit power, one of supports.powerAdjustment.options
sessionNumberInventory session, one of supports.inventorySession.options
rssiFilterNumberReads weaker than this RSSI are ignored
readerModeNumberReader mode, one of the values in supports.readerMode.options

Properties the reader does not support are left out.

Get Device Settings Supports​

Returns which settings the reader supports, their allowed values, and its antenna and GPIO counts.

Endpoint Details​

  • URL: https://rest.api.xemelgo.com/edge/devices/{deviceId}/details/device-settings/supports
  • Method: GET

Query Parameters​

ParameterTypeDescriptionRequired
refreshStringtrue to ask the reader now. Omit to return the cached valueNo

StatusCode — 200 on success

Response Body​

{
"commandVersion": "2.2.0",
"supportSummary": {
"supports": {
"powerAdjustment": { "perAntenna": true, "options": [3000, 2900, 2800, "…", 200, 100] },
"inventorySession": { "perAntenna": true, "options": [0, 1, 2, 3] },
"rssiFilter": { "perAntenna": true, "options": [-90, -89, -88, "…", -52, -51] },
"readerMode": {
"perAntenna": true,
"options": [
{ "name": "0", "value": 0 },
{ "name": "1", "value": 1 },
{ "name": "2", "value": 2 },
{ "name": "3", "value": 3 },
{ "name": "4", "value": 4 },
{ "name": "5", "value": 5 }
]
},
"toggleAntenna": { "perAntenna": true, "options": ["1", "2", "3", "4"] }
},
"capabilities": {
"totalAntennas": 4,
"totalGPIs": 0,
"totalGPOs": 4
}
}
}

Example from a Nordic ID reader; long options lists are shortened with "…".

PropertyTypeDescription
commandVersionStringCommand protocol version
supportSummary.supports.<setting>.perAntennaBooleantrue if the setting can differ per antenna; false if one value applies to all antennas
supportSummary.supports.<setting>.optionsArrayAllowed values
supportSummary.capabilitiesObjectNumber of antennas, GPIs, and GPOs

Options and capabilities vary by reader model. Settings the reader does not support are left out of supports.

Set Device Settings​

Changes antenna settings, then reads them back from the reader and returns them.

Endpoint Details​

  • URL: https://rest.api.xemelgo.com/edge/devices/{deviceId}/operations/device-settings
  • Method: POST

Properties​

PropertyTypeDescriptionRequired
antennaSettingsObjectSettings keyed by antenna number, or all for every antennaYes
antennaSettings.<antenna>.powerValueNumberTransmit powerNo
antennaSettings.<antenna>.sessionNumberInventory sessionNo
antennaSettings.<antenna>.rssiFilterNumberRSSI filterNo
antennaSettings.<antenna>.readerModeNumberReader modeNo

Use only values listed in Get Device Settings Supports. A setting whose perAntenna is false applies to all antennas: send it under all.

Request Body​

{
"antennaSettings": {
"all": { "session": 1 },
"1": { "powerValue": 2500 },
"2": { "powerValue": 3000 }
}
}

StatusCode — 200 on success

Response Body​

The settings now on the reader, in the same shape as Get Device Settings.

Errors​

ReasonCause
Payload validation failed on field antennaSettings due to: field is requiredantennaSettings is missing