hid Namespace Reference

Everything related to the HID protocol. More...

Functions
void	configure (std::string deviceName, std::string deviceManufacturer, bool enableAutoPowerOff=true, uint16_t vendorID=0, uint16_t productID=0)
	Initialize Bluetooth/USB device.
void	connectivity (Connectivity option)
	Choose a connectivity option.

Detailed Description

Everything related to the HID protocol.

Function Documentation

configure()

void hid::configure	(	std::string	deviceName,
		std::string	deviceManufacturer,
		bool	enableAutoPowerOff = true,
		uint16_t	vendorID = 0,
		uint16_t	productID = 0 )

Initialize Bluetooth/USB device.

Parameters

deviceName	Name of this device shown to the host computer
deviceManufacturer	Name of the manufacturer of this device
enableAutoPowerOff	True to shutdown when not connected within a certain time lapse. Set to false if there is no battery or for testing.
vendorID	Factory VID. Set to zero to use a default vendor ID. Value 0xFFFF is reserved for testing. Ignored in the USB implementation.
productID	Factory PID. Set to zero to use a default product ID. Value 0xFFFF is reserved for testing.

connectivity()

void hid::connectivity

(

Connectivity

option

)

Choose a connectivity option.

Warning

Your connectivity choice will be ignored if not available in the DevKit board. If both USB and BLE are unavailable or excluded from option , the firmware won't boot (with an error message).

Parameters

option

Connectivity option