ZAF_Transport_Multicast#

Enumerations#

enum
ETRANSPORT_MULTICAST_STATUS {
ETRANSPORTMULTICAST_FAILED = 0
ETRANSPORTMULTICAST_ADDED_TO_QUEUE = 1
}

Functions#

enum ETRANSPORT_MULTICAST_STATUS
ZW_TransportMulticast_SendRequest(const uint8_t *const p_data, uint8_t data_length, uint8_t fSupervisionEnable, TRANSMIT_OPTIONS_TYPE_EX *p_nodelist, ZAF_TX_Callback_t p_callback)

Initiates transmission of a frame and will handle multi channel and multicast transmissions.

void
ZW_TransportMulticast_init(void)

Initializes the Tx Buffer.

Enumeration Documentation#

ETRANSPORT_MULTICAST_STATUS#

ETRANSPORT_MULTICAST_STATUS
Enumerator
ETRANSPORTMULTICAST_FAILED
ETRANSPORTMULTICAST_ADDED_TO_QUEUE

Definition at line 22 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportMulticast.h

Function Documentation#

ZW_TransportMulticast_SendRequest#

enum ETRANSPORT_MULTICAST_STATUS ZW_TransportMulticast_SendRequest (const uint8_t *const p_data, uint8_t data_length, uint8_t fSupervisionEnable, TRANSMIT_OPTIONS_TYPE_EX *p_nodelist, ZAF_TX_Callback_t p_callback)

Initiates transmission of a frame and will handle multi channel and multicast transmissions.

Parameters
[in]p_data

Pointer to data.

[in]data_length

Length of data in bytes.

[in]fSupervisionEnable

Enable Supervision encapsulation if set to true.

[in]p_nodelist

Pointer to a list of nodes.

[in]p_callback

Pointer to a callback function which is called for each transmission to a node.

If the node has associations to multiple endpoints of the same node, this function will transmit one multi channel encapsulated frame that addresses the associated endpoints.

If the node is included using S2 and has more than one non-endpoint association, this function will transmit an S2 multicast (broadcast) frame addressing those associations followed by singlecast follow-up frames.

If the node is included using S0 there will be no multicast since S0 does not support multicast.

If the node is non-securely included and has more than one non-endpoint association, this function will transmit a non-secure multicast followed by singlecast follow-up frames.

Returns

  • Returns status of transmission.


Definition at line 51 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportMulticast.h

ZW_TransportMulticast_clearTimeout#

void ZW_TransportMulticast_clearTimeout (void)
Parameters
N/A

Definition at line 60 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportMulticast.h

ZW_TransportMulticast_init#

void ZW_TransportMulticast_init (void)

Initializes the Tx Buffer.

Parameters
N/A

Definition at line 66 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ZW_TransportMulticast.h