Data used by Z-Wave Transports to track their "session". More...

#include <zwave_tx_definitions.h>

Collaboration diagram for zwave_tx_transport_options:

Public Attributes
zwave_tx_session_id_t	parent_session_id
	zwave_tx_session_id_t of the parent frame. A parent frame is a frame More...

bool	valid_parent_session_id

zwave_multicast_group_id_t	group_id

bool	is_first_follow_up

bool	is_test_frame

bool	is_protocol_frame

bool	ignore_incoming_frames_back_off

rf_power_level_t	rf_power

Detailed Description

Data used by Z-Wave Transports to track their "session".

Member Data Documentation

◆ group_id

zwave_multicast_group_id_t zwave_tx_transport_options::group_id

This flag can be used for tracking multicast/singlecast follow-ups transmissions. For Singlecast messages (remote.is_multicast = false), this must be set to ZWAVE_TX_INVALID_GROUP if the frame is not a follow-up frame, else to the group_id for which it is a follow-up. For Multicast messages (remote.is_multicast = true), if this field is set with a group_id different than 0, the Tx Queue will use the TRANSMIT_OPTION_MULTICAST_AS_BROADCAST and the multicast will be sent as a "singlecast to the broadcast destination"

◆ ignore_incoming_frames_back_off

bool zwave_tx_transport_options::ignore_incoming_frames_back_off

This flag indicates if the frame is to be sent even if we have incoming frames. Should be used only if the transport need a frame send/delivered at the risk of a collision.

◆ is_first_follow_up

bool zwave_tx_transport_options::is_first_follow_up

Is this the first Singlecast follow-up frame ? Only set this to true if queuing the first follow-up frame.

◆ is_protocol_frame

bool zwave_tx_transport_options::is_protocol_frame

This flag indicates if the frame is a protocol frame. Protocol frame is introduced as part of S2V2 implementation as they need to be encrypted by the host.

◆ is_test_frame

bool zwave_tx_transport_options::is_test_frame

This flag indicates if the frame is to be sent as a test frame Test frame was intended to be used to test link reliability, the Z-Wave API will send a test frame without any routing and with 9600 kbit/s transmission speed. The payload will also be ignored.

◆ parent_session_id

zwave_tx_session_id_t zwave_tx_transport_options::parent_session_id

zwave_tx_session_id_t of the parent frame. A parent frame is a frame

◆ rf_power

rf_power_level_t zwave_tx_transport_options::rf_power

This value indicates if the a test frame must be sent with a particular Tx Power. This value will be ignored if the is_test_frame flag is set to false.

◆ valid_parent_session_id

bool zwave_tx_transport_options::valid_parent_session_id

This flag indicates if the parent_session_id field is supposed to contain a valid value. If this field is set to true, qos_priority will be overwritten so that the frame is sent before the parent.

The documentation for this struct was generated from the following file:

applications/zpc/components/zwave/zwave_definitions/include/zwave_tx_definitions.h

Public Attributes