ZCL library  4.3
ZCL library to manage a Zigbee network
Status Class Reference

This Class defines the status for a response of a ZCL command. More...

#include <Status.h>

List of all members.

Public Types

enum  Value {
  SUCCESS = 0x00, FAILURE = 0x01, NOT_AUTHORIZED = 0x7e, RESERVED_FIELD_NOT_ZERO = 0x7f,
  MALFORMED_COMMAND = 0x80, UNSUP_CLUSTER_COMMAND = 0x81, UNSUP_GENERAL_COMMAND = 0x82, UNSUP_MANUF_CLUSTER_COMMAND = 0x83,
  UNSUP_MANUF_GENERAL_COMMAND = 0x84, INVALID_FIELD = 0x85, UNSUPPORTED_ATTRIBUTE = 0x86, INVALID_VALUE = 0x87,
  READ_ONLY = 0x88, INSUFFICIENT_SPACE = 0x89, DUPLICATE_EXISTS = 0x8a, NOT_FOUND = 0x8b,
  UNREPORTABLE_ATTRIBUTE = 0x8c, INVALID_DATA_TYPE = 0x8d, INVALID_SELECTOR = 0x8e, WRITE_ONLY = 0x8f,
  INCONSISTENT_STARTUP_STATE = 0x90, DEFINED_OUT_OF_BAND = 0x91, INCONSISTENT = 0x92, ACTION_DENIED = 0x93,
  TIMEOUT = 0x94, HARDWARE_FAILURE = 0xc0, SOFTWARE_FAILURE = 0xc1, CALIBRATION_ERROR = 0xc2
}
 Enumeration constants to specify the Status for a response of a ZCL command. More...

Static Public Member Functions

static Status::Value fromByte (const byte value)
 Build a Status from a byte.

Detailed Description

This Class defines the status for a response of a ZCL command.


Member Enumeration Documentation

Enumeration constants to specify the Status for a response of a ZCL command.

Enumerator:
SUCCESS 

Operation was successful.

FAILURE 

Operation was not successful.

NOT_AUTHORIZED 

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

RESERVED_FIELD_NOT_ZERO 

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

MALFORMED_COMMAND 

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 

The specified cluster command is not supported on the device.

Command not carried out.

UNSUP_GENERAL_COMMAND 

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

UNSUP_MANUF_CLUSTER_COMMAND 

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 

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 

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

UNSUPPORTED_ATTRIBUTE 

The specified attribute does not exist on the device.

INVALID_VALUE 

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_ONLY 

Attempt to write a read only attribute.

INSUFFICIENT_SPACE 

An operation (e.g.

an attempt to create an entry in a table) failed due to an insufficient amount of free space available.

DUPLICATE_EXISTS 

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

NOT_FOUND 

The requested information (e.g.

table entry) could not be found.

UNREPORTABLE_ATTRIBUTE 

Periodic reports cannot be issued for this attribute.

INVALID_DATA_TYPE 

The data type given for an attribute is incorrect.

Command not carried out.

INVALID_SELECTOR 

The selector for an attribute is incorrect.

WRITE_ONLY 

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

No action taken.

INCONSISTENT_STARTUP_STATE 

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

No action taken.

DEFINED_OUT_OF_BAND 

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.

INCONSISTENT 

The supplied values (e.g.

contents of table cells) are inconsistent.

ACTION_DENIED 

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

TIMEOUT 

The exchange was aborted due to excessive response time.

HARDWARE_FAILURE 

An operation was unsuccessful due to a hardware failure.

SOFTWARE_FAILURE 

An operation was unsuccessful due to a software failure.

CALIBRATION_ERROR 

An error occurred during calibration.


Member Function Documentation

static Status::Value Status::fromByte ( const byte  value) [inline, static]

Build a Status from a byte.

Parameters:
valuethe Status as a byte.
Returns:
the Status enumeration constant.

The documentation for this class was generated from the following file: