General frame description

Data Structures
struct	zb_zcl_frame_ctrl_s
	ZCL frame control field. More...
struct	zb_zcl_frame_hdr_full_s
	ZCL frame header with manufacturer code. More...
struct	zb_zcl_frame_hdr_short_s
	ZCL frame header without manufacturer code. More...
struct	zb_zcl_addr_s
	Type to represent source address of ZCL message. More...
struct	zb_zcl_parsed_hdr_s
struct	zb_zcl_attr_addr_info_s

Typedefs
typedef enum zb_zcl_frame_type_e	zb_zcl_frame_type_t
	ZCL frame type. More...
typedef enum zb_zcl_manufacturer_specific_e	zb_zcl_manufacturer_specific_t
	Values for Manufacturer-specific subfield of FCF in ZCL frame. More...
typedef enum zb_zcl_disable_default_response_e	zb_zcl_disable_default_response_t
	Values for Disable default response subfield of FCF in ZCL frame. More...
typedef enum zb_zcl_frame_direction_e	zb_zcl_frame_direction_t
	ZCL frame direction. More...
typedef struct zb_zcl_frame_ctrl_s	zb_zcl_frame_ctrl_t
	ZCL frame control field. More...
typedef struct zb_zcl_frame_hdr_full_s	zb_zcl_frame_hdr_full_t
	ZCL frame header with manufacturer code. More...
typedef struct zb_zcl_frame_hdr_short_s	zb_zcl_frame_hdr_short_t
	ZCL frame header without manufacturer code. More...
typedef struct zb_zcl_addr_s	zb_zcl_addr_t
	Type to represent source address of ZCL message. More...
typedef struct zb_zcl_parsed_hdr_s	zb_zcl_parsed_hdr_t
typedef struct zb_zcl_attr_addr_info_s	zb_zcl_attr_addr_info_t

Enumerations
enum	zb_zcl_frame_type_e { ZB_ZCL_FRAME_TYPE_COMMON = 0x00, ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC = 0x01 }
	ZCL frame type. More...
enum	zb_zcl_manufacturer_specific_e { ZB_ZCL_NOT_MANUFACTURER_SPECIFIC = 0x00, ZB_ZCL_MANUFACTURER_SPECIFIC = 0x01 }
	Values for Manufacturer-specific subfield of FCF in ZCL frame. More...
enum	zb_zcl_disable_default_response_e { ZB_ZCL_ENABLE_DEFAULT_RESPONSE = 0x00, ZB_ZCL_DISABLE_DEFAULT_RESPONSE = 0x01 }
	Values for Disable default response subfield of FCF in ZCL frame. More...
enum	zb_zcl_frame_direction_e { ZB_ZCL_FRAME_DIRECTION_TO_SRV = 0x00, ZB_ZCL_FRAME_DIRECTION_TO_CLI = 0x01 }
	ZCL frame direction. More...
enum	zb_zcl_addr_type_e { ZB_ZCL_ADDR_TYPE_SHORT, ZB_ZCL_ADDR_TYPE_IEEE_GPD, ZB_ZCL_ADDR_TYPE_SRC_ID_GPD, ZB_ZCL_ADDR_TYPE_IEEE }
	Possible address types of devices from which ZCL message is received.

Detailed Description

Types and macros required for ZCL frame manipulations

Typedef Documentation

typedef struct zb_zcl_addr_s zb_zcl_addr_t

Type to represent source address of ZCL message.

It is needed if ZGP sink is enabled and therefore messages can be received from ZGPD devices which are identified by 32-bit source Id.

typedef struct zb_zcl_attr_addr_info_s zb_zcl_attr_addr_info_t

Attribute address info structure

typedef enum zb_zcl_disable_default_response_e zb_zcl_disable_default_response_t

Values for Disable default response subfield of FCF in ZCL frame.

See Also

ZCL spec, subclause 2.3.1.1.3.

typedef struct zb_zcl_frame_ctrl_s zb_zcl_frame_ctrl_t

ZCL frame control field.

See Also

ZCL spec, subclause 2.3.1.1

typedef enum zb_zcl_frame_direction_e zb_zcl_frame_direction_t

ZCL frame direction.

See Also

ZCL spec, subclause 2.3.1.1.3.

typedef struct zb_zcl_frame_hdr_full_s zb_zcl_frame_hdr_full_t

ZCL frame header with manufacturer code.

See Also

ZCL spec, subclause 2.3.1

typedef struct zb_zcl_frame_hdr_short_s zb_zcl_frame_hdr_short_t

ZCL frame header without manufacturer code.

See Also

ZCL spec, subclause 2.3.1

typedef enum zb_zcl_frame_type_e zb_zcl_frame_type_t

ZCL frame type.

Defines Permitted values for Frame Type subfield of Frame Control field in ZCL frame.

See Also

ZCL spec, subclause 2.3.1.1.1.

typedef enum zb_zcl_manufacturer_specific_e zb_zcl_manufacturer_specific_t

Values for Manufacturer-specific subfield of FCF in ZCL frame.

See Also

ZCL spec, subclause 2.3.1.1.2.

typedef struct zb_zcl_parsed_hdr_s zb_zcl_parsed_hdr_t

Parsed ZCL header

Enumeration Type Documentation

enum zb_zcl_disable_default_response_e

Values for Disable default response subfield of FCF in ZCL frame.

See Also

ZCL spec, subclause 2.3.1.1.3.

Enumerator
ZB_ZCL_ENABLE_DEFAULT_RESPONSE	Enable default response.
ZB_ZCL_DISABLE_DEFAULT_RESPONSE	Disble default response.

enum zb_zcl_frame_direction_e

ZCL frame direction.

See Also

ZCL spec, subclause 2.3.1.1.3.

Enumerator
ZB_ZCL_FRAME_DIRECTION_TO_SRV	Command sent from client to a server
ZB_ZCL_FRAME_DIRECTION_TO_CLI	Command sent from server to a client

enum zb_zcl_frame_type_e

ZCL frame type.

Defines Permitted values for Frame Type subfield of Frame Control field in ZCL frame.

See Also

ZCL spec, subclause 2.3.1.1.1.

Enumerator
ZB_ZCL_FRAME_TYPE_COMMON	Command acts across the entire profile
ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC	Command is specific to a cluster

enum zb_zcl_manufacturer_specific_e

Values for Manufacturer-specific subfield of FCF in ZCL frame.

See Also

ZCL spec, subclause 2.3.1.1.2.

Enumerator
ZB_ZCL_NOT_MANUFACTURER_SPECIFIC	Standard profile command. Manufacturer code field shall not be included into ZCL frame header.
ZB_ZCL_MANUFACTURER_SPECIFIC	Command refers to manufacturer-specific profile extension. Manufacturer code field shall be included into ZCL frame header.