BLEAdvertisementData Class Reference

Advertisement data set by the programmer to be published by the BLE server. More...

#include <BLEAdvertising.hpp>

Public Types
enum	{ MAX_LEN = 31 }

Public Member Functions
void	setAppearance (uint16_t appearance)
	Set the appearance. More...
void	setCompleteServices (BLEUUID uuid)
	Set the complete services. More...
void	setFlags (uint8_t)
	Set the advertisement flags. More...
void	setManufacturerData (std::string data)
	Set manufacturer specific data. More...
void	setName (std::string name)
	Set the name. More...
void	setPartialServices (BLEUUID uuid)
	Set the partial services. More...
void	setServiceData (BLEUUID uuid, std::string data)
	Set the service data (UUID + data) More...
void	setShortName (std::string name)
	Set the short name. More...
void	addData (std::string data)
	Add data to the payload to be advertised. More...
std::string	getPayload ()
	Retrieve the payload that is to be advertised. More...

Detailed Description

Advertisement data set by the programmer to be published by the BLE server.

Member Function Documentation

addData()

void BLEAdvertisementData::addData

(

std::string

data

)

Add data to the payload to be advertised.

Parameters

[in]

data

The data to be added to the payload.

                                                 {
    if ((m_payload.length() + data.length()) > MAX_LEN) {
        return;
    }
    m_payload.append(data);
} // addData

getPayload()

std::string BLEAdvertisementData::getPayload

(

)

Retrieve the payload that is to be advertised.

Returns

The payload that is to be advertised.

                                           {
    return m_payload;
} // getPayload

setAppearance()

void BLEAdvertisementData::setAppearance

(

uint16_t

appearance

)

Set the appearance.

Parameters

[in]

appearance

The appearance code value.

See also: https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.gap.appearance.xml

                                                            {
    char cdata[2];
    cdata[0] = 3;
    cdata[1] = BLE_AD_TYPE_APPEARANCE; // 0x19
    addData(std::string(cdata, 2) + std::string((char*) &appearance, 2));
} // setAppearance

setCompleteServices()

void BLEAdvertisementData::setCompleteServices

(

BLEUUID

uuid

)

Set the complete services.

Parameters

[in]

uuid

The single service to advertise.

                                                           {
    char cdata[2];
    switch (uuid.bitSize()) {
        case 16: {
            // [Len] [0x02] [LL] [HH]
            cdata[0] = 3;
            cdata[1] = BLE_AD_TYPE_16SRV_CMPL;  // 0x03
            addData(std::string(cdata, 2) + std::string((char*) &uuid.raw16, 2));
            break;
        }
 
        case 32: {
            // [Len] [0x04] [LL] [LL] [HH] [HH]
            cdata[0] = 5;
            cdata[1] = BLE_AD_TYPE_32SRV_CMPL;  // 0x05
            addData(std::string(cdata, 2) + std::string((char*) &uuid.raw32, 4));
            break;
        }
 
        case 128: {
            // [Len] [0x04] [0] [1] ... [15]
            cdata[0] = 17;
            cdata[1] = BLE_AD_TYPE_128SRV_CMPL;  // 0x07
            addData(std::string(cdata, 2) + std::string((char*) uuid.raw128, 16));
            break;
        }
 
        default:
            return;
    }
} // setCompleteServices

setFlags()

void BLEAdvertisementData::setFlags

(

uint8_t

flag

)

Set the advertisement flags.

Parameters

[in]

The

flags to be set in the advertisement.

• BLE_ADV_FLAG_LIMIT_DISC
• BLE_ADV_FLAG_GEN_DISC
• BLE_ADV_FLAG_BREDR_NOT_SPT
• BLE_ADV_FLAG_DMT_CONTROLLER_SPT
• BLE_ADV_FLAG_DMT_HOST_SPT
• BLE_ADV_FLAG_NON_LIMIT_DISC

                                                {
    char cdata[3];
    cdata[0] = 2;
    cdata[1] = BLE_AD_TYPE_FLAG;  // 0x01
    cdata[2] = flag;
    addData(std::string(cdata, 3));
} // setFlag

setManufacturerData()

void BLEAdvertisementData::setManufacturerData

(

std::string

data

)

Set manufacturer specific data.

Parameters

[in]

data

Manufacturer data.

                                                             {
    _debug_print("BLEAdvertisementData", ">> setManufacturerData");
    char cdata[2];
    cdata[0] = data.length() + 1;
    cdata[1] = BLE_AD_TYPE_MANUFACTURER_SPECIFIC;  // 0xff
    addData(std::string(cdata, 2) + data);
    _debug_print("BLEAdvertisementData", "<< setManufacturerData");
} // setManufacturerData

setName()

void BLEAdvertisementData::setName

(

std::string

name

)

Set the name.

Parameters

[in]

The

complete name of the device.

                                                 {
    _debug_print_s("BLEAdvertisementData", ">> setName", name.c_str());
    char cdata[2];
    cdata[0] = name.length() + 1;
    cdata[1] = BLE_AD_TYPE_NAME_CMPL;  // 0x09
    addData(std::string(cdata, 2) + name);
    _debug_print("BLEAdvertisementData", "<< setName");
} // setName

setPartialServices()

void BLEAdvertisementData::setPartialServices

(

BLEUUID

uuid

)

Set the partial services.

Parameters

[in]

uuid

The single service to advertise.

                                                          {
    char cdata[2];
    switch (uuid.bitSize()) {
        case 16: {
            // [Len] [0x02] [LL] [HH]
            cdata[0] = 3;
            cdata[1] = BLE_AD_TYPE_16SRV_PART;  // 0x02
            addData(std::string(cdata, 2) + std::string((char *) &uuid.raw16, 2));
            break;
        }
 
        case 32: {
            // [Len] [0x04] [LL] [LL] [HH] [HH]
            cdata[0] = 5;
            cdata[1] = BLE_AD_TYPE_32SRV_PART; // 0x04
            addData(std::string(cdata, 2) + std::string((char *) &uuid.raw32, 4));
            break;
        }
 
        case 128: {
            // [Len] [0x04] [0] [1] ... [15]
            cdata[0] = 17;
            cdata[1] = BLE_AD_TYPE_128SRV_PART;  // 0x06
            addData(std::string(cdata, 2) + std::string((char *) uuid.raw128, 16));
            break;
        }
 
        default:
            return;
    }
} // setPartialServices

setServiceData()

void BLEAdvertisementData::setServiceData	(	BLEUUID	uuid,
		std::string	data
	)

Set the service data (UUID + data)

Parameters

[in]	uuid	The UUID to set with the service data. Size of UUID will be used.
[in]	data	The data to be associated with the service data advert.

                                                                      {
    char cdata[2];
    switch (uuid.bitSize()) {
        case 16: {
            // [Len] [0x16] [UUID16] data
            cdata[0] = data.length() + 3;
            cdata[1] = BLE_AD_TYPE_SERVICE_DATA;  // 0x16
            addData(std::string(cdata, 2) + std::string((char*) &uuid.raw16, 2) + data);
            break;
        }
 
        case 32: {
            // [Len] [0x20] [UUID32] data
            cdata[0] = data.length() + 5;
            cdata[1] = BLE_AD_TYPE_32SERVICE_DATA; // 0x20
            addData(std::string(cdata, 2) + std::string((char*) &uuid.raw32, 4) + data);
            break;
        }
 
        case 128: {
            // [Len] [0x21] [UUID128] data
            cdata[0] = data.length() + 17;
            cdata[1] = BLE_AD_TYPE_128SERVICE_DATA;  // 0x21
            addData(std::string(cdata, 2) + std::string((char*) uuid.raw128, 16) + data);
            break;
        }
 
        default:
            return;
    }
} // setServiceData

setShortName()

void BLEAdvertisementData::setShortName

(

std::string

name

)

Set the short name.

Parameters

[in]

The

short name of the device.

                                                      {
    _debug_print_s("BLEAdvertisementData", ">> setShortName", name.c_str());
    char cdata[2];
    cdata[0] = name.length() + 1;
    cdata[1] = BLE_AD_TYPE_NAME_SHORT;  // 0x08
    addData(std::string(cdata, 2) + name);
    _debug_print("BLEAdvertisementData", "<< setShortName");
} // setShortName

---

The documentation for this class was generated from the following files:

• nola-sdk/include/BLEAdvertising.hpp
• src/net/BluetoothLE/BLEAdvertising.cpp