ZAF_Transport_Endpoint#
Modules#
_TRANSMIT_OPTIONS_TYPE_SINGLE_EX_
Enumerations#
Defines return values for ZAF_Transmit.
Typedefs#
MULTICHAN_NODE_INFO should include feature node informations as CRC, security etc.
Functions#
Initializes the ZAF Transport Layer.
Get endpoint non-secure or secure command class list.
Send data.
Invokes a command class handler based on the first byte in the frame.
Helper function to switching endpoints for SendData.
Validate destination endpoint use bit-addressing.
This function indicates if the frame was received using multicast addressing The Z-Wave Multicast frame, the broadcast NodeID and the Multi Channel multi-End Point destination are all considered multicast addressing methods.
Set supervision-encapsulated-frame flag.
Enumeration Documentation#
EZAF_EnqueueStatus_t#
EZAF_EnqueueStatus_t
Defines return values for ZAF_Transmit.
They match the enum values defined in EQueueNotifyingStatus (i.e., EQUEUENOTIFYING_STATUS_SUCCESS and EQUEUENOTIFYING_STATUS_TIMEOUT, respectively).
| Enumerator | |
|---|---|
| ZAF_ENQUEUE_STATUS_SUCCESS | Item successfully put on queue. |
| ZAF_ENQUEUE_STATUS_TIMEOUT | Failed to put item on queue as it was full. |
| ZAF_ENQUEUE_STATUS_BUFFER_OVERRUN | Failed to put item on queue as it was to long to fit in tx buffer. |
_ENDPOINT_#
_ENDPOINT_
| Enumerator | |
|---|---|
| ENDPOINT_ROOT | |
| ENDPOINT_1 | |
| ENDPOINT_2 | |
| ENDPOINT_3 | |
| ENDPOINT_4 | |
| ENDPOINT_5 | |
| ENDPOINT_6 | |
| ENDPOINT_7 | |
| ENDPOINT_8 | |
| ENDPOINT_9 | |
Typedef Documentation#
MULTICHAN_NODE_INFO#
typedef struct _MULTICHAN_NODE_INFO_ MULTICHAN_NODE_INFO
MULTICHAN_NODE_INFO should include feature node informations as CRC, security etc.
TRANSMIT_OPTIONS_TYPE_SINGLE_EX#
typedef struct _TRANSMIT_OPTIONS_TYPE_SINGLE_EX_ TRANSMIT_OPTIONS_TYPE_SINGLE_EX
Function Documentation#
ZW_TransportEndpoint_Init#
void ZW_TransportEndpoint_Init (void )
Initializes the ZAF Transport Layer.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
GetEndpointcmdClassList#
zaf_cc_list_t * GetEndpointcmdClassList (bool secList, uint8_t endpoint)
Get endpoint non-secure or secure command class list.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | [in] | secList | true if secure list else false for non-secure list |
| uint8_t | [in] | endpoint | parameter |
Returns
Return endpoint command class list. Return NULL if list is not present!
ZAF_Transmit#
EZAF_EnqueueStatus_t ZAF_Transmit (uint8_t * pData, size_t dataLength, TRANSMIT_OPTIONS_TYPE_SINGLE_EX * pTxOptionsEx, ZAF_TX_Callback_t pCallback)
Send data.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | [in] | pData | IN Data buffer pointer. |
| size_t | [in] | dataLength | IN Data buffer length. |
| TRANSMIT_OPTIONS_TYPE_SINGLE_EX * | [in] | pTxOptionsEx | transmit options pointer. |
| ZAF_TX_Callback_t | [out] | pCallback | is a callback function-pointer returning result of the job. Please note that both bStatus TRANSMIT_COMPLETE_OK and TRANSMIT_COMPLETE_VERIFIED indicates successful transmission. |
This function is used both as response to a command and for sending unsolicited frames Encapsulate data for endpoint support and call protocol ZW_SendDataEx.
Returns
status of enum type EZAF_EnqueueStatus_t
Transport_ApplicationCommandHandlerEx#
received_frame_status_t Transport_ApplicationCommandHandlerEx (RECEIVE_OPTIONS_TYPE_EX * rxOpt, ZW_APPLICATION_TX_BUFFER * pCmd, uint8_t cmdLength)
Invokes a command class handler based on the first byte in the frame.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| RECEIVE_OPTIONS_TYPE_EX * | [in] | rxOpt | IN receive options of type RECEIVE_OPTIONS_TYPE_EX. |
| ZW_APPLICATION_TX_BUFFER * | [in] | pCmd | IN Payload from the received frame. |
| uint8_t | [in] | cmdLength | IN Number of command bytes including command. |
Must be defined in the application.
DeprecatedIf all command classes use one of the REGISTER_CC macros, this function is not required to be implemented in the application. There exists a weak definition of it. ZAF_CC_Invoker will take care of invoking the right command class handler.
Returns
status of extracting frame
RxToTxOptions#
void RxToTxOptions (RECEIVE_OPTIONS_TYPE_EX * rxopt, TRANSMIT_OPTIONS_TYPE_SINGLE_EX ** txopt)
Helper function to switching endpoints for SendData.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| RECEIVE_OPTIONS_TYPE_EX * | [in] | rxopt | Receive options to convert. |
| TRANSMIT_OPTIONS_TYPE_SINGLE_EX ** | [out] | txopt | Converted transmit options |
Check_not_legal_response_job#
bool Check_not_legal_response_job (RECEIVE_OPTIONS_TYPE_EX * rxOpt)
Validate destination endpoint use bit-addressing.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| RECEIVE_OPTIONS_TYPE_EX * | [in] | rxOpt | pointer of type RECEIVE_OPTIONS_TYPE_EX |
This function must only be used to check jobs that return response (Get <-> Report). Returns
Boolean true if use bit-addressing else false
is_multicast#
bool is_multicast (RECEIVE_OPTIONS_TYPE_EX * rxOpt)
This function indicates if the frame was received using multicast addressing The Z-Wave Multicast frame, the broadcast NodeID and the Multi Channel multi-End Point destination are all considered multicast addressing methods.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| RECEIVE_OPTIONS_TYPE_EX * | [in] | rxOpt | pointer of type RECEIVE_OPTIONS_TYPE_EX |
Returns
Boolean true if use bit-addressing else false
SetFlagSupervisionEncap#
void SetFlagSupervisionEncap (bool flag)
Set supervision-encapsulated-frame flag.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | [in] | flag | supervision-encapsulated-frame true if active and false if deactive. |
The Command class call Check_not_legal_response_job() Use the flag to discard current job if a Get<->Response job (CC:006C.01.00.13.002).