RUI3 (RAK Unified Interface 3) - RAK4631
RAKBleSettings::broadcastName

Public Member Functions

bool set (char *ble_name, uint8_t device_name_length)
 
char * get ()
 

Detailed Description

Description

Member Function Documentation

◆ set()

bool set ( char *  ble_name,
uint8_t  device_name_length 
)
Description
Set the name for this device. Used in advertisements and as the Device Name available to a connected peer.
Syntax
api.ble.settings.broadcastName.set(ble_name, device_name_length)
Parameters
ble_namesetting device name an array of data to send as bytes
device_name_lengththe number of bytes to transmit
Returns
bool
Return values
TRUEfor success
FALSEfor failure
Examples:
BLE_Configuration/src/app.cpp.

◆ get()

char* get ( )
Description
Get the current BLE Device Name
Syntax
api.ble.settings.broadcastName.get()
Returns
the current BLE Device Name
Examples:
BLE_Configuration/src/app.cpp.