BTHID Class Reference

#include <BTHID.h>

Inheritance diagram for BTHID:

Collaboration diagram for BTHID:

Public Member Functions
	BTHID (BTD *p, bool pair=false, const char *pin="0000")
HIDReportParser *	GetReportParser (uint8_t id)
bool	SetReportParser (uint8_t id, HIDReportParser *prs)
void	setProtocolMode (uint8_t mode)
void	setLeds (uint8_t data)
void	pair (void)
Public Member Functions inherited from BluetoothService
	BluetoothService (BTD *p)
void	attachOnInit (void(*funcOnInit)(void))

Public Attributes
bool	connected

Protected Member Functions
Overridable functions
virtual void	ParseBTHIDData (uint8_t len, uint8_t *buf)
virtual void	OnInitBTHID ()
virtual void	ResetBTHID ()
Protected Member Functions inherited from BluetoothService
bool	checkHciHandle (uint8_t *buf, uint16_t handle)

Protected Attributes
uint8_t	control_scid [2]
uint8_t	interrupt_scid [2]
Protected Attributes inherited from BluetoothService
void(*	pFuncOnInit )(void)
BTD *	pBtd
uint16_t	hci_handle
uint32_t	l2cap_event_flag
uint8_t	identifier

BluetoothService implementation
void	disconnect ()
void	ACLData (uint8_t *ACLData)
void	Run ()
void	Reset ()
void	onInit ()

Detailed Description

This BluetoothService class implements support for Bluetooth HID devices.

Definition at line 29 of file BTHID.h.

Constructor & Destructor Documentation

BTHID::BTHID	(	BTD *	p,
		bool	pair = false,
		const char *	pin = "0000"
	)

Constructor for the BTHID class.

Parameters

p	Pointer to the BTD class instance.
pair	Set this to true in order to pair with the device. If the argument is omitted then it will not pair with it. One can use PAIR to set it to true.
pin	Write the pin to BTD::btdPin. If argument is omitted, then "0000" will be used.

Definition at line 23 of file BTHID.cpp.

Member Function Documentation

void BTHID::disconnect ( )

virtual

Used this to disconnect the devices.

Implements BluetoothService.

Definition at line 49 of file BTHID.cpp.

HIDReportParser* BTHID::GetReportParser ( uint8_t  id )

inline

Get HIDReportParser.

Parameters

id	ID of parser.

Returns

Returns the corresponding HIDReportParser. Returns NULL if id is not valid.

Definition at line 49 of file BTHID.h.

bool BTHID::SetReportParser ( uint8_t  id, HIDReportParser *  prs  )

inline

Set HIDReportParser to be used.

Parameters

id	Id of parser.
prs	Pointer to HIDReportParser.

Returns

Returns true if the HIDReportParser is set. False otherwise.

Definition at line 61 of file BTHID.h.

void BTHID::setProtocolMode ( uint8_t  mode )

inline

Set HID protocol mode.

Parameters

mode	HID protocol to use. Either HID_BOOT_PROTOCOL or HID_RPT_PROTOCOL.

Definition at line 72 of file BTHID.h.

void BTHID::setLeds

(

uint8_t

data

)

Used to set the leds on a keyboard.

Parameters

data	See KBDLEDS in hidboot.h

Definition at line 393 of file BTHID.cpp.

void BTHID::pair ( void  )

inline

Call this to start the paring sequence with a device

Definition at line 86 of file BTHID.h.

void BTHID::ACLData ( uint8_t *  ACLData )

protectedvirtual

Used to pass acldata to the services.

Parameters

ACLData

Incoming acldata.

Implements BluetoothService.

Definition at line 56 of file BTHID.cpp.

void BTHID::Run ( )

protectedvirtual

Used to run part of the state machine.

Implements BluetoothService.

Definition at line 344 of file BTHID.cpp.

void BTHID::Reset ( )

protectedvirtual

Use this to reset the service.

Implements BluetoothService.

Definition at line 41 of file BTHID.cpp.

void BTHID::onInit ( )

inlineprotectedvirtual

Called when a device is successfully initialized. Use attachOnInit(void (*funcOnInit)(void)) to call your own function. This is useful for instance if you want to set the LEDs in a specific way.

Implements BluetoothService.

Definition at line 107 of file BTHID.h.

virtual void BTHID::ParseBTHIDData ( uint8_t  len, uint8_t *  buf  )

inlineprotectedvirtual

Used to parse Bluetooth HID data to any class that inherits this class.

Parameters

len	The length of the incoming data.
buf	Pointer to the data buffer.

Reimplemented in PS4BT.

Definition at line 120 of file BTHID.h.

virtual void BTHID::OnInitBTHID ( )

inlineprotectedvirtual

Called when a device is connected

Reimplemented in PS4BT.

Definition at line 124 of file BTHID.h.

virtual void BTHID::ResetBTHID ( )

inlineprotectedvirtual

Used to reset any buffers in the class that inherits this

Reimplemented in PS4BT.

Definition at line 128 of file BTHID.h.

Member Data Documentation

bool BTHID::connected

True if a device is connected

Definition at line 83 of file BTHID.h.

uint8_t BTHID::control_scid[2]

protected

L2CAP source CID for HID_Control

Definition at line 134 of file BTHID.h.

uint8_t BTHID::interrupt_scid[2]

protected

L2CAP source CID for HID_Interrupt

Definition at line 137 of file BTHID.h.

---

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

• BTHID.h
• BTHID.cpp