BLERemoteCharacteristic Class Reference

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

#include <BLERemoteCharacteristic.hpp>

Public Member Functions
	~BLERemoteCharacteristic ()
	Destructor.
bool	canBroadcast ()
	Does the characteristic support broadcasting? More...
bool	canIndicate ()
	Does the characteristic support indications? More...
bool	canNotify ()
	Does the characteristic support notifications? More...
bool	canRead ()
	Does the characteristic support reading? More...
bool	canWrite ()
	Does the characteristic support writing? More...
bool	canWriteNoResponse ()
	Does the characteristic support writing with no response? More...
BLERemoteDescriptor *	getDescriptor (BLEUUID uuid)
	Get the descriptor instance with the given UUID that belongs to this characteristic. More...
std::map< std::string, BLERemoteDescriptor * > *	getDescriptors ()
	Retrieve the map of descriptors keyed by UUID.
uint16_t	getHandle ()
	Get the handle for this characteristic. More...
BLEUUID	getUUID ()
	Get the UUID for this characteristic. More...
std::string	readValue ()
uint8_t	readUInt8 ()
	Read a byte value. More...
uint16_t	readUInt16 ()
	Read an unsigned 16 bit value. More...
uint32_t	readUInt32 ()
	Read an unsigned 32 bit value. More...
void	registerForNotify (notify_callback _callback, bool notifications=true)
bool	writeValue (uint8_t *data, size_t length, bool response=false)
bool	writeValue (std::string newValue, bool response=false)
	Write the new value for the characteristic. More...
bool	writeValue (uint8_t newValue, bool response=false)
	Write the new value for the characteristic. More...
std::string	toString ()
	Convert a BLERemoteCharacteristic to a string representation;. More...
uint8_t *	readRawData ()
	Read raw data from remote characteristic as hex bytes. More...
BLERemoteService *	getRemoteService ()
	Get the remote service associated with this characteristic. More...

Detailed Description

A model of a remote BLE characteristic.

Member Function Documentation

canBroadcast()

bool BLERemoteCharacteristic::canBroadcast

(

)

Does the characteristic support broadcasting?

Returns

True if the characteristic supports broadcasting.

                                           {
    return (m_charProp & BLE_GATT_CHAR_PROP_BIT_BROADCAST) != 0;
} // canBroadcast

canIndicate()

bool BLERemoteCharacteristic::canIndicate

(

)

Does the characteristic support indications?

Returns

True if the characteristic supports indications.

                                          {
    return (m_charProp & BLE_GATT_CHAR_PROP_BIT_INDICATE) != 0;
} // canIndicate

canNotify()

bool BLERemoteCharacteristic::canNotify

(

)

Does the characteristic support notifications?

Returns

True if the characteristic supports notifications.

                                        {
    return (m_charProp & BLE_GATT_CHAR_PROP_BIT_NOTIFY) != 0;
} // canNotify

canRead()

bool BLERemoteCharacteristic::canRead

(

)

Does the characteristic support reading?

Returns

True if the characteristic supports reading.

                                      {
    return (m_charProp & BLE_GATT_CHAR_PROP_BIT_READ) != 0;
} // canRead

canWrite()

bool BLERemoteCharacteristic::canWrite

(

)

Does the characteristic support writing?

Returns

True if the characteristic supports writing.

                                       {
    return (m_charProp & BLE_GATT_CHAR_PROP_BIT_WRITE) != 0;
} // canWrite

canWriteNoResponse()

bool BLERemoteCharacteristic::canWriteNoResponse

(

)

Does the characteristic support writing with no response?

Returns

True if the characteristic supports writing with no response.

                                                 {
    return (m_charProp & BLE_GATT_CHAR_PROP_BIT_WRITE_NR) != 0;
} // canWriteNoResponse

getDescriptor()

BLERemoteDescriptor * BLERemoteCharacteristic::getDescriptor

(

BLEUUID

uuid

)

Get the descriptor instance with the given UUID that belongs to this characteristic.

Parameters

[in]

uuid

The UUID of the descriptor to find.

Returns

The Remote descriptor (if present) or null if not present.

                                                                        {
    _debug_print_s(TAG, ">> getDescriptor: uuid", uuid.toString().c_str());
 
    std::string v = uuid.toString();
    for (auto &myPair : m_descriptorMap) {
        if (myPair.first == v) {
            _debug_print(TAG, "<< getDescriptor: found");
            return myPair.second;
        }
    }
 
    _debug_print(TAG, "<< getDescriptor: Not found");
    return nullptr;
} // getDescriptor

getHandle()

uint16_t BLERemoteCharacteristic::getHandle

(

)

Get the handle for this characteristic.

Returns

The handle for this characteristic.

                                            {
    //ESP_LOGD(LOG_TAG, ">> getHandle: Characteristic: %s", getUUID().toString().c_str());
    //ESP_LOGD(LOG_TAG, "<< getHandle: %d 0x%.2x", m_handle, m_handle);
    return m_handle;
} // getHandle

getRemoteService()

BLERemoteService * BLERemoteCharacteristic::getRemoteService

(

)

Get the remote service associated with this characteristic.

Returns

The remote service associated with this characteristic.

                                                            {
    return m_pRemoteService;
} // getRemoteService

getUUID()

BLEUUID BLERemoteCharacteristic::getUUID

(

)

Get the UUID for this characteristic.

Returns

The UUID for this characteristic.

                                         {
    return m_uuid;
} // getUUID

readRawData()

uint8_t * BLERemoteCharacteristic::readRawData

(

)

Read raw data from remote characteristic as hex bytes.

Returns

return pointer data read

                                              {
    return m_rawData;
}

readUInt16()

uint16_t BLERemoteCharacteristic::readUInt16

(

)

Read an unsigned 16 bit value.

Returns

The unsigned 16 bit value.

                                             {
    std::string value = readValue();
    if (value.length() >= 2) {
        return *(uint16_t*)(value.data());
    }
    return 0;
} // readUInt16

readUInt32()

uint32_t BLERemoteCharacteristic::readUInt32

(

)

Read an unsigned 32 bit value.

Returns

the unsigned 32 bit value.

                                             {
    std::string value = readValue();
    if (value.length() >= 4) {
        return *(uint32_t*)(value.data());
    }
    return 0;
} // readUInt32

readUInt8()

uint8_t BLERemoteCharacteristic::readUInt8

(

)

Read a byte value.

Returns

The value as a byte

                                           {
    std::string value = readValue();
    if (value.length() >= 1) {
        return (uint8_t)value[0];
    }
    return 0;
} // readUInt8

toString()

std::string BLERemoteCharacteristic::toString

(

)

Convert a BLERemoteCharacteristic to a string representation;.

Returns

a String representation.

                                            {
    std::ostringstream ss;
    ss << "Characteristic: uuid: " << m_uuid.toString() <<
        ", handle: " << getHandle() << " 0x" << std::hex << getHandle() <<
        ", props: " << " 0x" << std::hex << m_charProp;
    return ss.str();
} // toString

writeValue() [1/2]

bool BLERemoteCharacteristic::writeValue	(	std::string	newValue,
		bool	response = false
	)

Write the new value for the characteristic.

Parameters

[in]	newValue	The new value to write.
[in]	response	Do we expect a response?

Returns

false if not connected or cant perform write for some reason.

                                                                          {
    return writeValue((uint8_t*)newValue.c_str(), strlen(newValue.c_str()), response);
} // writeValue

writeValue() [2/2]

bool BLERemoteCharacteristic::writeValue	(	uint8_t	newValue,
		bool	response = false
	)

Write the new value for the characteristic.

This is a convenience function. Many BLE characteristics are a single byte of data.

Parameters

[in]	newValue	The new byte value to write.
[in]	response	Whether we require a response from the write.

Returns

false if not connected or cant perform write for some reason.

                                                                        {
    return writeValue(&newValue, 1, response);
} // writeValue

---

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

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