Enumerations

ReferenceAudience: API consumerUse: look up the exact values an enumerated field accepts or reports

Values are case-sensitive and must be sent exactly as shown. Enumerations are closed: a schema validator rejects any other value. Where a note describes firmware support, the value is valid on the wire but current firmware reports it only in the places named.

Shared Enumerations

`accessMemoryBank`

Tag access memory bank. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`EPC`
`TID`
`USER`
`RESERVED`

`accessOperationType`

Tag access operation type. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`READ`
`WRITE`
`ACCESS`
`LOCK`
`KILL`

`apiVersion`

IoTC API version. JSON type string. Used by 21 pages. mqttConnEVT sends it as a number instead; see that page.

Value	Note
`V1.0`
`V1.1`
`V1.2`
`V1.21`
`V1.22`

`authenticationType`

Remote-source authentication type. JSON type string. Used by install_certificate, set_os.

Value	Note
`NONE`
`CERTIFICATE`

`batteryChargeState`

Battery charge state. JSON type string. Used by alerts, heartBeatEVT.

Value	Note
`LOW`
`CRITICAL`
`CHARGING`
`FULL`
`HIGH`

`batteryHealth`

Battery state of health. JSON type string. Used by alerts, get_status, heartBeatEVT.

Value	Note
`GOOD`
`CRITICAL`
`MODERATE`

`certificateAlgorithm`

Endpoint certificate signature algorithm. JSON type string. Used by config_endpoint, get_endpoint_config.

Value	Note
`RSA256`
`RSA512`

`certificateComponentKey`

Certificate component key. JSON type string. Used by get_wifi, install_certificate, set_wifi.

Value	Note
`ca_cert`
`client_key`
`client_cert`
`cert_key_password`

`certificateFormat`

Certificate encoding format. JSON type string. Used by config_endpoint, get_endpoint_config.

Value	Note
`PEM`	The only format currently supported.
`PFX`	Listed in the enum, but the contract states that only `PEM` is currently supported.

`certificateType`

Certificate category. JSON type string. Used by delete_certificate, get_installed_certificates, install_certificate.

Value	Note
`client`
`server`
`mqtt`
`wifi`
`filestore`

`commandName`

IoTC command name. JSON type string. Used by 21 pages.

config_endpoint · config_events · control_operation · delete_certificate · delete_wifi_profile · get_current_region · get_endpoint_config · get_eth · get_installed_certificates · get_operating_mode · get_post_filter · get_status · get_version · get_wifi · install_certificate · reboot · set_operating_mode · set_os · set_post_filter · set_wifi

`connectionState`

Connection state. JSON type string. The contract uses two enumerations with different casing.

Value	Note
`CONNECTED`	`alerts` network items, `get_status` (`radioConnection`, `terminalConnection.status`), `get_wifi` (`accessPoint.status`), and `mqttConnEVT`
`DISCONNECTED`	The same members
`Connected`	`get_eth` only, in `linkStatus.status`
`Disconnected`	The same member

Compare case-insensitively if one code path handles both.

`dataEndpointType`

Tag-data endpoint selector. JSON type string. Used by get_post_filter, set_post_filter.

Value	Note
`DATA_EP1`
`DATA_EP2`	Targets the `DATA2` endpoint, which is currently not supported.

`deviceModel`

Reader model. JSON type string. Used by get_version, mqttConnEVT.

Value	Note
`RFD40`
`RFD90`

`endpointProtocol`

Endpoint transport protocol. JSON type string. Used by config_endpoint, get_endpoint_config.

Value	Note
`MQTT`
`MQTT_TLS`

`epType`

Endpoint type. JSON type string. Used by config_endpoint, get_endpoint_config.

Value	Note
`MGMT`
`MGMT_EVT`
`CTRL`
`DATA1`
`DATA2`	Currently not supported.
`MDM`

`gen2Session`

EPC Gen2 inventory session. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`SESSION_0`
`SESSION_1`
`SESSION_2`
`SESSION_3`

`interfaceEnableState`

Network interface administrative state. JSON type string. Used by get_eth, get_wifi.

Value	Note
`Enabled`
`Disabled`

The contract's own get_wifi examples also show ENABLED and an empty string, which the enum does not allow. Compare case-insensitively, and treat an empty string as unknown.

`inventoryProtocol`

RFID inventory protocol. JSON type string. Used by get_operating_mode, set_operating_mode. The default operating mode uses GEN2.

Value	Note
`GEN2`
`GEN2X`
`HYBRID`

`inventoryState`

Gen2 inventoried-flag state selector. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`STATE_A`
`STATE_B`
`STATE_AB`

`linkProfile`

Gen2 air-interface link profile. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`M4_256K`
`M2_240K`
`M2_256K`
`M2_320K`
`M4_240K`
`M4_320K`
`FM0_0K`
`FM0_320K`
`M8_240K`
`M8_256K`
`M8_320K`

`lockAction`

Tag lock action. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`READ_AND_WRITE`
`PERMANENT_LOCK`
`PERMANENT_UNLOCK`
`UNLOCK`

`lockMemoryBank`

Lockable tag resource. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`EPC`
`ACCESS_PWD`
`KILL_PWD`
`TID`
`USER`
`ALL`

`matchPatternMethod`

Post-filter match method. JSON type string. Used by get_post_filter, set_post_filter.

Value	Note
`PREFIX`
`SUFFIX`
`REGEX`

`mqttQoS`

MQTT Quality of Service level. JSON type integer. Used by config_endpoint, get_endpoint_config.

The contract declares qos and qosCommon as integers without an enumeration or a default. MQTT 3.1.1 defines the levels 0, 1 and 2; the broker description states that the reader supports 0 and 1. The contract's examples use 0 and 1.

`operatingModeProfile`

RFID reader operating-mode profile. JSON type string; default "BALANCED_PERFORMANCE" in the set_operating_mode request and the get_operating_mode reply. Used by dataEVT, get_operating_mode, set_operating_mode.

Value	Note
`FAST_READ`
`CYCLE_COUNT`
`DENSE_READERS`
`OPTIMAL_BATTERY`
`BALANCED_PERFORMANCE`
`ADVANCED`

`powerSource`

Device power source. JSON type string. The two messages that report it use different enumerations, and each spells the wall-charger value differently.

Value	`alerts` `powerEvent`	`get_status` `deviceStatus`
`BATTERY`	Yes	No
`USB`	Yes	Yes
`CRADLE`	Yes	Yes
`WALLCHARGER`	No	Yes
`WALL_CHARGER`	Yes	No

Current firmware has also been reported to return NONE in get_status when no external power source is attached. Neither enumeration allows it.

`radioTrigger`

Inventory trigger condition. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`PRESSED`
`RELEASED`
`IMMEDIATE`

`reportOperation`

Post-filter reporting disposition. JSON type string. Used by get_post_filter, set_post_filter.

Value	Note
`INCLUDE`
`EXCLUDE`

`selectAction`

Gen2 select action. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`INV_A_NOT_INV_B_OR_ASRT_SL_NOT_DSRT_SL`
`INV_A_OR_ASRT_SL`
`NOT_INV_B_OR_NOT_DSRT_SL`
`INV_A2BB2A_NOT_INV_A_OR_NEG_SL_NOT_ASRT_SL`
`INV_B_NOT_INV_A_OR_DSRT_SL_NOT_ASRT_SL`
`INV_B_OR_DSRT_SL`
`NOT_INV_A_OR_NOT_ASRT_SL`
`NOT_INV_A2BB2A_OR_NOT_NEG_SL`

`selectMemoryBank`

Select pre-filter memory bank. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`EPC`
`TID`
`USER`

`selectTarget`

Gen2 select target flag. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`SESSION_SL`
`SESSION_0`
`SESSION_1`
`SESSION_2`
`SESSION_3`

`slFlag`

Gen2 SL (Select) flag selector. JSON type string. Used by get_operating_mode, set_operating_mode.

Value	Note
`ALL`
`ASSERTED`
`DEASSERTED`

`statusCode`

IoTC status code: response.code. JSON type integer, from 0 to 101. Used by 20 pages.

The 39 codes are listed with their meanings in Response Codes.

`verificationType`

TLS verification mode. JSON type string. Used by config_endpoint, get_endpoint_config, install_certificate, set_os.

This documentation describes two values:

Value	Note
`VERIFY_HOST_AND_PEER`	Verify the broker's certificate chain and that the certificate matches the host. Use it in production.
`VERIFY_NONE`	No verification. Must not be used in production. An `MQTT_TLS` endpoint rejects it with code `37`.

`wifiEapMethod`

Wi-Fi enterprise EAP outer authentication method. JSON type string. Used by get_wifi, set_wifi.

Value	Note
`tls`
`ttls`
`peap`

`wifiInnerEapMethod`

Wi-Fi enterprise EAP inner authentication method. JSON type string. Used by get_wifi, set_wifi.

Value	Note
`none`
`mschapv2`	Required for `ttls` and `peap`, and the value the reader uses when the member is omitted for them. Omit the member for `tls`.

`wifiSecurityType`

Wi-Fi access point security type. JSON type string. Used by get_wifi, set_wifi.

Value	Note
`WPA2Personal`
`WPA3Personal`
`WPA2Enterprise`
`WPA3Enterprise`

`wpa2EnterpriseProtocol`

WPA2-Enterprise encryption protocol. JSON type string. Used by get_wifi, set_wifi.

Value	Note
`WPA2_Enterprise_CCMP`

`wpa3EnterpriseProtocol`

WPA3-Enterprise encryption protocol. JSON type string. Used by get_wifi, set_wifi.

Value	Note
`WPA3_Enterprise_CCMP`
`WPA3_Enterprise_CCMP_256`
`WPA3_Enterprise_GCMP_128`
`WPA3_Enterprise_GCMP_256_SHA256`
`WPA3_Enterprise_GCMP_256_SUITEB_192`

Enumerations Used by One Message

These enumerations appear in only one command or event. Their values are listed on that operation's page.

Enumeration	Values	Defined on
`alertId`	5	`alerts`
`alertPriority`	3	`alerts`
`alertState`	3	`alerts`
`alertType`	3	`alerts`
`certContentFormat`	2	`install_certificate`
`certSource`	2	`install_certificate`
`controlType`	2	`control_operation`
`endpointOperation`	3	`config_endpoint`
`ethEapInnerMethod`	3	`get_eth`
`ethEapMethod`	8	`get_eth`
`fileTransferStatus`	4	`alerts`
`fileType`	2	`alerts`
`linkState`	2	`alerts`
`lldpNegotiationState`	3	`alerts`
`postFilterOperation`	3	`set_post_filter`
`powerMode`	2	`alerts`
`publicKeyAlgorithm`	6	`get_installed_certificates`
`radioActivity`	2	`get_status`
`radioOperation`	2	`control_operation`
`rfidInventoryStatus`	2	`heartBeatEVT`
`terminalType`	3	`get_status`
`wifiOperation`	2	`set_wifi`

Related: 📕 Reserved and Deprecated Fields · 📕 Common Objects · 📕 Response Codes

Shared Enumerations​

accessMemoryBank​

accessOperationType​

apiVersion​

authenticationType​

batteryChargeState​

batteryHealth​

certificateAlgorithm​

certificateComponentKey​

certificateFormat​

certificateType​

commandName​

connectionState​

dataEndpointType​

deviceModel​

endpointProtocol​

epType​

gen2Session​

interfaceEnableState​

inventoryProtocol​

inventoryState​

linkProfile​

lockAction​

lockMemoryBank​

matchPatternMethod​

mqttQoS​

operatingModeProfile​

powerSource​

radioTrigger​

reportOperation​

selectAction​

selectMemoryBank​

selectTarget​

slFlag​

statusCode​

verificationType​

wifiEapMethod​

wifiInnerEapMethod​

wifiSecurityType​

wpa2EnterpriseProtocol​

wpa3EnterpriseProtocol​

Enumerations Used by One Message​