//

TYPES#

Modules#

_MULTICHAN_SOURCE_NODE_ID_

_MULTICHAN_DEST_NODE_ID_

MULTICHAN_DEST_NODE_ID_8bit

_RECEIVE_OPTIONS_TYPE_EX_

ZAF_TRANSPORT_TX_BUFFER

transmission_result_t

_cc_handler_input_t

_cc_handler_output_t

CC_handler_map_t

CC_handler_map_v2_t

CC_handler_map_v3_t

CC_handler_map_v4_t

CC_handler_map_v5_t

zaf_cc_config_t

zaf_cc_config_entry_v1_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

}

Status on incoming frame.

enum

zaf_job_status_t {

JOB_STATUS_SUCCESS = 0

JOB_STATUS_BUSY

JOB_STATUS_NO_DESTINATIONS

}

Callback status used on framework API for request/response-job.

enum

TRANSMISSION_RESULT_FINISH_STATUS {

TRANSMISSION_RESULT_NOT_FINISHED

TRANSMISSION_RESULT_FINISHED

TRANSMISSION_RESULT_UNKNOWN

}

Indicates whether all transmissions are done.

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

Properties of the received frame.

typedef ccc_pair_t

For backwards compatibility.

typedef cc_group_t

typedef agi_profile_t

For backwards compatibility.

typedef zaf_job_status_t

For backwards compatibility.

typedef job_status_t

typedef transmission_result_t

TRANSMISSION_RESULT

For backwards compatibility.

typedef void(*

cc_handler_t)(void)

typedef received_frame_status_t(*

cc_handler_v1_t)(RECEIVE_OPTIONS_TYPE_EX *, ZW_APPLICATION_TX_BUFFER *, uint8_t)

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 *)

typedef struct _cc_handler_input_t

cc_handler_input_t

typedef struct _cc_handler_output_t

cc_handler_output_t

typedef received_frame_status_t(*

cc_handler_v3_t)(cc_handler_input_t *, cc_handler_output_t *)

typedef void(*

basic_set_mapper_t)(ZW_APPLICATION_TX_BUFFER *p_frame)

Basic Set mapper function type.

typedef void(*

basic_get_mapper_t)(uint8_t endpoint, uint8_t *p_current_value, uint8_t *p_target_value, uint8_t *p_duration)

Basic Get mapper function type.

typedef void(*

cc_init_function_t)(void)

typedef void(*

cc_reset_function_t)(void)

typedef void(*

cc_migrate_function_t)(void)

typedef uint8_t(*

lifeline_report_get_t)(cc_group_t *p_cc_pair)

A lifeline report function must take an array of CC pairs as input and return the number of CC pairs being added to the array.

typedef CC_handler_map_v5_t

CC_handler_map_latest_t

Defines a type for the latest available CC handle type.

typedef void(*

ZAF_TX_Callback_t)(transmission_result_t *pTxResult)

typedef void(*

ZW_TX_Callback_t)(uint8_t txStatus, TX_STATUS_TYPE *extendedTxStatus)

Callback function triggered after completed transmission.

typedef void(*

ZW_TX_Multi_Callback_t)(uint8_t txStatus)

Callback function triggered after ZW_SendDataMulti_Bridge completed transmission.

typedef void(*

ZW_Void_Callback_t)(void)

Generic Callback function type.

typedef zaf_cc_config_entry_v1_t

zaf_cc_config_entry_latest_t

Eases the upgrade to future versions of the CC config struct.

Variables#

const CC_handler_map_latest_t

__start_zw_cc_handlers_v5

This is the first of the registered app handlers.

const CC_handler_map_latest_t

__stop_zw_cc_handlers_v5

This marks the end of the handlers.

Macros#

#define

HANDLER_SECTION "zw_cc_handlers_v5"

#define

cc_handlers_start __start_zw_cc_handlers_v5

#define

cc_handlers_stop __stop_zw_cc_handlers_v5

#define

CC_API_HANDLER_V1 (1)

This marks the version of the command class handlers used by ZAF_CC_Invoker.

#define

CC_API_HANDLER_V2 (2)

#define

CC_API_HANDLER_V3 (3)

#define

REGISTER_CC_V6 (cc_api_handler_version, cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb, migrate_cb)

Registers a given command class with version, handler, etc.

#define

REGISTER_CC_V5 (cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb)

Registers a given command class with version, handler, etc.

#define

REGISTER_CC_V4 (cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags, init_cb, reset_cb)

Registers a given command class with version, handler, etc.

#define

REGISTER_CC_V3 (cc, version, handler, basic_set_mapper, basic_get_mapper, lifeline_report_cb, flags)

Registers a given command class with version, handler, etc.

#define

REGISTER_CC_V2 (cc, version, handler)

Registers a given command class with version, handler, etc.

#define

REGISTER_CC (cc, version, handler)

Registers a given command class with version, handler, etc.

#define

ZAF_CC_CONFIG_SECTION "zw_zaf_cc_config"

#define

ZAF_CC_REGISTER_CONFIG (cc, config, index)

Registers a given command class configuration.

Enumeration Documentation#

e_cmd_handler_return_code_t#

e_cmd_handler_return_code_t

Enumerator
E_CMD_HANDLER_RETURN_CODE_FAIL	Not accepted or accepted but failed to execute. Command class returns FAIL.
E_CMD_HANDLER_RETURN_CODE_HANDLED	Accepted and executed by the command handler. Command class returns SUCCESS.
E_CMD_HANDLER_RETURN_CODE_WORKING	Accepted but is not fully executed. Command class returns WORKING.
E_CMD_HANDLER_RETURN_CODE_NOT_SUPPORTED	Command handler does not support this command. Command class returns NO_SUPPORT.
E_CMD_HANDLER_RETURN_CODE_NO_CHANGE	Accepted but device was already in final state, so no change was made. Command class returns SUCCESS.

received_frame_status_t#

received_frame_status_t

Status on incoming frame.

Use same values as cc_supervision_status_t

Enumerator
RECEIVED_FRAME_STATUS_NO_SUPPORT	Frame not supported.
RECEIVED_FRAME_STATUS_WORKING	Frame received successfully and timed change started.
RECEIVED_FRAME_STATUS_FAIL	Could not handle incoming frame.
RECEIVED_FRAME_STATUS_CANCEL	Don't care about status. CC or App will send the report.
RECEIVED_FRAME_STATUS_CC_NOT_FOUND	CC handler was not found in CC handler map.
RECEIVED_FRAME_STATUS_SUCCESS	Frame received successfully.

zaf_job_status_t#

zaf_job_status_t

Callback status used on framework API for request/response-job.

Enumerator
JOB_STATUS_SUCCESS	Job has been started.
JOB_STATUS_BUSY	Job couldn't start.
JOB_STATUS_NO_DESTINATIONS	Job couldn't start because there is no destinations.

TRANSMISSION_RESULT_FINISH_STATUS#

TRANSMISSION_RESULT_FINISH_STATUS

Indicates whether all transmissions are done.

Used by TRANSMISSION_RESULT.

Enumerator
TRANSMISSION_RESULT_NOT_FINISHED	Still transmitting.
TRANSMISSION_RESULT_FINISHED	Done transmitting to all nodes.
TRANSMISSION_RESULT_UNKNOWN	Reserved for callbacks from the stack as the stack supplies no valid value for the finish field.

Typedef Documentation#

MULTICHAN_SOURCE_NODE_ID#

typedef struct _MULTICHAN_SOURCE_NODE_ID_ MULTICHAN_SOURCE_NODE_ID

MULTICHAN_DEST_NODE_ID#

typedef struct _MULTICHAN_DEST_NODE_ID_ MULTICHAN_DEST_NODE_ID

RECEIVE_OPTIONS_TYPE_EX#

typedef struct _RECEIVE_OPTIONS_TYPE_EX_ RECEIVE_OPTIONS_TYPE_EX

Properties of the received frame.

Used mostly by command classes to prepare response to a command.

cc_group_t#

typedef ccc_pair_t cc_group_t

For backwards compatibility.

CMD_CLASS_GRP#

typedef cc_group_t CMD_CLASS_GRP

AGI_PROFILE#

typedef agi_profile_t AGI_PROFILE

For backwards compatibility.

job_status_t#

typedef zaf_job_status_t job_status_t

For backwards compatibility.

JOB_STATUS#

typedef job_status_t JOB_STATUS

TRANSMISSION_RESULT#

typedef transmission_result_t TRANSMISSION_RESULT

For backwards compatibility.

cc_handler_t#

typedef void(* cc_handler_t) (void) )(void)

cc_handler_v1_t#

typedef received_frame_status_t(* cc_handler_v1_t) (RECEIVE_OPTIONS_TYPE_EX *, ZW_APPLICATION_TX_BUFFER *, uint8_t) )(RECEIVE_OPTIONS_TYPE_EX *, ZW_APPLICATION_TX_BUFFER *, uint8_t)

cc_handler_v2_t#

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 *) )(RECEIVE_OPTIONS_TYPE_EX *, ZW_APPLICATION_TX_BUFFER *, uint8_t, ZW_APPLICATION_TX_BUFFER *, uint8_t *)

cc_handler_input_t#

typedef struct _cc_handler_input_t cc_handler_input_t

cc_handler_output_t#

typedef struct _cc_handler_output_t cc_handler_output_t

cc_handler_v3_t#

typedef received_frame_status_t(* cc_handler_v3_t) (cc_handler_input_t *, cc_handler_output_t *) )(cc_handler_input_t *, cc_handler_output_t *)

basic_set_mapper_t#

typedef void(* basic_set_mapper_t) (ZW_APPLICATION_TX_BUFFER *p_frame) )(ZW_APPLICATION_TX_BUFFER *p_frame)

Basic Set mapper function type.

Parameters

Type	Direction	Argument Name	Description
	[out]	p_frame	The frame that must have command class and command replaced by the command class that defines the Basic Set mapping function.

Use this type when defining a function for Basic Set mapping.

basic_get_mapper_t#

typedef void(* basic_get_mapper_t) (uint8_t endpoint, uint8_t *p_current_value, uint8_t *p_target_value, uint8_t *p_duration) )(uint8_t endpoint, uint8_t *p_current_value, uint8_t *p_target_value, uint8_t *p_duration)

Basic Get mapper function type.

Parameters

Type	Direction	Argument Name	Description
	[in]	endpoint	The endpoint that received the Basic Get command.
	[out]	p_current_value	Pointer to variable where the current value can be written.
	[out]	p_target_value	Pointer to variable where the target value can be written.
	[out]	p_duration	Pointer to variable where the duration can be written.

Use this type when defining a function for Basic Get mapping.

cc_init_function_t#

typedef void(* cc_init_function_t) (void) )(void)

cc_reset_function_t#

typedef void(* cc_reset_function_t) (void) )(void)

cc_migrate_function_t#

typedef void(* cc_migrate_function_t) (void) )(void)

lifeline_report_get_t#

typedef uint8_t(* lifeline_report_get_t) (cc_group_t *p_cc_pair) )(cc_group_t *p_cc_pair)

A lifeline report function must take an array of CC pairs as input and return the number of CC pairs being added to the array.

CC_handler_map_latest_t#

typedef CC_handler_map_v5_t CC_handler_map_latest_t

Defines a type for the latest available CC handle type.

Users of the CC handle must use this type to avoid changes caused by a future handle version.

ZAF_TX_Callback_t#

typedef void(* ZAF_TX_Callback_t) (transmission_result_t *pTxResult) )(transmission_result_t *pTxResult)

ZW_TX_Callback_t#

typedef void(* ZW_TX_Callback_t) (uint8_t txStatus, TX_STATUS_TYPE *extendedTxStatus) )(uint8_t txStatus, TX_STATUS_TYPE *extendedTxStatus)

Callback function triggered after completed transmission.

Parameters

Type	Direction	Argument Name	Description
	N/A	txStatus	Transmit complete codes
	N/A	extendedTxStatus	Extended Tx Status

ZW_TX_Multi_Callback_t#

typedef void(* ZW_TX_Multi_Callback_t) (uint8_t txStatus) )(uint8_t txStatus)

Callback function triggered after ZW_SendDataMulti_Bridge completed transmission.

Parameters

Type	Direction	Argument Name	Description
	N/A	txStatus	Transmit complete codes

ZW_Void_Callback_t#

typedef void(* ZW_Void_Callback_t) (void) )(void)

Generic Callback function type.

zaf_cc_config_entry_latest_t#

typedef zaf_cc_config_entry_v1_t zaf_cc_config_entry_latest_t

Eases the upgrade to future versions of the CC config struct.

Variable Documentation#

__start_zw_cc_handlers_v5#

const CC_handler_map_latest_t __start_zw_cc_handlers_v5

This is the first of the registered app handlers.

__stop_zw_cc_handlers_v5#

const CC_handler_map_latest_t __stop_zw_cc_handlers_v5

This marks the end of the handlers.

The element after the last element. This means that this element is not valid.