RAKBleAdvertise

Public Member Functions
bool	start (uint8_t adv_time)
bool	stop ()
bool	status ()

Detailed Description

Description

Member Function Documentation

start()

bool start

(

uint8_t

adv_time

)

Description

Used to start advertising when after configuring BLE settings

Syntax

api.ble.advertise.start(adv_time)

Parameters

adv_time

advertising timeout in seconds. If x = 0, advertising never stops

Returns

bool

Return values

TRUE	for start advertising success
FALSE	for for start advertising failure

Examples:

BLE_Beacon/src/app.cpp, BLE_Beacon_Custom_Payload/src/app.cpp, and BLE_Configuration/src/app.cpp.

stop()

bool stop

(

)

Description

Used to stop advertising

Syntax

api.ble.advertise.stop()

Returns

bool

Return values

TRUE	for stop advertising success
FALSE	for for stop advertising failure

Example

void setup()
{
  api.ble.advertise.stop();
}

void loop()
{
}  

status()

bool status

(

)

Description

Syntax

api.ble.advertise.status()

Returns

bool

Return values

TRUE	: the device is in advertising
FALSE	: the device is stop advertis

Examples:

BLE_Configuration/src/app.cpp.