TYPES#
Modules#
Enumerations#
Status on incoming frame.
Callback status used on framework API for request/response-job.
Indicates whether all transmissions are done.
Typedefs#
Properties of the received frame.
For backwards compatibility.
For backwards compatibility.
For backwards compatibility.
For backwards compatibility.
Basic Set mapper function type.
Basic Get mapper function type.
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.
Defines a type for the latest available CC handle type.
Callback function triggered after completed transmission.
Callback function triggered after ZW_SendDataMulti_Bridge completed transmission.
Generic Callback function type.
Eases the upgrade to future versions of the CC config struct.
Variables#
This is the first of the registered app handlers.
This marks the end of the handlers.
Macros#
Registers a given command class with version, handler, etc.
Registers a given command class with version, handler, etc.
Registers a given command class with version, handler, etc.
Registers a given command class with version, handler, etc.
Registers a given command class with version, handler, etc.
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. |
90
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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. |
102
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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. |
144
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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. |
160
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
Typedef Documentation#
MULTICHAN_SOURCE_NODE_ID#
typedef struct _MULTICHAN_SOURCE_NODE_ID_ MULTICHAN_SOURCE_NODE_ID
33
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
MULTICHAN_DEST_NODE_ID#
typedef struct _MULTICHAN_DEST_NODE_ID_ MULTICHAN_DEST_NODE_ID
44
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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.
75
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_group_t#
typedef ccc_pair_t cc_group_t
For backwards compatibility.
124
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
CMD_CLASS_GRP#
typedef cc_group_t CMD_CLASS_GRP
125
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
AGI_PROFILE#
typedef agi_profile_t AGI_PROFILE
For backwards compatibility.
139
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
job_status_t#
typedef zaf_job_status_t job_status_t
For backwards compatibility.
154
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
JOB_STATUS#
typedef job_status_t JOB_STATUS
155
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
TRANSMISSION_RESULT#
typedef transmission_result_t TRANSMISSION_RESULT
For backwards compatibility.
186
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_handler_t#
typedef void(* cc_handler_t) (void) )(void)
188
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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)
189
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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 *)
190
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_handler_input_t#
typedef struct _cc_handler_input_t cc_handler_input_t
201
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_handler_output_t#
typedef struct _cc_handler_output_t cc_handler_output_t
207
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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 *)
209
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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.
[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.
220
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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.
[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.
231
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_init_function_t#
typedef void(* cc_init_function_t) (void) )(void)
233
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_reset_function_t#
typedef void(* cc_reset_function_t) (void) )(void)
234
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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.
240
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
CC_handler_map_latest_t#
typedef CC_handler_map_v4_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.
304
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
ZAF_TX_Callback_t#
typedef void(* ZAF_TX_Callback_t) (transmission_result_t *pTxResult) )(transmission_result_t *pTxResult)
306
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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.
N/A | txStatus | Transmit complete codes |
N/A | extendedTxStatus | Extended Tx Status |
313
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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.
N/A | txStatus | Transmit complete codes |
319
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
ZW_Void_Callback_t#
typedef void(* ZW_Void_Callback_t) (void) )(void)
Generic Callback function type.
324
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
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.
490
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
Variable Documentation#
__start_zw_cc_handlers_v3#
const CC_handler_map_latest_t __start_zw_cc_handlers_v3
This is the first of the registered app handlers.
335
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
__stop_zw_cc_handlers_v3#
const CC_handler_map_latest_t __stop_zw_cc_handlers_v3
This marks the end of the handlers.
The element after the last element. This means that this element is not valid.
342
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
Macro Definition Documentation#
HANDLER_SECTION#
#define HANDLER_SECTIONValue:
"zw_cc_handlers_v3"
331
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_handlers_start#
#define cc_handlers_startValue:
__start_zw_cc_handlers_v3
336
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
cc_handlers_stop#
#define cc_handlers_stopValue:
__stop_zw_cc_handlers_v3
343
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
REGISTER_CC_V5#
#define REGISTER_CC_V5Value:
Registers a given command class with version, handler, etc.
Every CC must register itself using the latest REGISTER_CC macro. Doing so will enable ZAF to process certain parts without the need for additional handling in the application. One example being the dispatching of command class frames to the correct command class.
Using this macro will make the linker place a variable in a specific linker section which effectively will create an array of registered command classes. ZAF uses this array to look up different information about the supported command classes.
Please see existing command classes for examples of usage.
Remarks
Requires a CC handler matching cc_handler_v3_t.
378
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
REGISTER_CC_V4#
#define REGISTER_CC_V4Value:
Registers a given command class with version, handler, etc.
Every CC must register itself using the latest REGISTER_CC macro. Doing so will enable ZAF to process certain parts without the need for additional handling in the application. One example being the dispatching of command class frames to the correct command class.
Using this macro will make the linker place a variable in a specific linker section which effectively will create an array of registered command classes. ZAF uses this array to look up different information about the supported command classes.
Please see existing command classes for examples of usage.
Remarks
Requires a CC handler matching cc_handler_v2_t.
415
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
REGISTER_CC_V3#
#define REGISTER_CC_V3Value:
Registers a given command class with version, handler, etc.
Every CC must register itself using the latest REGISTER_CC macro. Doing so will enable ZAF to process certain parts without the need for additional handling in the application. One example being the dispatching of command class frames to the correct command class.
Using this macro will make the linker place a variable in a specific linker section which effectively will create an array of registered command classes. ZAF uses this array to look up different information about the supported command classes.
Please see existing command classes for examples of usage.
Remarks
Requires a CC handler matching cc_handler_v2_t.
449
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
REGISTER_CC_V2#
#define REGISTER_CC_V2Value:
Registers a given command class with version, handler, etc.
Requires a CC handler matching cc_handler_v2_t.
458
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
REGISTER_CC#
#define REGISTER_CCValue:
Registers a given command class with version, handler, etc.
Requires a CC handler matching cc_handler_t.
467
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
ZAF_CC_CONFIG_SECTION#
#define ZAF_CC_CONFIG_SECTIONValue:
"zw_zaf_cc_config"
495
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h
ZAF_CC_REGISTER_CONFIG#
#define ZAF_CC_REGISTER_CONFIGValue:
Registers a given command class configuration.
505
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZAF_types.h