Bluetooth generic API. More...

#include <stdint.h>
#include <bluetooth/bluetooth.h>

Classes
struct	bt_common_state_s
	Bluetooth base context. More...

struct	bt_acl_state_s
	Bluetooth ACL context. More...

struct	ble_state_s
	Bluetooth LE context. More...

struct	ble_addr_s
	BLE address. More...

struct	ble_idkey_s

struct	ble_cccd_s

struct	ble_bondinfo_s
	Bluetooth LE bonding information. More...

struct	ble_scan_param_s

struct	ble_conn_param_s

struct	bt_common_ops_s
	Bluetooth Common application callbacks. More...

struct	ble_common_ops_s
	Bluetooth LE Common application callbacks. More...

struct	bt_eir_s
	The format of one data in advertising data. More...

Macros
#define	BT_ADV_DATA_MAX_LEN (255)

#define	BT_ADV_DATA_LEN_LEN (1)

#define	BT_ADV_DATA_TYPE_LEN (1)

#define	BT_EIR_LEN

#define	BLE_IRK_LEN (16)

#define	BLE_CSRK_LEN (16)

#define	BLE_LTK_LEN (16)

#define	BLE_RAND_LEN (8)

#define	BLE_SCAN_PARAM_INTERVAL_MSEC(t) ((t) * 1000 / 625)

#define	BLE_SCAN_PARAM_WINDOW_MSEC(t) ((t) * 1000 / 625)

#define	BLE_SCAN_PARAM_TIMEOUT_MSEC(t) ((t) * 1000 / 10000)

#define	BLE_CONN_PARAM_INTERVAL_MSEC(t) ((t) * 1000 / 1250)

#define	BLE_CONN_PARAM_TIMEOUT_MSEC(t) ((t) * 1000 / 10000)

#define	BLESTAT_SUCCESS 0x00

#define	BLESTAT_MEMCAP_EXCD 0x07

#define	BLESTAT_CONNECT_TIMEOUT 0x08

#define	BLESTAT_PEER_TERMINATED 0x13

#define	BLESTAT_PEER_TERM_LOWRES 0x14

#define	BLESTAT_PEER_TERM_POFF 0x15

#define	BLESTAT_TERMINATED 0x16

#define	BLESTAT_UNSPEC_ERR 0x1F

#define	BLESTAT_DEVICE_BUSY 0x3A

#define	BLESTAT_PARAM_REJECTED 0x3B

#define	BLESTAT_CONNECT_FAILED 0x3E

#define	EXTERN extern "C"

Enumerations
enum	BT_CONNECT_STATUS { BT_DISCONNECTED = 0 , BT_DISCONNECTING = 1 , BT_CONNECTING = 2 , BT_CONNECTED = 3 }
	BT profile connection status. More...

Functions
int	bt_init (void)
	Bluetooth module initialize For initialize a pin config, NV storage, UART, etc. More...

int	bt_finalize (void)
	Bluetooth module finalize. More...

int	bt_set_address (BT_ADDR *addr)
	Set Bluetooth module address This is Spresense side address and should be called before bt_enable. More...

int	bt_get_address (BT_ADDR *addr)
	Get Bluetooth module address. More...

int	bt_set_name (char *name)
	Set Bluetooth module name This name visible for other devices and should be called before bt_enable. More...

int	bt_get_name (char *name)
	Get Bluetooth module name. More...

int	bt_enable (void)
	Bluetooth module enable Bluetooth set power on(and download firmware, etc). More...

int	bt_disable (void)
	Bluetooth module disable Bluetooth set power off. More...

int	bt_pairing_enable (void)
	Bluetooth pairing enable Entering bluetooth pairing mode. More...

int	bt_paring_disable (void)
	Bluetooth pairing disable Escaping bluetooth pairing mode. More...

int	bt_get_bond_list (BT_ADDR addr, int num)
	Bluetooth get bond device list Get bond devices list with BD_ADDR. More...

int	bt_unbond (BT_ADDR *addr)
	Bluetooth unbond by BD_ADDR Unbond device by BD_ADDR. More...

int	bt_set_visibility (BT_VISIBILITY visibility)
	Bluetooth set visible Visible this device from others. More...

int	bt_start_inquiry (void)
	Bluetooth inquiry start Start to inquiry for connect peer device. More...

int	bt_cancel_inquiry (void)
	Bluetooth inquiry cancel Cancel to inquiry. More...

int	bt_register_common_cb (struct bt_common_ops_s *bt_common_ops)
	Bluetooth register common callbacks Register Connect/Pairing/Inquiry callback. More...

int	ble_set_address (BT_ADDR *addr)
	Set Bluetooth LE module address of the random static address type. This is Spresense side address and should be called before bt_enable. More...

int	ble_get_address (BT_ADDR *addr)
	Get Bluetooth LE module address. More...

int	ble_set_public_address (BT_ADDR *addr)
	Set Bluetooth LE module address of the public address type. This is Spresense side address and should be called before bt_enable. More...

uint8_t	ble_get_address_type (void)
	Get Bluetooth LE module address type. More...

int	ble_set_name (char *name)
	Set Bluetooth LE module name This name visible for other devices and should be called before bt_enable. More...

int	ble_get_name (char *name)
	Get Bluetooth LE module name. More...

int	ble_set_appearance (BLE_APPEARANCE appearance)
	Set Bluetooth LE module appearance. More...

int	ble_enable (void)
	Bluetooth LE enable. More...

int	ble_disable (void)
	Bluetooth LE disable. More...

int	ble_connect (struct ble_state_s *ble_state)
	Bluetooth LE connect for Central. More...

int	ble_disconnect (struct ble_state_s *ble_state)
	Bluetooth LE dicsonnect for Central. More...

int	ble_start_advertise (void)
	Bluetooth LE start advertise Start BLE advertise mode. More...

int	ble_cancel_advertise (void)
	Bluetooth LE cancel advertise Cancel BLE advertise mode. More...

int	ble_start_scan (bool duplicate_filter)
	Bluetooth LE start scan Start BLE scan mode. More...

int	ble_cancel_scan (void)
	Bluetooth LE cancel scan Cancel BLE scan mode. More...

int	ble_register_common_cb (struct ble_common_ops_s *ble_common_ops)
	Bluetooth LE register common callbacks Register Connect/Advertise/Scan callback. More...

uint16_t	ble_set_request_mtusize (uint16_t sz)
	Set MTU size that application requests. More...

uint16_t	ble_get_request_mtusize (void)
	Get MTU size that application requests. More...

int	ble_get_negotiated_mtusize (uint16_t handle)
	Get negotiated MTU size. More...

int	ble_set_tx_power (int8_t tx_power)
	Set Tx power. More...

int	ble_set_scan_param (struct ble_scan_param_s *param)
	Set scan parameter. More...

int	ble_set_conn_param (struct ble_conn_param_s *param)
	Set connection parameter. More...

int	ble_pairing (uint16_t handle)
	Execute pairing. More...

int	ble_parse_advertising_data (BLE_AD_TYPE target, uint8_t adv_data, uint8_t adv_len, struct bt_eir_s eir)
	Parse advertise data. More...

Detailed Description

Bluetooth generic API.

Author: Sony Semiconductor Solutions Corporation

This API is generic functions for bluetooth operations

Macro Definition Documentation

◆ BT_EIR_LEN

#define BT_EIR_LEN

Value:

                   (BT_ADV_DATA_MAX_LEN \
                   - BT_ADV_DATA_LEN_LEN \
                   - BT_ADV_DATA_TYPE_LEN)

◆ BLESTAT_SUCCESS

#define BLESTAT_SUCCESS 0x00

BLE status code Success

◆ BLESTAT_MEMCAP_EXCD

#define BLESTAT_MEMCAP_EXCD 0x07

Memory Capacity Exceeded

◆ BLESTAT_CONNECT_TIMEOUT

#define BLESTAT_CONNECT_TIMEOUT 0x08

Connection Timeout

◆ BLESTAT_PEER_TERMINATED

#define BLESTAT_PEER_TERMINATED 0x13

Peer Device Terminated Connection

◆ BLESTAT_PEER_TERM_LOWRES

#define BLESTAT_PEER_TERM_LOWRES 0x14

Peer Device Terminated Connection due to Low Resources

◆ BLESTAT_PEER_TERM_POFF

#define BLESTAT_PEER_TERM_POFF 0x15

Peer Device Terminated Connection due to Power Off

◆ BLESTAT_TERMINATED

#define BLESTAT_TERMINATED 0x16

Connection Terminated By Own device

◆ BLESTAT_UNSPEC_ERR

#define BLESTAT_UNSPEC_ERR 0x1F

Unspecified Error

◆ BLESTAT_DEVICE_BUSY

#define BLESTAT_DEVICE_BUSY 0x3A

Controller Busy

◆ BLESTAT_PARAM_REJECTED

#define BLESTAT_PARAM_REJECTED 0x3B

Unacceptable Connection Parameters

◆ BLESTAT_CONNECT_FAILED

#define BLESTAT_CONNECT_FAILED 0x3E

Connection Failed to be Established / Synchronization Timeout

Enumeration Type Documentation

◆ BT_CONNECT_STATUS

enum BT_CONNECT_STATUS

BT profile connection status.

Enumerator
BT_DISCONNECTED	Disconnected
BT_DISCONNECTING	Disconnect operation working
BT_CONNECTING	Connect operation working
BT_CONNECTED	Connected

Function Documentation

◆ bt_init()

int bt_init ( void )

Bluetooth module initialize For initialize a pin config, NV storage, UART, etc.

Return values

error code

◆ bt_finalize()

int bt_finalize ( void )

Bluetooth module finalize.

Return values

error code

◆ bt_set_address()

int bt_set_address ( BT_ADDR * addr )

Set Bluetooth module address This is Spresense side address and should be called before bt_enable.

Parameters

[in] addr Bluetooth device address BT_ADDR

Return values

error code

◆ bt_get_address()

int bt_get_address ( BT_ADDR * addr )

Get Bluetooth module address.

Parameters

[out] addr Bluetooth device address BT_ADDR

Return values

error code

◆ bt_set_name()

int bt_set_name ( char * name )

Set Bluetooth module name This name visible for other devices and should be called before bt_enable.

Parameters

[in] name Bluetooth device name

Return values

error code

◆ bt_get_name()

int bt_get_name ( char * name )

Get Bluetooth module name.

Parameters

[out] name Bluetooth device name

Return values

error code

◆ bt_enable()

int bt_enable ( void )

Bluetooth module enable Bluetooth set power on(and download firmware, etc).

Return values

error code

◆ bt_disable()

int bt_disable ( void )

Bluetooth module disable Bluetooth set power off.

Return values

error code

◆ bt_pairing_enable()

int bt_pairing_enable ( void )

Bluetooth pairing enable Entering bluetooth pairing mode.

Return values

error code

◆ bt_paring_disable()

int bt_paring_disable ( void )

Bluetooth pairing disable Escaping bluetooth pairing mode.

Return values

error code

◆ bt_get_bond_list()

int bt_get_bond_list	(	BT_ADDR *	addr,
		int *	num
	)

Bluetooth get bond device list Get bond devices list with BD_ADDR.

Parameters

[in]	addr	Device address list BT_ADDR
[in]	num	Number of BD_ADDR

Return values

error code

◆ bt_unbond()

int bt_unbond ( BT_ADDR * addr )

Bluetooth unbond by BD_ADDR Unbond device by BD_ADDR.

Parameters

[out] addr Unbond device BD_ADDR BT_ADDR

Return values

error code

◆ bt_set_visibility()

int bt_set_visibility ( BT_VISIBILITY visibility )

Bluetooth set visible Visible this device from others.

Parameters

[in] visibility Device visibility parameter BT_VISIBILITY

Return values

error code

◆ bt_start_inquiry()

int bt_start_inquiry ( void )

Bluetooth inquiry start Start to inquiry for connect peer device.

Return values

error code

◆ bt_cancel_inquiry()

int bt_cancel_inquiry ( void )

Bluetooth inquiry cancel Cancel to inquiry.

Return values

error code

◆ bt_register_common_cb()

int bt_register_common_cb ( struct bt_common_ops_s * bt_common_ops )

Bluetooth register common callbacks Register Connect/Pairing/Inquiry callback.

Parameters

[in] bt_common_ops Application callback bt_common_ops_s

Return values

error code

◆ ble_set_address()

int ble_set_address ( BT_ADDR * addr )

Set Bluetooth LE module address of the random static address type. This is Spresense side address and should be called before bt_enable.

Parameters

[in] addr Bluetooth LE device address BT_ADDR

Return values

error code

◆ ble_get_address()

int ble_get_address ( BT_ADDR * addr )

Get Bluetooth LE module address.

Parameters

[out] addr Bluetooth LE device address BT_ADDR

Return values

error code

◆ ble_set_public_address()

int ble_set_public_address ( BT_ADDR * addr )

Set Bluetooth LE module address of the public address type. This is Spresense side address and should be called before bt_enable.

Parameters

[in] addr Bluetooth LE device address BT_ADDR

Return values

error code

◆ ble_get_address_type()

uint8_t ble_get_address_type ( void )

Get Bluetooth LE module address type.

Return values

Bluetooth LE device address type

◆ ble_set_name()

int ble_set_name ( char * name )

Set Bluetooth LE module name This name visible for other devices and should be called before bt_enable.

Parameters

[in] name Bluetooth LE device name

Return values

error code

◆ ble_get_name()

int ble_get_name ( char * name )

Get Bluetooth LE module name.

Parameters

[out] name Bluetooth LE device name

Return values

error code

◆ ble_set_appearance()

int ble_set_appearance ( BLE_APPEARANCE appearance )

Set Bluetooth LE module appearance.

Parameters

[in] appearance Bluetooth LE device appearance

Return values

error code

◆ ble_enable()

int ble_enable ( void )

Bluetooth LE enable.

Return values

error code

◆ ble_disable()

int ble_disable ( void )

Bluetooth LE disable.

Return values

error code

◆ ble_connect()

int ble_connect ( struct ble_state_s * ble_state )

Bluetooth LE connect for Central.

Parameters

[in] ble_state Bluetooth context ble_state_s

Return values

error code

◆ ble_disconnect()

int ble_disconnect ( struct ble_state_s * ble_state )

Bluetooth LE dicsonnect for Central.

Parameters

[in] ble_state Bluetooth context ble_state_s

Return values

error code

◆ ble_start_advertise()

int ble_start_advertise ( void )

Bluetooth LE start advertise Start BLE advertise mode.

Return values

error code

◆ ble_cancel_advertise()

int ble_cancel_advertise ( void )

Bluetooth LE cancel advertise Cancel BLE advertise mode.

Return values

error code

◆ ble_start_scan()

int ble_start_scan ( bool duplicate_filter )

Bluetooth LE start scan Start BLE scan mode.

Parameters

[in] duplicate_filter true means that duplicate scan results are filtered out.

Return values

error code

◆ ble_cancel_scan()

int ble_cancel_scan ( void )

Bluetooth LE cancel scan Cancel BLE scan mode.

Return values

error code

◆ ble_register_common_cb()

int ble_register_common_cb ( struct ble_common_ops_s * ble_common_ops )

Bluetooth LE register common callbacks Register Connect/Advertise/Scan callback.

Parameters

[in] ble_common_ops Application callback ble_common_ops_s

Return values

error code

◆ ble_set_request_mtusize()

uint16_t ble_set_request_mtusize ( uint16_t sz )

Set MTU size that application requests.

Parameters

[in] sz MTU size that application requests

Return values

Accepted MTU size

◆ ble_get_request_mtusize()

uint16_t ble_get_request_mtusize ( void )

Get MTU size that application requests.

Return values

Accepted MTU size

◆ ble_get_negotiated_mtusize()

int ble_get_negotiated_mtusize ( uint16_t handle )

Get negotiated MTU size.

Parameters

[in] handle connection handle

Return values

Positive value measn Negotiated MTU size, otherwise errno.

◆ ble_set_tx_power()

int ble_set_tx_power ( int8_t tx_power )

Set Tx power.

Parameters

[in] tx_power Tx power [dBm]

Note: Set the value supported by each device.; This API can be called after ble_enable.

Return values

BLE_SUCCESS or negated errno.

◆ ble_set_scan_param()

int ble_set_scan_param ( struct ble_scan_param_s * param )

Set scan parameter.

Parameters

[in] param scan parameter

Return values

error code

◆ ble_set_conn_param()

int ble_set_conn_param ( struct ble_conn_param_s * param )

Set connection parameter.

Parameters

[in] param connection parameter

Return values

error code

◆ ble_pairing()

int ble_pairing ( uint16_t handle )

Execute pairing.

Parameters

[in] handle connection handle

Return values

BLE_SUCCESS or negated errno.

◆ ble_parse_advertising_data()

int ble_parse_advertising_data	(	BLE_AD_TYPE	target,
		uint8_t *	adv_data,
		uint8_t	adv_len,
		struct bt_eir_s *	eir
	)

Parse advertise data.

Parameters

[in]	target	parse target EIR type
[in]	adv_data	advertising data
[in]	adv_len	length of advertising data
[in]	eir	parse result

Classes

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ BT_EIR_LEN

◆ BLESTAT_SUCCESS

◆ BLESTAT_MEMCAP_EXCD

◆ BLESTAT_CONNECT_TIMEOUT

◆ BLESTAT_PEER_TERMINATED

◆ BLESTAT_PEER_TERM_LOWRES

◆ BLESTAT_PEER_TERM_POFF

◆ BLESTAT_TERMINATED

◆ BLESTAT_UNSPEC_ERR

◆ BLESTAT_DEVICE_BUSY

◆ BLESTAT_PARAM_REJECTED

◆ BLESTAT_CONNECT_FAILED

Enumeration Type Documentation

◆ BT_CONNECT_STATUS

Function Documentation

◆ bt_init()

◆ bt_finalize()

◆ bt_set_address()

◆ bt_get_address()

◆ bt_set_name()

◆ bt_get_name()

◆ bt_enable()

◆ bt_disable()

◆ bt_pairing_enable()

◆ bt_paring_disable()

◆ bt_get_bond_list()

◆ bt_unbond()

◆ bt_set_visibility()

◆ bt_start_inquiry()

◆ bt_cancel_inquiry()

◆ bt_register_common_cb()

◆ ble_set_address()

◆ ble_get_address()

◆ ble_set_public_address()

◆ ble_get_address_type()

◆ ble_set_name()

◆ ble_get_name()

◆ ble_set_appearance()

◆ ble_enable()

◆ ble_disable()

◆ ble_connect()

◆ ble_disconnect()

◆ ble_start_advertise()

◆ ble_cancel_advertise()

◆ ble_start_scan()

◆ ble_cancel_scan()

◆ ble_register_common_cb()

◆ ble_set_request_mtusize()

◆ ble_get_request_mtusize()

◆ ble_get_negotiated_mtusize()

◆ ble_set_tx_power()

◆ ble_set_scan_param()

◆ ble_set_conn_param()

◆ ble_pairing()

◆ ble_parse_advertising_data()