BLEClient Class Reference

A model of a BLE client. More...

#include <BLEClient.hpp>

Public Member Functions
bool	connect (BLEAdvertisedDevice *device)
bool	connect (BLEAddress address, BLEAddress::Type_t type=BLEAddress::TYPE_PUBLIC)
void	disconnect ()
BLEAddress	getPeerAddress ()
	Retrieve the address of the peer. More...
int	getRssi ()
std::map< std::string, BLERemoteService * > *	getServices ()
BLERemoteService *	getService (const char *uuid)
	Get the service BLE Remote Service instance corresponding to the uuid. More...
BLERemoteService *	getService (BLEUUID uuid)
	Get the service object corresponding to the uuid. More...
std::string	getValue (BLEUUID serviceUUID, BLEUUID characteristicUUID)
void	handleGAPEvent (void *info)
bool	isConnected ()
	Are we connected to a partner? More...
void	setClientCallbacks (BLEClientCallbacks *pClientCallbacks, bool deleteCallbacks=true)
	Set the callbacks that will be invoked.
void	setValue (BLEUUID serviceUUID, BLEUUID characteristicUUID, std::string value)
	Set the value of a specific characteristic associated with a specific service. More...
std::string	toString ()
uint16_t	getConnId ()
void *	getGattcIf ()
uint16_t	getMTU ()

Public Attributes
uint16_t	m_appId

Detailed Description

A model of a BLE client.

Member Function Documentation

connect()

bool BLEClient::connect

(

BLEAdvertisedDevice *

device

)

Add overloaded function to ease connect to peer device with not public address

                                                   {
    BLEAddress address =  device->getAddress();
    BLEAddress::Type_t type = device->getAddressType();
    return connect(address, type);
}

getPeerAddress()

BLEAddress BLEClient::getPeerAddress

(

)

Retrieve the address of the peer.

Returns the Bluetooth device address of the BLE peer to which this client is connected.

                                     {
    return m_peerAddress;
} // getAddress

getService() [1/2]

BLERemoteService * BLEClient::getService

(

BLEUUID

uuid

)

Get the service object corresponding to the uuid.

Parameters

[in]

uuid

The UUID of the service being sought.

Returns

A reference to the Service or nullptr if don't know about it.

Exceptions

BLEUuidNotFound

                                                    {
    _debug_print_s(TAG, ">> getService: uuid", uuid.toString().c_str());
// Design
// ------
// We wish to retrieve the service given its UUID.  It is possible that we have not yet asked the
// device what services it has in which case we have nothing to match against.  If we have not
// asked the device about its services, then we do that now.  Once we get the results we can then
// examine the services map to see if it has the service we are looking for.
    if (!m_haveServices) {
        getServices();
    }
    std::string uuidStr = uuid.toString();
    for (auto &myPair : m_servicesMap) {
        if (myPair.first == uuidStr) {
            _debug_print_s(TAG, "<< getService: found the service with uuid", uuid.toString().c_str());
            return myPair.second;
        }
    } // End of each of the services.
    _debug_print(TAG, "<< getService: not found");
    return nullptr;
} // getService

getService() [2/2]

BLERemoteService * BLEClient::getService

(

const char *

uuid

)

Get the service BLE Remote Service instance corresponding to the uuid.

Parameters

[in]

uuid

The UUID of the service being sought.

Returns

A reference to the Service or nullptr if don't know about it.

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

isConnected()

bool BLEClient::isConnected

(

)

Are we connected to a partner?

Returns

True if we are connected and false if we are not connected.

                            {
    return m_isConnected;
} // isConnected

setValue()

void BLEClient::setValue	(	BLEUUID	serviceUUID,
		BLEUUID	characteristicUUID,
		std::string	value
	)

Set the value of a specific characteristic associated with a specific service.

Parameters

[in]	serviceUUID	The service that owns the characteristic.
[in]	characteristicUUID	The characteristic whose value we wish to write.

Exceptions

BLEUuidNotFound

                                                                                         {
    void *logCtx __attribute__((unused)) = nullptr;
    _debug_print_s(TAG, ">> setValue: serviceUUID", serviceUUID.toString().c_str());
    _debug_print_s(TAG, ", characteristicUUID", characteristicUUID.toString().c_str());
    getService(serviceUUID)->getCharacteristic(characteristicUUID)->writeValue(value);
    _debug_print(TAG, "<< setValue");
} // setValue

---

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

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