Key Codes

This section describes parameters configured using ipj_set, ipj_set_value, or ipj_bulk_set IRI API functions, or retrieved using ipj_get, ipj_get_value, and ipj_bulk_get IRI API functions.

Key Codes By Category

Antenna

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_ANTENNA_TX_POWER 49 [0,3150] 1/1 cdBm R/W
E_IPJ_KEY_ANTENNA_SEQUENCE 50 uint8 0/16 R/W

Boot Action

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_ONBOOT_START_ACTION 258 ipj_action 0/1 R/W

Device

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_DEVICE_BAUDRATE 256 ipj_baud_rate 0/1 R/W

Error

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_FIRST_ERROR 224 ipj_error 0/5 R
E_IPJ_KEY_LAST_ERROR 225 ipj_error 0/5 R
E_IPJ_KEY_SYSTEM_ERROR 226 ipj_error 0/5 R

GPIO

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_GPIO_MODE 192 ipj_gpio_mode 5/1 R/W
E_IPJ_KEY_GPIO_STATE 193 ipj_gpio_state 5/1 R/W
E_IPJ_KEY_GPIO_HI_ACTION 194 ipj_gpi_action 5/1 R/W
E_IPJ_KEY_GPIO_LO_ACTION 195 ipj_gpi_action 5/1 R/W
E_IPJ_KEY_GPIO_DEBOUNCE_MS 197 uint32 5/1 ms R/W
E_IPJ_KEY_GPIO_CURRENT_STATE 198 ipj_gpio_state 5/1 R

Generic

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_GENERIC_DATA 3072 uint32 1/16 R/W
E_IPJ_KEY_OEM_DATA 3073 uint32 0/16 R

Info Only

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_BOOTSTRAP_VERSION 1 uint32 0/1 R
E_IPJ_KEY_BOOTSTRAP_CRC 2 uint32 0/1 R
E_IPJ_KEY_APPLICATION_VERSION 3 uint32 0/1 R
E_IPJ_KEY_APPLICATION_CRC 4 uint32 0/1 R
E_IPJ_KEY_SECONDARY_IMAGE_VERSION 5 uint32 3/1 R
E_IPJ_KEY_SECONDARY_IMAGE_CRC 6 uint32 3/1 R
E_IPJ_KEY_SECONDARY_IMAGE_TYPE 7 uint32 3/1 R
E_IPJ_KEY_APPLICATION_REVISION_ID 8 uint32 0/1 R
E_IPJ_KEY_APPLICATION_BUILD_ID 9 uint32 0/1 R
E_IPJ_KEY_PRODUCT_ID 10 ipj_product_id 0/1 R
E_IPJ_KEY_SERIAL_NUMBER 11 uint32 0/1 R
E_IPJ_KEY_TRANSCEIVER_ID 12 uint32 0/1 R
E_IPJ_KEY_MICROPROCESSOR_ID 13 uint32 0/4 R
E_IPJ_KEY_CUSTOMER_VERSION 14 uint32 0/1 R
E_IPJ_KEY_CUSTOMER_ID 15 uint32 0/1 R
E_IPJ_KEY_CUSTOMER_PRODUCT_ID 16 uint32 0/1 R
E_IPJ_KEY_CALIBRATION_INFO 17 uint32 0/1 R
E_IPJ_KEY_TEST_INFO 18 uint32 0/1 R
E_IPJ_KEY_PRODUCT_SKU 19 ipj_product_sku 0/1 R
E_IPJ_KEY_LOT_DATE_CODE 20 uint32 0/1 R
E_IPJ_KEY_PRODUCT_KEY 21 uint32 0/1 R
E_IPJ_KEY_SECONDARY_IMAGE_LOCATION 22 uint32 3/1 R
E_IPJ_KEY_SECONDARY_IMAGE_SIZE 23 uint32 3/1 R
E_IPJ_KEY_UNIQUE_ID 24 uint32 0/2 R
E_IPJ_KEY_HARDWARE_REVISION 25 uint8 0/1 R

Inventory

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_INVENTORY_TAG_POPULATION 64 uint32 0/1 R/W
E_IPJ_KEY_INVENTORY_SELECT_FLAG 65 ipj_inventory_select_flag 0/1 R/W
E_IPJ_KEY_INVENTORY_SESSION 66 [0,3] 0/1 R/W
E_IPJ_KEY_INVENTORY_SEARCH_MODE 67 ipj_inventory_search_mode 0/1 R/W
E_IPJ_KEY_FAST_ID_ENABLE 69 bool 0/1 R/W
E_IPJ_KEY_TAG_FOCUS_ENABLE 70 bool 0/1 R/W
E_IPJ_KEY_TAG_OPERATION_ENABLE 71 bool 0/1 R/W
E_IPJ_KEY_TAG_OPERATION_RETRIES 72 uint8 0/1 R/W
E_IPJ_KEY_AUTOSTOP_DURATION_MS 137 uint32 0/1 ms R/W
E_IPJ_KEY_AUTOSTOP_TAG_COUNT 139 uint32 0/1 R/W

Power Mode

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_DEVICE_IDLE_POWER_MODE 257 ipj_idle_power_mode 0/1 R/W

RF Mode

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_RF_MODE 208 [0,4] 0/1 R/W

Region

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_REGION_ID 32 ipj_region 0/1 R/W

Region - Custom

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_REGION_CHANNEL_TABLE 33 uint8 0/50 R/W
E_IPJ_KEY_REGION_CHANNEL_TABLE_SIZE 34 [0,50] 0/1 R/W
E_IPJ_KEY_REGION_ON_TIME_NOMINAL 35 uint32 0/1 ms R/W
E_IPJ_KEY_REGION_ON_TIME_ACCESS 36 uint32 0/1 ms R/W
E_IPJ_KEY_REGION_OFF_TIME 37 uint32 0/1 ms R/W
E_IPJ_KEY_REGION_OFF_TIME_SAME_CHANNEL 38 uint32 0/1 ms R/W
E_IPJ_KEY_REGION_START_FREQUENCY_KHZ 39 uint32 0/1 kHz R/W
E_IPJ_KEY_REGION_CHANNEL_SPACING_KHZ 40 uint32 0/1 kHz R/W
E_IPJ_KEY_REGION_RANDOM_HOP 41 bool 0/1 R/W
E_IPJ_KEY_REGION_INDY_PLL_R_DIVIDER 42 [24,60] 0/1 R/W
E_IPJ_KEY_REGION_RF_FILTER 43 [0,2] 0/1 R/W

Select

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_SELECT_ENABLE 80 bool 2/1 R/W
E_IPJ_KEY_SELECT_TARGET 81 ipj_select_target 2/1 R/W
E_IPJ_KEY_SELECT_ACTION 82 ipj_select_action 2/1 R/W
E_IPJ_KEY_SELECT_MEM_BANK 83 ipj_mem_bank 2/1 R/W
E_IPJ_KEY_SELECT_POINTER 84 int32 2/1 R/W
E_IPJ_KEY_SELECT_MASK_LENGTH 85 [0,255] 2/1 R/W
E_IPJ_KEY_SELECT_MASK_VALUE 86 uint16 2/16 R/W

Tag Access

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_TAG_OPERATION 96 ipj_tag_operation_type 0/1 R/W
E_IPJ_KEY_ACCESS_PASSWORD 97 uint32 0/1 R/W
E_IPJ_KEY_KILL_PASSWORD 98 uint32 0/1 R/W
E_IPJ_KEY_READ_MEM_BANK 99 ipj_mem_bank 0/1 R/W
E_IPJ_KEY_READ_WORD_POINTER 100 uint32 0/1 R/W
E_IPJ_KEY_READ_WORD_COUNT 101 [0,32] 0/1 R/W
E_IPJ_KEY_WRITE_MEM_BANK 102 ipj_mem_bank 0/1 R/W
E_IPJ_KEY_WRITE_WORD_POINTER 103 uint32 0/1 R/W
E_IPJ_KEY_WRITE_WORD_COUNT 104 [0,32] 0/1 R/W
E_IPJ_KEY_WRITE_DATA 105 uint16 0/32 R/W
E_IPJ_KEY_LOCK_PAYLOAD 106 [0,0xFFFFF] 0/1 R/W
E_IPJ_KEY_BLOCKPERMALOCK_ACTION 107 ipj_blockpermalock_action 0/1 R/W
E_IPJ_KEY_BLOCKPERMALOCK_MEM_BANK 108 ipj_mem_bank 0/1 R/W
E_IPJ_KEY_BLOCKPERMALOCK_BLOCK_POINTER 109 uint32 0/1 R/W
E_IPJ_KEY_BLOCKPERMALOCK_BLOCK_RANGE 110 uint32 0/1 R/W
E_IPJ_KEY_BLOCKPERMALOCK_MASK 111 uint16 0/16 R/W
E_IPJ_KEY_WRITE_EPC_LENGTH_CONTROL 112 ipj_write_epc_length_control 0/1 R/W
E_IPJ_KEY_WRITE_EPC_LENGTH_VALUE 113 [0,31] 0/1 R/W
E_IPJ_KEY_WRITE_EPC_AFI_CONTROL 114 uint8 0/1 R/W
E_IPJ_KEY_WRITE_EPC_AFI_VALUE 115 uint8 0/1 R/W
E_IPJ_KEY_QT_ACTION 116 ipj_qt_action 0/1 R/W
E_IPJ_KEY_QT_PERSISTENCE 117 ipj_qt_persistence 0/1 R/W
E_IPJ_KEY_QT_DATA_PROFILE 118 ipj_qt_data_profile 0/1 R/W
E_IPJ_KEY_QT_ACCESS_RANGE 119 ipj_qt_access_range 0/1 R/W
E_IPJ_KEY_QT_TAG_OPERATION 120 ipj_tag_operation_type 0/1 R/W

Test

Key Key Id Range/Type Banks/Values Units R/W
E_IPJ_KEY_TEST_ID 1024 uint32 0/1 R/W
E_IPJ_KEY_TEST_PARAMETERS 1025 uint32 0/16 R/W
E_IPJ_KEY_TEST_RESULT_1 1026 uint32 0/1 R
E_IPJ_KEY_TEST_RESULT_2 1027 uint32 0/1 R
E_IPJ_KEY_TEST_RESULT_3 1028 uint32 0/1 R
E_IPJ_KEY_TEST_DATA 1029 uint32 0/16 R
E_IPJ_KEY_TEST_FREQUENCY 1030 uint32 0/1 R
E_IPJ_KEY_TEST_POWER 1031 uint32 0/22 R
E_IPJ_KEY_TEST_RF_MODE 1032 uint32 0/5 R
E_IPJ_KEY_TEST_TIME 1033 uint32 0/1 R
E_IPJ_KEY_TEST_EVENT 1034 uint32 0/8 R
E_IPJ_KEY_TEST_REPORTS 1035 uint32 0/6 R
E_IPJ_KEY_TEST_SYSTEM 1036 uint32 0/1 R
E_IPJ_KEY_TEST_DEBUG_PORT 1037 uint32 0/1 R/W

Key Codes By Key Id

E_IPJ_KEY_BOOTSTRAP_VERSION

  • Key Id: 1
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Bootstrap Version

E_IPJ_KEY_BOOTSTRAP_CRC

  • Key Id: 2
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Bootstrap CRC

E_IPJ_KEY_APPLICATION_VERSION

  • Key Id: 3
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Application Version

E_IPJ_KEY_APPLICATION_CRC

  • Key Id: 4
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Application CRC

E_IPJ_KEY_SECONDARY_IMAGE_VERSION

  • Key Id: 5
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 3
  • Value Count: 1
  • Default: Dynamic
  • Description: Secondary Image Version

E_IPJ_KEY_SECONDARY_IMAGE_CRC

  • Key Id: 6
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 3
  • Value Count: 1
  • Default: Dynamic
  • Description: Secondary Image CRC

E_IPJ_KEY_SECONDARY_IMAGE_TYPE

  • Key Id: 7
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 3
  • Value Count: 1
  • Default: Dynamic
  • Description: Secondary Image Type

E_IPJ_KEY_APPLICATION_REVISION_ID

  • Key Id: 8
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Application Revision Id

E_IPJ_KEY_APPLICATION_BUILD_ID

  • Key Id: 9
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Application Build Id

E_IPJ_KEY_PRODUCT_ID

  • Key Id: 10
  • Permissions: R
  • Range/Type: ipj_product_id
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Product Id

E_IPJ_KEY_SERIAL_NUMBER

  • Key Id: 11
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Serial Number within a lot

E_IPJ_KEY_TRANSCEIVER_ID

  • Key Id: 12
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Transceiver ID

E_IPJ_KEY_MICROPROCESSOR_ID

  • Key Id: 13
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 4
  • Default: Dynamic
  • Description: Microcontroller ID and unique identifier

E_IPJ_KEY_CUSTOMER_VERSION

  • Key Id: 14
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Customer Version

E_IPJ_KEY_CUSTOMER_ID

  • Key Id: 15
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Customer ID

E_IPJ_KEY_CUSTOMER_PRODUCT_ID

  • Key Id: 16
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Customer Product ID

E_IPJ_KEY_CALIBRATION_INFO

  • Key Id: 17
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Calibration Source Information

E_IPJ_KEY_TEST_INFO

  • Key Id: 18
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: The number of test commands executed

E_IPJ_KEY_PRODUCT_SKU

  • Key Id: 19
  • Permissions: R
  • Range/Type: ipj_product_sku
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: The hardware SKU of the reader

E_IPJ_KEY_LOT_DATE_CODE

  • Key Id: 20
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Combined lot and date code ZZWWYY where ZZ is lot number, WW is work week, and YY is year produced

E_IPJ_KEY_PRODUCT_KEY

  • Key Id: 21
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Product Key

E_IPJ_KEY_SECONDARY_IMAGE_LOCATION

  • Key Id: 22
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 3
  • Value Count: 1
  • Default: Dynamic
  • Description: Secondary Image Location

E_IPJ_KEY_SECONDARY_IMAGE_SIZE

  • Key Id: 23
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 3
  • Value Count: 1
  • Default: Dynamic
  • Description: Secondary Image Size

E_IPJ_KEY_UNIQUE_ID

  • Key Id: 24
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 2
  • Default: Dynamic
  • Description: 64-bit Unique Id for each device XXZZWWYYAAAA where XX is SKU, ZZWWYY is Lot Date Code, and AAAA is Serial Number within the lot

E_IPJ_KEY_HARDWARE_REVISION

  • Key Id: 25
  • Permissions: R
  • Range/Type: uint8
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: The hardware revision of the reader.

E_IPJ_KEY_REGION_ID

  • Key Id: 32
  • Permissions: R/W
  • Range/Type: ipj_region
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Region ID. Please refer to section Regulatory Region for the list of supported regions.

E_IPJ_KEY_REGION_CHANNEL_TABLE

  • Key Id: 33
  • Permissions: R/W
  • Range/Type: uint8
  • Units: –
  • Bank Count: 0
  • Value Count: 50
  • Default: Dynamic
  • Description: Channel Table. If this key code is not configured, the default channel table for the current regulatory region is used. The mapping from channel indices to frequency values depends upon the regulatory region.

E_IPJ_KEY_REGION_CHANNEL_TABLE_SIZE

  • Key Id: 34
  • Permissions: R/W
  • Range/Type: [0,50]
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Channel Table usable entry size

E_IPJ_KEY_REGION_ON_TIME_NOMINAL

  • Key Id: 35
  • Permissions: R/W
  • Range/Type: uint32
  • Units: ms
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Dwell time (in ms). Only valid for user-specified region. Recommended that this be 200ms less than REGION_ON_TIME_ACCESS

E_IPJ_KEY_REGION_ON_TIME_ACCESS

  • Key Id: 36
  • Permissions: R/W
  • Range/Type: uint32
  • Units: ms
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Dwell time (in ms) when access operation performed. Only valid for user-specified region.

E_IPJ_KEY_REGION_OFF_TIME

  • Key Id: 37
  • Permissions: R/W
  • Range/Type: uint32
  • Units: ms
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Off-time (in ms) when switching to a different channel. Only valid for user-specified region.

E_IPJ_KEY_REGION_OFF_TIME_SAME_CHANNEL

  • Key Id: 38
  • Permissions: R/W
  • Range/Type: uint32
  • Units: ms
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Off-time (in ms) when switching to the same channel. Only valid for user-specified region.

E_IPJ_KEY_REGION_START_FREQUENCY_KHZ

  • Key Id: 39
  • Permissions: R/W
  • Range/Type: uint32
  • Units: kHz
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Channel 1 frequency in kHz. Only valid for user-specified region.

E_IPJ_KEY_REGION_CHANNEL_SPACING_KHZ

  • Key Id: 40
  • Permissions: R/W
  • Range/Type: uint32
  • Units: kHz
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Channel spacing in kHz. Only valid for user-specified region.

E_IPJ_KEY_REGION_RANDOM_HOP

  • Key Id: 41

  • Permissions: R/W

  • Range/Type: bool

  • Units: –

  • Bank Count: 0

  • Value Count: 1

  • Default: Dynamic

  • Description: Specifies a random hop sequence. Only valid for user-specified region.
    • 0: Hopping off
    • 1: Hopping on

E_IPJ_KEY_REGION_INDY_PLL_R_DIVIDER

  • Key Id: 42
  • Permissions: R/W
  • Range/Type: [24,60]
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: Dynamic
  • Description: Indy PLL parameter. Recommended values are 24, 30, 48, and 60. Only valid for user-specified region.

E_IPJ_KEY_REGION_RF_FILTER

  • Key Id: 43

  • Permissions: R/W

  • Range/Type: [0,2]

  • Units: –

  • Bank Count: 0

  • Value Count: 1

  • Default: Dynamic

  • Description: External RF Filter selection.
    • 0 = FCC
    • 1 = EU
    • 2 = JP

E_IPJ_KEY_ANTENNA_TX_POWER

  • Key Id: 49
  • Permissions: R/W
  • Range/Type: [0,3150]
  • Units: cdBm
  • Bank Count: 1
  • Value Count: 1
  • Default: Dynamic
  • Description: Antenna Transmit Power in cdBm (eg. 2300 = 23 dBm). By default, this is set to the maximum rated power of the device and region combination. For example, the RS2000 configured for the USA defaults to 31.5 dBm transmit power.

E_IPJ_KEY_ANTENNA_SEQUENCE

  • Key Id: 50
  • Permissions: R/W
  • Range/Type: uint8
  • Units: –
  • Bank Count: 0
  • Value Count: 16
  • Default: 0
  • Description: The sequence of antennas through which the reader will cycle. Each value represents one antenna index in the sequence. Any values of 0 will be skipped.

E_IPJ_KEY_INVENTORY_TAG_POPULATION

  • Key Id: 64
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 16
  • Description: An estimate of the tag population in view of the RF field of the antenna.

E_IPJ_KEY_INVENTORY_SELECT_FLAG

  • Key Id: 65
  • Permissions: R/W
  • Range/Type: ipj_inventory_select_flag
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 1
  • Description: Inventory Select Flag. Determines which Tags will respond during Inventory.

E_IPJ_KEY_INVENTORY_SESSION

  • Key Id: 66
  • Permissions: R/W
  • Range/Type: [0,3]
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Inventory Session Number (0 - 3)

E_IPJ_KEY_INVENTORY_SEARCH_MODE

  • Key Id: 67
  • Permissions: R/W
  • Range/Type: ipj_inventory_search_mode
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Inventory Search Mode

E_IPJ_KEY_FAST_ID_ENABLE

  • Key Id: 69
  • Permissions: R/W
  • Range/Type: bool
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Enable FastID Capability for Monza Tags

E_IPJ_KEY_TAG_FOCUS_ENABLE

  • Key Id: 70
  • Permissions: R/W
  • Range/Type: bool
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Tag Focus Capability for Monza Tags (Session must be S1 and Search Mode must be A->B Only)

E_IPJ_KEY_TAG_OPERATION_ENABLE

  • Key Id: 71
  • Permissions: R/W
  • Range/Type: bool
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Tag Operation Enable during inventory

E_IPJ_KEY_TAG_OPERATION_RETRIES

  • Key Id: 72
  • Permissions: R/W
  • Range/Type: uint8
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 3
  • Description: Maximum number of retries on a failed tag access operation. If a valid tag response with a Memory Locked or Memory Overrun Gen2 Error is received, the tag access operation is not retried.

E_IPJ_KEY_SELECT_ENABLE

  • Key Id: 80
  • Permissions: R/W
  • Range/Type: bool
  • Units: –
  • Bank Count: 2
  • Value Count: 1
  • Default: 0
  • Description: Enables the transmission of a Select command before an inventory round.

E_IPJ_KEY_SELECT_TARGET

  • Key Id: 81
  • Permissions: R/W
  • Range/Type: ipj_select_target
  • Units: –
  • Bank Count: 2
  • Value Count: 1
  • Default: 0
  • Description: Determines if the Select command modifies a Tag’s SL flag or its inventoried flag. In the case of the inventoried flag it further determines one of the four sessions

E_IPJ_KEY_SELECT_ACTION

  • Key Id: 82
  • Permissions: R/W
  • Range/Type: ipj_select_action
  • Units: –
  • Bank Count: 2
  • Value Count: 1
  • Default: 0
  • Description: Specifies if during the Select command, matching tags should assert SL, de-assert SL, or set their inventoried flag to A or to B.

E_IPJ_KEY_SELECT_MEM_BANK

  • Key Id: 83
  • Permissions: R/W
  • Range/Type: ipj_mem_bank
  • Units: –
  • Bank Count: 2
  • Value Count: 1
  • Default: 0
  • Description: The memory bank on which the tag filter is applied. Tag filters may be configured to search for content in the Epc, Tid, and User memory banks. Tag filters will not match against the Reserved memory bank.

E_IPJ_KEY_SELECT_POINTER

  • Key Id: 84
  • Permissions: R/W
  • Range/Type: int32
  • Units: –
  • Bank Count: 2
  • Value Count: 1
  • Default: 0
  • Description: The bit offset in the specified memory bank at which the tag mask begins. This is bit offset and need not be word or even byte-aligned.

E_IPJ_KEY_SELECT_MASK_LENGTH

  • Key Id: 85
  • Permissions: R/W
  • Range/Type: [0,255]
  • Units: –
  • Bank Count: 2
  • Value Count: 1
  • Default: 0
  • Description: This key code along with SELECT_POINTER key determine the memory range over which the Select command mask (SELECT_MASK_VALUE) is applied. This key code specifies the length of the memory range in bits.

E_IPJ_KEY_SELECT_MASK_VALUE

  • Key Id: 86
  • Permissions: R/W
  • Range/Type: uint16
  • Units: –
  • Bank Count: 2
  • Value Count: 16
  • Default: 0
  • Description: The tag mask defines the bit pattern that the tag filter must match on. For a non-16 bit aligned tag mask the final bits are left justified (high order bits) in the last word.

E_IPJ_KEY_TAG_OPERATION

  • Key Id: 96
  • Permissions: R/W
  • Range/Type: ipj_tag_operation_type
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Determines the specific Access command issued to a Tag when Tag Operation enabled.

E_IPJ_KEY_ACCESS_PASSWORD

  • Key Id: 97
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Specifies the 32-bit Access password that is used in conjunction with the EPCglobal Gen2 Access command to move the Tag to the Secured state. If the key value is non-zero, the reader implements the access procedure before issuing access commands.

E_IPJ_KEY_KILL_PASSWORD

  • Key Id: 98
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Specifies the 32-bit Kill password used to kill the Tag.

E_IPJ_KEY_READ_MEM_BANK

  • Key Id: 99
  • Permissions: R/W
  • Range/Type: ipj_mem_bank
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Memory Bank to access for read operation.

E_IPJ_KEY_READ_WORD_POINTER

  • Key Id: 100
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Word Pointer to access for read operation.

E_IPJ_KEY_READ_WORD_COUNT

  • Key Id: 101
  • Permissions: R/W
  • Range/Type: [0,32]
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Number of words to access for read operation.

E_IPJ_KEY_WRITE_MEM_BANK

  • Key Id: 102
  • Permissions: R/W
  • Range/Type: ipj_mem_bank
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Memory Bank to access for write operation.

E_IPJ_KEY_WRITE_WORD_POINTER

  • Key Id: 103
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Word Pointer to access for write operation.

E_IPJ_KEY_WRITE_WORD_COUNT

  • Key Id: 104
  • Permissions: R/W
  • Range/Type: [0,32]
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Number of words to write.

E_IPJ_KEY_WRITE_DATA

  • Key Id: 105
  • Permissions: R/W
  • Range/Type: uint16
  • Units: –
  • Bank Count: 0
  • Value Count: 32
  • Default: 0
  • Description: Data to write into the tag memory. Specified in 16-bit words.

E_IPJ_KEY_LOCK_PAYLOAD

  • Key Id: 106
  • Permissions: R/W
  • Range/Type: [0,0xFFFFF]
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Payload field for the lock command. Specified in a 20-bit value.

E_IPJ_KEY_BLOCKPERMALOCK_ACTION

  • Key Id: 107
  • Permissions: R/W
  • Range/Type: ipj_blockpermalock_action
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Blockpermalock action for blockpermalock operation.

E_IPJ_KEY_BLOCKPERMALOCK_MEM_BANK

  • Key Id: 108
  • Permissions: R/W
  • Range/Type: ipj_mem_bank
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Memory Bank to access for blockpermalock operation.

E_IPJ_KEY_BLOCKPERMALOCK_BLOCK_POINTER

  • Key Id: 109
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Block Pointer for the blockpermalock operation.

E_IPJ_KEY_BLOCKPERMALOCK_BLOCK_RANGE

  • Key Id: 110
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Blockpermalock mask range in units of 16 blocks for the blockpermalock operation.

E_IPJ_KEY_BLOCKPERMALOCK_MASK

  • Key Id: 111
  • Permissions: R/W
  • Range/Type: uint16
  • Units: –
  • Bank Count: 0
  • Value Count: 16
  • Default: 0
  • Description: Blockpermalock mask for the blockpermalock operation.

E_IPJ_KEY_WRITE_EPC_LENGTH_CONTROL

  • Key Id: 112
  • Permissions: R/W
  • Range/Type: ipj_write_epc_length_control
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: EPC length handling control for the WRITE_EPC tag operation. There are options to automatically update the length, specificy a user length, zero the length, or do not change the length value.

E_IPJ_KEY_WRITE_EPC_LENGTH_VALUE

  • Key Id: 113
  • Permissions: R/W
  • Range/Type: [0,31]
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: The user specified EPC length value when user value EPC length control is selected.

E_IPJ_KEY_WRITE_EPC_AFI_CONTROL

  • Key Id: 114
  • Permissions: R/W
  • Range/Type: uint8
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: This enables the write of the AFI bits in the tag EPC memory if set to True. AFI bits are bits 18h-1Fh in EPC memory. The AFI bits will be updated to the user value set by E_IPJ_KEY_WRITE_EPC_AFI_VALUE. Please note that bit 17h in EPC memory should have a logical 1 for bits 18h-1Fh to contain a valid AFI value.

E_IPJ_KEY_WRITE_EPC_AFI_VALUE

  • Key Id: 115
  • Permissions: R/W
  • Range/Type: uint8
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: The user specified AFI Bits when AFI Control is enabled.

E_IPJ_KEY_QT_ACTION

  • Key Id: 116
  • Permissions: R/W
  • Range/Type: ipj_qt_action
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: QT Action for the QT operation.

E_IPJ_KEY_QT_PERSISTENCE

  • Key Id: 117
  • Permissions: R/W
  • Range/Type: ipj_qt_persistence
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: QT Persistence for the QT operation.

E_IPJ_KEY_QT_DATA_PROFILE

  • Key Id: 118
  • Permissions: R/W
  • Range/Type: ipj_qt_data_profile
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: QT Data Profile for the QT operation.

E_IPJ_KEY_QT_ACCESS_RANGE

  • Key Id: 119
  • Permissions: R/W
  • Range/Type: ipj_qt_access_range
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: QT Access Range for the QT operation.

E_IPJ_KEY_QT_TAG_OPERATION

  • Key Id: 120
  • Permissions: R/W
  • Range/Type: ipj_tag_operation_type
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Determines the specific Access command issued to a Tag when Tag Operation enabled after the QT Command. Only Read and Write are supported.

E_IPJ_KEY_AUTOSTOP_DURATION_MS

  • Key Id: 137
  • Permissions: R/W
  • Range/Type: uint32
  • Units: ms
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Specifies the duration of time to Inventory. Inventory stops automatically once the specified time has elaspsed.

E_IPJ_KEY_AUTOSTOP_TAG_COUNT

  • Key Id: 139
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Specifies the number of Tags to Inventory. Inventory stops automatically once the specified number of Tags are inventoried.

E_IPJ_KEY_REPORT_CONTROL_TAG

  • Key Id: 161
  • Permissions: R/W
  • Range/Type: ipj_tag_flag
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0x00000023
  • Description: Controls which Tag fields are present in a TagOperationReport

E_IPJ_KEY_REPORT_CONTROL_STATUS

  • Key Id: 162
  • Permissions: R/W
  • Range/Type: ipj_status_flag
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Controls which Status reports will be generated

E_IPJ_KEY_REPORT_CONTROL_TIMESTAMP

  • Key Id: 163
  • Permissions: R/W
  • Range/Type: ipj_report_timestamp_flag
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Controls which Reports will contain timestamps

E_IPJ_KEY_RESPONSE_CONTROL_TIMESTAMP

  • Key Id: 164
  • Permissions: R/W
  • Range/Type: ipj_response_timestamp_flag
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Controls which Responses will contain timestamps

E_IPJ_KEY_GPIO_MODE

  • Key Id: 192
  • Permissions: R/W
  • Range/Type: ipj_gpio_mode
  • Units: –
  • Bank Count: 5
  • Value Count: 1
  • Default: 0
  • Description: Controls the GPIO mode (Input/output/action/etc)

E_IPJ_KEY_GPIO_STATE

  • Key Id: 193
  • Permissions: R/W
  • Range/Type: ipj_gpio_state
  • Units: –
  • Bank Count: 5
  • Value Count: 1
  • Default: 0
  • Description: Controls the GPIO Logic level (+3.3 V/0.0 V). Output is driven (maximum load is +/- 8 mA), input is pulled internally via resistors(or left floating).

E_IPJ_KEY_GPIO_HI_ACTION

  • Key Id: 194
  • Permissions: R/W
  • Range/Type: ipj_gpi_action
  • Units: –
  • Bank Count: 5
  • Value Count: 1
  • Default: 0
  • Description: Control the action when GPIO transitions High. Note that this MUST NOT be set to the same value as GPIO_LO_ACTION on a given pin (undefined behavior will result)

E_IPJ_KEY_GPIO_LO_ACTION

  • Key Id: 195
  • Permissions: R/W
  • Range/Type: ipj_gpi_action
  • Units: –
  • Bank Count: 5
  • Value Count: 1
  • Default: 0
  • Description: Controls the action when GPIO transitions Low. Note that this MUST NOT be set to the same value as GPIO_HI_ACTION on a given pin (undefined behavior will result)

E_IPJ_KEY_GPIO_DEBOUNCE_MS

  • Key Id: 197
  • Permissions: R/W
  • Range/Type: uint32
  • Units: ms
  • Bank Count: 5
  • Value Count: 1
  • Default: 0
  • Description: Controls internal debounce timeout for GPI actions

E_IPJ_KEY_GPIO_CURRENT_STATE

  • Key Id: 198
  • Permissions: R
  • Range/Type: ipj_gpio_state
  • Units: –
  • Bank Count: 5
  • Value Count: 1
  • Default: 0
  • Description: Reflects the current logic level (+3.3 V/0.0 V) of the GPIO pins. State is updated while running GPIO action

E_IPJ_KEY_RF_MODE

  • Key Id: 208

  • Permissions: R/W

  • Range/Type: [0,4]

  • Units: –

  • Bank Count: 0

  • Value Count: 1

  • Default: 0

  • Description: RF Mode for inventory operation:
    • Mode 0: Auto (Default Mode 1)
    • Mode 1: 25 us Tari, M4, 250 kHz
    • Mode 2: 25 us Tari, M4, 300 kHz
    • Mode 3: 6.25 us Tari, FM0, 400 kHz
    • Mode 4: 25 us Tari, FM0, 40 kHz

E_IPJ_KEY_FIRST_ERROR

  • Key Id: 224
  • Permissions: R
  • Range/Type: ipj_error
  • Units: –
  • Bank Count: 0
  • Value Count: 5
  • Default: 0
  • Description: Holds the first error that occurred since last cleared (or boot)

E_IPJ_KEY_LAST_ERROR

  • Key Id: 225
  • Permissions: R
  • Range/Type: ipj_error
  • Units: –
  • Bank Count: 0
  • Value Count: 5
  • Default: 0
  • Description: Holds the Last error that occurred

E_IPJ_KEY_SYSTEM_ERROR

  • Key Id: 226
  • Permissions: R
  • Range/Type: ipj_error
  • Units: –
  • Bank Count: 0
  • Value Count: 5
  • Default: 0
  • Description: Holds the last System level error that occurred (Hard Faults)

E_IPJ_KEY_DEVICE_BAUDRATE

  • Key Id: 256
  • Permissions: R/W
  • Range/Type: ipj_baud_rate
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Serial baud rate the device connects at after boot

E_IPJ_KEY_DEVICE_IDLE_POWER_MODE

  • Key Id: 257
  • Permissions: R/W
  • Range/Type: ipj_idle_power_mode
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Power consumption mode when the device is idle

E_IPJ_KEY_ONBOOT_START_ACTION

  • Key Id: 258
  • Permissions: R/W
  • Range/Type: ipj_action
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: E_IPJ_ACTION_NONE
  • Description: If an action is set in the device stored settings then the action will automatically start on device boot.

E_IPJ_KEY_ENABLE_LT_REPORTS

  • Key Id: 259
  • Permissions: R/W
  • Range/Type: bool
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: Useful in an RX only use case for the ITK-LT host library. The reader can be configured with an ONBOOT_START_ACTION and this key to automatically send up LT tag operation reports.

E_IPJ_KEY_TEST_ID

  • Key Id: 1024
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Test Command Id is used to select the specific test command. Please refer to ITK examples for usage.

E_IPJ_KEY_TEST_PARAMETERS

  • Key Id: 1025
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 16
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Test Command Parameters provide inputs for specific test commands. Please refer to ITK examples for usage.

E_IPJ_KEY_TEST_RESULT_1

  • Key Id: 1026
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Test Command Result 1

E_IPJ_KEY_TEST_RESULT_2

  • Key Id: 1027
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Test Command Result 2

E_IPJ_KEY_TEST_RESULT_3

  • Key Id: 1028
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Test Command Result 3

E_IPJ_KEY_TEST_DATA

  • Key Id: 1029
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 16
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Test Command Data

E_IPJ_KEY_TEST_FREQUENCY

  • Key Id: 1030
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Last locked frequency

E_IPJ_KEY_TEST_POWER

  • Key Id: 1031
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 22
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Last transmit power

E_IPJ_KEY_TEST_RF_MODE

  • Key Id: 1032
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 5
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) RF Profile identifier

E_IPJ_KEY_TEST_TIME

  • Key Id: 1033
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Last transmit on time

E_IPJ_KEY_TEST_EVENT

  • Key Id: 1034
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 8
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Event Info

E_IPJ_KEY_TEST_REPORTS

  • Key Id: 1035
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 6
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Report Info

E_IPJ_KEY_TEST_SYSTEM

  • Key Id: 1036
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) System Info

E_IPJ_KEY_TEST_DEBUG_PORT

  • Key Id: 1037
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 1
  • Default: 0
  • Description: (ENGINEERING USE ONLY - SUBJECT TO CHANGE) Serial Debug Port Configuration

E_IPJ_KEY_GENERIC_DATA

  • Key Id: 3072
  • Permissions: R/W
  • Range/Type: uint32
  • Units: –
  • Bank Count: 1
  • Value Count: 16
  • Default: 0
  • Description: Generic data storage for third parties to add custom data to the device.

E_IPJ_KEY_OEM_DATA

  • Key Id: 3073
  • Permissions: R
  • Range/Type: uint32
  • Units: –
  • Bank Count: 0
  • Value Count: 16
  • Default: 0
  • Description: OEM data storage to add custom data to the device during calibration.

Table Of Contents

Previous topic

Defines

Next topic

Regulatory Regions