General frame description

((_addr_type) == ZB_ZCL_ADDR_TYPE_IEEE_GPD || \
   (_addr_type) == ZB_ZCL_ADDR_TYPE_SRC_ID_GPD)

Construct ZCL header.

Note

To add Manufacturer specific field, use ZB_ZCL_CONSTRUCT_COMMAND_HEADER_EXT(), macro.

{                                                                     \
    if ((_is_manuf_spec))                                               \
    {                                                                   \
      ZB_ZCL_PACKET_PUT_DATA16_VAL((_data_ptr), (_manuf_specific));     \
    }                                                                   \
    ZB_ZCL_PACKET_PUT_DATA8((_data_ptr), (_tsn));                       \
    ZB_ZCL_PACKET_PUT_DATA8((_data_ptr), (_cmd_id));                    \
  }

Construct ZCL header, Manufacturer specific value is conditionally supported.

(ZB_ZCL_CONSTRUCT_SET_FRAME_CONTROL(*(buf_ptr),                    \
        ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC,                          \
        ZB_ZCL_NOT_MANUFACTURER_SPECIFIC,                            \
        ZB_ZCL_FRAME_DIRECTION_TO_CLI,                               \
        ZB_ZCL_DISABLE_DEFAULT_RESPONSE),                            \
    (buf_ptr)++)
ZB_ZCL_FRAME_DIRECTION_TO_CLI
#define ZB_ZCL_FRAME_DIRECTION_TO_CLI
Definition: zb_zcl_common.h:1053
ZB_ZCL_NOT_MANUFACTURER_SPECIFIC
#define ZB_ZCL_NOT_MANUFACTURER_SPECIFIC
Definition: zb_zcl_common.h:1006
ZB_ZCL_DISABLE_DEFAULT_RESPONSE
#define ZB_ZCL_DISABLE_DEFAULT_RESPONSE
Definition: zb_zcl_common.h:1032
ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC
#define ZB_ZCL_FRAME_TYPE_CLUSTER_SPECIFIC
Definition: zb_zcl_common.h:987

Construct ZCL header frame control value for cluster-specific command response.

  zb_uint8_t* ptr = ZB_ZCL_START_PACKET(param);
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr);
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER(ptr, ZB_ZCL_GET_SEQ_NUM(), ZB_ZCL_CMD_DOOR_LOCK_OPERATION_EVENT_NOTIFICATION_ID);

(ZB_MEMCPY(                                       \
      (dst),                                        \
      ZB_BUF_GET_PARAM((buf), zb_zcl_parsed_hdr_t), \
      sizeof(zb_zcl_parsed_hdr_t)))
zb_zcl_parsed_hdr_s
Definition: zb_zcl_common.h:1145
ZB_BUF_GET_PARAM
#define ZB_BUF_GET_PARAM(buf, type)
Definition: zboss_api_buf.h:466

Copy parsed ZCL header from buffer.

Parameters

buf	- ID zb_bufid_t of buffer containing parsed ZCL header as parameter
dst	- pointer to the memory area to copy header to

Disable default response

Enable default response

Command sent from server to a client

Command sent from client to a server

Command is specific to a cluster

Command acts across the entire profile

Command refers to manufacturer-specific profile extension. Manufacturer code field shall be included into ZCL frame header.

Standard profile command. Manufacturer code field shall not be included into ZCL frame header.

Extract common addressing data from parsed ZCL structure.

Parameters

header

- pointer to the parsed ZCL header structure (see zb_zcl_parsed_hdr_s).

{                                                                                              \
  zb_uint8_t* ptr = ZB_ZCL_START_PACKET_REQ(buffer)                                            \
  ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_REQ_FRAME_CONTROL(ptr, dis_default_resp)                   \
  ZB_ZCL_CONSTRUCT_COMMAND_HEADER_REQ(ptr, ZB_ZCL_GET_SEQ_NUM(), command_id);                  \
  ZB_ZCL_FINISH_PACKET(buffer, ptr)                                                           \
  ZB_ZCL_SEND_COMMAND_SHORT(buffer, addr, dst_addr_mode, dst_ep, ep, prof_id, cluster_id, cb); \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame. 
Definition: zb_zcl_common.h:1443

General macro for sending a command with empty payload.

Parameters

buffer	to put command payload and headers to
addr	address to send to
dst_addr_mode	destination address mode
dst_ep	destination endpoint
ep	source endpoint
prof_id	profile the command belongs to
dis_default_resp	"Disable default response" flag
cluster_id	cluster identifier
command_id	command identifier
cb	command send status callback

#define ZB_ZCL_DOOR_LOCK_SEND_LOCK_DOOR_REQ(buffer,           \
                                            dst_addr,         \
                                            dst_addr_mode,    \
                                            dst_ep,           \
                                            ep,               \
                                            dis_default_resp, \
                                            cb)               \
  ZB_ZCL_SEND_CMD(  buffer,                                   \
                    dst_addr,                                 \
                    dst_addr_mode,                            \
                    dst_ep,                                   \
                    ep,                                       \
                    ZB_AF_HA_PROFILE_ID,                      \
                    dis_default_resp,                         \
                    ZB_ZCL_CLUSTER_ID_DOOR_LOCK,              \
                    ZB_ZCL_CMD_DOOR_LOCK_LOCK_DOOR,           \
                    cb)

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.

Attribute address info structure

Type for possible values of Disable default response subfield of FCF in ZCL frame.

Holds one of zcl_disable_default_response. Kept for backward compatibility as zcl_disable_default_response were declared previously as enum.

ZCL frame control field.

See also

ZCL spec, subclause 2.3.1.1

Type for ZCL frame direction.

Holds one of zcl_frame_direction. Kept only for backward compatibility as zcl_frame_direction were declared previously as enum.

ZCL frame header with manufacturer code.

See also

ZCL spec, subclause 2.3.1

ZCL frame header without manufacturer code.

See also

ZCL spec, subclause 2.3.1

Type for ZCL frame type.

Type for return statuses of mathematical operations.

Parsed ZCL header

Construct ZCL command header in the buffer.

Parameters

zbbuf	buffer ID
frame_ctl	Frame Control field for ZCL packet
manuf_code	manufacturer code, not used manufacturer-specific flag is not set
cmd_id	ZCL command id
tsn	pointer to variable (may be NULL) for TSN value of ZCL packet (generated by the function)

Returns pointer to the buffer data begin after ZCL header (where command payload can be placed if needed).