class USB_HID – USB Human Interface Device (HID) — MicroPython latest documentation (original) (raw)

This is the documentation for the latest development branch of MicroPython and may refer to features that are not available in released versions.

If you are looking for the documentation for a specific release, use the drop-down menu on the left and select the desired version.

The USB_HID class allows creation of an object representing the USB Human Interface Device (HID) interface. It can be used to emulate a peripheral such as a mouse or keyboard.

Before you can use this class, you need to use pyb.usb_mode() to set the USB mode to include the HID interface.

Constructors¶

class pyb.USB_HID¶

Create a new USB_HID object.

Methods¶

USB_HID.recv(data, *, timeout=5000)¶

Receive data on the bus:

• data can be an integer, which is the number of bytes to receive, or a mutable buffer, which will be filled with received bytes.
• timeout is the timeout in milliseconds to wait for the receive.

Return value: if data is an integer then a new buffer of the bytes received, otherwise the number of bytes read into data is returned.

USB_HID.send(data)¶

Send data over the USB HID interface:

• data is the data to send (a tuple/list of integers, or a bytearray).