diff options
| author | Damien George <damien.p.george@gmail.com> | 2019-09-26 14:00:21 +1000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2019-09-26 14:00:21 +1000 |
| commit | 78e0e76b4f91e7c51d757779814447eeaab54f9a (patch) | |
| tree | eb710b85cdc1f6ef0286451e41ebe8d5a8b012eb /docs | |
| parent | 2397b44062899cfa6fc39d5f57976c4ec62c3cf8 (diff) | |
docs/library/pyb.USB_VCP.rst: Add info about id and flow params.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/pyb.USB_VCP.rst | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst index 3bc6c749c..94ea41848 100644 --- a/docs/library/pyb.USB_VCP.rst +++ b/docs/library/pyb.USB_VCP.rst @@ -12,14 +12,21 @@ the connected host. Constructors ------------ -.. class:: pyb.USB_VCP() +.. class:: pyb.USB_VCP(id=0) - Create a new USB_VCP object. + Create a new USB_VCP object. The *id* argument specifies which USB VCP port to + use. Methods ------- +.. method:: USB_VCP.init(\*, flow=-1) + + 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. + .. method:: USB_VCP.setinterrupt(chr) Set the character which interrupts running Python code. This is set @@ -101,3 +108,12 @@ Methods - ``timeout`` is the timeout in milliseconds to wait for the send. Return value: number of bytes sent. + + +Constants +--------- + +.. data:: USB_VCP.RTS + USB_VCP.CTS + + to select the flow control type. |