RAIL_RxChannelHoppingConfig_t Struct Reference

Wrapper struct that will contain the sequence of RAIL_RxChannelHoppingConfig_t that represent the channel sequence to use during RX Channel Hopping.

#include <rail_types.h>

Data Fields

uint32_t * buffer
 Pointer to contiguous memory that will be used to store channel hopping information.
 
uint16_t bufferLength
 This parameter must be set to the length of the buffer array.
 
uint8_t numberOfChannels
 The number of channels that is in the channel hopping sequence.
 
RAIL_RxChannelHoppingConfigEntry_tentries
 An array of RAIL_RxChannelHoppingConfig_t to represent the channels used during channel hopping.

Wrapper struct that will contain the sequence of RAIL_RxChannelHoppingConfig_t that represent the channel sequence to use during RX Channel Hopping.

Definition at line 2654 of file rail_types.h.

Field Documentation

uint32_t* RAIL_RxChannelHoppingConfig_t::buffer

Pointer to contiguous memory that will be used to store channel hopping information.

Since the RAIL library uses this space for its own calculations and processing, application level code should never write data into anywhere in this buffer.

Note
: the size of this buffer must be at least as large as 3 + 30 * numberOfChannels, plus the sum of the sizes of the radioConfigDeltaAdd's of the required channels, plus the size of the radioConfigDeltaSubtract. In the case that one channel appears two or more times in your channel sequence (e.g. 1, 2, 1, 3), you must account for the radio config size that number of times (i.e. need to count channel 1's radio config size twice for the given example). The overall 3 words and 30 words per channel needed in this buffer are for internal use to the library.

Definition at line 2672 of file rail_types.h.

uint16_t RAIL_RxChannelHoppingConfig_t::bufferLength

This parameter must be set to the length of the buffer array.

This way, during configuration, the software can confirm it's writing within the range of the buffer. The configuration API will return an error if bufferLength is insufficient.

Definition at line 2679 of file rail_types.h.

RAIL_RxChannelHoppingConfigEntry_t* RAIL_RxChannelHoppingConfig_t::entries

An array of RAIL_RxChannelHoppingConfig_t to represent the channels used during channel hopping.

The length of this array must be numberOfChannels

Definition at line 2687 of file rail_types.h.

uint8_t RAIL_RxChannelHoppingConfig_t::numberOfChannels

The number of channels that is in the channel hopping sequence.

Definition at line 2681 of file rail_types.h.


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