:mod:`usb_hid`
==============

.. py:module:: usb_hid

.. autoapi-nested-parse::

   USB Human Interface Device

   The `usb_hid` module allows you to output data as a HID device.





.. data:: devices
   :annotation: :Tuple[Device, ...]

   Tuple of all active HID device interfaces.


.. py:class:: Device

   HID Device

   Usage::

      import usb_hid

      mouse = usb_hid.devices[0]

      mouse.send_report()

   Not currently dynamically supported.

   .. attribute:: usage_page
      :annotation: :int

      The usage page of the device as an `int`. Can be thought of a category. (read-only)


   .. attribute:: usage
      :annotation: :int

      The functionality of the device as an int. (read-only)

      For example, Keyboard is 0x06 within the generic desktop usage page 0x01.
      Mouse is 0x02 within the same usage page.


   .. method:: send_report(self, buf: ReadableBuffer) -> None

      Send a HID report.