This section describes the Generic Access Profile (GAP) APIs for Bluetooth with Enhanced Data Rate (EDR). More...

Overview

This section describes the Generic Access Profile (GAP) APIs for Bluetooth with Enhanced Data Rate (EDR).

The GAP defines the generic procedures related to discovery of Bluetooth devices and link management aspects of connecting to Bluetooth devices.

Terms and Acronyms

Terms	Details
GAP	Generic Access Profile. This profile defines the generic procedures related to discovery of Bluetooth devices and link management aspects of connecting to Bluetooth devices. It also defines procedures related to use of different security levels.
RSSI	Received Signal Strength Indication. For more information, please refer to Wikipedia.
SSP	Secure Simple Pairing. Simplifies the pairing process and improves Bluetooth security.
IO Capability	Input/Output Capability. It is used in pairing feature exchange process to determine which pairing method to use.
MITM	Man-in-the-middle Protection. For more information, please refer to Wikipedia.
COD	Class of Device, indicating the type of device.
EIR	Extended Inquiry Response data. It is sent during the inquiry response state. It can contain device name, transmit power level, service class UUIDs and more.
HCI	Host Controller Interface. For more information, please refer to Wikipedia.

How to use this module

GAP confirmation or indication event is used to notify the upper layer whether a process has finished or an indication has been received. BT_GAP_XXX_CNF represents the confirmation events, such as the HCI has received the related command. BT_GAP_XXX_IND represents the indication events.
GAP confirmation or indication event structures define the information required by the upper layer. The required data is an event parameter.

The event callback function, implemented by the upper layer, processes the received confirmation or indication events based on the event type.
- Sample code:
  - 1. Configure GAP.
    const bt_gap_config_t bt_config_default = {
    .inquiry_mode = BT_GAP_INQUIRY_MODE_RSSI_EIR,
    .io_capability = BT_GAP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT,
    .cod = 0x240404, // Audio device type.
    .device_name = {"HB Duo dev"},
    };
    // Implement the GAP configuration callback to pass the configuration parameters to initialize the GAP process.
    const bt_gap_config_t* bt_gap_get_local_configuration(void)
    {
    return &bt_config_default;
    }
  - 2. Search for nearby devices, as shown in the figure titled as "GAP inquiry message sequence" in the Bluetooth developer's guide under the [sdk_root]/doc folder.
    void user_application_search_nearby_devices(void)
    {
    bt_gap_inquiry(15, 20); // Duration = 15*1.28sec, maximum count=20.
    }
    // Implement the event callback to process the related GAP events.
    bt_status_t bt_app_event_callback(bt_msg_type_t msg, bt_status_t status, void *buff)
    {
    switch (msg)
    {
    case BT_GAP_INQUIRY_CNF:
    {
    if (status == BT_STATUS_SUCCESS) {
    // The inquiry command executed successfully.
    } else {
    // The inquiry command has failed.
    }
    }
    break;
    case BT_GAP_INQUIRY_IND:
    {
    // Find a nearby device.
    bt_gap_inquiry_ind_t* device = (bt_gap_inquiry_ind_t*) buff;
    // Handle the event, example connecting to the device.
    }
    break;
    case BT_GAP_INQUIRY_COMPLETE_IND:
    {
    // The inquiry is complete.
    }
    break;
    default:
    break;
    }
    return status;
    }
  - 3. Make the device visible, as shown in the figure titled as "Set the scan mode message sequence" in the Bluetooth developer's guide under the [sdk_root]/doc folder.
    void user_application_make_visiable(void)
    {
    bt_gap_set_scan_mode(BT_GAP_SCAN_MODE_GENERAL_ACCESSIBLE);
    }
    // Implement the event callback to process the related GAP events.
    bt_status_t bt_app_event_callback(bt_msg_type_t msg, bt_status_t status, void *buff)
    {
    switch (msg)
    {
    case BT_GAP_SET_SCAN_MODE_CNF:
    {
    if (status == BT_STATUS_SUCCESS) {
    // bt_gap_set_scan_mode() completed successfully, it can be found by nearby devices.
    } else {
    // Setting the scan mode has failed.
    }
    }
    break;
    default:
    break;
    }
    return status;
    }
  - 4. Create links.
    // Call the related profile API, such as bt_hfp_connect().
    // Implement the event callback to process the related GAP events.
    bt_status_t bt_app_event_callback(bt_msg_type_t msg, bt_status_t status, void *buff)
    {
    switch (msg)
    {
    case BT_GAP_LINK_STATUS_UPDATED_IND:
    {
    bt_gap_link_status_updated_ind_t* param = (bt_gap_link_status_updated_ind_t*) buff;
    // Handle the link status update event.
    if (param->link_status == BT_GAP_LINK_STATUS_DISCONNECTED) {
    // The link is disconnected and it cannot re-connect in this function call stack.
    } elseif (param->link_status >= BT_GAP_LINK_STATUS_CONNECTED_0) {
    // The link is connected.
    }
    break;
    }
    default:
    break;
    }
    return status;
    }
  - 5. Bonding, as shown in the figure titled as "Bonding using number comparison message sequence" in the Bluetooth developer's guide under the [sdk_root]/doc folder.
    // Start bonding when profiles are connecting and required security or the remote device request bonding.
    // Implement the event callback to process the related GAP events.
    bt_status_t bt_app_event_callback(bt_msg_type_t msg, bt_status_t status, void *buff)
    {
    switch (msg)
    {
    case BT_GAP_BONDING_START_IND:
    {
    bt_gap_connection_handle_t* link_handle = (bt_gap_connection_handle_t*) buff;
    // link_handle is going to bond.
    break;
    }
    case BT_GAP_IO_CAPABILITY_REQ_IND:
    {
    // This event is received after BT_GAP_BONDING_START_IND and both devices support SSP.
    bt_gap_connection_handle_t handle;
    handle = (bt_gap_connection_handle_t)buff;
    // Call the function bt_gap_reply_io_capability_request() to accept bonding or call bt_gap_reject_io_capability_request() to terminate bonding.
    break;
    }
    case BT_GAP_USER_CONFIRM_REQ_IND:
    {
    // This event is received after BT_GAP_IO_CAPABILITY_REQ_IND and IO Capability of both devices is BT_GAP_IO_CAPABILITY_DISPLAY_YES_NO.
    // Call the function bt_gap_reply_user_confirm_request(true) to accept bonding or call bt_gap_reply_user_confirm_request(false) to terminate bonding.
    break;
    }
    case BT_GAP_USER_PASSKEY_NOTIFICATION_IND:
    {
    // This event is received after BT_GAP_IO_CAPABILITY_REQ_IND, and local IO Capability is BT_GAP_IO_CAPABILITY_DISPLAY_ONLY or BT_GAP_IO_CAPABILITY_DISPLAY_YES_NO and remote IO Capability is BT_GAP_IO_CAPABILITY_KEYBOARD_ONLY
    // Display the passkey on the screen.
    uint32_t* passkey = (uint32_t*) buff;
    // Call GDI APIs to show the passkey.
    break;
    }
    case BT_GAP_USER_PASSKEY_NOTIFICATION_END_IND:
    {
    // This event will be received after BT_GAP_USER_PASSKEY_NOTIFICATION_IND.
    // User should stop displaying the passkey.
    break;
    }
    case BT_GAP_USER_REPLY_PASSKEY_IND:
    {
    // This event will be received after BT_GAP_IO_CAPABILITY_REQ_IND, and remote IO Capability is BT_GAP_IO_CAPABILITY_DISPLAY_ONLY or BT_GAP_IO_CAPABILITY_DISPLAY_YES_NO and local IO Capability is BT_GAP_IO_CAPABILITY_KEYBOARD_ONLY
    // Call the function bt_gap_reply_passkey_request() to replay the passkey before passkey timeout(25 second).
    break;
    }
    case BT_GAP_LINK_KEY_NOTIFICATION_IND:
    {
    // This event is received before BT_GAP_BONDING_COMPLETE_IND and bonding success or the old link key is phased out.
    bt_gap_link_key_notification_ind_t * key_info = (bt_gap_link_key_notification_ind_t *) buff;
    if (key_info->key_type == BT_GAP_LINK_KEY_TYPE_INVALID) {
    // The old link key is phased out, delete it from the link key database.
    }
    else {
    // Save the new link key, and key_type to link key database.
    }
    break;
    }
    case BT_GAP_BONDING_COMPLETE_IND:
    {
    // Bonding has finished.
    if (status == BT_STATUS_SUCCESS) {
    // Bonding is successfully complete.
    } else {
    // Bonding has Failed.
    }
    break;
    }
    default:
    break;
    }
    return status;
    }
    // Provide the link key in a user-defined API implementation.
    void bt_gap_get_link_key(bt_gap_link_key_notification_ind_t* key_information)
    {
    bool is_key_find;
    // Find the link key according to key_information->address from the link key database.
    // If the link key is found, fill the key_information->key and the key_information->key_type.
    if (is_key_find) {
    key_information->key_type = type;
    memcpy(&(key_information->key), key, BT_KEY_SIZE);
    }
    }
    // If local or remote device doesn't support SSP, the pin code pairing will be used.
    // Default pin code is "0000", to change it, implement the function bt_gap_get_pin_code().
    static const bt_gap_pin_code_information_t bt_gap_my_pin_code =
    {
    .pin_len = 4,
    .pin_code = {"1111"},
    };
    // A user-defined API.
    const bt_gap_pin_code_information_t* bt_gap_get_pin_code(void)
    {
    return &bt_gap_my_pin_code;
    }

Functions
bt_status_t	bt_gap_set_scan_mode (bt_gap_scan_mode_t mode)
	This function sets the accessible mode. More...

bt_status_t	bt_gap_inquiry (uint8_t duration, uint8_t max_count)
	This function inquires the search for nearby devices. More...

bt_status_t	bt_gap_cancel_inquiry (void)
	This function stops the inquiry. More...

bt_status_t	bt_gap_exit_sniff_mode (bt_gap_connection_handle_t handle)
	This function exits the sniff mode for the link. More...

bt_status_t	bt_gap_disconnect (bt_gap_connection_handle_t handle)
	This function disconnects the special link. More...

bt_status_t	bt_gap_set_role (bt_gap_connection_handle_t handle, bt_role_t role)
	This function changes the device's role type. More...

bt_status_t	bt_gap_get_role (bt_gap_connection_handle_t handle)
	This function gets the device's role type. More...

bt_status_t	bt_gap_read_remote_name (const bt_bd_addr_t *address)
	This function gets the device's name, no need to be connected to the device. More...

bt_status_t	bt_gap_cancel_name_request (const bt_bd_addr_t *address)
	This function cancels the request of bt_gap_read_remote_name(). More...

bt_status_t	bt_gap_enter_test_mode (void)
	This function sets the device into a test mode. More...

bt_status_t	bt_gap_set_extended_inquiry_response (uint8_t *eir_data, uint32_t data_length)
	This function sets the EIR data. More...

bt_status_t	bt_gap_write_inquiry_tx (int8_t tx_power)
	This function writes the inquiry transmit power. More...

bt_status_t	bt_gap_read_inquiry_response_tx (void)
	This function reads the inquiry response transmit power. More...

bt_status_t	bt_gap_write_page_scan_activity (uint16_t interval, uint16_t window)
	This function writes the values for the interval and the window of page scanning. More...

bt_status_t	bt_gap_write_inquiry_scan_activity (uint16_t interval, uint16_t window)
	This function writes values for the interval and the window of inquiry scanning. More...

const bt_bd_addr_t *	bt_gap_get_remote_address (bt_gap_connection_handle_t handle)
	This function gets the address of a connected device. More...

bt_status_t	bt_gap_read_rssi (bt_gap_connection_handle_t handle)
	This function reads the RSSI of the connected device. More...

const bt_gap_pin_code_information_t *	bt_gap_get_pin_code (void)
	This is a user defined callback to get the pin code and pass it to the GAP process. More...

bt_status_t	bt_gap_reply_io_capability_request (bt_gap_oob_data_presented_t oob_present, bt_gap_security_auth_request_t auth_request)
	This function sends a reply to the BT_GAP_IO_CAPABILITY_REQ_IND event with Out-of-band data presented and security authentication request. More...

bt_status_t	bt_gap_reject_io_capability_request (void)
	This function rejects the BT_GAP_IO_CAPABILITY_REQ_IND event and terminates the bonding. More...

bt_status_t	bt_gap_reply_passkey_request (const uint32_t *passkey)
	This function is a reply to the BT_GAP_USER_REPLY_PASSKEY_IND event. More...

bt_status_t	bt_gap_reply_user_confirm_request (bool accept)
	This function is a reply to the BT_GAP_USER_CONFIRM_REQ_IND event. More...

void	bt_gap_get_link_key (bt_gap_link_key_notification_ind_t *key_information)
	This is a user defined callback to get the link key and pass it to the GAP process. More...

const bt_gap_config_t *	bt_gap_get_local_configuration (void)
	This is a user defined callback to get the configuration parameters for the GAP initialization process. More...

bt_status_t	bt_gap_set_default_sniff_parameters (const bt_gap_default_sniff_params_t *sniff_params)
	This function sets the default sniff parameters. More...

bt_status_t	bt_gap_set_default_sniff_subrating_parameters (const bt_gap_default_sniff_subrating_params_t *sniff_subrating_params)
	This function sets the default subrating_parameters. More...

bt_gap_accept_connection_status_t	bt_gap_check_connect_request (bt_bd_addr_ptr_t address, uint32_t cod)
	This is a user defined callback to check whether to accept the connecting request or reject it. More...

Modules
	Define
	Define Classic Bluetooth GAP data types and values.

	Struct
	Define Classic Bluetooth GAP structures for GAP APIs and events.

Function Documentation

bt_status_t bt_gap_cancel_inquiry ( void )

This function stops the inquiry.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_cancel_name_request ( const bt_bd_addr_t * address )

This function cancels the request of bt_gap_read_remote_name().

Parameters

[in] address is the address of the remote device.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_gap_accept_connection_status_t bt_gap_check_connect_request	(	bt_bd_addr_ptr_t	address,
		uint32_t	cod
	)

This is a user defined callback to check whether to accept the connecting request or reject it.

Parameters

[in]	address	is the address of a connecting device.
[in]	cod	is the class of a device.

Returns: BT_GAP_ACCEPT_AS_MASTER, accept the connecting request as master role. BT_GAP_ACCEPT_AS_SLAVE, accept the connecting request as slave role. BT_GAP_REJECTED_DUE_TO_LIMITED_RESOURCES, reject the connecting request due to a lack of resources. BT_GAP_REJECTED_DUE_TO_SECURITY_REASONS, reject the connecting request due to security. BT_GAP_ACCEPT_REJECTED_DUE_TO_UNACCEPTABLE_BDADDR, reject the connecting request due to unacceptable device address.

bt_status_t bt_gap_disconnect ( bt_gap_connection_handle_t handle )

This function disconnects the special link.

Parameters

[in] handle is the link handle to be disconnected.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory. BT_STATUS_CONNECTION_NOT_FOUND, the operation has failed, the link does not exist.

bt_status_t bt_gap_enter_test_mode ( void )

This function sets the device into a test mode.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_exit_sniff_mode ( bt_gap_connection_handle_t handle )

This function exits the sniff mode for the link.

Parameters

[in] handle is the link handle.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory. BT_STATUS_CONNECTION_NOT_FOUND, the operation has failed, the link does not exist.

void bt_gap_get_link_key ( bt_gap_link_key_notification_ind_t * key_information )

This is a user defined callback to get the link key and pass it to the GAP process.

Parameters

[in,out] key_information provide the key and key_type for a given address.

Returns: None.

const bt_gap_config_t* bt_gap_get_local_configuration ( void )

This is a user defined callback to get the configuration parameters for the GAP initialization process.

Returns: the configuration information supplied by user.

const bt_gap_pin_code_information_t* bt_gap_get_pin_code ( void )

This is a user defined callback to get the pin code and pass it to the GAP process.

Returns: A pointer to the pin information.

const bt_bd_addr_t* bt_gap_get_remote_address ( bt_gap_connection_handle_t handle )

This function gets the address of a connected device.

Parameters

[in] handle is the connection handle.

Returns: A pointer to the address, if the operation completed successfully. NULL, if it failed.

bt_status_t bt_gap_get_role ( bt_gap_connection_handle_t handle )

This function gets the device's role type.

The BT_GAP_GET_ROLE_CNF event is received when finished.

Parameters

[in] handle is the link handle.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_inquiry	(	uint8_t	duration,
		uint8_t	max_count
	)

This function inquires the search for nearby devices.

The BT_GAP_INQUIRY_IND event is received once a new device is found.

Parameters

[in]	duration	is the maximum time of the inquiry. The inquiry stops after the timeout. The range is from 0x01 to 0x30. Time = N * 1.28sec.
[in]	max_count	is the maximum device count of the inquiry, stops the inquiry, if the number of searched devices reaches the max_count. The range is from 0x00 to 0xFF, 0 - unlimited number of responses.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_read_inquiry_response_tx ( void )

This function reads the inquiry response transmit power.

The BT_GAP_READ_INQUIRY_RESPONSE_TX_CNF event is received once the operation is complete.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_read_remote_name ( const bt_bd_addr_t * address )

This function gets the device's name, no need to be connected to the device.

The BT_GAP_READ_REMOTE_NAME_COMPLETE_IND event is received once the operation is complete.

Parameters

[in] address is the address of the remote device.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_read_rssi ( bt_gap_connection_handle_t handle )

This function reads the RSSI of the connected device.

BT_GAP_READ_RSSI_CNF event is received once the operation is complete.

Parameters

[in] handle is the link handle.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_reject_io_capability_request ( void )

This function rejects the BT_GAP_IO_CAPABILITY_REQ_IND event and terminates the bonding.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, the operation has timed out. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_reply_io_capability_request	(	bt_gap_oob_data_presented_t	oob_present,
		bt_gap_security_auth_request_t	auth_request
	)

This function sends a reply to the BT_GAP_IO_CAPABILITY_REQ_IND event with Out-of-band data presented and security authentication request.

Parameters

[in]	oob_present	is the Out-of-band data presented.
[in]	auth_request	is the security authentication request.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, the operation has timed out. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_reply_passkey_request ( const uint32_t * passkey )

This function is a reply to the BT_GAP_USER_REPLY_PASSKEY_IND event.

Parameters

[in] passkey is a pointer to the user's passkey. If it is NULL, the reply is rejected.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, the operation has timed out. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_reply_user_confirm_request ( bool accept )

This function is a reply to the BT_GAP_USER_CONFIRM_REQ_IND event.

Parameters

[in] accept defines whether the pairing is accepted.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, the operation has timed out. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_set_default_sniff_parameters ( const bt_gap_default_sniff_params_t * sniff_params )

This function sets the default sniff parameters.

The default settings remain effective till the system reboot.

Parameters

[in] sniff_params is the default sniff parameters.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated.

bt_status_t bt_gap_set_default_sniff_subrating_parameters ( const bt_gap_default_sniff_subrating_params_t * sniff_subrating_params )

This function sets the default subrating_parameters.

The default settings remain effective till the system reboot.

Parameters

[in] sniff_subrating_params is the default sniff subrating parameters.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated.

bt_status_t bt_gap_set_extended_inquiry_response	(	uint8_t *	eir_data,
		uint32_t	data_length
	)

This function sets the EIR data.

Parameters

[in]	eir_data	is the content of EIR data.
[in]	data_length	is the size of the EIR data, the maximum length is 240.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_set_role	(	bt_gap_connection_handle_t	handle,
		bt_role_t	role
	)

This function changes the device's role type.

The BT_GAP_ROLE_CHANGED_IND event is received when the role changed.

Parameters

[in]	handle	is the link handle to change.
[in]	role	is the role to change.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_set_scan_mode ( bt_gap_scan_mode_t mode )

This function sets the accessible mode.

Parameters

[in] mode is the accessing mode.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_write_inquiry_scan_activity	(	uint16_t	interval,
		uint16_t	window
	)

This function writes values for the interval and the window of inquiry scanning.

The BT_GAP_WRITING_INQUIRY_SCAN_CNF event will be received when finished.

Parameters

[in]	interval	is the inquiry scan interval, default value is 0x1000, the range is from 0x12 to 0x1000. Time = N * 0.626 ms.
[in]	window	is the inquiry scan window, it shall be less than or equal to interval, default value is 0x0012, the range is from 0x12 to 0x1000. Time = N * 0.626 ms.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_write_inquiry_tx ( int8_t tx_power )

This function writes the inquiry transmit power.

Parameters

[in] tx_power is the transmit power, the range is from -70 to 20.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

bt_status_t bt_gap_write_page_scan_activity	(	uint16_t	interval,
		uint16_t	window
	)

This function writes the values for the interval and the window of page scanning.

The BT_GAP_WRITING_PAGE_SCAN_CNF event is received once the operation is complete.

Parameters

[in]	interval	is the page scan interval, default value is 0x0800, the range is from 0x12 to 0x1000. Time = N * 0.626 ms.
[in]	window	is the page scan window, it shall be less than or equal to interval, default value is 0x0012, the range is from 0x12 to 0x1000. Time = N * 0.626 ms.

Returns: BT_STATUS_SUCCESS, the operation completed successfully. BT_STATUS_FAIL, an error occurred, the operation has terminated. BT_STATUS_OUT_OF_MEMORY, the operation has failed, out of memory.

Overview

Terms and Acronyms

How to use this module

Functions

Modules

Function Documentation