BLERemoteService Class Reference

A model of a remote BLE service. More...

#include <BLERemoteService.hpp>

Public Member Functions
BLERemoteCharacteristic *	getCharacteristic (const char *uuid)
	Get the remote characteristic object for the characteristic UUID. More...
BLERemoteCharacteristic *	getCharacteristic (BLEUUID uuid)
	Get the characteristic object for the UUID. More...
BLERemoteCharacteristic *	getCharacteristic (uint16_t uuid)
std::map< std::string, BLERemoteCharacteristic * > *	getCharacteristics ()
	Retrieve a map of all the characteristics of this service. More...
std::map< uint16_t, BLERemoteCharacteristic * > *	getCharacteristicsByHandle ()
	Retrieve a map of all the characteristics of this service. More...
void	getCharacteristics (std::map< uint16_t, BLERemoteCharacteristic * > *pCharacteristicMap)
	This function is designed to get characteristics map when we have multiple characteristics with the same UUID.
BLEClient *	getClient (void)
	Get the client associated with this service. More...
uint16_t	getHandle ()
BLEUUID	getUUID (void)
std::string	getValue (BLEUUID characteristicUuid)
	Read the value of a characteristic associated with this service.
void	setValue (BLEUUID characteristicUuid, std::string value)
	Set the value of a characteristic. More...
std::string	toString (void)
	Create a string representation of this remote service. More...

Detailed Description

A model of a remote BLE service.

Member Function Documentation

getCharacteristic() [1/2]

BLERemoteCharacteristic * BLERemoteService::getCharacteristic

(

BLEUUID

uuid

)

Get the characteristic object for the UUID.

Parameters

[in]

uuid

Characteristic uuid.

Returns

Reference to the characteristic object.

Exceptions

BLEUuidNotFoundException

                                                                         {
// Design
// ------
// We wish to retrieve the characteristic given its UUID.  It is possible that we have not yet asked the
// device what characteristics it has in which case we have nothing to match against.  If we have not
// asked the device about its characteristics, then we do that now.  Once we get the results we can then
// examine the characteristics map to see if it has the characteristic we are looking for.
    if (!m_haveCharacteristics) {
        retrieveCharacteristics();
    }
    std::string v = uuid.toString();
    for (auto &myPair : m_characteristicMap) {
        if (myPair.first == v) {
            return myPair.second;
        }
    }
    // throw new BLEUuidNotFoundException();  // <-- we dont want exception here, which will cause app crash, we want to search if any characteristic can be found one after another
    return nullptr;
} // getCharacteristic

getCharacteristic() [2/2]

BLERemoteCharacteristic * BLERemoteService::getCharacteristic

(

const char *

uuid

)

Get the remote characteristic object for the characteristic UUID.

Parameters

[in]

uuid

Remote characteristic uuid.

Returns

Reference to the remote characteristic object.

Exceptions

BLEUuidNotFoundException

                                                                             {
    return getCharacteristic(BLEUUID(uuid));
} // getCharacteristic

getCharacteristics()

std::map< std::string, BLERemoteCharacteristic * > * BLERemoteService::getCharacteristics

(

)

Retrieve a map of all the characteristics of this service.

Returns

A map of all the characteristics of this service.

                                                                                  {
    _debug_print_s(TAG, ">> getCharacteristics() for service", getUUID().toString().c_str());
    // If is possible that we have not read the characteristics associated with the service so do that
    // now.  The request to retrieve the characteristics by calling "retrieveCharacteristics" is a blocking
    // call and does not return until all the characteristics are available.
    if (!m_haveCharacteristics) {
        retrieveCharacteristics();
    }
    _debug_print_s(TAG, "<< getCharacteristics() for service", getUUID().toString().c_str());
    return &m_characteristicMap;
} // getCharacteristics

getCharacteristicsByHandle()

std::map< uint16_t, BLERemoteCharacteristic * > * BLERemoteService::getCharacteristicsByHandle

(

)

Retrieve a map of all the characteristics of this service.

Returns

A map of all the characteristics of this service.

                                                                                         {
    _debug_print_s(TAG, ">> getCharacteristicsByHandle() for service", getUUID().toString().c_str());
    // If is possible that we have not read the characteristics associated with the service so do that
    // now.  The request to retrieve the characteristics by calling "retrieveCharacteristics" is a blocking
    // call and does not return until all the characteristics are available.
    if (!m_haveCharacteristics) {
        retrieveCharacteristics();
    }
    _debug_print_s(TAG, "<< getCharacteristicsByHandle() for service", getUUID().toString().c_str());
    return &m_characteristicMapByHandle;
} // getCharacteristicsByHandle

getClient()

BLEClient * BLERemoteService::getClient

(

void

)

Get the client associated with this service.

Returns

A reference to the client associated with this service.

                                       {
    return m_pClient;
} // getClient

setValue()

void BLERemoteService::setValue	(	BLEUUID	characteristicUuid,
		std::string	value
	)

Set the value of a characteristic.

Parameters

[in]	characteristicUuid	The characteristic to set.
[in]	value	The value to set.

Exceptions

BLEUuidNotFound

                                                                           {
    _debug_print_s(TAG, ">> setValue: uuid", characteristicUuid.toString().c_str());
    getCharacteristic(characteristicUuid)->writeValue(value);
    _debug_print(TAG, "<< setValue");
} // setValue

toString()

std::string BLERemoteService::toString

(

void

)

Create a string representation of this remote service.

Returns

A string representation of this remote service.

                                     {
    std::ostringstream ss;
    ss << "Service: uuid: " + m_uuid.toString();
    ss << ", start_handle: " << std::dec << m_startHandle << " 0x" << std::hex << m_startHandle <<
            ", end_handle: " << std::dec << m_endHandle << " 0x" << std::hex << m_endHandle;
    for (auto &myPair : m_characteristicMap) {
        ss << "\n" << myPair.second->toString();
       // myPair.second is the value
    }
    return ss.str();
} // toString

---

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

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