Error Codes

This section describes error codes returned from API function calls.

Error Codes
Name Category Error Description
E_IPJ_ERROR_SUCCESS 0 0x00000000 Success
E_IPJ_ERROR_GENERAL_ERROR 0 0x00000001 General Error
E_IPJ_ERROR_SET_KEY_INVALID 0 0x00000002 Set Key Invalid
E_IPJ_ERROR_SET_KEY_READ_ONLY 0 0x00000003 Set Key Read Only
E_IPJ_ERROR_SET_KEY_OUT_OF_RANGE 0 0x00000004 Set Key Out Of Range
E_IPJ_ERROR_GET_KEY_INVALID 0 0x00000005 Get Key Invalid
E_IPJ_ERROR_GET_KEY_WRITE_ONLY 0 0x00000006 Get Key Write Only
E_IPJ_ERROR_COMMAND_INVALID 0 0x00000007 Command Invalid
E_IPJ_ERROR_COMMAND_START_FAILURE 0 0x00000008 Command Start Failure
E_IPJ_ERROR_COMMAND_DECODE_FAILURE 0 0x00000009 Command Decode Failure
E_IPJ_ERROR_COMMAND_ENCODE_FAILURE 0 0x0000000A Command Decode Failure
E_IPJ_ERROR_COMMAND_STALLED 0 0x0000000B Command Stalled
E_IPJ_ERROR_VALUE_INVALID 0 0x0000000C Invalid Value
E_IPJ_ERROR_MORE_THAN_ONE_COMMAND_RECEIVED 0 0x0000000D More than one command received
E_IPJ_ERROR_NOT_IMPLEMENTED 0 0x0000000E The feature requested is not available in this release
E_IPJ_ERROR_INVALID_PRODUCT_CONFIGURATION 0 0x0000000F The product contains an invalid configuration
E_IPJ_ERROR_INVALID_FACTORY_SETTINGS 0 0x00000010 The product contains invalid factory settings
E_IPJ_ERROR_RESPONSE_ENCODE_FAILURE 0 0x00000011 The device encountered an error while trying to encode a Report/Response
E_IPJ_ERROR_COMMAND_VERIFY_FAILURE 0 0x00000012 The device detected that the intended data was not properly written
E_IPJ_ERROR_INTERNAL_NON_RECOVERABLE 0 0x00000013 The device encountered an internal non-recoverable error.
E_IPJ_ERROR_TEMPLATE_DECODE_FAILURE 0 0x00000014 The device was unable to properly decode the command template
E_IPJ_ERROR_SYSTEM_IN_ERROR_STATE 0 0x00000015 A non-recoverable error has occurred and the system is in an error state. See E_IPJ_KEY_SYSTEM_ERROR. Issue a E_IPJ_ACTION_CLEAR_ERROR to clear the error.
E_IPJ_ERROR_TEST_ERROR 0 0x00000016 A general test error has occured.
E_IPJ_ERROR_STORED_SETTING_DECODE 0 0x00000017 An error occurred while decoding a stored setting. The offending setting Key code is reported in the first error parameter.
E_IPJ_ERROR_VALUE_INDEX_OUT_OF_RANGE 0 0x00000018 A Set or Get value_index parameter is out of range
E_IPJ_ERROR_BANK_INDEX_OUT_OF_RANGE 0 0x00000019 A Set or Get bank_index parameter is out of range
E_IPJ_ERROR_INVALID_PRODUCT_CALIBRATION 0 0x0000001A The product contains invalid calibration data
E_IPJ_ERROR_REPORT_SIZE_WOULD_OVERFLOW 0 0x0000001B The requested report fields and data would overflow the buffer.
E_IPJ_ERROR_GEN2_TAG_OTHER_ERROR 1 0x01000001 Catch-all for tag errors not covered by other codes
E_IPJ_ERROR_GEN2_TAG_MEMORY_OVERRUN 1 0x01000002 The specified memory location does not exist or the EPC length field is not supported by the Tag
E_IPJ_ERROR_GEN2_TAG_MEMORY_LOCKED 1 0x01000003 The specified memory location is locked and/or permalocked and is either not writeable or not readable
E_IPJ_ERROR_GEN2_TAG_INSUFFICIENT_POWER 1 0x01000004 The Tag has insufficient power to perform the memory-write operation
E_IPJ_ERROR_GEN2_TAG_NON_SPECIFIC_ERROR 1 0x01000005 The Tag does not support error-specific codes
E_IPJ_ERROR_API_DEVICE_NOT_INITIALIZED 2 0x02000001 Device is not initialized
E_IPJ_ERROR_API_SERIAL_PORT_ERROR 2 0x02000002 Serial Port Error
E_IPJ_ERROR_API_CONNECTION_READ_TIMEOUT 2 0x02000003 Connection Read Timeout
E_IPJ_ERROR_API_CONNECTION_WRITE_TIMEOUT 2 0x02000004 Connection Write Timeout
E_IPJ_ERROR_API_CONNECTION_WRITE_ERROR 2 0x02000005 Connection Write Error
E_IPJ_ERROR_API_RX_BUFF_TOO_SMALL 2 0x02000006 Receive buffer too small
E_IPJ_ERROR_API_MESSAGE_INVALID 2 0x02000007 Invalid Message
E_IPJ_ERROR_API_NO_HANDLER 2 0x02000008 No user handler has been registered to handle this action
E_IPJ_ERROR_API_INVALID_LOADER_BLOCK 2 0x02000009 The API was passed an invalid loader block
E_IPJ_ERROR_API_RESPONSE_MISMATCH 2 0x0200000A The response received does not match the command that was sent
E_IPJ_ERROR_API_INVALID_PARAMETER 2 0x0200000B The API called detected an invalid parameter (a NULL pointer, an array length that is too large, etc.)
E_IPJ_ERROR_API_NON_LT_PACKET_DETECTED 2 0x0200000C The receive routine detected a non-LT packet
E_IPJ_ERROR_IRI_FRAME_DROPPED 3 0x03000001 Missing/Malformed IRI Packet
E_IPJ_ERROR_IRI_FRAME_INVALID 3 0x03000002 The calculated IRI frame CRC or parity did not match the value that was sent
E_IPJ_ERROR_MAC_GENERAL 4 0x04000001 General Catch all for all MAC Errors
E_IPJ_ERROR_MAC_CRC_MISMATCH 4 0x04000002 CRC Mismatch on Tag Response
E_IPJ_ERROR_MAC_NO_TAG_RESPONSE 4 0x04000003 No Tag Response
E_IPJ_ERROR_MAC_TAG_LOST 4 0x04000004 Tag Lost
E_IPJ_ERROR_BTS_DEVICE_WATCHDOG_RESET 5 0x05000001 Device has experienced a watchdog reset due to a hard lock
E_IPJ_ERROR_BTS_VALUE_INVALID 5 0x05000002 Command contains an invalid value
E_IPJ_ERROR_BTS_FLASH_WRITE 5 0x05000003 Error writing to flash
E_IPJ_ERROR_BTS_FLASH_READ 5 0x05000004 Error reading from flash
E_IPJ_ERROR_BTS_FLASH_ADDRESS 5 0x05000005 Address is protected
E_IPJ_ERROR_BTS_FLASH_ERASE 5 0x05000006 Error erasing flash page
E_IPJ_ERROR_BTS_UNKNOWN_COMMAND 5 0x05000007 Device received an unknown command
E_IPJ_ERROR_BTS_COMMAND_DECODE_FAILURE 5 0x05000008 Device was unable to decode the command
E_IPJ_ERROR_TRANSCEIVER_FAILURE 6 0x06000001 Error communicating with device transceiver
E_IPJ_ERROR_LIMIT_PA_TEMPERATURE_MAX 7 0x07000001 Device PA temperature exceeded part specification

E_IPJ_ERROR_SUCCESS

Success

  • Error: 0x00000000
  • Category: 0
  • Diagnostics: NA
  • Description: Success

E_IPJ_ERROR_GENERAL_ERROR

General Error

  • Error: 0x00000001
  • Category: 0
  • Diagnostics: NA
  • Description: General Error

E_IPJ_ERROR_SET_KEY_INVALID

Set Key Invalid

  • Error: 0x00000002
  • Category: 0
  • Diagnostics: NA
  • Description: Set Key Invalid

E_IPJ_ERROR_SET_KEY_READ_ONLY

Set Key Read Only

  • Error: 0x00000003
  • Category: 0
  • Diagnostics: NA
  • Description: Set Key Read Only

E_IPJ_ERROR_SET_KEY_OUT_OF_RANGE

Set Key Out Of Range

  • Error: 0x00000004
  • Category: 0
  • Diagnostics: Key, Min Value, Max Value, User Value
  • Description: Set Key Out Of Range

E_IPJ_ERROR_GET_KEY_INVALID

Get Key Invalid

  • Error: 0x00000005
  • Category: 0
  • Diagnostics: NA
  • Description: Get Key Invalid

E_IPJ_ERROR_GET_KEY_WRITE_ONLY

Get Key Write Only

  • Error: 0x00000006
  • Category: 0
  • Diagnostics: NA
  • Description: Get Key Write Only

E_IPJ_ERROR_COMMAND_INVALID

Command Invalid

  • Error: 0x00000007
  • Category: 0
  • Diagnostics: NA
  • Description: Command Invalid

E_IPJ_ERROR_COMMAND_START_FAILURE

Command Start Failure

  • Error: 0x00000008
  • Category: 0
  • Diagnostics: NA
  • Description: Command Start Failure

E_IPJ_ERROR_COMMAND_DECODE_FAILURE

Command Decode Failure

  • Error: 0x00000009
  • Category: 0
  • Diagnostics: NA
  • Description: Command Decode Failure

E_IPJ_ERROR_COMMAND_ENCODE_FAILURE

Command Decode Failure

  • Error: 0x0000000A
  • Category: 0
  • Diagnostics: NA
  • Description: Command Decode Failure

E_IPJ_ERROR_COMMAND_STALLED

Command Stalled

  • Error: 0x0000000B
  • Category: 0
  • Diagnostics: NA
  • Description: Command Stalled

E_IPJ_ERROR_VALUE_INVALID

Invalid Value

  • Error: 0x0000000C
  • Category: 0
  • Diagnostics: NA
  • Description: Invalid Value

E_IPJ_ERROR_MORE_THAN_ONE_COMMAND_RECEIVED

More than one command received

  • Error: 0x0000000D
  • Category: 0
  • Diagnostics: NA
  • Description: More than one command received

E_IPJ_ERROR_NOT_IMPLEMENTED

The feature requested is not available in this release

  • Error: 0x0000000E
  • Category: 0
  • Diagnostics: NA
  • Description: The feature requested is not available in this release

E_IPJ_ERROR_INVALID_PRODUCT_CONFIGURATION

The product contains an invalid configuration

  • Error: 0x0000000F
  • Category: 0
  • Diagnostics: NA
  • Description: The product contains an invalid configuration

E_IPJ_ERROR_INVALID_FACTORY_SETTINGS

The product contains invalid factory settings

  • Error: 0x00000010
  • Category: 0
  • Diagnostics: NA
  • Description: The product contains invalid factory settings

E_IPJ_ERROR_RESPONSE_ENCODE_FAILURE

The device encountered an error while trying to encode a Report/Response

  • Error: 0x00000011
  • Category: 0
  • Diagnostics: NA
  • Description: The device encountered an error while trying to encode a Report/Response

E_IPJ_ERROR_COMMAND_VERIFY_FAILURE

The device detected that the intended data was not properly written

  • Error: 0x00000012
  • Category: 0
  • Diagnostics: NA
  • Description: The device detected that the intended data was not properly written

E_IPJ_ERROR_INTERNAL_NON_RECOVERABLE

The device encountered an internal non-recoverable error.

  • Error: 0x00000013
  • Category: 0
  • Diagnostics: NA
  • Description: The device encountered an internal non-recoverable error.

E_IPJ_ERROR_TEMPLATE_DECODE_FAILURE

The device was unable to properly decode the command template

  • Error: 0x00000014
  • Category: 0
  • Diagnostics: NA
  • Description: The device was unable to properly decode the command template

E_IPJ_ERROR_SYSTEM_IN_ERROR_STATE

A non-recoverable error has occurred and the system is in an error state. See E_IPJ_KEY_SYSTEM_ERROR. Issue a E_IPJ_ACTION_CLEAR_ERROR to clear the error.

  • Error: 0x00000015
  • Category: 0
  • Diagnostics: NA
  • Description: A non-recoverable error has occurred and the system is in an error state. See E_IPJ_KEY_SYSTEM_ERROR. Issue a E_IPJ_ACTION_CLEAR_ERROR to clear the error.

E_IPJ_ERROR_TEST_ERROR

A general test error has occured.

  • Error: 0x00000016
  • Category: 0
  • Diagnostics: NA
  • Description: A general test error has occured.

E_IPJ_ERROR_STORED_SETTING_DECODE

An error occurred while decoding a stored setting. The offending setting Key code is reported in the first error parameter.

  • Error: 0x00000017
  • Category: 0
  • Diagnostics: NA
  • Description: An error occurred while decoding a stored setting. The offending setting Key code is reported in the first error parameter.

E_IPJ_ERROR_VALUE_INDEX_OUT_OF_RANGE

A Set or Get value_index parameter is out of range

  • Error: 0x00000018
  • Category: 0
  • Diagnostics: NA
  • Description: A Set or Get value_index parameter is out of range

E_IPJ_ERROR_BANK_INDEX_OUT_OF_RANGE

A Set or Get bank_index parameter is out of range

  • Error: 0x00000019
  • Category: 0
  • Diagnostics: NA
  • Description: A Set or Get bank_index parameter is out of range

E_IPJ_ERROR_INVALID_PRODUCT_CALIBRATION

The product contains invalid calibration data

  • Error: 0x0000001A
  • Category: 0
  • Diagnostics: NA
  • Description: The product contains invalid calibration data

E_IPJ_ERROR_REPORT_SIZE_WOULD_OVERFLOW

The requested report fields and data would overflow the buffer.

  • Error: 0x0000001B
  • Category: 0
  • Diagnostics: NA
  • Description: The requested report fields and data would overflow the buffer.

E_IPJ_ERROR_GEN2_TAG_OTHER_ERROR

Catch-all for tag errors not covered by other codes

  • Error: 0x01000001
  • Category: 1
  • Diagnostics: NA
  • Description: Catch-all for tag errors not covered by other codes

E_IPJ_ERROR_GEN2_TAG_MEMORY_OVERRUN

The specified memory location does not exist or the EPC length field is not supported by the Tag

  • Error: 0x01000002
  • Category: 1
  • Diagnostics: NA
  • Description: The specified memory location does not exist or the EPC length field is not supported by the Tag

E_IPJ_ERROR_GEN2_TAG_MEMORY_LOCKED

The specified memory location is locked and/or permalocked and is either not writeable or not readable

  • Error: 0x01000003
  • Category: 1
  • Diagnostics: NA
  • Description: The specified memory location is locked and/or permalocked and is either not writeable or not readable

E_IPJ_ERROR_GEN2_TAG_INSUFFICIENT_POWER

The Tag has insufficient power to perform the memory-write operation

  • Error: 0x01000004
  • Category: 1
  • Diagnostics: NA
  • Description: The Tag has insufficient power to perform the memory-write operation

E_IPJ_ERROR_GEN2_TAG_NON_SPECIFIC_ERROR

The Tag does not support error-specific codes

  • Error: 0x01000005
  • Category: 1
  • Diagnostics: NA
  • Description: The Tag does not support error-specific codes

E_IPJ_ERROR_API_DEVICE_NOT_INITIALIZED

Device is not initialized

  • Error: 0x02000001
  • Category: 2
  • Diagnostics: NA
  • Description: Device is not initialized

E_IPJ_ERROR_API_SERIAL_PORT_ERROR

Serial Port Error

  • Error: 0x02000002
  • Category: 2
  • Diagnostics: NA
  • Description: Serial Port Error

E_IPJ_ERROR_API_CONNECTION_READ_TIMEOUT

Connection Read Timeout

  • Error: 0x02000003
  • Category: 2
  • Diagnostics: NA
  • Description: Connection Read Timeout

E_IPJ_ERROR_API_CONNECTION_WRITE_TIMEOUT

Connection Write Timeout

  • Error: 0x02000004
  • Category: 2
  • Diagnostics: NA
  • Description: Connection Write Timeout

E_IPJ_ERROR_API_CONNECTION_WRITE_ERROR

Connection Write Error

  • Error: 0x02000005
  • Category: 2
  • Diagnostics: NA
  • Description: Connection Write Error

E_IPJ_ERROR_API_RX_BUFF_TOO_SMALL

Receive buffer too small

  • Error: 0x02000006
  • Category: 2
  • Diagnostics: NA
  • Description: Receive buffer too small

E_IPJ_ERROR_API_MESSAGE_INVALID

Invalid Message

  • Error: 0x02000007
  • Category: 2
  • Diagnostics: NA
  • Description: Invalid Message

E_IPJ_ERROR_API_NO_HANDLER

No user handler has been registered to handle this action

  • Error: 0x02000008
  • Category: 2
  • Diagnostics: NA
  • Description: No user handler has been registered to handle this action

E_IPJ_ERROR_API_INVALID_LOADER_BLOCK

The API was passed an invalid loader block

  • Error: 0x02000009
  • Category: 2
  • Diagnostics: NA
  • Description: The API was passed an invalid loader block

E_IPJ_ERROR_API_RESPONSE_MISMATCH

The response received does not match the command that was sent

  • Error: 0x0200000A
  • Category: 2
  • Diagnostics: NA
  • Description: The response received does not match the command that was sent

E_IPJ_ERROR_API_INVALID_PARAMETER

The API called detected an invalid parameter (a NULL pointer, an array length that is too large, etc.)

  • Error: 0x0200000B
  • Category: 2
  • Diagnostics: NA
  • Description: The API called detected an invalid parameter (a NULL pointer, an array length that is too large, etc.)

E_IPJ_ERROR_API_NON_LT_PACKET_DETECTED

The receive routine detected a non-LT packet

  • Error: 0x0200000C
  • Category: 2
  • Diagnostics: NA
  • Description: The receive routine detected a non-LT packet

E_IPJ_ERROR_IRI_FRAME_DROPPED

Missing/Malformed IRI Packet

  • Error: 0x03000001
  • Category: 3
  • Diagnostics: NA
  • Description: Missing/Malformed IRI Packet

E_IPJ_ERROR_IRI_FRAME_INVALID

The calculated IRI frame CRC or parity did not match the value that was sent

  • Error: 0x03000002
  • Category: 3
  • Diagnostics: NA
  • Description: The calculated IRI frame CRC or parity did not match the value that was sent

E_IPJ_ERROR_MAC_GENERAL

General Catch all for all MAC Errors

  • Error: 0x04000001
  • Category: 4
  • Diagnostics: NA
  • Description: General Catch all for all MAC Errors

E_IPJ_ERROR_MAC_CRC_MISMATCH

CRC Mismatch on Tag Response

  • Error: 0x04000002
  • Category: 4
  • Diagnostics: NA
  • Description: CRC Mismatch on Tag Response

E_IPJ_ERROR_MAC_NO_TAG_RESPONSE

No Tag Response

  • Error: 0x04000003
  • Category: 4
  • Diagnostics: NA
  • Description: No Tag Response

E_IPJ_ERROR_MAC_TAG_LOST

Tag Lost

  • Error: 0x04000004
  • Category: 4
  • Diagnostics: NA
  • Description: Tag Lost

E_IPJ_ERROR_BTS_DEVICE_WATCHDOG_RESET

Device has experienced a watchdog reset due to a hard lock

  • Error: 0x05000001
  • Category: 5
  • Diagnostics: NA
  • Description: Device has experienced a watchdog reset due to a hard lock

E_IPJ_ERROR_BTS_VALUE_INVALID

Command contains an invalid value

  • Error: 0x05000002
  • Category: 5
  • Diagnostics: NA
  • Description: Command contains an invalid value

E_IPJ_ERROR_BTS_FLASH_WRITE

Error writing to flash

  • Error: 0x05000003
  • Category: 5
  • Diagnostics: NA
  • Description: Error writing to flash

E_IPJ_ERROR_BTS_FLASH_READ

Error reading from flash

  • Error: 0x05000004
  • Category: 5
  • Diagnostics: NA
  • Description: Error reading from flash

E_IPJ_ERROR_BTS_FLASH_ADDRESS

Address is protected

  • Error: 0x05000005
  • Category: 5
  • Diagnostics: NA
  • Description: Address is protected

E_IPJ_ERROR_BTS_FLASH_ERASE

Error erasing flash page

  • Error: 0x05000006
  • Category: 5
  • Diagnostics: NA
  • Description: Error erasing flash page

E_IPJ_ERROR_BTS_UNKNOWN_COMMAND

Device received an unknown command

  • Error: 0x05000007
  • Category: 5
  • Diagnostics: NA
  • Description: Device received an unknown command

E_IPJ_ERROR_BTS_COMMAND_DECODE_FAILURE

Device was unable to decode the command

  • Error: 0x05000008
  • Category: 5
  • Diagnostics: NA
  • Description: Device was unable to decode the command

E_IPJ_ERROR_TRANSCEIVER_FAILURE

Error communicating with device transceiver

  • Error: 0x06000001
  • Category: 6
  • Diagnostics: NA
  • Description: Error communicating with device transceiver

E_IPJ_ERROR_LIMIT_PA_TEMPERATURE_MAX

Device PA temperature exceeded part specification

  • Error: 0x07000001
  • Category: 7
  • Diagnostics: NA
  • Description: Device PA temperature exceeded part specification

Table Of Contents

Previous topic

Regulatory Regions

Next topic

Platform and Report Handlers