ZAF_types.h File Reference

#include <ZW_security_api.h>
#include <ZW_classcmd.h>
#include <ZW_transport_api.h>

Include dependency graph for ZAF_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_MULTICHAN_SOURCE_NODE_ID_
struct	_MULTICHAN_DEST_NODE_ID_
struct	MULTICHAN_DEST_NODE_ID_8bit
struct	_RECEIVE_OPTIONS_TYPE_EX_
struct	ZAF_TRANSPORT_TX_BUFFER
struct	ccc_pair_t
struct	agi_profile_t
struct	transmission_result_t
struct	_cc_handler_input_t
	Defines the input parameters of a command class handler. More...
struct	_cc_handler_output_t
	Defines the output parameters of a command class handler. More...
struct	CC_handler_map_t
struct	CC_handler_map_v2_t
struct	CC_handler_map_v3_t
struct	CC_handler_map_v4_t
struct	zaf_cc_config_t
struct	zaf_cc_config_entry_v1_t
struct	zaf_cc_list_t

Macros
#define	HANDLER_SECTION   "zw_cc_handlers_v3"
#define	cc_handlers_start   __start_zw_cc_handlers_v3
#define	cc_handlers_stop   __stop_zw_cc_handlers_v3
#define	REGISTER_CC_V5(cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb)
#define	REGISTER_CC_V4(cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb)
#define	REGISTER_CC_V3(cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags)
#define	REGISTER_CC_V2(cc, version, handler)
#define	REGISTER_CC(cc, version, handler)
#define	ZAF_CC_CONFIG_SECTION   "zw_zaf_cc_config"
#define	ZAF_CC_REGISTER_CONFIG(cc, config, index)

Typedefs
typedef struct _MULTICHAN_SOURCE_NODE_ID_	MULTICHAN_SOURCE_NODE_ID
typedef struct _MULTICHAN_DEST_NODE_ID_	MULTICHAN_DEST_NODE_ID
typedef struct _RECEIVE_OPTIONS_TYPE_EX_	RECEIVE_OPTIONS_TYPE_EX
typedef ccc_pair_t	cc_group_t
typedef cc_group_t	CMD_CLASS_GRP
typedef agi_profile_t	AGI_PROFILE
typedef zaf_job_status_t	job_status_t
typedef job_status_t	JOB_STATUS
typedef transmission_result_t	TRANSMISSION_RESULT
typedef void(*	cc_handler_t) (void)
	Defines a type for the generic command class handler.
typedef received_frame_status_t(*	cc_handler_v1_t) (RECEIVE_OPTIONS_TYPE_EX *, ZW_APPLICATION_TX_BUFFER *, uint8_t)
	Defines a type for version 1 of the command class handler.
typedef received_frame_status_t(*	cc_handler_v2_t) (RECEIVE_OPTIONS_TYPE_EX *, ZW_APPLICATION_TX_BUFFER *, uint8_t, ZW_APPLICATION_TX_BUFFER *, uint8_t *)
	Defines a type for version 2 of the command class handler.
typedef struct _cc_handler_input_t	cc_handler_input_t
	Defines the input parameters of a command class handler.
typedef struct _cc_handler_output_t	cc_handler_output_t
	Defines the output parameters of a command class handler.
typedef received_frame_status_t(*	cc_handler_v3_t) (cc_handler_input_t *, cc_handler_output_t *)
	Defines a type for version 3 of the command class handler.
typedef void(*	basic_set_mapper_t) (ZW_APPLICATION_TX_BUFFER *p_frame)
typedef void(*	basic_get_mapper_t) (uint8_t endpoint, uint8_t *p_current_value, uint8_t *p_target_value, uint8_t *p_duration)
typedef void(*	cc_init_function_t) (void)
typedef void(*	cc_reset_function_t) (void)
typedef uint8_t(*	lifeline_report_get_t) (cc_group_t *p_cc_pair)
typedef CC_handler_map_v4_t	CC_handler_map_latest_t
typedef void(*	ZAF_TX_Callback_t) (transmission_result_t *pTxResult)
typedef void(*	ZW_TX_Callback_t) (uint8_t txStatus, TX_STATUS_TYPE *extendedTxStatus)
typedef void(*	ZW_TX_Multi_Callback_t) (uint8_t txStatus)
typedef void(*	ZW_Void_Callback_t) (void)
typedef zaf_cc_config_entry_v1_t	zaf_cc_config_entry_latest_t

Enumerations
enum	e_cmd_handler_return_code_t {   E_CMD_HANDLER_RETURN_CODE_FAIL ,   E_CMD_HANDLER_RETURN_CODE_HANDLED ,   E_CMD_HANDLER_RETURN_CODE_WORKING ,   E_CMD_HANDLER_RETURN_CODE_NOT_SUPPORTED ,   E_CMD_HANDLER_RETURN_CODE_NO_CHANGE }
enum	received_frame_status_t {   RECEIVED_FRAME_STATUS_NO_SUPPORT = 0x00 ,   RECEIVED_FRAME_STATUS_WORKING = 0x01 ,   RECEIVED_FRAME_STATUS_FAIL = 0x02 ,   RECEIVED_FRAME_STATUS_CANCEL = 0x03 ,   RECEIVED_FRAME_STATUS_CC_NOT_FOUND = 0x04 ,   RECEIVED_FRAME_STATUS_SUCCESS = 0xFF }
enum	zaf_job_status_t {   JOB_STATUS_SUCCESS = 0 ,   JOB_STATUS_BUSY ,   JOB_STATUS_NO_DESTINATIONS }
enum	TRANSMISSION_RESULT_FINISH_STATUS {   TRANSMISSION_RESULT_NOT_FINISHED ,   TRANSMISSION_RESULT_FINISHED ,   TRANSMISSION_RESULT_UNKNOWN }

Variables
const CC_handler_map_latest_t	__start_zw_cc_handlers_v3
const CC_handler_map_latest_t	__stop_zw_cc_handlers_v3

Detailed Description

Contains a number of types commonly used by the ZAF.

Warning

To keep dependencies clean, this header file MUST NOT depend on any other header files than standard header files or Z-Wave API header files (located in ZWave/API).

Copyright

2018 Silicon Laboratories Inc.