logo
API docs by Redocly

IoT Connector Local REST APIs (1.0.0)

Download OpenAPI specification:Download

URL: http://zebra.com/support

Management

Retrieves reader component version information

Retrieves reader component version information including Boot Loader, OS, Reader Application, and Radio Firmware versions

Responses

Response samples

Content type
application/json
{
  • "readerApplication": "2.7.19.0",
  • "radioApi": "2.2.8.2",
  • "radioFirmware": "2.1.14.0",
  • "radioControlApplication": "1.0.0",
  • "readerOS": "2.2.15.0",
  • "readerHardware": "0.0.5.0",
  • "readerBootLoader": "2.1.2.0",
  • "readerFileSystem": "2.1.2.0",
  • "cloudAgentApplication": "1.0.0",
  • "availableOsUpgrades": "[ 3.1.12, 3.0.35 ]",
  • "fpga": "1.8.0.0",
  • "model": "FX7500",
  • "serialNumber": "84248dee5721",
  • "revertBackFirmware": {
    }
}

Retrieves reader network configuration

Retrieves reader network information including IP address, subnet mask, gateway and DNS

Responses

Response samples

Content type
application/json
{
  • "hostName": "FX9600F0F4B5",
  • "ipAddress": "192.168.1.10",
  • "gatewayAddress": "192.168.1.1",
  • "subnetMask": "255.255.255.0",
  • "dnsAddress": "8.8.8.8",
  • "dhcp": "true",
  • "macAddress": "84:24:8D:F0:F4:B5"
}

Updates reader network configuration

Updates the reader network configuration settings

Request Body schema: application/json
dhcp
required
boolean

A value indicating DHCP configuration

macAdress
required
string

MAC address of the reader(read only)

dnsAddress
required
string

IP address of the DNS server

subnetMask
required
string

Subnet mask for the network adapter

gatewayAddress
required
string

IP address of the gateway

ipAddress
required
string

IP address of the reader (read only if dhcp = true)

hostName
required
string

Hostname of the reader

Responses

Request samples

Content type
application/json
{
  • "dhcp": "true",
  • "macAdress": "84:24:8D:F0:F4:B5",
  • "dnsAddress": "8.8.8.8",
  • "subnetMask": "255.255.255.0",
  • "gatewayAddress": "192.168.1.1",
  • "ipAddress": "192.168.1.10",
  • "hostName": "FX9600F0F4B5"
}

Retrieves reader operational statistics

Retrieves reader operational statistics for read points

Responses

Response samples

Content type
application/json
Example
{
  • "uptime": "26 days 01:11:17",
  • "systemTime": "2020-01-08T15:36:53+00:00",
  • "ram": {
    },
  • "flash": {
    },
  • "cpu": {
    },
  • "radioConnection": "connected",
  • "antennas": {
    },
  • "temperature": 31,
  • "radioActivitiy": "active",
  • "powerSource": "DC",
  • "powerNegotiation": "DISABLED",
  • "ntp": {
    },
  • "interfaceConnectionStatus": {
    }
}

Restarts reader

Restarts the reader with the device ID provided

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Updates GPO port state

Updates the GPO state on the specified port of the reader

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
Request Body schema: application/json
port
required
integer [ 1 .. 4 ]

The GPO port ID

state
required
boolean
Default: false

The GPO state signal to send

Responses

Request samples

Content type
application/json
{
  • "port": 2,
  • "state": false
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Get GPO Status

Retrieves the GPO status

Note :  Maximum number of ports available per device type

  1. FX7500 = 3 GPO pins
  2. FX9600 = 4 GPO pins
  3. ATR7000 = 3 GPO pins

Responses

Response samples

Content type
application/json
{
  • "1": "HIGH",
  • "2": "LOW",
  • "3": "HIGH",
  • "4": "LOW"
}

Updates application LED state

Updates the application LED state on the reader to the state specified

query Parameters
color
required
string
Enum: "red" "amber" "green"

The color of the LED (red, amber, green)

seconds
required
integer

The duration in seconds for the LED state to be in effect

flash
boolean

A value indicating whether to flash the LED

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Retrieves application LED state

Retrieves a value indicating the current state of the application LED

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Retrieves reader region information

Retrieves reader region (country) information

Responses

Response samples

Content type
application/json
{
  • "region": "US",
  • "regulatoryStandard": "FCC",
  • "lbtEnabled": "false",
  • "channelData": [
    ],
  • "minTxPowerSupported": 100,
  • "maxTxPowerSupported": 300
}

Updates software on device

Update the OS software on the device

Request Body schema: application/json
url
required
string

URL where the OS image is served

authenticationType
required
string
Enum: "NONE" "BASIC"

Type of authentication required to get OS image

object

Responses

Request samples

Content type
application/json
{}

Updates reader configuration

Updates the reader configuration

Request Body schema: application/json

The new reader configuration XML file

xml
string

Current reader XML configuration

object (GPIO-LED configuration)

GPIO-LED module configuration

Configure GPO and LED behaviour based on Events generated

Supported Events:

  1. GPI_1_L: event raised when GPI 1 changed from HIGH to LOW
  2. GPI_1_H: event raised when GPI 1 changed from LOW to HIGH
  3. GPI_2_L: event raised when GPI 2 changed from HIGH to LOW
  4. GPI_2_H: event raised when GPI 2 changed from LOW to HIGH
  5. CLOUD_DISCONNECT: event raised when reader is disconnected from cloud
  6. CLOUD_CONNECT: event raised when reader is connected to cloud
  7. TAG_READ: event raised when a tag is read
  8. RADIO_START: event raised when inventory operation started using START API
  9. RADIO_STOP: event raised when inventory operation stopped using STOP API
object

Gateway specific configuration

Responses

Request samples

Content type
application/json
{
  • "xml": "string",
  • "GPIO-LED": {
    },
  • "READER-GATEWAY": {
    }
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Retrieves reader configuration

Retrieves reader configuration

Responses

Response samples

Content type
application/json
{
  • "xml": "string",
  • "GPIO-LED": {
    },
  • "READER-GATEWAY": {
    }
}

Log Configuration

Retrieves reader log configuration

Responses

Response samples

Content type
application/json
{
  • "radioPacketLog": true,
  • "components": [
    ]
}

Configures the logs

Changes logging level

Request Body schema: application/json

The log level to configure

radioPacketLog
boolean

Enables or Disables the Radio Control radio packet log

Array of objects

System sub-components

Responses

Request samples

Content type
application/json
{
  • "radioPacketLog": true,
  • "components": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Retrieve Log

Retrieves a reader log

path Parameters
logType
required
string
Enum: "syslog" "radioPacketLog" "RgErrorLog" "RgWarningLog" "RcErrorLog" "RcWarningLog" "RcInfoLog"

Type of Log to Retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Purge Log

Purges a particular log

path Parameters
logType
required
string
Enum: "syslog" "radioPacketLog" "RgErrorLog" "RgWarningLog" "RcErrorLog" "RcWarningLog" "RcInfoLog"

Type of Log to Retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Retrieves the Supported Region List based on the Readertype

Gets the List of Regions supported by the reader based on the Readertype

Responses

Response samples

Content type
application/json
{
  • "SupportedRegions": [
    ]
}

Retrieves the standard channels of the Supported regions

based on the region name provided it retrieves the standard channel list

Request Body schema: application/json

based on the region name provided it will provide the channeldata

region
string
Value: "Argentina"

provide the region name

Responses

Request samples

Content type
application/json
{
  • "region": "Argentina"
}

Response samples

Content type
application/json
{
  • "SupportedStandards": [
    ]
}

Retrieves Reader Time Zone

get the active time zone

Responses

Response samples

Content type
application/json
{
  • "timeZone": "(GMT-12:00) International Date Line West"
}

Sets Reader Time Zone

Request Body schema: application/json
timeZone
required
string
Enum: "International Date Line West" "Midway Island" "Samoa" "Hawaii" "Alaska" "Pacific Time (US & Canada)" "Tijuana" "Baja California" "Mountain Time (US & Canada)" "Arizona" "Chihuahua" "La Paz" "Mazatlan" "Central Time (US & Canada)" "Saskatchewan" "Central America" "Guadalajara" "Mexico City" "Monterrey" "Eastern Time (US & Canada)" "Indiana (East)" "Bogota" "Lima" "Quito" "Caracas" "Atlantic Time (Canada)" "Georgetown" "La Paz" "San Juan" "Santiago" "Manaus" "Asuncion" "Greenland" "Newfoundland" "Brasilia" "Cayenne" "Buenos Aires" "Montevideo" "Mid-Atlantic" "Azores" "Cape Verde Is." "Dublin" "Edinburgh" "Lisbon" "London" "Monrovia" "Reykjavik" "Casablanca" "Coordinated Universal Time" "Belgrade" "Bratislava" "Budapest" "Ljubljana" "Prague" "Sarajevo" "Skopje" "Warsaw" "Zagreb" "Brussels" "Copenhagen" "Madrid" "Paris" "Amsterdam" "Berlin" "Bern" "Rome" "Stockholm" "Vienna" "West Central Africa" "Cairo" "Helsinki" "Kyiv" "Riga" "Sofia" "Tallinn" "Vilnius" "Athens" "Bucharest" "Harare" "Pretoria" "Jerusalem" "Windhoek" "Amman" "Beirut" "Minsk" "Istanbul" "Moscow" "St. Petersburg" "Volgograd" "Kuwait" "Riyadh" "Nairobi" "Baghdad" "Tbilisi" "Tehran" "Abu Dhabi" "Muscat" "Yerevan" "Baku" "Port Louis" "Kabul" "Ekaterinburg" "Tashkent" "Islamabad" "Karachi" "Chennai" "Kolkata" "Mumbai" "New Delhi" "Sri Jayawardenepura" "Kathmandu" "Almaty" "Astana" "Dhaka" "Yangon (Rangoon)" "Novosibirsk" "Bangkok" "Hanoi" "Jakarta" "Krasnoyarsk" "Beijing" "Chongqing" "Hong Kong" "Urumqi" "Taipei" "Perth" "Irkutsk" "Kuala Lumpur" … 121 more

Allowed time zones on the reader

Responses

Request samples

Content type
application/json
{
  • "timeZone": "International Date Line West"
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Retrieve NTP Server

Retrieves the configured NTP Server on the Reader

Responses

Response samples

Content type
application/json
{
  • "server": "time.google.com"
}

Sets NTP Server

Configures an NTP Server on the Reader

Request Body schema: application/json
server
required
string

Server Host Name or IP Address

Responses

Request samples

Content type
application/json
{
  • "server": "time.google.com"
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

GET cableLossCompensation

Gets the Reader Cable Loss Compensation. Includes Cable Length and Cable Loss per Hundred Feet

Responses

Response samples

Content type
application/json
{
  • "1": {
    },
  • "2": {
    },
  • "3": {
    },
  • "4": {
    }
}

PUT cableLossCompensation

Sets the Reader Cable Loss Compensation. Includes Cable Length and Cable Loss per Hundred Feet

Request Body schema: application/json
One of
cableLength
required
integer >= 0

Cable Length Field. Accepts float values

cableLossPerHundredFt
required
integer >= 0

Cable Loss per Hundred Feet. Accepts float values

Responses

Request samples

Content type
application/json
Example
{
  • "1": {
    },
  • "2": {
    },
  • "3": {
    },
  • "4": {
    },
  • "cableLength": 0,
  • "cableLossPerHundredFt": 0
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

GET Reader Capabilities

Gets the list of supported capabilites on the current reader.

Responses

Response samples

Content type
application/json
{
  • "capabilities": {
    }
}

GET Name and Description

Get name and description of the reader

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

PUT Name and Description

Put name and description of the reader

Request Body schema: application/json
name
required
string

name of the reader

description
required
string

description of the reader

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Send Request to Userapp

sending request to uers application

path Parameters
appname
required
string
Example: sample

name of the application

Request Body schema: application/json
userapp
required
string

name of userapp to send command

command
required
string

custom command or data to send

Responses

Request samples

Content type
application/json
{
  • "userapp": "sample",
  • "command": "string"
}

Response samples

Content type
application/json
{
  • "response": "string"
}

Install User Application

Insatll userapp

Request Body schema: application/json
url
required
string

http or https file server url

filename
required
string

userapp filename in file server

authenticationType
required
string
Enum: "NONE" "BASIC"

file server authentication type

object

file server basic authentication options

verifyPeer
boolean
Default: true

verify file server certificate

verifyHost
boolean
Default: true

verify file server hostname

CACertificateFileLocation
string

CA file location to be used for server authentication

CACertificateFileContent
string

CA certificate file content to be used for server authentication

Responses

Request samples

Content type
application/json
{
  • "url": "https://example.com/apps/",
  • "filename": "sample_1.0.0.deb",
  • "authenticationType": "NONE",
  • "options": {
    },
  • "verifyPeer": true,
  • "verifyHost": true,
  • "CACertificateFileLocation": "/apps/ca.pem",
  • "CACertificateFileContent": "string"
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

Uninstall User Application

Unistall Userapp

path Parameters
appname
required
string

name of the userapp

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

Start User Application

Start userapp

path Parameters
appname
required
string
Example: sample

name of the application

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

Stop user Application

stop userapp

path Parameters
appname
required
string
Example: sampl

name of the application

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

Autostart User Application

autostart userapp

path Parameters
appname
required
string
Example: sample

name of the application

Request Body schema: application/json
autostart
boolean
Default: true

toggle userapp autostart settings

Responses

Request samples

Content type
application/json
{
  • "autostart": true
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

List User Application

Lists all userapp installed

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrive installed certificate details

Retrive installed certificate details

Responses

Response samples

Content type
application/json
{
  • "name": "Reader Main Certificates",
  • "type": "server",
  • "installTime": "Mon Jun 21 12:38:03 2021",
  • "issuerName": "FX9600EE5729",
  • "publickey": "string",
  • "serial": "410835777",
  • "subjectName": "string",
  • "validityStart": "21/06/2021",
  • "validityEnd": "16/06/2041"
}

Delete Certificate

Delete Certificate

path Parameters
certname
required
string

name of the certificate

Request Body schema: application/json
type
required
string
Enum: "client" "app"

certificate type

Request samples

Content type
application/json
{
  • "type": "app"
}

Install Certificate

Install Certificate

path Parameters
certificates
required
string

name of the certificate

Request Body schema: application/json
name
required
string non-empty

name of certificate

type
required
string non-empty
Enum: "server" "client" "app"

certificate type

url
required
string non-empty

ftps server url hosting certificate pfx file

authenticationType
string
Enum: "NONE" "BASIC"

ftps server authentication type

pfxFileName
string

PFX certiifcates file Name

pfxContent
string

pfx certificate content

timeoutInSec
number
filename
string

certificate file name

verifyHost
boolean

verify host boolean

verifyPeer
boolean

verify peer boolean

CACertificateFileLocation
string

CA Certification File Location

CACertificateFileContent
string

CA Certificate File Content

installedCertificateType
string

Installed Certificate Type

installedCertificateName
string

Installed Certificate Name

publicKeyFileLocation
string

public key file path

publicKeyFileContent
string

public key file content

privateKeyFileLocation
string

private key file path

privateKeyFileContent
string

private key file content

headers
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "test",
  • "type": "client",
  • "url": "ftps://10.17.231.92/CA-Certs_3.18.2/myCA/reader.pfx",
  • "authenticationType": "NONE",
  • "pfxFileName": "dfbhnhf",
  • "pfxContent": "mhmfgm",
  • "timeoutInSec": 0,
  • "filename": "czdsvfs",
  • "verifyHost": true,
  • "verifyPeer": true,
  • "CACertificateFileLocation": "gfwwhg",
  • "CACertificateFileContent": "wehwe",
  • "installedCertificateType": "string",
  • "installedCertificateName": "string",
  • "publicKeyFileLocation": "string",
  • "publicKeyFileContent": "string",
  • "privateKeyFileLocation": "string",
  • "privateKeyFileContent": "string",
  • "headers": { },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

Refresh Certificate

Refresh Certificate

path Parameters
certificate
required
string
Request Body schema: application/json
type
required
string
Enum: "server" "app" "client"

certificate type

Responses

Request samples

Content type
application/json
{
  • "type": "app"
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

set data to RG

set data to RG

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "Not found error"
}

Revert back reader firmware to secondary partition

Revert back reader firmware to secondary partition

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Get GPI Status

Retrieves the GPI status

Note :  Maximum number of ports available per device type

  1. FX7500 = 2 GPI pins
  2. FX9600 = 4 GPI pins
  3. ATR7000 = 2 GPI pins

Responses

Response samples

Content type
application/json
{
  • "1": "HIGH",
  • "2": "LOW",
  • "3": "HIGH"
}

Control

Starts reading tags

Starts the reader reading tags

Request Body schema: application/json

Start tag reads

doNotPersistState
boolean
Default: true

persist current tag read state of reader

Responses

Request samples

Content type
application/json
{
  • "doNotPersistState": true
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Stops reading tags

Stops the reader reading tags

Responses

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Retrieves operating mode

Retrieves current operating mode

Request Body schema: application/json
verbose
boolean
  1. if verbose is true then it will return entire configuration
  2. if verbose is false it returns only configured mode configuration

Responses

Request samples

Content type
application/json
{
  • "verbose": true
}

Response samples

Content type
application/json
{
  • "type": "INVENTORY",
  • "antennas": [
    ],
  • "transmitPower": 30.1,
  • "antennaStopCondition": [
    ],
  • "tagMetaData": [
    ],
  • "rssiFilter": {
    }
}

Updates operating mode

Changes the reader's operating mode

Request Body schema: application/json
type
required
string
Default: "SIMPLE"
Enum: "SIMPLE" "INVENTORY" "PORTAL" "CONVEYOR" "CUSTOM" "DIRECTIONALITY"

The type of mode of operation

inventorySettings (object) or portalSettings (object) or directionalitySettings (object)
environment
string
Default: "HIGH_INTERFERENCE"
Enum: "LOW_INTERFERENCE" "HIGH_INTERFERENCE" "VERY_HIGH_INTERFERENCE" "AUTO_DETECT" "DEMO"

The type of environment in which the reader operates. Along with the regulatory configuration of the reader, the environment parameter will set the default link profile parameters (i.e., Miller mode, BLF, Tari, etc.) and the receiver dynamic range (interference immunity).

LOW_INTERFERENCE: The reader is operating in an environment when the likelihood of interference is very low or only occurs for very brief periods of time (defined as a single interrogator environment in the Gen2 and ISO standards).

HIGH_INTERFERENCE: The reader is operating in the presence of other readers (defined as a multi-interrogator or dense interrogator environment in the Gen2 and ISO standards).

VERY_HIGH_INTERFERENCE: The reader is operating in an environment where the number of readers is greater than the number of available channels, or when interfering readers are in very close proximity to each other.

AUTO_DETECT: This will cause the reader to try and assess the environment and adjust accordingly.

DEMO: Should be used when demonstrating the maximum performance (fastest read rate) of a reader. This assumes no other readers in the environement.

If absent, the environment is set to HIGH_INTERFERENCE

antennas
Array of integers

An array of integers representing the antenna ports to use to read tags. For ATR, the integers represent beam numbers.

If absent, all antennas ports are used; for the ATR, a set of 38 beams are used.

object (tagIdFilter)

Represents filter on the tag id.

If absent, no filter is used.

number or Array of numbers

Desired Transmit Power (in dbm). If absent, the value is set to 27 dbm; for the ATR, the value is set to 36 dbm EIRP.

antennaStopCondition (object) or Array of antennaStopCondition array (objects)

Stop Condition for antennas. If absent, the antenna stop condition is set to run a single inventory round for no longer than 1/N seconds. Where N is the number of enabled antennas.

query (object) or Array of query array (objects)

Gen2 query parameters. See Gen2 spec for details. If absent, "sel" is set to ALL, session is set to 1, target is set to A, and tag population set to 1.

Array of select (objects) or Array of select array (objects)

Gen2 select parameters. See Gen2 spec for details. If absent, no select will be issued. Cannot be set when filter with prefix type is also set. If there is an array of select objects, all of the selects in the array will be applied to all antennas. If there is an array of array of select objects, each array of select objects will apply to each antenna. The array of arrays must have the same number of entries as the antennas array.

delayAfterSelects
integer [ 0 .. 65 ]

Duration in milliseconds to wait after issuing the final select before issuing a query. If absent, the minimum time will be used.

(Array of access_cmds (read (object) or write (object) or access (object) or lock (object) or kill (object))) or (Array of access_cmds array (read (object) or write (object) or access (object) or lock (object) or kill (object)))

Gen2 access parameters. See Gen2 spec for details.

If absent, no access will be issued.

If there is an array of access objects, all of the accesss in the array will be applied to all antennas.

If there is an array of array of access objects, each array of access objects will apply to each antenna. The array of arrays must have the same number of entries as the antennas array.

object (delayBetweenAntennaCycles)

This introduces a delay between antenna cycles if no tags are read or if no unique tags are read. This allows the reader to share the spectrum if there are no tags to be read.

If absent, on the ATR7000 and the FX9600, delayBetweenAntennas cycles is set to wait for 75 mS if no unique tags are read during a antenna cycle.
on the FX7500, delayBetweenAntennas cycles is set to wait for 75 mS if no tags are read during a antenna cycle.

Array of strings or objects (tagMetaData)

Controls the metadata that is sent when a tag is reported

“ANTENNA” will report the antenna port upon which the tag was inventoried.

“RSSI” will report the rssi (in dbm) of the inventoried tag. If the tag is only reported occasionally (see reportFilter), this tag will be the peak rssi since the last reported read.

“PHASE” will report the phase (in degrees) of the inventoried tag. This value will only be reported if each individual tag read is reported (in other words, if reportFilter duration is set to 0). Otherwise, it will not be reported.

“CHANNEL” will report the channel (in MHz) the reader was using when the tag was inventoried. This value will only be reported if each individual tag read is reported (in other words, if reportFilter duration is set to 0). Otherwise, it will not be reported.

“SEEN_COUNT” will report the number of times the tag has been inventoried since the previous report. This value will always be 1 if each individual tag read is reported (in other words, if reportFilter duration is set to 0).

“PC” will report the PC bits of the inventoried tag as a hex string.

“XPC” will report the XPC bits of the inventoried tag, if present, as a hex string.

“CRC” will report the CRC bits of the inventoried tag as a hex string.

“EPC” will report the entire contents of the EPC bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “EPC[1]”. If the first word and the 3-5 word are desired, the value can be set to “EPC[1,3-5]”.

“TID” will report the entire contents of the TID bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “TID[1]”. If the first word and the 3-5 word are desired, the value can be set to “TID[1,3-5]”.

“USER” will report the entire contents of the USER bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “TID[1]”. If the first word and the 3-5 word are desired, the value can be set to “TID[1,3-5]”.

“MAC” will report the MAC Address of the reader reporting the tag.

“HOSTNAME” will report the hostname of the reader reporting the tag.

“TAGURI” will report the GS1 TDS decoded “EPC Tag URI”. See GS1 TDS documentation for details.

“EPCURI” will report the GS1 TDS decoded “Pure Identity EPC URI”. See GS1 TDS documentation for details.

The array may also contain an object or objects. The object must contain a single name value pair with the name being set to “userDefined” or “antennaNames”

If absent, “SIMPLE” mode does not report any additional meta data, “PORTAL” and “CONVEYOR” modes reports “ANTENNA”, and “INVENTORY” mode reports “ANTENNA”, “RSSI”, and “SEEN_COUNT”.

object (radioStartConditions)

Controls when, after a “start” is issued, the radio starts trying to inventory tags.

If absent, the radio will immediately begin inventorying tags upon a "start" command.

object (radioStopConditions)

Controls when an ongoing operation completes.

If absent, the radio will continue trying to inventory tags until a "stop" is issued.

object (reportFilter)

Controls when and how often a tag is reported

NOTE: This cannot be set while in "INVENTORY" mode. Setting the modeSpecificSetting for interval must be used in "INVENTORY" mode.

If absent, each mode uses a different default.

"SIMPLE": report tag read once.

"PORTAL" and "CONVEYOR": report each tag the first time it is read on each antenna.

object (rssiFilter)

Tag with RSSI below threshold will not be inventoried by the radio

If absent, rssi filter is not used.

Note: Currently ONLY supported by the FX9600.

Array of objects

Array of beams to use

Note : beams is only supported for ATR7000 reader

Responses

Request samples

Content type
application/json
{
  • "type": "INVENTORY",
  • "antennas": [
    ],
  • "transmitPower": 30.1,
  • "antennaStopCondition": [
    ],
  • "tagMetaData": [
    ],
  • "rssiFilter": {
    }
}

Response samples

Content type
application/json
{
  • "code": 123,
  • "message": "internal system error."
}

Configuration for the Operating Modes

type
required
string
Default: "SIMPLE"
Enum: "SIMPLE" "INVENTORY" "PORTAL" "CONVEYOR" "CUSTOM" "DIRECTIONALITY"

The type of mode of operation

inventorySettings (object) or portalSettings (object) or directionalitySettings (object)
environment
string
Default: "HIGH_INTERFERENCE"
Enum: "LOW_INTERFERENCE" "HIGH_INTERFERENCE" "VERY_HIGH_INTERFERENCE" "AUTO_DETECT" "DEMO"

The type of environment in which the reader operates. Along with the regulatory configuration of the reader, the environment parameter will set the default link profile parameters (i.e., Miller mode, BLF, Tari, etc.) and the receiver dynamic range (interference immunity).

LOW_INTERFERENCE: The reader is operating in an environment when the likelihood of interference is very low or only occurs for very brief periods of time (defined as a single interrogator environment in the Gen2 and ISO standards).

HIGH_INTERFERENCE: The reader is operating in the presence of other readers (defined as a multi-interrogator or dense interrogator environment in the Gen2 and ISO standards).

VERY_HIGH_INTERFERENCE: The reader is operating in an environment where the number of readers is greater than the number of available channels, or when interfering readers are in very close proximity to each other.

AUTO_DETECT: This will cause the reader to try and assess the environment and adjust accordingly.

DEMO: Should be used when demonstrating the maximum performance (fastest read rate) of a reader. This assumes no other readers in the environement.

If absent, the environment is set to HIGH_INTERFERENCE

antennas
Array of integers

An array of integers representing the antenna ports to use to read tags. For ATR, the integers represent beam numbers.

If absent, all antennas ports are used; for the ATR, a set of 38 beams are used.

object (tagIdFilter)

Represents filter on the tag id.

If absent, no filter is used.

number or Array of numbers

Desired Transmit Power (in dbm). If absent, the value is set to 27 dbm; for the ATR, the value is set to 36 dbm EIRP.

antennaStopCondition (object) or Array of antennaStopCondition array (objects)

Stop Condition for antennas. If absent, the antenna stop condition is set to run a single inventory round for no longer than 1/N seconds. Where N is the number of enabled antennas.

query (object) or Array of query array (objects)

Gen2 query parameters. See Gen2 spec for details. If absent, "sel" is set to ALL, session is set to 1, target is set to A, and tag population set to 1.

Array of select (objects) or Array of select array (objects)

Gen2 select parameters. See Gen2 spec for details. If absent, no select will be issued. Cannot be set when filter with prefix type is also set. If there is an array of select objects, all of the selects in the array will be applied to all antennas. If there is an array of array of select objects, each array of select objects will apply to each antenna. The array of arrays must have the same number of entries as the antennas array.

delayAfterSelects
integer [ 0 .. 65 ]

Duration in milliseconds to wait after issuing the final select before issuing a query. If absent, the minimum time will be used.

(Array of access_cmds (read (object) or write (object) or access (object) or lock (object) or kill (object))) or (Array of access_cmds array (read (object) or write (object) or access (object) or lock (object) or kill (object)))

Gen2 access parameters. See Gen2 spec for details.

If absent, no access will be issued.

If there is an array of access objects, all of the accesss in the array will be applied to all antennas.

If there is an array of array of access objects, each array of access objects will apply to each antenna. The array of arrays must have the same number of entries as the antennas array.

object (delayBetweenAntennaCycles)

This introduces a delay between antenna cycles if no tags are read or if no unique tags are read. This allows the reader to share the spectrum if there are no tags to be read.

If absent, on the ATR7000 and the FX9600, delayBetweenAntennas cycles is set to wait for 75 mS if no unique tags are read during a antenna cycle.
on the FX7500, delayBetweenAntennas cycles is set to wait for 75 mS if no tags are read during a antenna cycle.

Array of strings or objects (tagMetaData)

Controls the metadata that is sent when a tag is reported

“ANTENNA” will report the antenna port upon which the tag was inventoried.

“RSSI” will report the rssi (in dbm) of the inventoried tag. If the tag is only reported occasionally (see reportFilter), this tag will be the peak rssi since the last reported read.

“PHASE” will report the phase (in degrees) of the inventoried tag. This value will only be reported if each individual tag read is reported (in other words, if reportFilter duration is set to 0). Otherwise, it will not be reported.

“CHANNEL” will report the channel (in MHz) the reader was using when the tag was inventoried. This value will only be reported if each individual tag read is reported (in other words, if reportFilter duration is set to 0). Otherwise, it will not be reported.

“SEEN_COUNT” will report the number of times the tag has been inventoried since the previous report. This value will always be 1 if each individual tag read is reported (in other words, if reportFilter duration is set to 0).

“PC” will report the PC bits of the inventoried tag as a hex string.

“XPC” will report the XPC bits of the inventoried tag, if present, as a hex string.

“CRC” will report the CRC bits of the inventoried tag as a hex string.

“EPC” will report the entire contents of the EPC bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “EPC[1]”. If the first word and the 3-5 word are desired, the value can be set to “EPC[1,3-5]”.

“TID” will report the entire contents of the TID bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “TID[1]”. If the first word and the 3-5 word are desired, the value can be set to “TID[1,3-5]”.

“USER” will report the entire contents of the USER bank as a hex string. If only a portion of the memory bank is desired, this can be requested by appending a [] to the string and placing the words requested. For instance, if only the first word is desired, the value can be set as “TID[1]”. If the first word and the 3-5 word are desired, the value can be set to “TID[1,3-5]”.

“MAC” will report the MAC Address of the reader reporting the tag.

“HOSTNAME” will report the hostname of the reader reporting the tag.

“TAGURI” will report the GS1 TDS decoded “EPC Tag URI”. See GS1 TDS documentation for details.

“EPCURI” will report the GS1 TDS decoded “Pure Identity EPC URI”. See GS1 TDS documentation for details.

The array may also contain an object or objects. The object must contain a single name value pair with the name being set to “userDefined” or “antennaNames”

If absent, “SIMPLE” mode does not report any additional meta data, “PORTAL” and “CONVEYOR” modes reports “ANTENNA”, and “INVENTORY” mode reports “ANTENNA”, “RSSI”, and “SEEN_COUNT”.

object (radioStartConditions)

Controls when, after a “start” is issued, the radio starts trying to inventory tags.

If absent, the radio will immediately begin inventorying tags upon a "start" command.

object (radioStopConditions)

Controls when an ongoing operation completes.

If absent, the radio will continue trying to inventory tags until a "stop" is issued.

object (reportFilter)

Controls when and how often a tag is reported

NOTE: This cannot be set while in "INVENTORY" mode. Setting the modeSpecificSetting for interval must be used in "INVENTORY" mode.

If absent, each mode uses a different default.

"SIMPLE": report tag read once.

"PORTAL" and "CONVEYOR": report each tag the first time it is read on each antenna.

object (rssiFilter)

Tag with RSSI below threshold will not be inventoried by the radio

If absent, rssi filter is not used.

Note: Currently ONLY supported by the FX9600.

Array of objects

Array of beams to use

Note : beams is only supported for ATR7000 reader

{
  • "type": "INVENTORY",
  • "antennas": [
    ],
  • "transmitPower": 30.1,
  • "antennaStopCondition": [
    ],
  • "tagMetaData": [
    ],
  • "rssiFilter": {
    }
}

GPIO-LED configuration

object

GPO default configurations

object

LED default configurations

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

Array of GPO Action (object) or LED Action (object) (GPO-LED Action)

Array of GPO or LED actions. Actions will be performed sequentially.

{
  • "GPODefaults": {
    },
  • "LEDDefaults": {
    },
  • "GPI_1_H": [
    ],
  • "GPI_1_L": [
    ],
  • "GPI_2_H": [
    ],
  • "GPI_2_L": [
    ],
  • "CLOUD_DISCONNECT": [
    ],
  • "CLOUD_CONNECT": [
    ],
  • "TAG_READ": [
    ],
  • "RADIO_START": [
    ],
  • "RADIO_STOP": [
    ]
}

Management Events Configuration

object

Asynchronous Management Errors

object

Asynchronous Management Warnings

object

Asynchronous Heartbeat Events

gpiEvents
boolean
Default: true

GPI Events

userappEvents
boolean
Default: true

asyncronous events from user applications

gpoEvents
boolean
Default: true

GPO Events

{
  • "errors": {
    },
  • "warnings": {
    },
  • "heartbeat": {
    },
  • "gpiEvents": true,
  • "userappEvents": true,
  • "gpoEvents": true
}