summaryrefslogtreecommitdiff
path: root/docs/library/pyb.USB_HID.rst
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-02-27 22:03:52 -0500
committerGitHub <noreply@github.com>2018-02-27 22:03:52 -0500
commit568c04e6afa8016062f685b2198c0209f62827f4 (patch)
treed07b76119f715add462983b335797adf64b61249 /docs/library/pyb.USB_HID.rst
parent6a2379fd0bfe10017d8abc5c36ef1d470c0d9b27 (diff)
parentea633117d01d94e8d56ed94344e4b3e46b4eef03 (diff)
Merge pull request #650 from tannewt/merge_2x3.0.0-alpha.2
Merge in commits from 2.x branch.
Diffstat (limited to 'docs/library/pyb.USB_HID.rst')
-rw-r--r--docs/library/pyb.USB_HID.rst40
1 files changed, 0 insertions, 40 deletions
diff --git a/docs/library/pyb.USB_HID.rst b/docs/library/pyb.USB_HID.rst
deleted file mode 100644
index 702704435..000000000
--- a/docs/library/pyb.USB_HID.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-.. currentmodule:: pyb
-.. _pyb.USB_HID:
-
-class USB_HID -- USB Human Interface Device (HID)
-=================================================
-
-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 :meth:`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
--------
-
-.. method:: 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.
-
-.. method:: 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).