Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TEST_USB_Nucleo_F429ZI Essais_USB_Nucleo_F429ZI SID_V3_Nucleo_F429ZI SID_V4_Nucleo_F429ZI_copy
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
| USBHostKeyboard | ( | ) | 
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:
- 
  ptr function 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:
- 
  ptr function 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.
Generated on Thu Jul 14 2022 19:39:44 by
 1.7.2
 1.7.2