Logo
Developing with ZBOSS for Zigbee
Data Structures | Macros | Typedefs | Functions
zb_zcl_ias_wd.h File Reference
#include "zcl/zb_zcl_common.h"
#include "zcl/zb_zcl_commands.h"

Data Structures

struct  zb_zcl_ias_wd_start_warning_s
 Structure representsation Start warning command. ZCL spec 8.4.2.3.1. More...
 
struct  zb_zcl_ias_wd_squawk_s
 Structure representsation Squawk command. ZCL spec 8.4.2.3.2. More...
 
struct  zb_zcl_ias_wd_start_warning_value_param_s
 Declare run Start Warning command for User Application. More...
 
struct  zb_zcl_ias_wd_start_warning_user_app_schedule_e
 
struct  zb_zcl_ias_wd_squawk_value_param_s
 Declare run Squawk command for User Application. More...
 
struct  zb_zcl_ias_wd_squawk_user_app_schedule_e
 

Macros

#define ZB_ZCL_IAS_WD_START_WARNING_SCHEDULE_USER_APP(buffer, pcmd_info, warningMode, strobe_, siren_level_, duration_, strobe_duty_cycle_, strobe_level_)
 
#define ZB_ZCL_IAS_WD_SQUAWK_SCHEDULE_USER_APP(buffer, pcmd_info, squawkMode, strobe_, level)
 
#define ZB_ZCL_CLUSTER_ID_IAS_WD_SERVER_ROLE_INIT   zb_zcl_ias_wd_init_server
 
#define ZB_ZCL_CLUSTER_ID_IAS_WD_CLIENT_ROLE_INIT   zb_zcl_ias_wd_init_client
 

Typedefs

typedef struct zb_zcl_ias_wd_start_warning_value_param_s zb_zcl_ias_wd_start_warning_value_param_t
 Declare run Start Warning command for User Application. More...
 
typedef struct zb_zcl_ias_wd_start_warning_user_app_schedule_e zb_zcl_ias_wd_start_warning_user_app_schedule_t
 
typedef struct zb_zcl_ias_wd_squawk_value_param_s zb_zcl_ias_wd_squawk_value_param_t
 Declare run Squawk command for User Application. More...
 
typedef struct zb_zcl_ias_wd_squawk_user_app_schedule_e zb_zcl_ias_wd_squawk_user_app_schedule_t
 

Functions

void zb_zcl_ias_wd_init_server (void)
 
void zb_zcl_ias_wd_init_client (void)
 

IAS WD cluster attributes

#define ZB_ZCL_IAS_WD_CLUSTER_REVISION_DEFAULT   ((zb_uint16_t)0x0002u)
 Default value for IAS WD cluster revision global attribute. More...
 
#define ZB_ZCL_ATTR_IAS_WD_MAX_DURATION_DEF_VALUE   240
 Max Duration attribute default value. More...
 
#define ZB_ZCL_ATTR_IAS_WD_MAX_DURATION_MIN_VALUE   0
 Max Duration attribute minimum value. More...
 
#define ZB_ZCL_ATTR_IAS_WD_MAX_DURATION_MAX_VALUE   0xfffe
 Max Duration attribute maximum value. More...
 
#define ZB_ZCL_DECLARE_IAS_WD_ATTRIB_LIST(attr_list, max_duration)
 Declare attribute list for IAS WD cluster - server side. More...
 
enum  zb_zcl_ias_wd_attr_e { ZB_ZCL_ATTR_IAS_WD_MAX_DURATION_ID = 0x0000 }
 IAS WD cluster attribute identifiers. More...
 

IAS WD cluster commands

#define ZB_ZCL_IAS_WD_GET_WARNING_MODE(status)   (((status) >> 4) & 0x0f)
 Get Warning Mode from payload Start warning command. More...
 
#define ZB_ZCL_IAS_WD_GET_STROBE(status)   (((status) >> 2) & 0x03)
 Get Strobe from payload Start warning command. More...
 
#define ZB_ZCL_IAS_WD_GET_SIREN_LEVEL(status)   ((status) & 0x03)
 Get Siren level from payload Start warning command. More...
 
#define ZB_ZCL_IAS_WD_MAKE_START_WARNING_STATUS(warning_mode, strobe, siren_level)   (((siren_level) & 0x03) | (((strobe) & 0x03) << 2) | (((warning_mode) & 0x0f) << 4))
 Make Status field Start warning command from Warning Mode, Strobe and Siren Level. More...
 
#define ZB_ZCL_IAS_WD_STROBE_DUTY_CYCLE_DEFAULT_VALUE   0
 Strobe Duty Cycle default value. More...
 
#define ZB_ZCL_IAS_WD_STROBE_DUTY_CYCLE_MAX_VALUE   100
 Strobe Duty Cycle maximum value. More...
 
#define ZB_ZCL_IAS_WD_SEND_START_WARNING_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, status, duration, strobe_duty_cycle, strobe_level)
 Start warning command. ZCL spec 8.4.2.3.1. More...
 
#define ZB_ZCL_IAS_WD_GET_START_WARNING_REQ(data_ptr, buffer, status)
 Macro for getting Start warning command. ZCL spec 8.4.2.3.1. More...
 
#define ZB_ZCL_IAS_WD_GET_SQUAWK_MODE(status)   (((status) >> 4) & 0x0f)
 Get Squawk Mode from payload Squawk command. More...
 
#define ZB_ZCL_IAS_WD_GET_SQUAWK_STROBE(status)   (((status) >> 3) & 0x01)
 Get Squawk Strobe from payload Squawk command. More...
 
#define ZB_ZCL_IAS_WD_GET_SQUAWK_LEVEL(status)   ((status) & 0x03)
 Get Squawk Level from payload Squawk command. More...
 
#define ZB_ZCL_IAS_WD_MAKE_SQUAWK_STATUS(mode, strobe, level)   (((level) & 0x03) | (((strobe) & 0x01) << 3) | (((mode) & 0x0f) << 4))
 Make Status field Squawk command from Squawk mode, Strobe and Squawk level. More...
 
#define ZB_ZCL_IAS_WD_SEND_SQUAWK_REQ( buffer, addr, dst_addr_mode, dst_ep, ep, prfl_id, def_resp, cb, status)
 Squawk command. ZCL spec 8.4.2.3.2. More...
 
#define ZB_ZCL_IAS_WD_GET_SQUAWK_REQ(data_ptr, buffer, status)
 Macro for getting Squawk command. ZCL spec 8.4.2.3.2. More...
 
enum  zb_zcl_ias_wd_cmd_e { ZB_ZCL_CMD_IAS_WD_START_WARNING_ID = 0x00, ZB_ZCL_CMD_IAS_WD_SQUAWK_ID = 0x01 }
 IAS WD cluster command identifiers. More...
 
enum  zb_zcl_ias_wd_warning_mode_e {
  ZB_ZCL_IAS_WD_WARNING_MODE_STOP = 0x00, ZB_ZCL_IAS_WD_WARNING_MODE_BURGLAR = 0x01, ZB_ZCL_IAS_WD_WARNING_MODE_FIRE = 0x02, ZB_ZCL_IAS_WD_WARNING_MODE_EMERGENCY = 0x03,
  ZB_ZCL_IAS_WD_WARNING_MODE_POLICE_PANIC = 0x04, ZB_ZCL_IAS_WD_WARNING_MODE_FIRE_PANIC = 0x05, ZB_ZCL_IAS_WD_WARNING_MODE_EMERGENCY_PANIC = 0x06
}
 Warning Mode Field, see ZCL spec 8.4.2.3.1.2. More...
 
enum  zb_zcl_ias_wd_strobe_e { ZB_ZCL_IAS_WD_STROBE_NO_STROBE = 0x00, ZB_ZCL_IAS_WD_STROBE_USE_STROBE = 0x01 }
 Strobe Field, see ZCL spec 8.4.2.3.1.3. More...
 
enum  zb_zcl_ias_wd_siren_level_e { ZB_ZCL_IAS_WD_SIREN_LEVEL_LOW = 0x00, ZB_ZCL_IAS_WD_SIREN_LEVEL_MEDIUM = 0x01, ZB_ZCL_IAS_WD_SIREN_LEVEL_HIGH = 0x02, ZB_ZCL_IAS_WD_SIREN_LEVEL_VERY_HIGH = 0x03 }
 Siren Level Field, see ZCL spec 8.4.2.3.1.4. More...
 
enum  zb_zcl_ias_wd_strobe_level_e { ZB_ZCL_IAS_WD_STROBE_LEVEL_LOW = 0x00, ZB_ZCL_IAS_WD_STROBE_LEVEL_MEDIUM = 0x01, ZB_ZCL_IAS_WD_STROBE_LEVEL_HIGH = 0x02, ZB_ZCL_IAS_WD_STROBE_LEVEL_VERY_HIGH = 0x03 }
 Strobe Level Field, see ZCL spec 8.4.2.2.1.7. More...
 
enum  zb_zcl_ias_wd_squawk_mode_e { ZB_ZCL_IAS_WD_SQUAWK_MODE_ARMED = 0x00, ZB_ZCL_IAS_WD_SQUAWK_MODE_DISARMED = 0x01 }
 Squawk Mode Field, see ZCL spec 8.4.2.3.2.2. More...
 
enum  zb_zcl_ias_wd_squawk_strobe_e { ZB_ZCL_IAS_WD_SQUAWK_STROBE_NO_STROBE = 0x00, ZB_ZCL_IAS_WD_SQUAWK_STROBE_USE_STROBE = 0x01 }
 Strobe Field, see ZCL spec 8.4.2.3.2.3. More...
 
enum  zb_zcl_ias_wd_squawk_level_e { ZB_ZCL_IAS_WD_SQUAWK_LEVEL_LOW = 0x00, ZB_ZCL_IAS_WD_SQUAWK_LEVEL_MEDIUM = 0x01, ZB_ZCL_IAS_WD_SQUAWK_LEVEL_HIGH = 0x02, ZB_ZCL_IAS_WD_SQUAWK_LEVEL_VERY_HIGH = 0x03 }
 Squawk level Field, see ZCL spec 8.4.2.3.2.4. More...
 
typedef struct zb_zcl_ias_wd_start_warning_s zb_zcl_ias_wd_start_warning_t
 Structure representsation Start warning command. ZCL spec 8.4.2.3.1. More...
 
typedef struct zb_zcl_ias_wd_squawk_s zb_zcl_ias_wd_squawk_t
 Structure representsation Squawk command. ZCL spec 8.4.2.3.2. More...
 

Macro Definition Documentation

§ ZB_ZCL_CLUSTER_ID_IAS_WD_CLIENT_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_IAS_WD_CLIENT_ROLE_INIT   zb_zcl_ias_wd_init_client

§ ZB_ZCL_CLUSTER_ID_IAS_WD_SERVER_ROLE_INIT

#define ZB_ZCL_CLUSTER_ID_IAS_WD_SERVER_ROLE_INIT   zb_zcl_ias_wd_init_server

§ ZB_ZCL_IAS_WD_SQUAWK_SCHEDULE_USER_APP

#define ZB_ZCL_IAS_WD_SQUAWK_SCHEDULE_USER_APP (   buffer,
  pcmd_info,
  squawkMode,
  strobe_,
  level 
)
Value:
{ \
zb_zcl_ias_wd_squawk_user_app_schedule_t* user_data = \
ZB_BUF_GET_PARAM((buffer), zb_zcl_ias_wd_squawk_user_app_schedule_t); \
ZB_MEMMOVE(&(user_data->cmd_info), (pcmd_info), sizeof(zb_zcl_parsed_hdr_t)); \
user_data->param.squawk_mode = (squawkMode); \
user_data->param.strobe = (strobe_); \
user_data->param.squawk_level = (level); \
ZB_SCHEDULE_CALLBACK(zb_zcl_ias_wd_squawk_invoke_user_app, ((buffer))); \
}
zb_zcl_parsed_hdr_s
Definition: zb_zcl_common.h:1158
zb_zcl_ias_wd_squawk_user_app_schedule_e
Definition: zb_zcl_ias_wd.h:428

§ ZB_ZCL_IAS_WD_START_WARNING_SCHEDULE_USER_APP

#define ZB_ZCL_IAS_WD_START_WARNING_SCHEDULE_USER_APP (   buffer,
  pcmd_info,
  warningMode,
  strobe_,
  siren_level_,
  duration_,
  strobe_duty_cycle_,
  strobe_level_ 
)
Value:
{ \
zb_zcl_ias_wd_start_warning_user_app_schedule_t* user_data = \
ZB_BUF_GET_PARAM((buffer), zb_zcl_ias_wd_start_warning_user_app_schedule_t); \
ZB_MEMMOVE(&(user_data->cmd_info), (pcmd_info), sizeof(zb_zcl_parsed_hdr_t)); \
user_data->param.warning_mode = (warningMode); \
user_data->param.strobe = (strobe_); \
user_data->param.siren_level = (siren_level_); \
user_data->param.duration = (duration_); \
user_data->param.strobe_duty_cycle = (strobe_duty_cycle_); \
user_data->param.strobe_level = (strobe_level_); \
ZB_SCHEDULE_CALLBACK(zb_zcl_ias_wd_start_warning_invoke_user_app, (buffer)); \
}
zb_zcl_parsed_hdr_s
Definition: zb_zcl_common.h:1158
zb_zcl_ias_wd_start_warning_user_app_schedule_e
Definition: zb_zcl_ias_wd.h:395

Typedef Documentation

§ zb_zcl_ias_wd_squawk_user_app_schedule_t

typedef struct zb_zcl_ias_wd_squawk_user_app_schedule_e zb_zcl_ias_wd_squawk_user_app_schedule_t

Struct for invoke User App & continue after

§ zb_zcl_ias_wd_squawk_value_param_t

typedef struct zb_zcl_ias_wd_squawk_value_param_s zb_zcl_ias_wd_squawk_value_param_t

Declare run Squawk command for User Application.

§ zb_zcl_ias_wd_start_warning_user_app_schedule_t

typedef struct zb_zcl_ias_wd_start_warning_user_app_schedule_e zb_zcl_ias_wd_start_warning_user_app_schedule_t

Struct for invoke User App & continue after

§ zb_zcl_ias_wd_start_warning_value_param_t

typedef struct zb_zcl_ias_wd_start_warning_value_param_s zb_zcl_ias_wd_start_warning_value_param_t

Declare run Start Warning command for User Application.

Function Documentation

§ zb_zcl_ias_wd_init_client()

void zb_zcl_ias_wd_init_client ( void  )

§ zb_zcl_ias_wd_init_server()

void zb_zcl_ias_wd_init_server ( void  )
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.