Merge remote branch 'leaf/master'

1 files changed, 226 insertions, 0 deletions

diff --git a/docs/source/lang/api/serial.rst b/docs/source/lang/api/serial.rst
new file mode 100644
index 0000000..ca89b31
--- /dev/null
+++ b/docs/source/lang/api/serial.rst
@@ -0,0 +1,226 @@
+.. _lang-serial:
+
+Serial Ports (``Serial1``, ``Serial2``, ``Serial3``)
+====================================================
+
+Used for communication between the Maple board and a computer or other
+devices.
+
+.. contents:: Contents
+   :local:
+
+Introduction
+------------
+
+The Maple has three serial ports (also known as a UARTs or USARTs):
+``Serial1``, ``Serial2``, and ``Serial3``. They communicate using the
+pins summarized in the following table:
+
+.. list-table::
+   :header-rows: 1
+
+   * - Serial port
+     - TX, RX, CK
+     - CTS, RTS (if present)
+
+   * - ``Serial1``
+     - 7, 8, 6
+     -
+
+   * - ``Serial2``
+     - 1, 0, 10
+     - 2, 3
+
+   * - ``Serial3``
+     - 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.
+
+If you want to communicate with the Maple using the provided USB port,
+use :ref:`SerialUSB <lang-serialusb>` instead.
+
+To use them to communicate with an external TTL serial device, connect
+the TX pin to your device's RX pin, the RX to your device's TX pin,
+and the ground of your Maple to your device's ground.
+
+.. warning:: Don't connect these pins directly to an RS232 serial
+   port; they operate at +/- 12V and can damage your board.
+
+
+Library Documentation
+---------------------
+
+All of the ``Serial[1,2,3]`` objects are instances of the
+``HardwareSerial`` class, which is documented in this section.  (This
+means that you can use any of these functions on any of ``Serial1``,
+``Serial2``, and ``Serial3``).
+
+.. cpp:class:: HardwareSerial
+
+   Serial port class.  Predefined instances are ``Serial1``,
+   ``Serial2``, and ``Serial3``.
+
+.. cpp:function:: HardwareSerial::begin(unsigned int baud)
+
+   Set up a ``HardwareSerial`` object for communications.  This method
+   must be called before attempting to use the ``HardwareSerial``
+   object (typically, you call this in your :ref:`setup()
+   <lang-setup>` function).
+
+.. cpp:function:: HardwareSerial::end()
+
+   Disables the USART associated with this object, allowing any
+   associated communication pins to be used for other purposes.
+
+.. cpp:function:: unsigned int HardwareSerial::available()
+
+   Returns the number of bytes available for reading.
+
+.. cpp:function:: unsigned char HardwareSerial::read()
+
+   Returns the next available, unread character.  If there are no
+   available characters (you can check this with :cpp:func:`available
+   <HardwareSerial::available>`), the call will block until one
+   becomes available.
+
+.. cpp:function:: HardwareSerial::flush()
+
+   Removes the contents of the Serial's associated USART RX FIFO.
+   That is, clears any buffered characters, so that the next character
+   read is guaranteed to be new.
+
+.. cpp:function:: HardwareSerial::print(unsigned char b)
+
+   Print the given byte over the USART.
+
+.. cpp:function:: HardwareSerial::print(char c)
+
+   Print the given character over the USART.  7-bit clean characters
+   are typically interpreted as ASCII text.
+
+.. cpp:function:: HardwareSerial::print(const char *str)
+
+   Print the given null-terminated string over the USART.
+
+.. cpp:function:: HardwareSerial::print(int n)
+
+   Print the argument's digits over the USART, in decimal format.
+   Negative values will be prefixed with a ``'-'`` character.
+
+.. cpp:function:: HardwareSerial::print(unsigned int n)
+
+   Print the argument's digits over the USART, in decimal format.
+
+.. cpp:function:: HardwareSerial::print(long n)
+
+   Print the argument's digits over the USART, in decimal format.
+   Negative values will be prefixed with a ``'-'`` character.
+
+.. cpp:function:: HardwareSerial::print(unsigned long n)
+
+   Print the argument's digits over the USART, in decimal format.
+
+.. cpp:function:: HardwareSerial::print(long n, int base)
+
+   Print the digits of ``n`` over the USART, in base ``base`` (which
+   may be between 2 and 16).  The ``base`` value 2 corresponds to
+   binary, 8 to octal, 10 to decimal, and 16 to hexadecimal.  Negative
+   values will be prefixed with a ``'-'`` character.
+
+.. cpp:function:: HardwareSerial::print(double n)
+
+   Print ``n``, accurate to 2 digits after the decimal point.
+
+.. _lang-serial-println:
+
+.. cpp:function:: HardwareSerial::println(char c)
+
+   Like ``print(c)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(const char *c)
+
+   Like ``print(c)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(unsigned char b)
+
+   Like ``print(b)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(int n)
+
+   Like ``print(n)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(unsigned int n)
+
+   Like ``print(n)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(long n)
+
+   Like ``print(n)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(unsigned long n)
+
+   Like ``print(n)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(long n, int base)
+
+   Like ``print(n, b)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println(double n)
+
+   Like ``print(n)``, followed by ``"\r\n"``.
+
+.. cpp:function:: HardwareSerial::println()
+
+   Prints ``"\r\n"`` over the USART.
+
+.. cpp:function:: HardwareSerial::write(unsigned char ch)
+
+   Sends one character over the USART.  This function is currently
+   blocking, although nonblocking writes are a planned future
+   extension.
+
+   This is a low-level function.  One of the ``print()`` or
+   ``println()`` functions is likely to be more useful when printing
+   multiple characters, when formatting numbers for printing, etc.
+
+.. cpp:function:: HardwareSerial::write(const char* str)
+
+   Send the given null-terminated character string over the USART.
+
+   This is a low-level function.  One of the ``print()`` or
+   ``println()`` functions is likely to be more useful when printing
+   multiple characters, when formatting numbers for printing, etc.
+
+.. cpp:function:: HardwareSerial::write(void *buf, unsigned int size)
+
+   Writes the first ``size`` bytes of ``buf`` over the USART.  Each
+   byte is transmitted as an individual character.
+
+   This is a low-level function.  One of the ``print()`` or
+   ``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
+.. --------
+
+.. -  `ASCII Table <http://arduino.cc/en/Tutorial/ASCIITable>`_
+.. -  `Dimmer <http://arduino.cc/en/Tutorial/Dimmer>`_
+.. -  `Graph <http://arduino.cc/en/Tutorial/Graph>`_
+.. -  `Physical Pixel <http://arduino.cc/en/Tutorial/PhysicalPixel>`_
+.. -  `Virtual Color Mixer <http://arduino.cc/en/Tutorial/VirtualColorMixer>`_
+.. -  `Serial Call Response <http://arduino.cc/en/Tutorial/SerialCallResponse>`_
+.. -  `Serial Call Response ASCII <http://arduino.cc/en/Tutorial/SerialCallResponseASCII>`_
+
+.. include:: cc-attribution.txt