Class BLERemoteDescriptor

BLERemoteDescriptor Class

Description

A class used for managing BLE GATT descriptors on connected remote devices.

Syntax

class BLERemoteDescriptor

Members

Public Constructors
No public constructor is available for this class. You can get a pointer to an instance of this class using BLERemoteCharacteristic::getDescriptor()
Public Methods
BLERemoteDescriptor::getUUID	Get the descriptor UUID
BLERemoteDescriptor::setBufferLen	Set the size of the internal data buffer
BLERemoteDescriptor::getBufferLen	Get the current size of the internal data buffer
BLERemoteDescriptor::readString	Read the descriptor data buffer as a String object
BLERemoteDescriptor::readData8	Read the descriptor data buffer as an unsigned 8-bit integer
BLERemoteDescriptor::readData16	Read the descriptor data buffer as an unsigned 16-bit integer
BLERemoteDescriptor::readData32	Read the descriptor data buffer as an unsigned 32-bit integer
BLERemoteDescriptor::writeString	Write data to the descriptor as a String object or character array
BLERemoteDescriptor::writeData8	Write data to the descriptor as an unsigned 8-bit integer
BLERemoteDescriptor::writeData16	Write data to the descriptor as an unsigned 16-bit integer
BLERemoteDescriptor::writeData32	Write data to the descriptor as an unsigned 32-bit integer
BLERemoteDescriptor::setData	Write data to the descriptor
BLERemoteDescriptor::getData	Get data from the descriptor

BLERemoteDescriptor::getUUID

Description

Get the descriptor UUID.

Syntax

BLEUUID getUUID(void);

Parameters

NA

Returns

This function returns the descriptor UUID as a BLEUUID class object.

Example Code

NA

Note

“BLERemoteDescriptor.h” must be included to use the class function.

BLERemoteDescriptor::setBufferLen

Description

Set the size of the internal data buffer of the descriptor.

Syntax

void setBufferLen(uint16_t max_len);

Parameters

max_len: the size in bytes to resize the internal buffer to.

Returns

NA

Example Code

NA

Note

Descriptor data buffer has a default size of 20 bytes and can be increased up to 230 bytes. “BLERemoteDescriptor.h” must be included to use the class function.

BLERemoteDescriptor::getBufferLen

Description

Get the current size of the descriptor internal buffer.

Syntax

uint16_t getBufferLen(void);

Parameters

NA

Returns

This function returns the current internal buffer size that is set.

Example Code

NA

Note

“BLERemoteDescriptor.h” must be included to use the class function.

BLERemoteDescriptor::readString

Description

Request for descriptor data from the remote device and read the data in the buffer, expressed as a String class object.

Syntax

String readString(void);

Parameters

NA

Returns

The function returns the data in the descriptor buffer expressed as a String class object.

Example Code

NA

Note

“BLERemoteDescriptor.h” must be included to use the class function.

BLERemoteDescriptor::readData8

Description

Request for descriptor data from the remote device and read the data in the buffer, expressed as an unsigned 8-bit integer.

Syntax

uint8_t readData8(void);

Parameters

NA

Returns

The function returns the data in the descriptor buffer expressed as a uint8_t value.

Example Code

NA

Note

“BLERemoteDescriptor.h” must be included to use the class function.

BLERemoteDescriptor::readData16

Description

Request for descriptor data from the remote device and read the data in the buffer, expressed as an unsigned 16-bit integer.

Syntax

uint16_t readData16(void);

Parameters

NA

Returns

The function returns the data in the descriptor buffer expressed as a uint16_t value.

Example Code

NA

Note

“BLERemoteDescriptor.h” must be included to use the class function.

BLERemoteDescriptor::readData32

Description

Request for descriptor data from the remote device and read the data in the buffer, expressed as an unsigned 32-bit integer.

Syntax

uint32_t readData32(void);

Parameters

NA

Returns

The function returns the data in the descriptor buffer expressed as a uint32_t value.

Example Code

NA

Note

“BLERemoteDescriptor.h” must be included to use the class function.

BLERemoteDescriptor::writeString

Description

Write data to the remote device descriptor as a String object or character array.

Syntax

bool writeString(String str);
bool writeString(const char* str);

“BLERemoteDescriptor.h” must be included to use the class function.

bool writeData8(uint8_t num);

“BLERemoteDescriptor.h” must be included to use the class function.

bool writeData16(uint16_t num);

“BLERemoteDescriptor.h” must be included to use the class function.

bool writeData32(uint32_t num);
bool writeData32(int num);

“BLERemoteDescriptor.h” must be included to use the class function.

bool setData(uint8_t* data, uint16_t datalen);

“BLERemoteDescriptor.h” must be included to use the class function.

uint16_t getData(uint8_t* data, uint16_t datalen);

If the data buffer contains less data than requested, it will only read the available number of bytes of data. “BLERemoteDescriptor.h” must be included to use the class function.