zephyr::raw

Function bt_le_oob_get_local

Source
pub unsafe extern "C" fn bt_le_oob_get_local(
    id: u8,
    oob: *mut bt_le_oob,
) -> i32
Expand description

@brief Get local LE Out of Band (OOB) information.

This function allows to get local information that are useful for Out of Band pairing or connection creation.

If privacy @kconfig{CONFIG_BT_PRIVACY} is enabled this will result in generating new Resolvable Private Address (RPA) that is valid for @kconfig{CONFIG_BT_RPA_TIMEOUT} seconds. This address will be used for advertising started by @ref bt_le_adv_start, active scanning and connection creation.

@note If privacy is enabled the RPA cannot be refreshed in the following cases: - Creating a connection in progress, wait for the connected callback. In addition when extended advertising @kconfig{CONFIG_BT_EXT_ADV} is not enabled or not supported by the controller: - Advertiser is enabled using a Random Static Identity Address for a different local identity. - The local identity conflicts with the local identity used by other roles.

@param[in] id Local identity, in most cases BT_ID_DEFAULT. @param[out] oob LE OOB information

@return Zero on success or error code otherwise, positive in case of protocol error or negative (POSIX) in case of stack internal error.