pyb.USB_VCP
===========
.. This document was autogenerated by Sphinx-autoapi from a .pyi stub or a source code file.
.. Do not edit this file, instead edit the source file and run Sphinx to update. 
.. Source: docs/stubs/pyb/USB_VCP.pyi

.. py:module:: pyb.USB_VCP


Classes
-------

.. autoapisummary::

   pyb.USB_VCP.USB_VCP


Module Contents
---------------

.. py:class:: USB_VCP(id=0)

   Create a new USB_VCP object.  The *id* argument specifies which USB VCP port to
   use.


   .. py:method:: any() -> bool

      Return ``True`` if any characters waiting, else ``False``.



   .. py:method:: close() -> _typeshed.Incomplete

      This method does nothing.  It exists so the USB_VCP object can act as
      a file.



   .. py:method:: init(*, flow=-1) -> None

      Configure the USB VCP port.  If the *flow* argument is not -1 then the value sets
      the flow control, which can be a bitwise-or of ``USB_VCP.RTS`` and ``USB_VCP.CTS``.
      RTS is used to control read behaviour and CTS, to control write behaviour.



   .. py:method:: irq(handler=None, trigger=IRQ_RX, hard=False) -> None

      Register *handler* to be called whenever an event specified by *trigger*
      occurs.  The *handler* function must take exactly one argument, which will
      be the USB VCP object.  Pass in ``None`` to disable the callback.

      Valid values for *trigger* are:

        - ``USB_VCP.IRQ_RX``: new data is available for reading from the USB VCP object.



   .. py:method:: isconnected() -> bool

      Return ``True`` if USB is connected as a serial device, else ``False``.



   .. py:method:: read(nbytes: Optional[Any] = None) -> bytes

      Read at most ``nbytes`` from the serial device and return them as a
      bytes object.  If ``nbytes`` is not specified then the method reads
      all available bytes from the serial device.
      USB_VCP `stream` implicitly works in non-blocking mode,
      so if no pending data available, this method will return immediately
      with ``None`` value.



   .. py:method:: readinto(buf, maxlen: Optional[Any] = None) -> int

      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.
      If ``maxlen`` is given and then at most ``min(maxlen, len(buf))`` bytes
      are read.

      Returns the number of bytes read and stored into ``buf`` or ``None``
      if no pending data available.



   .. py:method:: readline() -> bytes

      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.



   .. py:method:: readlines() -> List

      Read as much data as possible from the serial device, breaking it into
      lines.

      Returns a list of bytes objects, each object being one of the lines.
      Each line will include the newline character.



   .. py:method:: recv(data, *, timeout=5000) -> int

      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.



   .. py:method:: send(data, *, timeout=5000) -> int

      Send data over the USB VCP:

        - ``data`` is the data to send (an integer to send, or a buffer object).
        - ``timeout`` is the timeout in milliseconds to wait for the send.

      Return value: number of bytes sent.



   .. py:method:: setinterrupt(chr) -> None

      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
      the USB VCP port, a KeyboardInterrupt exception is raised.

      Set to -1 to disable this interrupt feature.  This is useful when you
      want to send raw bytes over the USB VCP port.



   .. py:method:: write(buf) -> int

      Write the bytes from ``buf`` to the serial device.

      Returns the number of bytes written.



   .. py:attribute:: CTS
      :type:  _typeshed.Incomplete

      to select the flow control type.


   .. py:attribute:: IRQ_RX
      :type:  _typeshed.Incomplete

      IRQ trigger values for :meth:`USB_VCP.irq`.


   .. py:attribute:: RTS
      :type:  _typeshed.Incomplete

      to select the flow control type.