RAIL_RxPacketDetails_t Struct Reference

Successfully received packet details obtained via RAIL_GetRxPacketDetails().

#include <rail_types.h>

Data Fields

RAIL_PacketTimeStamp_t timeReceived
 The timestamp of the received packet in the RAIL timebase.
 
bool crcPassed
 Indicates whether the CRC passed or failed for the receive packet.
 
bool isAck
 Indicates whether the received packet is an ACK.
 
int8_t rssi
 RSSI of the received packet in integer dBm.
 
uint8_t lqi
 The link quality indicator of the received packet.
 
uint8_t syncWordId
 For radios and PHY configurations that support multiple sync words, this number is the ID of the sync word that was used for this packet.
 
uint8_t subPhyId
 In configurations where the radio has the option of receiving a given packet in multiple ways, indicates which of the sub-PHY options was used to receive the packet.
 
uint8_t antennaId
 For configurations where the device has multiple antennas, indicates which antenna received the packets.

Successfully received packet details obtained via RAIL_GetRxPacketDetails().

Definition at line 1925 of file rail_types.h.

Field Documentation

uint8_t RAIL_RxPacketDetails_t::antennaId

For configurations where the device has multiple antennas, indicates which antenna received the packets.

For hardware configurations with only one antenna, this will be set to the default of 0.

Definition at line 1970 of file rail_types.h.

bool RAIL_RxPacketDetails_t::crcPassed

Indicates whether the CRC passed or failed for the receive packet.

It is set to 0 for fail and 1 for pass.

Definition at line 1935 of file rail_types.h.

bool RAIL_RxPacketDetails_t::isAck

Indicates whether the received packet is an ACK.

An 'ACK' is defined as a packet received during the RX ACK window when auto ACK is enabled. Set to 0 if not an ACK, and 1 for an ACK. It is always 0 if auto ACK is not enabled.

Definition at line 1942 of file rail_types.h.

uint8_t RAIL_RxPacketDetails_t::lqi

The link quality indicator of the received packet.

It is calculated as the average correlation for the first 8 symbols in a frame.

Definition at line 1952 of file rail_types.h.

int8_t RAIL_RxPacketDetails_t::rssi

RSSI of the received packet in integer dBm.

It is latched when the sync word is detected for the packet.

Definition at line 1947 of file rail_types.h.

uint8_t RAIL_RxPacketDetails_t::subPhyId

In configurations where the radio has the option of receiving a given packet in multiple ways, indicates which of the sub-PHY options was used to receive the packet.

Most radio configurations do not have this ability and the subPhy is set to 0.

Definition at line 1964 of file rail_types.h.

RAIL_PacketTimeStamp_t RAIL_RxPacketDetails_t::timeReceived

The timestamp of the received packet in the RAIL timebase.

The time is the end of the sync word of the received packet.

Definition at line 1930 of file rail_types.h.


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