Serial Protocol - RapidConnect : ZCL Status Codes/Enumerations

Where a ZCL command contains a status field, the value of the enumerated statuses are listed here. The information in the following table comes from the ZigBee Cluster Library Specification dated May 31, 2012


ZCL Status Codes / Enumerations

Enumerated Status

Value

Description

SUCCESS

0x00

Operation was successful.

FAILURE

0x01

Operation was not successful.

-

0x02 – 0x7d

Reserved.

NOT_AUTHORIZED

0x7e

The sender of the command does not have authorization to carry out this command.

RESERVED_FIELD_NOT_ZERO

0x7f

A reserved field/subfield/bit contains a non-zero value.

MALFORMED_COMMAND

0x80

The command appears to contain the wrong fields, as detected either by the presence of one or more invalid field entries or by there being missing fields. Command not carried out. Implementer has discretion as to whether to return this error or INVALID_FIELD.

UNSUP_CLUSTER_COMMAND

0x81

The specified cluster command is not supported on the device. Command not carried out.

UNSUP_GENERAL_COMMAND

0x82

The specified general ZCL command is not supported on the device.

UNSUP_MANUF_CLUSTER_COMMAND

0x83

A manufacturer specific unicast, cluster specific command was received with an unknown manufacturer code, or the manufacturer code was recognized but the command is not supported.

UNSUP_MANUF_GENERAL_COMMAND

0x84

A manufacturer specific unicast, ZCL specific command was received with an unknown manufacturer code, or the manufacturer code was recognized but the command is not supported.

INVALID_FIELD

0x85

At least one field of the command contains an incorrect value, according to the specification the device is implemented to.

UNSUPPORTED_ATTRIBUTE

0x86

The specified attribute does not exist on the device.

INVALID_VALUE

0x87

Out of range error, or set to a reserved value. Attribute keeps its old value.

Note that an attribute value may be out of range if an attribute is related to another, e.g. with minimum and maximum attributes. See the individual attribute descriptions for specific details.

READ_ONLY0x88

Attempt to write a read only attribute.

INSUFFICIENT_SPACE0x89

An operation (e.g., an attempt to create an entry in a table) failed due to an insufficient amount of free space available.

DUPLICATE_EXISTS0x8a

An attempt to create an entry in a table failed due to a duplicate entry already being present in the table.

NOT_FOUND0x8b

The requested information (e.g., table entry) could not be found.

UNREPORTABLE_ATTRIBUTE0x8cPeriodic reports cannot be issued for this attribute.
INVALID_DATA_TYPE0x8d

The data type given for an attribute is incorrect. Command not carried out.

INVALID_SELECTOR0x8e

The selector for an attribute is incorrect.

WRITE _ONLY

0x8f

A request has been made to read an attribute that the requestor is not authorized to read. No action taken.

INCONSISTENT_STARTUP_STATE0x90

Setting the requested values would put the device in an inconsistent state on startup. No action taken.

DEFINED_OUT_OF_BAND0x91

An attempt has been made to write an attribute that is present but is defined using an out-of-band method and not over the air.

INCONSISTENT0x92

The supplied values (e.g., contents of table cells) are inconsistent.

ACTION_DENIED0x93

The credentials presented by the device sending the command are not sufficient to perform this action.

TIMEOUT0x94

The exchange was aborted due to excessive response time.

ABORT0x95

Failed case when a client or a server decides to abort the upgrade process.

INVALID_IMAGE0x96

Invalid OTA upgrade image (ex. failed signature validation or signer information check or CRC check).

WAIT_FOR_DATA0x97

Server does not have data block available yet.

NO_IMAGE_AVAILABLE0x98

No OTA upgrade image available for a particular client.

REQUIRE_MORE_IMAGE0x99

The client still requires more OTA upgrade image files in order to successfully upgrade.

NOTIFICATION_PENDING0x9a

The command has been received and is being processed.

HARDWARE_FAILURE0xc0

An operation was unsuccessful due to a hardware failure.

SOFTWARE_FAILURE0xc1

An operation was unsuccessful due to a software failure.

CALIBRATION_ERROR0xc2

An error occurred during calibration.