Extended error codes

If extended error handling is implemented (see Section 6.7), it provides more detail about the error that led to any one of the following function return codes:

The extended error codes, which elaborate on the above codes are provided in the ZPS_teExtendedStatusenumerations.

Extended error codes

Name

Value

Description

ZPS_XS_OK

0x00

Success

ZPS_XS_E_FATAL

0x01

Fatal error - retrying will cause the error again

ZPS_XS_E_LOOPBACK_BAD_ENDPOINT

0x02

Endpoint is not valid for loopback (fatal error)

ZPS_XS_E_SIMPLE_DESCRIPTOR_NO_ OUTPUT_CLUSTER

0x03

No output cluster in the Simple descriptor for this endpoint/cluster (fatal error)

ZPS_XS_E_FRAG_NEEDS_ACK

0x04

Fragmented data requests must be sent with APS ack (fatal error)

ZPS_XS_E_COMMAND_MANAGER_BAD_ PARAMETER

0x05

Bad parameter has been passed to the command manager (fatal error)

ZPS_XS_E_INVALID_ADDRESS

0x06

Address parameter is out-of-range (fatal error). For example, broadcast address when calling unicast function

ZPS_XS_E_INVALID_TX_ACK_FOR_LOCAL_EP

0x07

TX ACK bit has been set when attempting to post to a local endpoint (fatal error)

ZPS_XS_E_RESOURCE

0x08

Resource error/shortage - retrying may succeed

ZPS_XS_E_NO_FREE_NPDU

0x80

No free NPDUs (resource error) - the number of NPDUs is set in the “Number of NPDUs” property of the “PDU Manager” section of the ZPS Configuration Editor

ZPS_XS_E_NO_FREE_APDU

0x81

No free APDUs (resource error) - the number of APDUs is set in the “Instances” property of the appropriate “APDU” child of the “PDU Manager” section of the ZPS Configuration Editor.

ZPS_XS_E_NO_FREE_SIM_DATA_REQ

0x82

No free simultaneous data request handles (resource error) - the number of handles is set in the “Maximum Number of Simultaneous Data Requests” field of the “APS layer configuration” section of the ZPS Configuration Editor

ZPS_XS_E_NO_FREE_APS_ACK

0x83

No free APS acknowledgment handles (resource error) - the number of handles is set in the “Maximum Number of Simultaneous Data Requests with Acks” field of the “APS layer con- figuration” section of the ZPS Configuration Editor

ZPS_XS_E_NO_FREE_FRAG_RECORD

0x84

No free fragment record handles (resource error)- the number of handles is set in the “Maximum Number of Transmitted Simultaneous Fragmented Messages” field of the “APS layer configuration” section of the ZPS Configuration Editor

ZPS_XS_E_NO_FREE_MCPS_REQ

0x85

No free MCPS request descriptors (resource error) - there are 8 MCPS request descriptors and these are only ever likely to be exhausted under a very heavy network load or when trying to transmit too many frames too close together

ZPS_XS_E_NO_FREE_LOOPBACK

0x86

Loopback send is currently busy (resource error)- there can be only one loopback request at a time

ZPS_XS_E_NO_FREE_EXTENDED_ADDR

0x87

No free entries in the extended address table (resource error) - this table is configured in the ZPS Configuration Editor

ZPS_XS_E_SIMPLE_DESCRIPTOR_NOT_ FOUND

0x88

Simple descriptor does not exist for this endpoint/ cluster

ZPS_XS_E_BAD_PARAM_APSDE_REQ_RSP

0x89

Bad parameter has been found while processing an APSDE request or response

ZPS_XS_E_NO_RT_ENTRY

0x8a

No routing table entries free

ZPS_XS_E_NO_BTR

0x8b

No Broadcast transaction table entries free

ZPS_XS_E_FRAME_COUNTER_ERROR

0xC0

Decryption failed due to frame counter of received frame not greater than stored frame counter.

ZPS_XS_E_CCM_INVALID_ERROR

0xC1

Decryption failed due to invalid CCM data.

ZPS_XS_E_UNKNOWN_SRC_ADDR

0xC2

Decryption failed due to unknown source address in the received frame.

ZPS_XS_E_NO_KEY_DESCRIPTOR

0xC3

Decryption failed due to missing the matching key descriptor.

ZPS_XS_E_NULL_KEYDESCR

0xC4

Decryption failed due to NULL key descriptor.

ZPS_XS_E_PDUM_ERROR

0xC5

Decryption failed due to PDUM packet clone failure.

ZPS_XS_E_NULL_EXT_ADDR

0xC6

Encryption failed due to missing the Extended Address.

ZPS_XS_E_ENCRYPT_NULL_DESCR

0xC7

Encryption failed due to NULL key descriptor.

ZPS_XS_E_ENCRYPT_FRAME_COUNTER_FAIL

0xC8

Encryption failed due to frame counter of outgoing frame being invalid.

ZPS_XS_E_ENCRYPT_DEFAULT

0xC9

Encryption failed due to internal error.

ZPS_XS_E_FRAME_COUNTER_EXPIRED

0xCA

Decryption failed due to frame counter expiration of the received frame.

Parent topic:Return/Status Codes