logo
API docs by Redocly

RAW MQTT Payloads (1.0.0)

Download OpenAPI specification:Download

URL: http://zebra.com/support

Get Reader Version Information

command
required
string
Value: "get_version"

The value for the key command must be get_version

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
required
object (get_version)

Reader version information

{
  • "command": "get_version",
  • "command_id": "string",
  • "response": "success",
  • "payload": {
    }
}

Get Reader Network Configuration

command
required
string
Value: "get_network"

The value for command must be get_network

command_id
required
string

A Unique Id echoed by the reader in the response to Get Network

response
required
string
Enum: "success" "failure"
required
object (get_network)

Reader network information

{
  • "command": "get_network",
  • "command_id": "a12cb345654",
  • "response": "success",
  • "payload": {
    }
}

Get Reader Configuration

command
required
string
Value: "get_config"

The value for the key command must be get_config

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
required
object (Reader Configuration)
{
  • "command": "get_config",
  • "command_id": "1a234",
  • "response": "success",
  • "payload": {
    }
}

Set Network Configuration

command
required
string
Value: "set_network"

The value for the key command must be set_network

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_network)

Updates the reader network configuration settings

{
  • "command": "set_network",
  • "command_id": "abcd345",
  • "response": "success",
  • "payload": { }
}

Get Reader Status

command
required
string
Value: "get_status"

The value for the key command must be get_status

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
required
object (get_status)

Retrieves reader operational statistics for read points

{
  • "command": "get_status",
  • "command_id": "abcd1234",
  • "response": "success",
  • "payload": {
    }
}

Reboot the Reader

command
required
string
Value: "reboot"

The value for the key command must be reboot

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (reboot)

Restart Reader

{
  • "command": "reboot",
  • "command_id": "abcd1431243",
  • "response": "success",
  • "payload": { }
}

Control GPO

command
required
string
Value: "set_gpo"

The value for the key command must be set_gpo

Note :  Maximum number of ports available per device type

  1. FX7500 = 3 GPO pins
  2. FX9600 = 4 GPO pins
  3. ATR7000 = 3 GPO pins
command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
payload
required
object (set_gpo)

Updates GPO port state

{
  • "command": "set_gpo",
  • "command_id": "abcd1324",
  • "response": "success",
  • "payload": { }
}

Check LED Status

command
required
string
Value: "get_appled"

The value for the key command must be get_appled

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
required
object (get_appled)

Represents current userapp led status

{
  • "command": "get_appled",
  • "command_id": "string",
  • "response": "success",
  • "payload": {
    }
}

Control LED

command
required
string
Value: "set_appled"

The value for the key command must be set_appled

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
payload
required
object (set_appled)

Sets the reader APP LED to the specified color

{
  • "command": "set_appled",
  • "command_id": "abcd1243",
  • "response": "success",
  • "payload": { }
}

Get Reader Region Configuration

command
required
string
Value: "get_region"

The value for the key command must be get_region

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
required
object (get_region)

Represents the region and regulatory configuration.

{
  • "command": "get_region",
  • "command_id": "a1b2c3345",
  • "response": "success",
  • "payload": {
    }
}

Start Tag Reads

command
required
string
Value: "start"

The value for the key command must be start

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (start)

Starts the reader reading tags

{
  • "command": "start",
  • "command_id": "abcd1432",
  • "response": "success",
  • "payload": { }
}

Stop Tag Reads

command
required
string
Value: "stop"

The value for the key command must be stop

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (stop)

Stops the reader reading tags

{
  • "command": "stop",
  • "command_id": "abcd1324",
  • "response": "success",
  • "payload": { }
}

Get Operating Mode

command
required
string
Value: "get_mode"

The value for the key command must be get_mode

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (operatingMode)

Represents the reader operating mode.

{
  • "command": "get_mode",
  • "command_id": "a134454",
  • "response": "success",
  • "payload": {
    }
}

Set Operating Mode

command
string
Value: "set_mode"

The value for the key command must be set_mode

command_id
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
object (set_mode)

Changes the reader tag identification mode

{
  • "command": "set_mode",
  • "command_id": "abcd134",
  • "response": "success",
  • "payload": { }
}

Update Firmware

command
required
string
Value: "set_os"

The value for the key command must be set_os

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_os)

Update the OS software on the device

{
  • "command": "set_os",
  • "command_id": "abdc123",
  • "response": "success",
  • "payload": { }
}

Set Reader Configuration

command
required
string
Value: "set_config"

The value for the key command must be set_config

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_config)

Updates the reader configuration

{
  • "command": "set_config",
  • "command_id": "abdc2134",
  • "response": "success",
  • "payload": { }
}

Get Log Configuration

command
required
string
Value: "get_logs"

The value for the key command must be get_logs

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_logs)

Reader Logging Configuration

{
  • "command": "get_logs",
  • "command_id": "a2134",
  • "response": "success",
  • "payload": {
    }
}

Change Log Configuration

command
required
string
Value: "set_logs"

The value for the key command must be set_logs

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_logs)

Changes logging level

{
  • "command": "set_logs",
  • "command_id": "abcd2134234",
  • "response": "success",
  • "payload": { }
}

Pull Syslogs

command
required
string
Value: "get_logs_syslog"

The value for the key command must be get_version

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_logs_syslog)

Retrieves reader system log

{
  • "command": "get_logs_syslog",
  • "command_id": "a132234",
  • "response": "success",
  • "payload": {
    }
}

Pull Radio Packet Logs

command
required
string
Value: "get_logs_radioPacketLog"

The value for the key command must be get_logs_radioPacketLog

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_logs_radioPacketLog)

Retrieves reader radio packet log

{
  • "command": "get_logs_radioPacketLog",
  • "command_id": "a1324",
  • "response": "success",
  • "payload": {
    }
}

Purge Syslogs

command
required
string
Value: "del_logs_syslog"

The value for the key command must be del_logs_syslog

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (del_logs_syslog)

purge reader system logs

{
  • "command": "del_logs_syslog",
  • "command_id": "abcd1234",
  • "response": "success",
  • "payload": { }
}

Purge Radio Packet Logs

command
required
string
Value: "del_logs_radioPacketLog"

The value for the key command must be del_logs_radioPacketLog

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (del_logs_radioPacketLog)

purge radio packet logs

{
  • "command": "del_logs_radioPacketLog",
  • "command_id": "abcd2342",
  • "response": "success",
  • "payload": { }
}

Pull RG Error Logs

command
required
string
Value: "get_logs_rgErrorLog"

The value for the key command must be get_logs_rgErrorLog

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_logs_rgErrorLog)

Retrieves reader gateway Error logs

{
  • "command": "get_logs_rgErrorLog",
  • "command_id": "ab32445",
  • "response": "success",
  • "payload": {
    }
}

Pull RG Warning Logs

command
required
string
Value: "get_logs_rgWarningLog"

The value for the key command must be get_logs_rgWarningLog

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_logs_rgWarningLog)

Retrieves reader gateway Warning logs

{
  • "command": "get_logs_rgWarningLog",
  • "command_id": "abf868234",
  • "response": "success",
  • "payload": {
    }
}

Pull RC Logs

command
required
string
Value: "get_logs_rcLog"

The value for the key command must be get_logs_rcLog

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_logs_rcErrorLog)

Retrieves Radio Control Error logs

{
  • "command": "get_logs_rcLog",
  • "command_id": "abd12354",
  • "response": "success",
  • "payload": {
    }
}

Send Commands to User App

command
required
string
Value: "set_reqToUserapp"

The value for the key command must be set_reqToUserapp

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (set_reqToUserapp)

Response from userapp

{
  • "command": "set_reqToUserapp",
  • "command_id": "abcd13212",
  • "response": "success",
  • "payload": {
    }
}

Install User App

command
required
string
Value: "set_installUserapp"

The value for the key command must be set_installUserapp

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_installUserapp)

Install userapp debian package

{
  • "command": "set_installUserapp",
  • "command_id": "abcd123",
  • "response": "success",
  • "payload": { }
}

Uninstall User App

command
required
string
Value: "set_uninstallUserapp"

The value for the key command must be set_uninstallUserapp

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_uninstallUserapp)

uninstall userapp

{
  • "command": "set_uninstallUserapp",
  • "command_id": "abcd134",
  • "response": "success",
  • "payload": { }
}

Start User App

command
required
string
Value: "set_startUserapp"

The value for the key command must be set_startUserapp

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_startUserapp)

start userapp

{
  • "command": "set_startUserapp",
  • "command_id": "abcd1324",
  • "response": "success",
  • "payload": { }
}

Stop User App

command
required
string
Value: "set_stopUserapp"

The value for the key command must be set_stopUserapp

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_stopUserapp)

stop userapp

{
  • "command": "set_stopUserapp",
  • "command_id": "abcd1324",
  • "response": "success",
  • "payload": { }
}

Auto Start User App

command
required
string
Value: "set_autostartUserapp"

The value for the key command must be set_autostartUserapp

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
payload
required
object (set_autostartUserapp)

configure auto start settings for userapp

{
  • "command": "set_autostartUserapp",
  • "command_id": "abcd1234",
  • "response": "success",
  • "payload": { }
}

List Installed Apps

command
required
string
Value: "get_userapps"

The value for the key command must be get_userapps

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
Array of objects (get_userapps) non-empty unique

Retrive installed userapp status and details

{
  • "command": "get_userapps",
  • "command_id": "abcd243324",
  • "response": "success",
  • "payload": [
    ]
}

List Installed Certificate

command
required
string
Value: "get_certificates"

The value for the key command must be get_certificates

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
Array of objects (get_certificates) non-empty unique

Retrive installed certificates details

{
  • "command": "get_certificates",
  • "command_id": "abcd12354",
  • "response": "success",
  • "payload": [
    ]
}

Delete Certificate

command
required
string
Value: "del_certificate"

The value for the key command must be del_certificate

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
required
string
Enum: "success" "failure"
payload
required
object (del_certificate)

Delete certificate from reader

{
  • "command": "del_certificate",
  • "command_id": "abcd1234",
  • "response": "success",
  • "payload": { }
}

Install Certificate

command
required
string
Value: "set_updateCertificate"

The value for the key command must be set_updateCertificate

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (update-certificate-response)

Update the certficate on the reader

{
  • "command": "set_updateCertificate",
  • "command_id": "abcd1324",
  • "response": "success",
  • "payload": { }
}

Refresh Certificate

command
required
string
Value: "set_refreshCertificate"

The value for the key command must be set_refreshCertificate

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_refreshCertificate)

Refresh installed certificate

{
  • "command": "set_refreshCertificate",
  • "command_id": "abcd1324",
  • "response": "success",
  • "payload": { }
}

Revert Back Firmware Update

command
required
string
Value: "set_revertbackOS"

The value for the key command must be set_revertbackOS

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_revertbackOS)

Revertback OS firmware

{
  • "command": "set_revertbackOS",
  • "command_id": "abcd1434",
  • "response": "success",
  • "payload": { }
}

Get GPO Status

command
required
string
Value: "get_gpoStatus"

The value for the key command must be get_gpoStatus

Note :  Maximum number of ports available per device type

  1. FX7500 = 3 GPO pins
  2. FX9600 = 4 GPO pins
  3. ATR7000 = 3 GPO pins
command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_gpoStatus)

Retrive current GPO pin statuses

{
  • "command": "get_gpoStatus",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": {
    }
}

Get GPI Status

command
required
string
Value: "get_gpiStatus"

The value for the key command must be get_gpiStatus

Note: Maximum number of ports available per device type

  1. FX7500 = 2 GPI pins
  2. FX9600 = 4 GPI pins
  3. ATR7000 = 2 GPI pins
command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_gpiStatus)

Retrive GPI pin statuses

{
  • "command": "get_gpiStatus",
  • "command_id": "abcd21344",
  • "response": "success",
  • "payload": {
    }
}

Get Supported Region standard List

command
string
Value: "get_supportedStandardList"

The value for the key command must be get_supportedStandardList

command_id
string
Value: "fdag"

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
object (get_SupportedStandardList_response)

Retrieves the supported region standard list supported by the reader based on the readertype

{
  • "command": "get_supportedStandardList",
  • "command_id": "gfdd",
  • "payload": {
    },
  • "response": "success"
}

Get Supported Region List

command
required
string
Value: "get_supportedRegionList"

The value for the key command must be get_supportedRegionList

command_id
required
string
Value: "1a234"

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success " "failure"
object (get_SupportedRegionList)

Retrieves the region list supported by the reader based on the readertype

{
  • "command": "get_supportedRegionList",
  • "command_id": "1a234",
  • "response": "success",
  • "payload": {
    }
}

Set Reader Time Zone

command
required
string
Value: "set_timeZone"

The value for the key command must be set_timeZone

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_timeZone_response)

Sets Reader Time Zone

{
  • "command": "set_timeZone",
  • "command_id": "abcd1324",
  • "response": "success",
  • "payload": { }
}

Get Reader Time Zone

command
required
string
Value: "get_timeZone"

The value for the key command must be get_timeZone

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_timeZone_response)

Gets Current Reader Time Zone

{
  • "command": "get_timeZone",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": {
    }
}

Get Reader NTP Server

command
required
string
Value: "get_ntpServer"

The value for the key command must be get_ntpServer

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_ntpServer_response)

Gets the Reader NTP Server

{
  • "command": "get_ntpServer",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": {
    }
}

Set Reader NTP Server

command
required
string
Value: "set_ntpServer"

The value for the key command must be set_ntpServer

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_ntpServer_response)

Sets the Reader NTP Server

{
  • "command": "set_ntpServer",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": { }
}

Set Cable Loss Compensation

command
required
string
Value: "set_cableLossCompensation"

The value for the key command must be set_cableLossCompensation

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_cableLossCompensation_response)

Sets the Reader Cable Loss Compensation. Includes Cable Length and Cable Loss per Hundred Feet. (Not applicable to ATR7000 readers)

{
  • "command": "set_cableLossCompensation",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": { }
}

Get Cable Loss Compensation

command
required
string
Value: "get_cableLossCompensation"

The value for the key command must be get_cableLossCompensation

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_cableLossCompensation_response)

Gets the Reader Cable Loss Compensation. Includes Cable Length and Cable Loss per Hundred Feet. (Not applicable to ATR7000 readers)

{
  • "command": "get_cableLossCompensation",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": {
    }
}

Get Reader Capabilites

command
required
string
Value: "get_readerCapabilities"

The value for the key command must be get_readerCapabilites

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_readerCapabilites_response)

Defines the capabilities present on the reader

{
  • "command": "get_readerCapabilites",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": {
    }
}

Set name and description of the reader

command
required
string
Value: "set_nameAndDescription"

The value for the key command must be set_nameAndDescription

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
payload
required
object (set_nameAndDescription_response)

Set name and description of the reader

{
  • "command": "set_nameAndDescription",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": { }
}

Get name and description of the reader

command
required
string
Value: "get_nameAndDescription"

The value for the key command must be get_nameAndDescription

command_id
required
string

A unique ID that will be echoed back in the command response by the reader.

response
string
Enum: "success" "failure"
required
object (get_nameAndDescription_response)

Get name and description of the reader

{
  • "command": "get_nameAndDescription",
  • "command_id": "abdc453254",
  • "response": "success",
  • "payload": {
    }
}