nrf-softdevice-s112

Crates

git

Versions

default

Flavors

pub unsafe fn sd_radio_notification_cfg_set(type_: u8, distance: u8) -> u32
Expand description

@brief Configures the Radio Notification signal.

@note - The notification signal latency depends on the interrupt priority settings of SWI used for notification signal. - To ensure that the radio notification signal behaves in a consistent way, the radio notifications must be configured when there is no protocol stack or other SoftDevice activity in progress. It is recommended that the radio notification signal is configured directly after the SoftDevice has been enabled. - In the period between the ACTIVE signal and the start of the Radio Event, the SoftDevice will interrupt the application to do Radio Event preparation. - Using the Radio Notification feature may limit the bandwidth, as the SoftDevice may have to shorten the connection events to have time for the Radio Notification signals.

@param[in] type Type of notification signal, see @ref NRF_RADIO_NOTIFICATION_TYPES. @ref NRF_RADIO_NOTIFICATION_TYPE_NONE shall be used to turn off radio notification. Using @ref NRF_RADIO_NOTIFICATION_DISTANCE_NONE is recommended (but not required) to be used with @ref NRF_RADIO_NOTIFICATION_TYPE_NONE.

@param[in] distance Distance between the notification signal and start of radio activity, see @ref NRF_RADIO_NOTIFICATION_DISTANCES. This parameter is ignored when @ref NRF_RADIO_NOTIFICATION_TYPE_NONE or @ref NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE is used.

@retval ::NRF_ERROR_INVALID_PARAM The group number is invalid. @retval ::NRF_ERROR_INVALID_STATE A protocol stack or other SoftDevice is running. Stop all running activities and retry. @retval ::NRF_SUCCESS