summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-11-29 15:23:21 +0000
committerDamien George <damien.p.george@gmail.com>2014-11-29 15:23:21 +0000
commit19fb1b4dd7173ad2cf4b2bb1b0f0c06498499bd2 (patch)
tree0f557d2d687fad065dd4ad11a3ff3f3b35a83a0f /docs/library
parentb395220ef00ccf9700a37e470f4d4cf021743572 (diff)
stmhal: Add USB_VCP.setinterrupt method, to disable CTRL-C.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/pyb.USB_VCP.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst
index 733064072..4d87be4a3 100644
--- a/docs/library/pyb.USB_VCP.rst
+++ b/docs/library/pyb.USB_VCP.rst
@@ -17,6 +17,15 @@ Constructors
Methods
-------
+.. 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
+ 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.
+
.. method:: usb_vcp.any()
Return ``True`` if any characters waiting, else ``False``.