True Status Engine used by application framework.
This module is used to notify the Lifeline (or any other association groups) of state changes for any Command Class.
2018 Silicon Laboratories Inc.
Modules#
_s_zaf_tse_data_input_template_t_
Typedefs#
Callback function for True Status engine.
Functions#
An API for the True Status engine activation.
Initialization function for the TSE.
Must be passed as a callback to zaf_transport_tx() in functions used as TSE callbacks.
Typedef Documentation#
s_zaf_tse_data_input_template_t#
typedef struct _s_zaf_tse_data_input_template_t_ s_zaf_tse_data_input_template_t
32 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/TrueStatusEngine/ZAF_TSE.hzaf_tse_callback_t#
typedef void(* zaf_tse_callback_t) (zaf_tx_options_t *txOptions, void *pData) )(zaf_tx_options_t *txOptions, void *pData)
Callback function for True Status engine.
| [out] | txOptions | Tx options of the current transmission |
| [in] | pData | Data relevant to the caller of TSE |
Must be implemented by the caller of TSE
40 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/TrueStatusEngine/ZAF_TSE.hFunction Documentation#
ZAF_TSE_Trigger#
bool ZAF_TSE_Trigger (zaf_tse_callback_t pCallback, void * pData, bool overwrite_previous_trigger)
An API for the True Status engine activation.
| [in] | pCallback | Pointer to the function to callback. The callback function must be a function taking the following arguments:
|
| [in] | pData | Pointer to a data struct that will be passed in argument to the pCallback function. The pData pointed struct MUST first contain a RECEIVE_OPTIONS_TYPE_EX variable indicating properties about the received frame that triggered the change. Local changes must also include a RECEIVE_OPTIONS_TYPE_EX in the pData. |
| [in] | overwrite_previous_trigger | Boolean parameter indicating if a previous trigger with the same pCallback and the same source Endpoint in the pData should be discarded or not. Set it to true for overwriting previous triggers and false to stack up all the trigger messages. |
The True Status engine will queue up the status reporting request into a queue The status report are triggered after ZAF_TSE_DELAY_TRIGGER milliseconds
If the pCallback was already in the queue and overwrite_previous_trigger is set to true, pData will be updated and the timer waiting ZAF_TSE_DELAY_TRIGGER will be restarted.
Returns
True if the pCallback / pData were queued in the engine False if the queue is full and the pCallback was not queued.
70 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/TrueStatusEngine/ZAF_TSE.hZAF_TSE_Init#
bool ZAF_TSE_Init (void )
Initialization function for the TSE.
| N/A |
The function initialize the necessary timers based on the ZAF_TSE_MAXIMUM_SIMULTANEOUS_TRIGGERS setting The status report are triggered after ZAF_TSE_DELAY_TRIGGER milliseconds
Returns
True if initialization completed successfully False if initialization could not be done without errors
83 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/TrueStatusEngine/ZAF_TSE.hZAF_TSE_TXCallback#
void ZAF_TSE_TXCallback (transmission_result_t * pTransmissionResult)
Must be passed as a callback to zaf_transport_tx() in functions used as TSE callbacks.
| N/A | pTransmissionResult | Pointer to transmission data. The argument is not used, but exists because zaf_transport_tx() takes an argument being a pointer to a function with this type. |
One example is CC_BinarySwitch_report_stx().
93 of file /mnt/raid/workspaces/ws.6QOxxjIBR/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/TrueStatusEngine/ZAF_TSE.h