Logo
Developing with ZBOSS for Zigbee
Data Structures | Functions
ZCL Direct Configuration cluster
Zigbee stack API » Zigbee Direct API

Data Structures

struct  zb_zcl_direct_configuration_configure_interface_req_s
 Configure Interface Request parameters. More...
 
struct  zb_zcl_direct_configuration_configure_interface_resp_s
 Configure Interface Response parameters. More...
 
struct  zb_zcl_direct_configuration_configure_anonymous_join_timeout_req_s
 Configure Anonymous Join Timeout Request parameters. More...
 

Functions

void zb_zcl_direct_configuration_write_attr_hook (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value)
 Hook on Write attribute. More...
 

Zigbee Direct Configuration cluster attributes

enum  zb_zcl_direct_configuration_attr_e { ZB_ZCL_ATTR_DIRECT_CONFIGURATION_INTERFACE_STATE_ID = 0x0000, ZB_ZCL_ATTR_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_ID = 0x0001 }
 Zigbee Direct Configuration cluster attribute identifiers. More...
 
enum  zb_zcl_direct_configuration_interface_state_bits_e { ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_CURRENT_STATE = 0 }
 Interface State Bitmap definition. Bitmap part. More...
 
typedef enum zb_zcl_direct_configuration_interface_state_bits_e zb_zcl_direct_configuration_interface_state_bits_t
 Interface State Bitmap definition. Bitmap part. More...
 
typedef zb_uint8_t zb_zcl_direct_configuration_interface_state_attr_t
 Interface State Bitmap definition. More...
 
typedef zb_uint24_t zb_zcl_direct_configuration_anonymous_join_timeout_attr_t
 Anonymous Join Timeout definition. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_EMPTY_VALUE   0x00
 Empty value of Interface State attribute. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_GET_CURRENT_STATE(state_bitmap)   ZB_CHECK_BIT_IN_BIT_VECTOR((&(state_bitmap)), ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_CURRENT_STATE)
 Get Current State from the Interface State Bitmap. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_SET_CURRENT_STATE(state_bitmap, current_state)   ZB_ASSIGN_BIT_IN_BIT_VECTOR((&(state_bitmap)), ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_CURRENT_STATE, current_state)
 Set Current State from the Interface State Bitmap. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_EMPTY_VALUE   60U
 Empty value of Anonymous Join Timeout, 13.3.5.3.2. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_GET_CURRENT_VALUE_U32(attr_p)   ZB_GET_UINT32_FROM_UINT24(*((zb_uint24_t *)(attr_p)->data_p))
 Get Current Anonymous Join Timeout value as zb_uint32_t. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_SET_CURRENT_VALUE_U32(attr_p, value_u32)
 Set Current Anonymous Join Timeout value. More...
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_INTERFACE_STATE_ID(data_ptr)
 
#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_ID(data_ptr)
 
#define ZB_ZCL_DIRECT_CONFIGURATION_REPORT_ATTR_COUNT   0
 
#define ZB_ZCL_DECLARE_DIRECT_CONFIGURATION_INFORMATION_ATTRIB_LIST(attr_list, interface_state, anonymous_join_timeout)
 Declare attribute list for Zigbee Direct Configuration cluster - server side (Information Attribute set) More...
 

Zigbee Direct Configuration cluster commands

enum  zb_zcl_direct_configuration_cmd_e { ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_ID = 0x00, ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_ANONYMOUS_TIMEOUT_JOIN_ID = 0x01 }
 Command identifiers for Zigbee Direct Configuration cluster. More...
 
enum  zb_zcl_direct_configuration_cmd_resp_e { ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_RESP_ID = 0x00 }
 Command response identifiers for Zigbee Direct Configuration cluster. More...
 
typedef struct zb_zcl_direct_configuration_configure_interface_req_s zb_zcl_direct_configuration_configure_interface_req_t
 Configure Interface Request parameters. More...
 
typedef struct zb_zcl_direct_configuration_configure_interface_resp_s zb_zcl_direct_configuration_configure_interface_resp_t
 Configure Interface Response parameters. More...
 
typedef struct zb_zcl_direct_configuration_configure_anonymous_join_timeout_req_s zb_zcl_direct_configuration_configure_anonymous_join_timeout_req_t
 Configure Anonymous Join Timeout Request parameters. More...
 
void zb_zcl_direct_configuration_init_server (void)
 
void zb_zcl_direct_configuration_init_client (void)
 
void zb_zcl_direct_configuration_anonymous_join_timer_start (zb_uint8_t endpoint)
 Start or restart Anonymous Join timer from Anonymous Join Timeout value. More...
 
zb_bool_t zb_zcl_direct_configuration_anonymous_join_enabled (void)
 Check if current value of Anonymous Join timer is bigger than 0. More...
 
zb_bool_t zb_zcl_direct_configuration_is_client_authorized (zb_uint16_t client_short_addr)
 
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_GENERATED_CMD_LIST   ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_RESP_ID
 
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_GENERATED_CMD_LIST
 
#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_OFF   0u
 Disable BLE interface. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_ON   1u
 Enable BLE interface. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_MIN_VALUE   0x000000U
 
#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_MAX_VALUE   0x100000U
 
#define ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ZBD_INTERFACE_REQ(buffer, dst_addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, callback, interface_state)
 Send Configure Zigbee Direct Interface command The command can be sent only with unicast addressing mode. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ZBD_INTERFACE_RES( buffer, seq_num, dst_addr, dst_ep, ep, prof_id, callback, status, interface_state)
 Send Configure Zigbee Direct Interface Response command. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_INTERFACE_REQ(data_ptr, buffer, status)
 Macro for getting Configure Zigbee Direct Interface command payload, see ZB Direct spec 13.3.5.4.2. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_INTERFACE_RESP(data_ptr, buffer, parse_status)
 Macro for getting Configure Zigbee Direct Interface Response command payload, see ZB Direct spec 13.3.5.5.1. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ANONYMOUS_JOIN_TIMEOUT_REQ( buffer, dst_addr, dst_addr_mode, dst_ep, ep, prof_id, dis_default_resp, callback, anonymous_join_timeout)
 Send Configure Zigbee Direct Anonymous Join Timeout command The command can be sent only with unicast addressing mode. More...
 
#define ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_ANONYMOUS_JOIN_TIMEOUT_REQ(data_ptr, buffer, status)
 Macro for getting Configure Zigbee Direct Anonymous Join Timeout command payload, see ZB Direct spec 13.3.5.4.4. More...
 
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_INIT   zb_zcl_direct_configuration_init_server
 
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_INIT   zb_zcl_direct_configuration_init_client
 

Detailed Description

Macro Definition Documentation

§ ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_ID

#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_ID (   data_ptr)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
ZB_ZCL_ATTR_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_ID, \
ZB_ZCL_ATTR_TYPE_U24, \
ZB_ZCL_ATTR_ACCESS_READ_ONLY, \
(ZB_ZCL_NON_MANUFACTURER_SPECIFIC), \
(void*) data_ptr \
}
ZB_ZCL_NON_MANUFACTURER_SPECIFIC
#define ZB_ZCL_NON_MANUFACTURER_SPECIFIC
Definition: zb_zcl_common.h:1034

§ ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_INTERFACE_STATE_ID

#define ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_INTERFACE_STATE_ID (   data_ptr)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
ZB_ZCL_ATTR_DIRECT_CONFIGURATION_INTERFACE_STATE_ID, \
ZB_ZCL_ATTR_TYPE_8BITMAP, \
ZB_ZCL_ATTR_ACCESS_READ_ONLY, \
(ZB_ZCL_NON_MANUFACTURER_SPECIFIC), \
(void*) data_ptr \
}
ZB_ZCL_NON_MANUFACTURER_SPECIFIC
#define ZB_ZCL_NON_MANUFACTURER_SPECIFIC
Definition: zb_zcl_common.h:1034

§ ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_GENERATED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_GENERATED_CMD_LIST

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_ID, \
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_ANONYMOUS_TIMEOUT_JOIN_ID
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_ID
Definition: zb_zcl_direct_configuration.h:189

§ ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_INIT   zb_zcl_direct_configuration_init_client

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_RECEIVED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_GENERATED_CMD_LIST

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_GENERATED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_GENERATED_CMD_LIST   ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_RESP_ID

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_INIT   zb_zcl_direct_configuration_init_server

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_RECEIVED_CMD_LIST

#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_SERVER_ROLE_RECEIVED_CMD_LIST   ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION_CLIENT_ROLE_GENERATED_CMD_LIST

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_DECLARE_DIRECT_CONFIGURATION_INFORMATION_ATTRIB_LIST

#define ZB_ZCL_DECLARE_DIRECT_CONFIGURATION_INFORMATION_ATTRIB_LIST (   attr_list,
  interface_state,
  anonymous_join_timeout 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_INTERFACE_STATE_ID(interface_state), \
ZB_SET_ATTR_DESCR_WITH_ZB_ZCL_ATTR_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_ID(anonymous_join_timeout), \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Zigbee Direct Configuration cluster - server side (Information Attribute set)

Parameters
attr_list- attribute list name
interface_state- pointer to variable to store Interface State attribute
anonymous_join_timeout- pointer to variable to store Anonymous Join Timeout

§ ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_EMPTY_VALUE

#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_EMPTY_VALUE   60U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Empty value of Anonymous Join Timeout, 13.3.5.3.2.

§ ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_GET_CURRENT_VALUE_U32

#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_GET_CURRENT_VALUE_U32 (   attr_p)    ZB_GET_UINT32_FROM_UINT24(*((zb_uint24_t *)(attr_p)->data_p))

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Get Current Anonymous Join Timeout value as zb_uint32_t.

Parameters
attr_ppointer to zb_zcl_direct_configuration_anonymous_join_timeout_attr_t
Returns
zb_uint32_t representing current Anonymous Join Timeout value

§ ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_MAX_VALUE

#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_MAX_VALUE   0x100000U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_MIN_VALUE

#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_MIN_VALUE   0x000000U

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_SET_CURRENT_VALUE_U32

#define ZB_ZCL_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_SET_CURRENT_VALUE_U32 (   attr_p,
  value_u32 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
do \
{ \
*((zb_uint24_t *)((attr_p)->data_p)) \
= (zb_zcl_direct_configuration_anonymous_join_timeout_attr_t)ZB_ASSIGN_UINT24_FROM_UINT32( \
value_u32); \
} while (ZB_FALSE)
zb_zcl_direct_configuration_anonymous_join_timeout_attr_t
zb_uint24_t zb_zcl_direct_configuration_anonymous_join_timeout_attr_t
Anonymous Join Timeout definition.
Definition: zb_zcl_direct_configuration.h:107
ZB_FALSE
#define ZB_FALSE
Definition: zb_types.h:349

Set Current Anonymous Join Timeout value.

Parameters
attr_pattribute pointer
value_u32desired value to be set

§ ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_ANONYMOUS_JOIN_TIMEOUT_REQ

#define ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_ANONYMOUS_JOIN_TIMEOUT_REQ (   data_ptr,
  buffer,
  status 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
zb_uint8_t *data = zb_buf_begin(buffer); \
if (zb_buf_len((buffer)) != \
sizeof(zb_uint24_t)) \
{ \
(status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
ZB_ZCL_PACKET_GET_DATA24(&(data_ptr)->anonymous_join_timeout, data); \
(status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
} \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:339
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:338
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:354
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:372

Macro for getting Configure Zigbee Direct Anonymous Join Timeout command payload, see ZB Direct spec 13.3.5.4.4.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_direct_configuration_configure_anonymous_join_timeout_req_t.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).

§ ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_INTERFACE_REQ

#define ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_INTERFACE_REQ (   data_ptr,
  buffer,
  status 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
zb_uint8_t *data = zb_buf_begin(buffer); \
if (zb_buf_len((buffer)) != \
sizeof(zb_uint8_t)) \
{ \
(status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
ZB_ZCL_PACKET_GET_DATA8(&(data_ptr)->interface_state, data); \
(status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
} \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:339
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:338
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:354
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:147
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:372

Macro for getting Configure Zigbee Direct Interface command payload, see ZB Direct spec 13.3.5.4.2.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_direct_configuration_configure_interface_req_t.
buffercontaining the packet (by pointer).
status- variable to put parse status to (see zb_zcl_parse_status_t).

§ ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_INTERFACE_RESP

#define ZB_ZCL_DIRECT_CONFIGURATION_GET_CONFIGURE_INTERFACE_RESP (   data_ptr,
  buffer,
  parse_status 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
zb_uint8_t *data = zb_buf_begin(buffer); \
if (zb_buf_len((buffer)) != \
sizeof(zb_uint8_t) + sizeof(zb_uint8_t)) \
{ \
(parse_status) = ZB_ZCL_PARSE_STATUS_FAILURE; \
} \
else \
{ \
ZB_ZCL_PACKET_GET_DATA8(&(data_ptr)->status, data); \
ZB_ZCL_PACKET_GET_DATA8(&(data_ptr)->interface_state, data); \
(parse_status) = ZB_ZCL_PARSE_STATUS_SUCCESS; \
} \
}
ZB_ZCL_PARSE_STATUS_FAILURE
Definition: zb_zcl_common.h:339
ZB_ZCL_PARSE_STATUS_SUCCESS
Definition: zb_zcl_common.h:338
zb_buf_begin
#define zb_buf_begin(buf)
Definition: zboss_api_buf.h:354
zb_uint8_t
unsigned char zb_uint8_t
Project-local 1-byte unsigned int type.
Definition: zb_types.h:147
zb_buf_len
#define zb_buf_len(buf)
Definition: zboss_api_buf.h:372

Macro for getting Configure Zigbee Direct Interface Response command payload, see ZB Direct spec 13.3.5.5.1.

Attention
Assumes that ZCL header already cut.
Parameters
data_ptr- pointer to a variable of type zb_zcl_direct_configuration_configure_interface_resp_t.
buffercontaining the packet (by pointer).
parse_status- variable to put parse status to (see zb_zcl_parse_status_t).

§ ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_EMPTY_VALUE

#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_EMPTY_VALUE   0x00

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Empty value of Interface State attribute.

§ ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_GET_CURRENT_STATE

#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_GET_CURRENT_STATE (   state_bitmap)    ZB_CHECK_BIT_IN_BIT_VECTOR((&(state_bitmap)), ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_CURRENT_STATE)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Get Current State from the Interface State Bitmap.

See also
zb_zcl_direct_configuration_interface_state_bits_t definition.
Parameters
state_bitmap- zb_zcl_direct_configuration_interface_state_attr_t value.
Returns
true or false.

§ ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_OFF

#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_OFF   0u

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Disable BLE interface.

See also
ZB Direct spec B.3.5.4.2.2

§ ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_ON

#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_ON   1u

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Enable BLE interface.

See also
ZB Direct spec B.3.5.4.2.2

§ ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_SET_CURRENT_STATE

#define ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_SET_CURRENT_STATE (   state_bitmap,
  current_state 
)    ZB_ASSIGN_BIT_IN_BIT_VECTOR((&(state_bitmap)), ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_CURRENT_STATE, current_state)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Set Current State from the Interface State Bitmap.

See also
zb_zcl_direct_configuration_interface_state_bits_t definition.
Parameters
state_bitmap- zb_zcl_direct_configuration_interface_state_attr_t value.
current_stateCurrent interface state (1U = enabled, 0U = disabled)

§ ZB_ZCL_DIRECT_CONFIGURATION_REPORT_ATTR_COUNT

#define ZB_ZCL_DIRECT_CONFIGURATION_REPORT_ATTR_COUNT   0

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ANONYMOUS_JOIN_TIMEOUT_REQ

#define ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ANONYMOUS_JOIN_TIMEOUT_REQ (   buffer,
  dst_addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prof_id,
  dis_default_resp,
  callback,
  anonymous_join_timeout 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
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(), \
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_ANONYMOUS_TIMEOUT_JOIN_ID); \
ZB_ZCL_PACKET_PUT_DATA24(ptr, &(anonymous_join_timeout)); \
ZB_ZCL_FINISH_PACKET(buffer, ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, \
dst_addr, \
dst_addr_mode, \
dst_ep, \
ep, \
prof_id, \
ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION, \
callback); \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1470
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_ANONYMOUS_TIMEOUT_JOIN_ID
Definition: zb_zcl_direct_configuration.h:191
ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION
Definition: zb_zcl_common.h:312

Send Configure Zigbee Direct Anonymous Join Timeout command The command can be sent only with unicast addressing mode.

Parameters
bufferto put packet to
dst_addr- address to send packet to
dst_addr_mode- addressing mode. ZB_APS_ADDR_MODE_16_ENDP_PRESENT will fit
dst_ep- destination endpoint
ep- sending endpoint
prof_id- profile identifier
dis_default_resp- enable/disable default response
callbackfor getting command send status
anonymous_join_timeout- requested state of ZBD interface

§ ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ZBD_INTERFACE_REQ

#define ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ZBD_INTERFACE_REQ (   buffer,
  dst_addr,
  dst_addr_mode,
  dst_ep,
  ep,
  prof_id,
  dis_default_resp,
  callback,
  interface_state 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
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(), \
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_ID); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (interface_state)); \
ZB_ZCL_FINISH_PACKET(buffer, ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, \
dst_addr, \
dst_addr_mode, \
dst_ep, \
ep, \
prof_id, \
ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION, \
callback); \
}
ZB_ZCL_GET_SEQ_NUM
#define ZB_ZCL_GET_SEQ_NUM()
Return next sequence number for ZCL frame.
Definition: zb_zcl_common.h:1470
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_ID
Definition: zb_zcl_direct_configuration.h:189
ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION
Definition: zb_zcl_common.h:312

Send Configure Zigbee Direct Interface command The command can be sent only with unicast addressing mode.

Parameters
bufferto put packet to
dst_addr- address to send packet to
dst_addr_mode- addressing mode. ZB_APS_ADDR_MODE_16_ENDP_PRESENT will fit
dst_ep- destination endpoint
ep- sending endpoint
prof_id- profile identifier
dis_default_resp- enable/disable default response
callbackfor getting command send status
interface_state- requested state of ZBD interface

§ ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ZBD_INTERFACE_RES

#define ZB_ZCL_DIRECT_CONFIGURATION_SEND_CONFIGURE_ZBD_INTERFACE_RES (   buffer,
  seq_num,
  dst_addr,
  dst_ep,
  ep,
  prof_id,
  callback,
  status,
  interface_state 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Value:
{ \
zb_uint8_t* ptr = ZB_ZCL_START_PACKET(buffer); \
ZB_ZCL_CONSTRUCT_SPECIFIC_COMMAND_RES_FRAME_CONTROL(ptr); \
ZB_ZCL_CONSTRUCT_COMMAND_HEADER( \
ptr, \
seq_num, \
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_RESP_ID); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (status)); \
ZB_ZCL_PACKET_PUT_DATA8(ptr, (interface_state)); \
ZB_ZCL_FINISH_PACKET(buffer, ptr) \
ZB_ZCL_SEND_COMMAND_SHORT( \
buffer, \
dst_addr, \
ZB_APS_ADDR_MODE_16_ENDP_PRESENT, \
dst_ep, \
ep, \
prof_id, \
ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION, \
callback); \
}
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_RESP_ID
Definition: zb_zcl_direct_configuration.h:200
ZB_ZCL_START_PACKET
#define ZB_ZCL_START_PACKET(zbbuf)
Initializes zb_buf_t buffer and returns pointer to the beginning of array.
Definition: zb_zcl_common.h:1550
ZB_APS_ADDR_MODE_16_ENDP_PRESENT
#define ZB_APS_ADDR_MODE_16_ENDP_PRESENT
Definition: zboss_api_aps.h:107
ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION
#define ZB_ZCL_CLUSTER_ID_DIRECT_CONFIGURATION
Definition: zb_zcl_common.h:312

Send Configure Zigbee Direct Interface Response command.

Parameters
bufferto put packet to
seq_num- ZCL sequence number
dst_addr- address to send packet to
dst_ep- destination endpoint
ep- sending endpoint
prof_id- profile identifier
callbackfor getting command send status
statusof the corresponding Configure Zigbee Direct Interface command execution. Appropriate values (defined in zcl_status enumeration)are:
interface_state- current state of ZBD interface

Typedef Documentation

§ zb_zcl_direct_configuration_anonymous_join_timeout_attr_t

typedef zb_uint24_t zb_zcl_direct_configuration_anonymous_join_timeout_attr_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Anonymous Join Timeout definition.

See also
ZB Direct spec, 13.3.5.3.2

§ zb_zcl_direct_configuration_configure_anonymous_join_timeout_req_t

typedef struct zb_zcl_direct_configuration_configure_anonymous_join_timeout_req_s zb_zcl_direct_configuration_configure_anonymous_join_timeout_req_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Configure Anonymous Join Timeout Request parameters.

§ zb_zcl_direct_configuration_configure_interface_req_t

typedef struct zb_zcl_direct_configuration_configure_interface_req_s zb_zcl_direct_configuration_configure_interface_req_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Configure Interface Request parameters.

§ zb_zcl_direct_configuration_configure_interface_resp_t

typedef struct zb_zcl_direct_configuration_configure_interface_resp_s zb_zcl_direct_configuration_configure_interface_resp_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Configure Interface Response parameters.

§ zb_zcl_direct_configuration_interface_state_attr_t

typedef zb_uint8_t zb_zcl_direct_configuration_interface_state_attr_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Interface State Bitmap definition.

See also
ZB Direct spec, 13.3.5.3.1

Bit 0 specifies the current state of the Zigbee Direct interface as follows: 1 = enabled, 0 = disabled. All other bits are reserved.

See also
zb_zcl_direct_configuration_interface_state_bits_t enum.

§ zb_zcl_direct_configuration_interface_state_bits_t

typedef enum zb_zcl_direct_configuration_interface_state_bits_e zb_zcl_direct_configuration_interface_state_bits_t

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Interface State Bitmap definition. Bitmap part.

Note
This enumeration defines bit position (bit-shift) of specified value in bitmap
See also
ZB Direct spec, 13.3.5.3.1.

Enumeration Type Documentation

§ zb_zcl_direct_configuration_attr_e

enum zb_zcl_direct_configuration_attr_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Zigbee Direct Configuration cluster attribute identifiers.

See also
ZB Direct spec, Zigbee Direct Configuration Cluster, 13.3
Enumerator
ZB_ZCL_ATTR_DIRECT_CONFIGURATION_INTERFACE_STATE_ID 

Interface State attribute, ZB Direct spec 13.3.5.2.

ZB_ZCL_ATTR_DIRECT_CONFIGURATION_ANONYMOUS_JOIN_TIMEOUT_ID 

Interface State attribute, ZB Direct spec 13.3.5.2.

§ zb_zcl_direct_configuration_cmd_e

enum zb_zcl_direct_configuration_cmd_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Command identifiers for Zigbee Direct Configuration cluster.

See also
ZB Direct spec, subclause 13.3.5.4
Enumerator
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_ID 

"Turn off" command.

ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_ANONYMOUS_TIMEOUT_JOIN_ID 

§ zb_zcl_direct_configuration_cmd_resp_e

enum zb_zcl_direct_configuration_cmd_resp_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Command response identifiers for Zigbee Direct Configuration cluster.

See also
ZB Direct spec, subclause 13.3.5.4
Enumerator
ZB_ZCL_CMD_DIRECT_CONFIGURATION_CONFIGURE_ZBD_INTERFACE_RESP_ID 

§ zb_zcl_direct_configuration_interface_state_bits_e

enum zb_zcl_direct_configuration_interface_state_bits_e

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Interface State Bitmap definition. Bitmap part.

Note
This enumeration defines bit position (bit-shift) of specified value in bitmap
See also
ZB Direct spec, 13.3.5.3.1.
Enumerator
ZB_ZCL_DIRECT_CONFIGURATION_INTERFACE_STATE_CURRENT_STATE 

Bit 0 specifies the current state of the Zigbee Direct interface as follows: 1 = enabled, 0 = disabled.

Function Documentation

§ zb_zcl_direct_configuration_anonymous_join_enabled()

zb_bool_t zb_zcl_direct_configuration_anonymous_join_enabled ( void  )

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Check if current value of Anonymous Join timer is bigger than 0.

Returns
ZB_TRUE if Anonymous Join for provisioned ZDD is enabled

§ zb_zcl_direct_configuration_anonymous_join_timer_start()

void zb_zcl_direct_configuration_anonymous_join_timer_start ( zb_uint8_t  endpoint)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Start or restart Anonymous Join timer from Anonymous Join Timeout value.

Parameters
endpointendpoint of Zigbee Direct Configuration cluster

§ zb_zcl_direct_configuration_init_client()

void zb_zcl_direct_configuration_init_client ( void  )

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ zb_zcl_direct_configuration_init_server()

void zb_zcl_direct_configuration_init_server ( void  )

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ zb_zcl_direct_configuration_is_client_authorized()

zb_bool_t zb_zcl_direct_configuration_is_client_authorized ( zb_uint16_t  client_short_addr)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

§ zb_zcl_direct_configuration_write_attr_hook()

void zb_zcl_direct_configuration_write_attr_hook ( zb_uint8_t  endpoint,
zb_uint16_t  attr_id,
zb_uint8_t *  new_value 
)

#include </conan-data/ti_zigbee/9.14.00.04/library-lprf/ga/build/f6d18801b7b469a709ae7e8290b03ecdc7a7ad4c/zboss_r23/include/zcl/zb_zcl_direct_configuration.h>

Hook on Write attribute.

Parameters
endpoint- endpoint number
attr_id- ID of attribute being written
new_value- pointer to new value of attribute
Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA. http://www.dsr-zboss.com http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.