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
 This setting tells RAIL what to do with a packet being received when the window end event occurs.

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 2388 of file rail_types.h.

Field Documentation

◆ end

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 2406 of file rail_types.h.

◆ endMode

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 2416 of file rail_types.h.

◆ hardWindowEnd

uint8_t RAIL_ScheduleRxConfig_t::hardWindowEnd

This setting tells RAIL what to do with a packet being received when the window end event occurs.

If set to 0, such a packet will be allowed to complete. Any other setting will cause that packet to be aborted. In either situation, any posting of RAIL_EVENT_RX_SCHEDULED_RX_END is deferred briefly to when the packet's corresponding RAIL_EVENTS_RX_COMPLETION occurs.

Definition at line 2445 of file rail_types.h.

◆ rxTransitionEndSchedule

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.

This setting also influences the posting of RAIL_EVENT_RX_SCHEDULED_RX_END when the scheduled Rx window is implicitly ended by a packet receive (any of the RAIL_EVENTS_RX_COMPLETION events). See that event for details.

Note
An Rx transition to Idle state will always terminate the scheduled Rx window, regardless of this setting. This can be used to ensure Scheduled RX terminates on the first packet received (or first successful packet if the RX error transition is to Rx while the Rx success transition is to Idle).

Definition at line 2436 of file rail_types.h.

◆ start

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 2393 of file rail_types.h.

◆ startMode

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 2401 of file rail_types.h.


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