USBHost library. NOTE: This library is only officially supported on the LPC1768 platform. For more information, please see the handbook page.

Dependencies:   FATFileSystem mbed-rtos

Dependents:   BTstack WallbotWii SD to Flash Data Transfer USBHost-MSD_HelloWorld ... more

Embed: (wiki syntax)

« Back to documentation index

USBHostKeyboard Class Reference

USBHostKeyboard Class Reference

A class to communicate a USB keyboard. More...

#include <USBHostKeyboard.h>

Inherits IUSBEnumerator.

Public Member Functions

 USBHostKeyboard ()
 Constructor.
bool connect ()
 Try to connect a keyboard device.
bool connected ()
 Check if a keyboard is connected.
void attach (void(*ptr)(uint8_t key))
 Attach a callback called when a keyboard event is received.
void attach (void(*ptr)(uint8_t keyCode, uint8_t modifier))
 Attach a callback called when a keyboard event is received.

Detailed Description

A class to communicate a USB keyboard.

Definition at line 29 of file USBHostKeyboard.h.


Constructor & Destructor Documentation

Constructor.

Definition at line 88 of file USBHostKeyboard.cpp.


Member Function Documentation

void attach ( void(*)(uint8_t key)  ptr )

Attach a callback called when a keyboard event is received.

Parameters:
ptrfunction pointer

Definition at line 57 of file USBHostKeyboard.h.

void attach ( void(*)(uint8_t keyCode, uint8_t modifier)  ptr )

Attach a callback called when a keyboard event is received.

Parameters:
ptrfunction pointer

Definition at line 69 of file USBHostKeyboard.h.

bool connect (  )

Try to connect a keyboard device.

Returns:
true if connection was successful

Definition at line 113 of file USBHostKeyboard.cpp.

bool connected (  )

Check if a keyboard is connected.

Returns:
true if a keyboard is connected

Definition at line 107 of file USBHostKeyboard.cpp.