The model of a BLE service. More...

#include <NimBLEService.h>

Public Member Functions
	NimBLEService (const char *uuid)
	Construct an instance of the NimBLEService. More...

	NimBLEService (const NimBLEUUID &uuid)
	Construct an instance of the BLEService. More...

NimBLEServer *	getServer ()
	Get the BLE server associated with this service. More...

NimBLEUUID	getUUID ()
	Get the UUID of the service. More...

uint16_t	getHandle ()
	Get the handle associated with this service. More...

std::string	toString ()
	Return a string representation of this service. A service is defined by: More...

void	dump ()
	Dump details of this BLE GATT service.

bool	start ()
	Builds the database of characteristics/descriptors for the service and registers it with the NimBLE stack. More...

NimBLECharacteristic *	createCharacteristic (const char *uuid, uint32_t properties=NIMBLE_PROPERTY::READ\|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)
	Create a new BLE Characteristic associated with this service. More...

NimBLECharacteristic *	createCharacteristic (const NimBLEUUID &uuid, uint32_t properties=NIMBLE_PROPERTY::READ\|NIMBLE_PROPERTY::WRITE, uint16_t max_len=BLE_ATT_ATTR_MAX_LEN)
	Create a new BLE Characteristic associated with this service. More...

void	addCharacteristic (NimBLECharacteristic *pCharacteristic)
	Add a characteristic to the service. More...

void	removeCharacteristic (NimBLECharacteristic *pCharacteristic, bool deleteChr=false)
	Remove a characteristic from the service. More...

NimBLECharacteristic *	getCharacteristic (const char *uuid, uint16_t instanceId=0)
	Get a pointer to the characteristic object with the specified UUID. More...

NimBLECharacteristic *	getCharacteristic (const NimBLEUUID &uuid, uint16_t instanceId=0)
	Get a pointer to the characteristic object with the specified UUID. More...

NimBLECharacteristic *	getCharacteristicByHandle (uint16_t handle)
	Get a pointer to the characteristic object with the specified handle. More...

std::vector< NimBLECharacteristic * >	getCharacteristics ()

std::vector< NimBLECharacteristic * >	getCharacteristics (const char *uuid)

std::vector< NimBLECharacteristic * >	getCharacteristics (const NimBLEUUID &uuid)

Detailed Description

The model of a BLE service.

Constructor & Destructor Documentation

◆ NimBLEService() [1/2]

NimBLEService::NimBLEService ( const char * uuid )

Construct an instance of the NimBLEService.

Parameters

[in] uuid The UUID of the service.

◆ NimBLEService() [2/2]

NimBLEService::NimBLEService ( const NimBLEUUID & uuid )

Construct an instance of the BLEService.

Parameters

[in] uuid The UUID of the service.

Member Function Documentation

◆ addCharacteristic()

void NimBLEService::addCharacteristic ( NimBLECharacteristic * pCharacteristic )

Add a characteristic to the service.

Parameters

[in] pCharacteristic A pointer to the characteristic instance to add to the service.

◆ createCharacteristic() [1/2]

NimBLECharacteristic * NimBLEService::createCharacteristic	(	const char *	uuid,
		uint32_t	properties = `NIMBLE_PROPERTY::READ \| NIMBLE_PROPERTY::WRITE`,
		uint16_t	max_len = `BLE_ATT_ATTR_MAX_LEN`
	)

Create a new BLE Characteristic associated with this service.

Parameters

[in]	uuid	- The UUID of the characteristic.
[in]	properties	- The properties of the characteristic.
[in]	max_len	- The maximum length in bytes that the characteristic value can hold.

Returns: The new BLE characteristic.

◆ createCharacteristic() [2/2]

NimBLECharacteristic * NimBLEService::createCharacteristic	(	const NimBLEUUID &	uuid,
		uint32_t	properties = `NIMBLE_PROPERTY::READ \| NIMBLE_PROPERTY::WRITE`,
		uint16_t	max_len = `BLE_ATT_ATTR_MAX_LEN`
	)

Create a new BLE Characteristic associated with this service.

Parameters

[in]	uuid	- The UUID of the characteristic.
[in]	properties	- The properties of the characteristic.
[in]	max_len	- The maximum length in bytes that the characteristic value can hold.

Returns: The new BLE characteristic.

◆ getCharacteristic() [1/2]

NimBLECharacteristic * NimBLEService::getCharacteristic	(	const char *	uuid,
		uint16_t	instanceId = `0`
	)

Get a pointer to the characteristic object with the specified UUID.

Parameters

[in]	uuid	The UUID of the characteristic.
	instanceId	The index of the characteristic to return (used when multiple characteristics have the same UUID).

Returns: A pointer to the characteristic object or nullptr if not found.

◆ getCharacteristic() [2/2]

NimBLECharacteristic * NimBLEService::getCharacteristic	(	const NimBLEUUID &	uuid,
		uint16_t	instanceId = `0`
	)

Get a pointer to the characteristic object with the specified UUID.

Parameters

[in]	uuid	The UUID of the characteristic.
	instanceId	The index of the characteristic to return (used when multiple characteristics have the same UUID).

Returns: A pointer to the characteristic object or nullptr if not found.

◆ getCharacteristicByHandle()

NimBLECharacteristic * NimBLEService::getCharacteristicByHandle ( uint16_t handle )

Get a pointer to the characteristic object with the specified handle.

Parameters

handle The handle of the characteristic.

Returns: A pointer to the characteristic object or nullptr if not found.

◆ getCharacteristics() [1/3]

std::vector< NimBLECharacteristic * > NimBLEService::getCharacteristics ( )

Returns: A vector containing pointers to each characteristic associated with this service.

◆ getCharacteristics() [2/3]

std::vector< NimBLECharacteristic * > NimBLEService::getCharacteristics ( const char * uuid )

Returns: A vector containing pointers to each characteristic with the provided UUID associated with this service.

◆ getCharacteristics() [3/3]

std::vector< NimBLECharacteristic * > NimBLEService::getCharacteristics ( const NimBLEUUID & uuid )

Returns: A vector containing pointers to each characteristic with the provided UUID associated with this service.

◆ getHandle()

uint16_t NimBLEService::getHandle ( )

Get the handle associated with this service.

Returns: The handle associated with this service.

◆ getServer()

NimBLEServer * NimBLEService::getServer ( )

Get the BLE server associated with this service.

Returns: The BLEServer associated with this service.

◆ getUUID()

NimBLEUUID NimBLEService::getUUID ( )

Get the UUID of the service.

Returns: the UUID of the service.

◆ removeCharacteristic()

void NimBLEService::removeCharacteristic	(	NimBLECharacteristic *	pCharacteristic,
		bool	deleteChr = `false`
	)

Remove a characteristic from the service.

Parameters

[in]	pCharacteristic	A pointer to the characteristic instance to remove from the service.
[in]	deleteChr	If true it will delete the characteristic instance and free it's resources.

◆ start()

bool NimBLEService::start ( )

Builds the database of characteristics/descriptors for the service and registers it with the NimBLE stack.

Returns: bool success/failure .

◆ toString()

std::string NimBLEService::toString ( )

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

Its UUID
Its handle
Returns
A string representation of this service.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NimBLEService() [1/2]

◆ NimBLEService() [2/2]

Member Function Documentation

◆ addCharacteristic()

◆ createCharacteristic() [1/2]

◆ createCharacteristic() [2/2]

◆ getCharacteristic() [1/2]

◆ getCharacteristic() [2/2]

◆ getCharacteristicByHandle()

◆ getCharacteristics() [1/3]

◆ getCharacteristics() [2/3]

◆ getCharacteristics() [3/3]

◆ getHandle()

◆ getServer()

◆ getUUID()

◆ removeCharacteristic()

◆ start()

◆ toString()