Norimasa Okamoto / USBLocalFileSystem

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.

Dependencies:   USBDevice

Dependents:   KL46Z-lpc81isp lpcterm2

Embed: (wiki syntax)

« Back to documentation index

USB_HID Class Reference
Public Member Functions

USB_HID Class Reference

USB HID device for CMSIS-DAP. More...

#include <USB_HID.h>

Public Member Functions

 USB_HID (USBDevice *device, uint8_t output_report_length=64, uint8_t input_report_length=64)
 Constructor.
bool send (HID_REPORT *report)
 Send a Report.
bool sendNB (HID_REPORT *report)
 Send a Report.
bool read (HID_REPORT *report)
 Read a report: blocking.
bool readNB (HID_REPORT *report)
 Read a report: non blocking.

Detailed Description

USB HID device for CMSIS-DAP.

Definition at line 29 of file USB_HID.h.

Constructor & Destructor Documentation

USB_HID ( USBDevice *  device,
uint8_t  output_report_length = 64,
uint8_t  input_report_length = 64 
)

Constructor.

Parameters:
output_report_lengthMaximum length of a sent report (up to 64 bytes) (default: 64 bytes)
input_report_lengthMaximum length of a received report (up to 64 bytes) (default: 64 bytes)

Definition at line 27 of file USB_HID.cpp.

Member Function Documentation

bool read ( HID_REPORT *  report )

Read a report: blocking.

Parameters:
reportpointer to the report to fill
Returns:
true if successful

Definition at line 45 of file USB_HID.cpp.

bool readNB ( HID_REPORT *  report )

Read a report: non blocking.

Parameters:
reportpointer to the report to fill
Returns:
true if successful

Definition at line 56 of file USB_HID.cpp.

bool send ( HID_REPORT *  report )

Send a Report.

warning: blocking

Parameters:
reportReport which will be sent (a report is defined by all data and the length)
Returns:
true if successful

Definition at line 35 of file USB_HID.cpp.

bool sendNB ( HID_REPORT *  report )

Send a Report.

warning: non blocking

Parameters:
reportReport which will be sent (a report is defined by all data and the length)
Returns:
true if successful

Definition at line 40 of file USB_HID.cpp.

Generated on Tue Jul 12 2022 19:39:32 by  doxygen 1.7.2