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 | 7f31099eead99718d279d9a4bb543131329891ce (patch) | |
| tree | d1bca663d7a8e3541085951664ecf26bea31c006 /source/lang/api/serialusb.rst | |
| parent | 210f3d2b1555bae87c9de27ea145e16d3bddb0f8 (diff) | |
| download | librambutan-7f31099eead99718d279d9a4bb543131329891ce.tar.gz librambutan-7f31099eead99718d279d9a4bb543131329891ce.zip | |
Finalized 0.0.9 documentation.
Diffstat (limited to 'source/lang/api/serialusb.rst')
| -rw-r--r-- | source/lang/api/serialusb.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/source/lang/api/serialusb.rst b/source/lang/api/serialusb.rst index af3a7e0..e1d12bf 100644 --- a/source/lang/api/serialusb.rst +++ b/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() |