summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/pyb.USB_VCP.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 16:21:28 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 16:21:28 +0300
commita384a5313013d8ffda4db0e509cf798a080b3526 (patch)
treec1b87be77f0a3a68fc5a55880bf9de8af3b90b87 /docs/library/pyb.USB_VCP.rst
parent585aafc27eb7fa8fe660e3eeaa29bf8d7ab99213 (diff)
downloadmicropython-a384a5313013d8ffda4db0e509cf798a080b3526.tar.gz
micropython-a384a5313013d8ffda4db0e509cf798a080b3526.zip
docs/pyb.*: Use proper class case in method headers.
Class designator will be used as is in indexes, so must match actual class name.
Diffstat (limited to 'docs/library/pyb.USB_VCP.rst')
-rw-r--r--docs/library/pyb.USB_VCP.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst
index 6a77f1eae3..4e34af2586 100644
--- a/docs/library/pyb.USB_VCP.rst
+++ b/docs/library/pyb.USB_VCP.rst
@@ -19,7 +19,7 @@ Constructors
Methods
-------
-.. method:: usb_vcp.setinterrupt(chr)
+.. method:: USB_VCP.setinterrupt(chr)
Set the character which interrupts running Python code. This is set
to 3 (CTRL-C) by default, and when a CTRL-C character is received over
@@ -28,20 +28,20 @@ Methods
Set to -1 to disable this interrupt feature. This is useful when you
want to send raw bytes over the USB VCP port.
-.. method:: usb_vcp.isconnected()
+.. method:: USB_VCP.isconnected()
Return ``True`` if USB is connected as a serial device, else ``False``.
-.. method:: usb_vcp.any()
+.. method:: USB_VCP.any()
Return ``True`` if any characters waiting, else ``False``.
-.. method:: usb_vcp.close()
+.. method:: USB_VCP.close()
This method does nothing. It exists so the USB_VCP object can act as
a file.
-.. method:: usb_vcp.read([nbytes])
+.. method:: USB_VCP.read([nbytes])
Read at most ``nbytes`` from the serial device and return them as a
bytes object. If ``nbytes`` is not specified then the method acts as
@@ -49,12 +49,12 @@ Methods
so if no pending data available, this method will return immediately
with ``None`` value.
-.. method:: usb_vcp.readall()
+.. method:: USB_VCP.readall()
Read all available bytes from the serial device and return them as
a bytes object, or ``None`` if no pending data available.
-.. method:: usb_vcp.readinto(buf, [maxlen])
+.. method:: USB_VCP.readinto(buf, [maxlen])
Read bytes from the serial device and store them into ``buf``, which
should be a buffer-like object. At most ``len(buf)`` bytes are read.
@@ -64,14 +64,14 @@ Methods
Returns the number of bytes read and stored into ``buf`` or ``None``
if no pending data available.
-.. method:: usb_vcp.readline()
+.. method:: USB_VCP.readline()
Read a whole line from the serial device.
Returns a bytes object containing the data, including the trailing
newline character or ``None`` if no pending data available.
-.. method:: usb_vcp.readlines()
+.. method:: USB_VCP.readlines()
Read as much data as possible from the serial device, breaking it into
lines.
@@ -79,13 +79,13 @@ Methods
Returns a list of bytes objects, each object being one of the lines.
Each line will include the newline character.
-.. method:: usb_vcp.write(buf)
+.. method:: USB_VCP.write(buf)
Write the bytes from ``buf`` to the serial device.
Returns the number of bytes written.
-.. method:: usb_vcp.recv(data, \*, timeout=5000)
+.. method:: USB_VCP.recv(data, \*, timeout=5000)
Receive data on the bus:
@@ -96,7 +96,7 @@ Methods
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_vcp.send(data, \*, timeout=5000)
+.. method:: USB_VCP.send(data, \*, timeout=5000)
Send data over the USB VCP: