Data Structures

struct EmberZclStringType_t

Typedefs

typedef uint8_t data8_t
typedef uint16_t data16_t
typedef uint32_t data32_t
typedef uint64_t data64_t
typedef uint8_t bitmap8_t
typedef uint16_t bitmap16_t
typedef uint32_t bitmap32_t
typedef uint64_t bitmap64_t
typedef uint8_t enum8_t
typedef uint16_t enum16_t
typedef uint32_t utc_time_t

Enumerations

enum EmberZclStatus_t {
EMBER_ZCL_STATUS_SUCCESS = 0x00,
EMBER_ZCL_STATUS_FAILURE = 0x01,
EMBER_ZCL_STATUS_NOT_AUTHORIZED = 0x7E,
EMBER_ZCL_STATUS_RESERVED_FIELD_NOT_ZERO = 0x7F,
EMBER_ZCL_STATUS_MALFORMED_COMMAND = 0x80,
EMBER_ZCL_STATUS_UNSUP_CLUSTER_COMMAND = 0x81,
EMBER_ZCL_STATUS_UNSUP_GENERAL_COMMAND = 0x82,
EMBER_ZCL_STATUS_UNSUP_MANUF_CLUSTER_COMMAND = 0x83,
EMBER_ZCL_STATUS_UNSUP_MANUF_GENERAL_COMMAND = 0x84,
EMBER_ZCL_STATUS_INVALID_FIELD = 0x85,
EMBER_ZCL_STATUS_UNSUPPORTED_ATTRIBUTE = 0x86,
EMBER_ZCL_STATUS_INVALID_VALUE = 0x87,
EMBER_ZCL_STATUS_READ_ONLY = 0x88,
EMBER_ZCL_STATUS_INSUFFICIENT_SPACE = 0x89,
EMBER_ZCL_STATUS_DUPLICATE_EXISTS = 0x8A,
EMBER_ZCL_STATUS_NOT_FOUND = 0x8B,
EMBER_ZCL_STATUS_UNREPORTABLE_ATTRIBUTE = 0x8C,
EMBER_ZCL_STATUS_INVALID_DATA_TYPE = 0x8D,
EMBER_ZCL_STATUS_INVALID_SELECTOR = 0x8E,
EMBER_ZCL_STATUS_WRITE_ONLY = 0x8F,
EMBER_ZCL_STATUS_INCONSISTENT_STARTUP_STATE = 0x90,
EMBER_ZCL_STATUS_DEFINED_OUT_OF_BAND = 0x91,
EMBER_ZCL_STATUS_INCONSISTENT = 0x92,
EMBER_ZCL_STATUS_ACTION_DENIED = 0x93,
EMBER_ZCL_STATUS_TIMEOUT = 0x94,
EMBER_ZCL_STATUS_ABORT = 0x95,
EMBER_ZCL_STATUS_INVALID_IMAGE = 0x96,
EMBER_ZCL_STATUS_WAIT_FOR_DATA = 0x97,
EMBER_ZCL_STATUS_NO_IMAGE_AVAILABLE = 0x98,
EMBER_ZCL_STATUS_REQUIRE_MORE_IMAGE = 0x99,
EMBER_ZCL_STATUS_NOTIFICATION_PENDING = 0x9A,
EMBER_ZCL_STATUS_HARDWARE_FAILURE = 0xC0,
EMBER_ZCL_STATUS_SOFTWARE_FAILURE = 0xC1,
EMBER_ZCL_STATUS_CALIBRATION_ERROR = 0xC2,
EMBER_ZCL_STATUS_NULL = 0xFF
}

Detailed Description

See zcl-core-types.h for source code.

Typedef Documentation

typedef uint16_t bitmap16_t
typedef uint32_t bitmap32_t
typedef uint64_t bitmap64_t
typedef uint8_t bitmap8_t
typedef uint16_t data16_t
typedef uint32_t data32_t
typedef uint64_t data64_t
typedef uint8_t data8_t
typedef uint16_t enum16_t
typedef uint8_t enum8_t
typedef uint32_t utc_time_t

Enumeration Type Documentation

A success or failure status, used as a system-wide return type for functions.

Enumerator
EMBER_ZCL_STATUS_SUCCESS

The operation was successful.

EMBER_ZCL_STATUS_FAILURE

The operation was not successful.

EMBER_ZCL_STATUS_NOT_AUTHORIZED

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

EMBER_ZCL_STATUS_RESERVED_FIELD_NOT_ZERO

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

EMBER_ZCL_STATUS_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 missing fields. Command not carried out.

EMBER_ZCL_STATUS_UNSUP_CLUSTER_COMMAND

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

EMBER_ZCL_STATUS_UNSUP_GENERAL_COMMAND

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

EMBER_ZCL_STATUS_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.

EMBER_ZCL_STATUS_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.

EMBER_ZCL_STATUS_INVALID_FIELD

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

EMBER_ZCL_STATUS_UNSUPPORTED_ATTRIBUTE

The specified attribute does not exist on the device.

EMBER_ZCL_STATUS_INVALID_VALUE

An out of range error, or set to a reserved value. An attribute keeps its old value. Note that an attribute value may be out of range if the attribute is related to another, e.g., with minimum and maximum attributes. See the individual attribute descriptions in ZCL specification for specific details.

EMBER_ZCL_STATUS_READ_ONLY

Attempt to write a read only attribute.

EMBER_ZCL_STATUS_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.

EMBER_ZCL_STATUS_DUPLICATE_EXISTS

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

EMBER_ZCL_STATUS_NOT_FOUND

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

EMBER_ZCL_STATUS_UNREPORTABLE_ATTRIBUTE

Periodic reports cannot be issued for this attribute.

EMBER_ZCL_STATUS_INVALID_DATA_TYPE

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

EMBER_ZCL_STATUS_INVALID_SELECTOR

The selector for an attribute is incorrect.

EMBER_ZCL_STATUS_WRITE_ONLY

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

EMBER_ZCL_STATUS_INCONSISTENT_STARTUP_STATE

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

EMBER_ZCL_STATUS_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.

EMBER_ZCL_STATUS_INCONSISTENT

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

EMBER_ZCL_STATUS_ACTION_DENIED

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

EMBER_ZCL_STATUS_TIMEOUT

The exchange was aborted due to excessive response time.

EMBER_ZCL_STATUS_ABORT

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

EMBER_ZCL_STATUS_INVALID_IMAGE

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

EMBER_ZCL_STATUS_WAIT_FOR_DATA

Server does not have the data block available yet.

EMBER_ZCL_STATUS_NO_IMAGE_AVAILABLE

No OTA upgrade image available for a particular client.

EMBER_ZCL_STATUS_REQUIRE_MORE_IMAGE

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

EMBER_ZCL_STATUS_NOTIFICATION_PENDING

The command has been received and is being processed.

EMBER_ZCL_STATUS_HARDWARE_FAILURE

An operation was unsuccessful due to a hardware failure.

EMBER_ZCL_STATUS_SOFTWARE_FAILURE

An operation was unsuccessful due to a software failure.

EMBER_ZCL_STATUS_CALIBRATION_ERROR

An error occurred during calibration.

EMBER_ZCL_STATUS_NULL

Distinguished value that represents a null (invalid) status.