RAIL_AutoAckConfig_t Struct Reference

Enable/disable the auto-ACK algorithm, based on "enable".

#include <rail_types.h>

Data Fields

bool enable
 Indicate whether auto-ACKing should be enabled or disabled.
 
uint16_t ackTimeout
 Define the RX ACK timeout duration in microseconds up to 65535 microseconds maximum.
 
RAIL_StateTransitions_t rxTransitions
 State transitions to do after receiving a packet.
 
RAIL_StateTransitions_t txTransitions
 State transitions to do after transmitting a packet.

Enable/disable the auto-ACK algorithm, based on "enable".

The structure provides a default state (the "success" of tx/rxTransitions when ACKing is enabled) for the radio to return to after an ACK operation occurs (transmitting or attempting to receive an ACK), or normal state transitions to return to in the case ACKing is disabled. Regardless whether the ACK operation was successful, the radio returns to the specified success state.

ackTimeout specifies how long to stay in receive and wait for an ACK to start (sync detected) before issuing a RAIL_EVENT_RX_ACK_TIMEOUT event and return to the default state.

Definition at line 2786 of file rail_types.h.

Field Documentation

◆ ackTimeout

uint16_t RAIL_AutoAckConfig_t::ackTimeout

Define the RX ACK timeout duration in microseconds up to 65535 microseconds maximum.

Only applied when auto-ACKing is enabled. The ACK timeout timer starts at the completion of a RAIL_TX_OPTION_WAIT_FOR_ACK transmit and expires only while waiting for a packet (prior to SYNC detect), triggering RAIL_EVENT_RX_ACK_TIMEOUT. During packet reception that event is held off until packet completion and suppressed entirely if the received packet is the expected ACK.

Definition at line 2801 of file rail_types.h.

◆ rxTransitions

RAIL_StateTransitions_t RAIL_AutoAckConfig_t::rxTransitions

State transitions to do after receiving a packet.

When auto-ACKing is enabled, the "error" transition is always ignored and the radio will return to the "success" state after any ACKing sequence (RAIL_RF_STATE_RX or RAIL_RF_STATE_IDLE). See RAIL_ConfigAutoAck for more details on this.

Definition at line 2809 of file rail_types.h.

◆ txTransitions

RAIL_StateTransitions_t RAIL_AutoAckConfig_t::txTransitions

State transitions to do after transmitting a packet.

When auto-ACKing is enabled, the "error" transition is always ignored and the radio will return to the "success" state after any ACKing sequence (RAIL_RF_STATE_RX or RAIL_RF_STATE_IDLE). See RAIL_ConfigAutoAck for more details on this.

Definition at line 2817 of file rail_types.h.


The documentation for this struct was generated from the following file:
  • common/rail_types.h