diff options
author | Marti Bolivar <mbolivar@mit.edu> | 2010-11-29 18:08:04 -0500 |
---|---|---|
committer | Marti Bolivar <mbolivar@mit.edu> | 2010-11-29 18:08:04 -0500 |
commit | 8e42d34c8d3c81c037a3acaca553ea8c5e4f25aa (patch) | |
tree | 3411efcb2a8831de3c6eb0e405ee56c404bd35e2 /source/lang | |
parent | ee35f641687d0d3159c15eea5ad80d71efff4f82 (diff) | |
download | librambutan-8e42d34c8d3c81c037a3acaca553ea8c5e4f25aa.tar.gz librambutan-8e42d34c8d3c81c037a3acaca553ea8c5e4f25aa.zip |
New documentation content is done. Next step is to theme.
Diffstat (limited to 'source/lang')
-rw-r--r-- | source/lang/analogwrite.rst | 2 | ||||
-rw-r--r-- | source/lang/serial.rst | 31 | ||||
-rw-r--r-- | source/lang/serialusb.rst | 2 | ||||
-rw-r--r-- | source/lang/unimplemented/stringclass.rst | 3 |
4 files changed, 23 insertions, 15 deletions
diff --git a/source/lang/analogwrite.rst b/source/lang/analogwrite.rst index 3d05f44..2c50a42 100644 --- a/source/lang/analogwrite.rst +++ b/source/lang/analogwrite.rst @@ -25,6 +25,8 @@ analogWrite() .. contents:: Contents :local: +.. _lang-analogwrite-compatibility: + Arduino Compatibility --------------------- diff --git a/source/lang/serial.rst b/source/lang/serial.rst index f96547d..ca89b31 100644 --- a/source/lang/serial.rst +++ b/source/lang/serial.rst @@ -20,25 +20,24 @@ pins summarized in the following table: :header-rows: 1 * - Serial port - - Pins (TX, RX) + - TX, RX, CK + - CTS, RTS (if present) * - ``Serial1`` - - 7, 8 + - 7, 8, 6 + - * - ``Serial2`` - - 1, 0 + - 1, 0, 10 + - 2, 3 * - ``Serial3`` - - 29, 30 + - 29, 30, 31 + - 32, 33 Thus, if you use a particular serial port, you cannot also use its communication pins for other purposes at the same time. -Unlike the Arduino, none of these serial ports is connected to the USB -port on the Maple board. Thus, to use these pins to communicate with -your personal computer, you will need an additional USB-to-serial -adaptor. - If you want to communicate with the Maple using the provided USB port, use :ref:`SerialUSB <lang-serialusb>` instead. @@ -60,8 +59,8 @@ means that you can use any of these functions on any of ``Serial1``, .. cpp:class:: HardwareSerial - Serial port class. Predefined instances are Serial1, Serial2, and - Serial3. + Serial port class. Predefined instances are ``Serial1``, + ``Serial2``, and ``Serial3``. .. cpp:function:: HardwareSerial::begin(unsigned int baud) @@ -73,7 +72,7 @@ means that you can use any of these functions on any of ``Serial1``, .. cpp:function:: HardwareSerial::end() Disables the USART associated with this object, allowing any - associated TX and RX pins to be used for other purposes. + associated communication pins to be used for other purposes. .. cpp:function:: unsigned int HardwareSerial::available() @@ -203,6 +202,14 @@ means that you can use any of these functions on any of ``Serial1``, ``println()`` functions is likely to be more useful when printing multiple characters, when formatting numbers for printing, etc. +Arduino Compatibility Note +-------------------------- + +Unlike the Arduino, none of the Maple's serial ports is connected to +the USB port on the Maple board (for that, use :ref:`SerialUSB +<lang-serialusb>`). Thus, to use these pins to communicate with your +personal computer, you will need an additional USB-to-serial adaptor. + .. TODO LATER port these examples over .. Examples diff --git a/source/lang/serialusb.rst b/source/lang/serialusb.rst index 9beee82..af3a7e0 100644 --- a/source/lang/serialusb.rst +++ b/source/lang/serialusb.rst @@ -71,6 +71,8 @@ world!")``. Returns the number of bytes available for reading. +.. _lang-serialusb-read: + .. cpp:function:: unsigned char USBSerial::read() Returns the next available, unread character. If there are no diff --git a/source/lang/unimplemented/stringclass.rst b/source/lang/unimplemented/stringclass.rst index cdd385d..b893e83 100644 --- a/source/lang/unimplemented/stringclass.rst +++ b/source/lang/unimplemented/stringclass.rst @@ -3,7 +3,4 @@ String Class ============ -Stub. - - .. include:: /lang/cc-attribution.txt |