cypress::embedded::Gap Class Reference

Description

Defines Embedded BLE GAP Class.

Public Member Functions
ble_error_t	getAddress (BluetoothAddress addr)
	Generic Bluetooth Controller/Device Management routine. More...
ble_error_t	setAddress (BluetoothAddress addr)
	Sets Device' Bluetooth GAP name. More...
ble_error_t	getName (char *name)
	Gets Device' Bluetooth GAP name. More...
ble_error_t	setName (const char *name)
	Sets Device' Bluetooth GAP name. More...
ble_error_t	setAdvertisementData (uint8_t *adv_data, uint8_t length)
	Bluetooth Low Energy Advertisement APIs. More...
ble_error_t	startAdvertisements (void)
	Start Advertising. More...
ble_error_t	stopAdvertisements (void)
	Stop advertising. More...
ble_error_t	startScan (void)
	Bluetooth Low Energy Scan APIs. More...
ble_error_t	stopScan (void)
	Stop Scanning of nearby advertising devices. More...

Static Public Member Functions
static Gap &	getGapInstance (void)
	Gets static singleton instance of Embedded BLE GAP interface.

Member Function Documentation

getAddress()

ble_error_t cypress::embedded::Gap::getAddress

(

BluetoothAddress

addr

)

Generic Bluetooth Controller/Device Management routine.

Gets Device' Bluetooth Address.

Parameters

[out]

addr

Device Bluetooth Address

Returns

ble_error_t

setAddress()

ble_error_t cypress::embedded::Gap::setAddress

(

BluetoothAddress

addr

)

Sets Device' Bluetooth GAP name.

Parameters

[in]

addr

Device Bluetooth Address

Returns

ble_error_t

getName()

ble_error_t cypress::embedded::Gap::getName

(

char *

name

)

Gets Device' Bluetooth GAP name.

Parameters

[out]

name

Device Bluetooth Name

Returns

ble_error_t

setName()

ble_error_t cypress::embedded::Gap::setName

(

const char *

name

)

Sets Device' Bluetooth GAP name.

Parameters

[in]

name

Device Bluetooth Name

Returns

ble_error_t

setAdvertisementData()

ble_error_t cypress::embedded::Gap::setAdvertisementData	(	uint8_t *	adv_data,
		uint8_t	length
	)

Bluetooth Low Energy Advertisement APIs.

Set Advertisement data.

Parameters

[in]	adv_data	Advertising data payload pointer
[in]	length	Advertising data payload length

Returns

ble_error_t

startAdvertisements()

ble_error_t cypress::embedded::Gap::startAdvertisements

(

void

)

Start Advertising.

Returns

ble_error_t

stopAdvertisements()

ble_error_t cypress::embedded::Gap::stopAdvertisements

(

void

)

Stop advertising.

Returns

ble_error_t

startScan()

ble_error_t cypress::embedded::Gap::startScan

(

void

)

Bluetooth Low Energy Scan APIs.

Start Scanning of nearby advertising devices.

Returns

ble_error_t

stopScan()

ble_error_t cypress::embedded::Gap::stopScan

(

void

)

Stop Scanning of nearby advertising devices.

Returns

ble_error_t