diff options
| author | Marti Bolivar <mbolivar@mit.edu> | 2010-12-15 01:50:56 -0500 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@mit.edu> | 2010-12-15 16:16:31 -0500 |
| commit | d744fb826f4a6d6ce560f3b78f2e63a1f9666d9e (patch) | |
| tree | 35d0939c959cec372e1a6ce2f4bdf95dbe977918 /docs/source/lang/api/serialusb.rst | |
| parent | 74c8937446e1be4e0d21f69a8c098e2caf7814d5 (diff) | |
| download | librambutan-d744fb826f4a6d6ce560f3b78f2e63a1f9666d9e.tar.gz librambutan-d744fb826f4a6d6ce560f3b78f2e63a1f9666d9e.zip | |
Finalized 0.0.9 documentation.
Diffstat (limited to 'docs/source/lang/api/serialusb.rst')
| -rw-r--r-- | docs/source/lang/api/serialusb.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/source/lang/api/serialusb.rst b/docs/source/lang/api/serialusb.rst index af3a7e0..e1d12bf 100644 --- a/docs/source/lang/api/serialusb.rst +++ b/docs/source/lang/api/serialusb.rst @@ -52,7 +52,9 @@ world!")``. .. cpp:class:: USBSerial Emulated serial-over-USB class. ``SerialUSB`` is the predefined - instance. + (singleton) instance. + +.. _lang-serialusb-begin: .. cpp:function:: USBSerial::begin() @@ -65,7 +67,12 @@ world!")``. .. cpp:function:: USBSerial::end() - Disables the USB peripheral. + Disables the USB peripheral. Note that using this function will + terminate all USB communications between the Maple and the USB + host; in particular, it implies that you won't be able to upload + any new programs without resetting the board or using + :ref:`perpetual bootloader mode + <troubleshooting-perpetual-bootloader>`. .. cpp:function:: unsigned int USBSerial::available() |