NimBLEHIDDevice Class Reference

A model of a BLE Human Interface Device. More...

#include <NimBLEHIDDevice.h>

Public Member Functions
	NimBLEHIDDevice (NimBLEServer *)
	Construct a default NimBLEHIDDevice object. More...
void	reportMap (uint8_t *map, uint16_t)
	Set the report map data formatting information. More...
void	startServices ()
	Start the HID device services. This function called when all the services have been created.
NimBLEService *	deviceInfo ()
	Returns a pointer to the device information service.
NimBLEService *	hidService ()
	Returns a pointer to the HID service.
NimBLEService *	batteryService ()
	Returns a pointer to the battery service.
NimBLECharacteristic *	manufacturer ()
	Create a manufacturer characteristic (this characteristic is optional).
void	manufacturer (std::string name)
	Set manufacturer name. More...
void	pnp (uint8_t sig, uint16_t vid, uint16_t pid, uint16_t version)
	Sets the Plug n Play characteristic value. More...
void	hidInfo (uint8_t country, uint8_t flags)
	Sets the HID Information characteristic value. More...
void	setBatteryLevel (uint8_t level)
	Set the battery level characteristic value. More...
NimBLECharacteristic *	hidControl ()
	Returns a pointer to the HID control point characteristic.
NimBLECharacteristic *	inputReport (uint8_t reportID)
	Create input report characteristic. More...
NimBLECharacteristic *	outputReport (uint8_t reportID)
	Create output report characteristic. More...
NimBLECharacteristic *	featureReport (uint8_t reportID)
	Create feature report characteristic. More...
NimBLECharacteristic *	protocolMode ()
	Returns a pointer to the protocol mode characteristic.
NimBLECharacteristic *	bootInput ()
	Creates a keyboard boot input report characteristic.
NimBLECharacteristic *	bootOutput ()
	Create a keyboard boot output report characteristic.

Detailed Description

A model of a BLE Human Interface Device.

Constructor & Destructor Documentation

NimBLEHIDDevice()

NimBLEHIDDevice::NimBLEHIDDevice

(

NimBLEServer *

server

)

Construct a default NimBLEHIDDevice object.

Parameters

[in]

server

A pointer to the server instance this HID Device will use.

Member Function Documentation

featureReport()

NimBLECharacteristic * NimBLEHIDDevice::featureReport

(

uint8_t

reportID

)

Create feature report characteristic.

Parameters

[in]

reportID

Feature report ID, the same as in report map for feature object related to the characteristic

Returns

Pointer to new feature report characteristic

hidInfo()

void NimBLEHIDDevice::hidInfo	(	uint8_t	country,
		uint8_t	flags
	)

Sets the HID Information characteristic value.

Parameters

[in]	country	The country code for the device.
[in]	flags	The HID Class Specification release number to use.

inputReport()

NimBLECharacteristic * NimBLEHIDDevice::inputReport

(

uint8_t

reportID

)

Create input report characteristic.

Parameters

[in]

reportID

input report ID, the same as in report map for input object related to the characteristic

Returns

pointer to new input report characteristic

manufacturer()

void NimBLEHIDDevice::manufacturer

(

std::string

name

)

Set manufacturer name.

Parameters

[in]

name

The manufacturer name of this HID device.

outputReport()

NimBLECharacteristic * NimBLEHIDDevice::outputReport

(

uint8_t

reportID

)

Create output report characteristic.

Parameters

[in]

reportID

Output report ID, the same as in report map for output object related to the characteristic

Returns

Pointer to new output report characteristic

pnp()

void NimBLEHIDDevice::pnp	(	uint8_t	sig,
		uint16_t	vid,
		uint16_t	pid,
		uint16_t	version
	)

Sets the Plug n Play characteristic value.

Parameters

[in]	sig	The vendor ID source number.
[in]	vid	The vendor ID number.
[in]	pid	The product ID number.
[in]	version	The produce version number.

reportMap()

void NimBLEHIDDevice::reportMap	(	uint8_t *	map,
		uint16_t	size
	)

Set the report map data formatting information.

Parameters

[in]	map	A pointer to an array with the values to set.
[in]	size	The number of values in the array.

setBatteryLevel()

void NimBLEHIDDevice::setBatteryLevel

(

uint8_t

level

)

Set the battery level characteristic value.

Parameters

[in]

level

The battery level value.