RAIL_ScheduleRxConfig_t Struct Reference

Configures the scheduled RX algorithm.

#include <rail_types.h>

Data Fields

RAIL_Time_t start
 The time to start receive.
 
RAIL_TimeMode_t startMode
 How to interpret the time value specified in the start parameter.
 
RAIL_Time_t end
 The time to end receive.
 
RAIL_TimeMode_t endMode
 How to interpret the time value specified in the end parameter.
 
uint8_t rxTransitionEndSchedule
 While in scheduled RX, you can still control the radio state via state transitions.
 
uint8_t hardWindowEnd
 If set to 0, this will allow any packets, which are received when the window end event occurs, to complete.

Configures the scheduled RX algorithm.

Defines the start and end times of the receive window created for a scheduled receive. If either start or end times are disabled, they will be ignored.

Definition at line 2129 of file rail_types.h.

Field Documentation

RAIL_Time_t RAIL_ScheduleRxConfig_t::end

The time to end receive.

See endMode for more information about the types of end times you can specify.

Definition at line 2147 of file rail_types.h.

RAIL_TimeMode_t RAIL_ScheduleRxConfig_t::endMode

How to interpret the time value specified in the end parameter.

See the RAIL_TimeMode_t documentation for more information. Note that, in this API, if you specify a RAIL_TIME_DELAY, it is relative to the start time if given and relative to now if none is specified. Also, using RAIL_TIME_DISABLED means that this window will not end unless you explicitly call RAIL_RfIdle() or add an end event through a future update to this configuration.

Definition at line 2157 of file rail_types.h.

uint8_t RAIL_ScheduleRxConfig_t::hardWindowEnd

If set to 0, this will allow any packets, which are received when the window end event occurs, to complete.

If set to anything else, an abort of any packets received when the window end occurs is forced.

Definition at line 2172 of file rail_types.h.

uint8_t RAIL_ScheduleRxConfig_t::rxTransitionEndSchedule

While in scheduled RX, you can still control the radio state via state transitions.

This option configures whether a transition to RX goes back to scheduled RX or to the normal RX state. Once in the normal RX state, you will effectively end the scheduled RX window and can continue to receive indefinitely depending on the state transitions. Set to 1 to transition to normal RX and 0 to stay in the scheduled RX.

Definition at line 2166 of file rail_types.h.

RAIL_Time_t RAIL_ScheduleRxConfig_t::start

The time to start receive.

See startMode for more information about the types of start times that you can specify.

Definition at line 2134 of file rail_types.h.

RAIL_TimeMode_t RAIL_ScheduleRxConfig_t::startMode

How to interpret the time value specified in the start parameter.

See the RAIL_TimeMode_t documentation for more information. Use RAIL_TIME_ABSOLUTE for absolute times, RAIL_TIME_DELAY for times relative to the current time and RAIL_TIME_DISABLED to ignore the start time.

Definition at line 2142 of file rail_types.h.


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