RAIL_AutoAckConfig_t Struct Reference

Enables/disables 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 µs.
 
RAIL_StateTransitions_t rxTransitions
 State transitions to do after receiving a packet.
 
RAIL_StateTransitions_t txTransitions
 State transitions to do after transmitting a packet.

Enables/disables the auto ACK algorithm, based on "enable".

The structure provides a default state (the "success" of tx/rxTransitions when acking is being 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 that acking is being 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 before issuing a RAIL_EVENT_RX_ACK_TIMEOUT event and return to the default state.

Definition at line 2113 of file rail_types.h.

Field Documentation

◆ ackTimeout

uint16_t RAIL_AutoAckConfig_t::ackTimeout

Define the RX ACK timeout duration in µs.

Limited to a maximum 65.535 ms. Only applied when auto acking is enabled. Triggers a RAIL_EVENT_RX_ACK_TIMEOUT event if this threshold is exceeded.

Definition at line 2123 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. See RAIL_ConfigAutoAck for more details on this.

Definition at line 2130 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. See RAIL_ConfigAutoAck for more details on this.

Definition at line 2137 of file rail_types.h.


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