BLEService Class Reference

The model of a BLE service. More...

#include <BLEService.hpp>

Public Member Functions
void	addCharacteristic (BLECharacteristic *pCharacteristic)
	Add a characteristic to the service. More...
BLECharacteristic *	createCharacteristic (const char *uuid, uint32_t properties)
	Create a new BLE Characteristic associated with this service. More...
BLECharacteristic *	createCharacteristic (BLEUUID uuid, uint32_t properties)
	Create a new BLE Characteristic associated with this service. More...
void	dump ()
	Dump details of this BLE GATT service. More...
void	executeCreate (BLEServer *pServer)
void	executeDelete ()
BLECharacteristic *	getCharacteristic (const char *uuid)
BLECharacteristic *	getCharacteristic (BLEUUID uuid)
BLEUUID	getUUID ()
	Get the UUID of the service. More...
BLEServer *	getServer ()
	Get the BLE server associated with this service. More...
void	start ()
void	stop ()
std::string	toString ()
	Return a string representation of this service. A service is defined by: More...
uint16_t	getHandle ()
	Get the handle associated with this service. More...

Public Attributes
uint8_t	m_instId = 0

Detailed Description

The model of a BLE service.

Member Function Documentation

addCharacteristic()

void BLEService::addCharacteristic

(

BLECharacteristic *

pCharacteristic

)

Add a characteristic to the service.

Parameters

[in]

pCharacteristic

A pointer to the characteristic to be added.

                                                                     {
    // We maintain a mapping of characteristics owned by this service.  These are managed by the
    // BLECharacteristicMap class instance found in m_characteristicMap.  We add the characteristic
    // to the map and then ask the service to add the characteristic at the BLE level (ESP-IDF).
 
    _debug_print(TAG, ">> addCharacteristic()");
    void *logCtx __attribute__((unused)) = nullptr;
    _debug_print_s(TAG, "Adding characteristic: uuid", pCharacteristic->getUUID().toString().c_str(), &logCtx);
    _debug_print_s(TAG, " to service", toString().c_str());
 
    // Check that we don't add the same characteristic twice.
    if (m_characteristicMap.getByUUID(pCharacteristic->getUUID()) != nullptr) {
        _debug_print(TAG, "<< Adding a new characteristic with the same UUID as a previous one");
        //return;
    }
 
    // Remember this characteristic in our map of characteristics.  At this point, we can lookup by UUID
    // but not by handle.  The handle is allocated to us on the ESP_GATTS_ADD_CHAR_EVT.
    m_characteristicMap.setByUUID(pCharacteristic, pCharacteristic->getUUID());
 
    _debug_print(TAG, "<< addCharacteristic()");
} // addCharacteristic

createCharacteristic() [1/2]

BLECharacteristic * BLEService::createCharacteristic	(	BLEUUID	uuid,
		uint32_t	properties
	)

Create a new BLE Characteristic associated with this service.

Parameters

[in]	uuid	- The UUID of the characteristic.
[in]	properties	- The properties of the characteristic.

Returns

The new BLE characteristic.

                                                                                     {
    BLECharacteristic* pCharacteristic = new BLECharacteristic(uuid, properties);
    addCharacteristic(pCharacteristic);
    return pCharacteristic;
} // createCharacteristic

createCharacteristic() [2/2]

BLECharacteristic * BLEService::createCharacteristic	(	const char *	uuid,
		uint32_t	properties
	)

Create a new BLE Characteristic associated with this service.

Parameters

[in]	uuid	- The UUID of the characteristic.
[in]	properties	- The properties of the characteristic.

Returns

The new BLE characteristic.

                                                                                         {
    return createCharacteristic(BLEUUID(uuid), properties);
}

dump()

void BLEService::dump

(

)

Dump details of this BLE GATT service.

Returns

N/A.

                      {
    void *logCtx __attribute__((unused)) = nullptr;
    _debug_print_s(TAG, "Service: uuid", m_uuid.toString().c_str(), &logCtx);
    _debug_print_d(TAG, ", handle:", m_handle, &logCtx);
    _debug_print_s(TAG, ", Characteristics", m_characteristicMap.toString().c_str(), &logCtx);
} // dump

getHandle()

uint16_t BLEService::getHandle

(

)

Get the handle associated with this service.

Returns

The handle associated with this service.

                               {
    return m_handle;
} // getHandle

getServer()

BLEServer * BLEService::getServer

(

)

Get the BLE server associated with this service.

Returns

The BLEServer associated with this service.

                                 {
    return m_pServer;
} // getServer

getUUID()

BLEUUID BLEService::getUUID

(

)

Get the UUID of the service.

Returns

the UUID of the service.

                            {
    return m_uuid;
} // getUUID

toString()

std::string BLEService::toString

(

)

Return a string representation of this service. A service is defined by:

• Its UUID
• Its handle

  Returns

  A string representation of this service.

                               {
    std::stringstream stringStream;
    stringStream << "UUID: " << getUUID().toString() <<
        ", handle: 0x" << std::hex << std::setfill('0') << std::setw(2) << getHandle();
    return stringStream.str();
} // toString

---

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

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