RF Sense#

RAIL_RfSenseBand_t#

RAIL_RfSenseBand_t

An enumeration for specifying the RF Sense frequency band.

DeprecatedRAIL 2.x synonym of sl_rail_rf_sense_band_t.

sl_rail_rf_sense_band_t#

sl_rail_rf_sense_band_t

An enumeration for specifying the RF Sense frequency band.

RAIL_RfSense_CallbackPtr_t#

typedef void(* RAIL_RfSense_CallbackPtr_t) (void) )(void)

A pointer to an RF Sense callback function.

Consider using the event RAIL_EVENT_RF_SENSED as an alternative.

DeprecatedRAIL 2.x synonym of sl_rail_rf_sense_callback_t().

sl_rail_rf_sense_callback_t#

typedef void(* sl_rail_rf_sense_callback_t) (void) )(void)

A pointer to an RF Sense callback function.

Consider using the event SL_RAIL_EVENT_RF_SENSED as an alternative.

sl_rail_rf_sense_high_sensitivity_value#

uint8_t sl_rail_rf_sense_high_sensitivity_value

The RF Sense high-sensitivity threshold value used by the next sl_rail_start_rf_sense() or sl_rail_start_selective_ook_rf_sense() call, when not specifying a low-sensitivity sl_rail_rf_sense_band_t.

The units are platform-dependent and range from 0 (highest sensitivity) to 255 (lowest sensitivity). This should be less than sl_rail_rf_sense_low_sensitivity_value. RAIL initializes this to a default setting.

sl_rail_rf_sense_low_sensitivity_value#

uint8_t sl_rail_rf_sense_low_sensitivity_value

The RF Sense low-sensitivity threshold value used by the next sl_rail_start_rf_sense() or sl_rail_start_selective_ook_rf_sense() call, when specifying a low-sensitivity sl_rail_rf_sense_band_t.

The units are platform-dependent and range from 0 (highest sensitivity) to 255 (lowest sensitivity). This should be greater than sl_rail_rf_sense_high_sensitivity_value. RAIL initializes this to a default setting.

RAIL_StartRfSense#

RAIL_Time_t RAIL_StartRfSense (RAIL_Handle_t railHandle, RAIL_RfSenseBand_t band, RAIL_Time_t senseTime, RAIL_RfSense_CallbackPtr_t cb)

Start/stop the RF Sense functionality in Energy Detection Mode for use during low-energy sleep modes.

Returns

• The actual senseTime used, which may be different than requested due to limitations of the hardware. If 0, RF sense was disabled or could not be enabled (no callback or event will be issued).

Some EFR32 radios have the ability to sense the presence of RF energy above -20 dBm within either or both the 2.4 GHz and Sub-GHz bands and trigger an event if that energy is continuously present for certain durations of time. An application can check when RF energy is sensed either by enabling the event RAIL_EVENT_RF_SENSED, by polling on the RAIL_IsRfSensed() API, or by using the cb callback.

Note

• After RF energy has been sensed, the RF Sense is automatically disabled and RAIL_StartRfSense() must be called again to reactivate it. If RF energy has not been sensed and to manually disable RF Sense, RAIL_StartRfSense() must be called with band specified as RAIL_RFSENSE_OFF or with senseTime set to 0 microseconds.

• Packet reception is not guaranteed to work correctly once RF Sense is enabled, both in single protocol and multiprotocol RAIL. To be safe, an application should turn this on only after idling the radio to stop receive and turn it off before attempting to restart receive. Since EM4 sleep causes the chip to come up through the reset vector any wake from EM4 must also shut off RF Sense to ensure proper receive functionality.

Warnings

• For some radios, RF Sense functionality is only guaranteed within a specified temperature range. See chip-specific documentation for more details.

DeprecatedRAIL 2.x synonym of sl_rail_start_rf_sense().

RAIL_StartSelectiveOokRfSense#

RAIL_Status_t RAIL_StartSelectiveOokRfSense (RAIL_Handle_t railHandle, RAIL_RfSenseSelectiveOokConfig_t * config)

Start/stop the RF Sense functionality in Selective(OOK Based) Mode for use during low-energy sleep modes.

Returns

• Status code indicating success of the function call.

Some radios support Selective RF energy detection (OOK mode) where the user can program the radio to look for a particular sync word pattern (1-4 bytes) sent using OOK and wake only when that is detected. See chip-specific documentation for more details.

The following code gives an example of how to use RF Sense functionality in Selective(OOK Based) Mode.

// Sync word length in bytes, 1-4 bytes.
#define NUM_SYNC_WORD_BYTES (2U)
// Sync word value.
#define SYNC_WORD           (0xB16FU)
// Desired RF band
RAIL_RfSenseBand_t rfBand = RAIL_RFSENSE_2_4GHZ;

// Configure the transmitting node for sending the wakeup packet.
RAIL_Idle(railHandle, RAIL_IDLE_ABORT, true);
RAIL_ConfigRfSenseSelectiveOokWakeupPhy(railHandle);
RAIL_SetRfSenseSelectiveOokWakeupPayload(railHandle, NUM_SYNC_WORD_BYTES, SYNC_WORD);
RAIL_StartTx(railHandle, channel, RAIL_TX_OPTIONS_DEFAULT, NULL);

// Configure the receiving node (EFR32xG22) for RF Sense.
RAIL_RfSenseSelectiveOokConfig_t config = {
 .band = rfBand,
 .syncWordNumBytes = NUM_SYNC_WORD_BYTES,
 .syncWord = SYNC_WORD,
 .cb = NULL // Use RAIL_EVENT_RF_SENSED event or poll RAIL_IsRfSensed()
};
RAIL_StartSelectiveOokRfSense(railHandle, &config);

Note

• After RF energy has been sensed, the RF Sense is automatically disabled and RAIL_StartSelectiveOokRfSense() must be called again to reactivate. If RF energy has not been sensed and to manually disable RF Sense, RAIL_StartSelectiveOokRfSense() must be called with band specified as RAIL_RFSENSE_OFF or with RAIL_RfSenseSelectiveOokConfig_t as NULL.

• Packet reception is not guaranteed to work correctly once RF Sense is enabled, both in single protocol and multiprotocol RAIL. To be safe, an application should turn this on only after idling the radio to stop receive and turn it off before attempting to restart receive. Since EM4 sleep causes the chip to come up through the reset vector any wake from EM4 must also shut off RF Sense to ensure proper receive functionality.

DeprecatedRAIL 2.x synonym of sl_rail_start_selective_ook_rf_sense().

RAIL_ConfigRfSenseSelectiveOokWakeupPhy#

RAIL_Status_t RAIL_ConfigRfSenseSelectiveOokWakeupPhy (RAIL_Handle_t railHandle)

Switch to RF Sense Selective(OOK) PHY.

Returns

• Status code indicating success of the function call.

This function switches to the RF Sense Selective(OOK) PHY for transmitting a packet to wake up a chip that supports Selective RF energy detection (OOK mode). You may only call this function while the radio is idle. While the radio is configured for this PHY, receive functionality should not be used.

Note

• The user must also set up the transmit FIFO, via RAIL_SetRfSenseSelectiveOokWakeupPayload, post this function call to include the first byte as the Preamble byte, followed by the Sync word (1-4 bytes). See chip-specific documentation for more details.

DeprecatedRAIL 2.x synonym of sl_rail_config_rf_sense_selective_ook_wakeup_phy().

RAIL_SetRfSenseSelectiveOokWakeupPayload#

RAIL_Status_t RAIL_SetRfSenseSelectiveOokWakeupPayload (RAIL_Handle_t railHandle, uint8_t numSyncwordBytes, uint32_t syncword)

Set the transmit payload for waking up a node configured for RF Sense Selective(OOK).

Returns

• Status code indicating success of the function call.

Note

• You must call this function after the chip has been set up with the RF Sense Selective(OOK) PHY, using RAIL_ConfigRfSenseSelectiveOokWakeupPhy.

DeprecatedRAIL 2.x synonym of sl_rail_set_rf_sense_selective_ook_wakeup_payload().

RAIL_IsRfSensed#

bool RAIL_IsRfSensed (RAIL_Handle_t railHandle)

Check whether the RF was sensed.

Returns

• true if RF was sensed since the last call to RAIL_StartRfSense(). false otherwise.

This function is useful if RAIL_StartRfSense() is called with a NULL callback. It is generally used after EM4 reboot but can be used any time.

DeprecatedRAIL 2.x synonym of sl_rail_is_rf_sensed().

sl_rail_start_rf_sense#

sl_rail_time_t sl_rail_start_rf_sense (sl_rail_handle_t rail_handle, sl_rail_rf_sense_band_t band, sl_rail_time_t sense_time_us, sl_rail_rf_sense_callback_t cb)

Start/stop the RF Sense functionality in Energy Detection Mode for use during low-energy sleep modes.

Returns

• The actual sense_time_us used, which may be different than requested due to limitations of the hardware. If 0, RF sense was disabled or could not be enabled (no callback or event will be issued).

Some EFR32 radios have the ability to sense the presence of RF energy above -20 dBm within either or both the 2.4 GHz and Sub-GHz bands and trigger an event if that energy is continuously present for certain durations of time. An application can check when RF energy is sensed either by enabling the event SL_RAIL_EVENT_RF_SENSED, by polling on the sl_rail_is_rf_sensed() API, or by using the cb callback.

Note

• After RF energy has been sensed, the RF Sense is automatically disabled and sl_rail_start_rf_sense() must be called again to reactivate it. If RF energy has not been sensed and to manually disable RF Sense, sl_rail_start_rf_sense() must be called with band specified as SL_RAIL_RF_SENSE_OFF or with sense_time_us set to 0 microseconds.

• Packet reception is not guaranteed to work correctly once RF Sense is enabled, both in single protocol and multiprotocol RAIL. To be safe, an application should turn this on only after idling the radio to stop receive and turn it off before attempting to restart receive. Since EM4 sleep causes the chip to come up through the reset vector any wake from EM4 must also shut off RF Sense to ensure proper receive functionality.

Warnings

• For some radios, RF Sense functionality is only guaranteed within a specified temperature range. See chip-specific documentation for more details.

sl_rail_start_selective_ook_rf_sense#

sl_rail_status_t sl_rail_start_selective_ook_rf_sense (sl_rail_handle_t rail_handle, sl_rail_rf_sense_selective_ook_config_t * p_config)

Start/stop the RF Sense functionality in Selective(OOK Based) Mode for use during low-energy sleep modes.

Returns

• Status code indicating success of the function call.

Some radios support Selective RF energy detection (OOK mode) where the user can program the radio to look for a particular sync word pattern (1-4 bytes) sent using OOK and wake only when that is detected. See chip-specific documentation for more details.

The following code gives an example of how to use RF Sense functionality in Selective(OOK Based) Mode.

// Sync word length in bytes, 1-4 bytes.
#define NUM_SYNC_WORD_BYTES (2U)
// Sync word value.
#define SYNC_WORD           (0xB16FU)
// Desired RF band
sl_rail_rf_sense_band_t rf_band = SL_RAIL_RF_SENSE_2P4_GHZ;

// Configure the transmitting node for sending the wakeup packet.
sl_rail_idle(rail_handle, SL_RAIL_IDLE_ABORT, true);
sl_rail_config_rf_sense_selective_ook_wakeup_phy(rail_handle);
sl_rail_set_rf_sense_selective_ook_wakeup_payload(rail_handle, NUM_SYNC_WORD_BYTES, SYNC_WORD);
sl_rail_start_tx(rail_handle, channel, SL_RAIL_TX_OPTIONS_DEFAULT, NULL);

// Configure the receiving node (EFR32xG22) for RF Sense.
sl_rail_rf_sense_selective_ook_config_t config = {
 .band = rf_band,
 .sync_word_bytes = NUM_SYNC_WORD_BYTES,
 .sync_word = SYNC_WORD,
 .cb = NULL // Use SL_RAIL_EVENT_RF_SENSED event or poll sl_rail_is_rf_sensed()
};
sl_rail_start_selective_ook_rf_sense(rail_handle, &config);

Note

• After RF energy has been sensed, the RF Sense is automatically disabled and sl_rail_start_selective_ook_rf_sense() must be called again to reactivate. If RF energy has not been sensed and to manually disable RF Sense, sl_rail_start_selective_ook_rf_sense() must be called with band specified as SL_RAIL_RF_SENSE_OFF or with sl_rail_rf_sense_selective_ook_config_t as NULL.

• Packet reception is not guaranteed to work correctly once RF Sense is enabled, both in single protocol and multiprotocol RAIL. To be safe, an application should turn this on only after idling the radio to stop receive and turn it off before attempting to restart receive. Since EM4 sleep causes the chip to come up through the reset vector any wake from EM4 must also shut off RF Sense to ensure proper receive functionality.

sl_rail_config_rf_sense_selective_ook_wakeup_phy#

sl_rail_status_t sl_rail_config_rf_sense_selective_ook_wakeup_phy (sl_rail_handle_t rail_handle)

Switch to RF Sense Selective(OOK) PHY.

Returns

• Status code indicating success of the function call.

This function switches to the RF Sense Selective(OOK) PHY for transmitting a packet to wake up a chip that supports Selective RF energy detection (OOK mode). You may only call this function while the radio is idle. While the radio is configured for this PHY, receive functionality should not be used.

Note

• The user must also set up the transmit FIFO, via sl_rail_set_rf_sense_selective_ook_wakeup_payload, post this function call to include the first byte as the Preamble byte, followed by the Sync word (1-4 bytes). See chip-specific documentation for more details.

sl_rail_set_rf_sense_selective_ook_wakeup_payload#

sl_rail_status_t sl_rail_set_rf_sense_selective_ook_wakeup_payload (sl_rail_handle_t rail_handle, uint8_t sync_word_bytes, uint32_t sync_word)

Set the transmit payload for waking up a node configured for RF Sense Selective(OOK).

Returns

• Status code indicating success of the function call.

Note

• You must call this function after the chip has been set up with the RF Sense Selective(OOK) PHY, using sl_rail_config_rf_sense_selective_ook_wakeup_phy.

sl_rail_is_rf_sensed#

bool sl_rail_is_rf_sensed (sl_rail_handle_t rail_handle)

Check whether the RF was sensed.

Returns

• true if RF was sensed since the last call to sl_rail_start_rf_sense(). false otherwise.

This function is useful if sl_rail_start_rf_sense() is called with a NULL callback. It is generally used after EM4 reboot but can be used any time.