Merge pull request #480 from per1234/update-serial-ports

Correct/update information about available serial ports for each board

Author: per1234

Language/Functions/Communication/Serial.adoc

@@ -16,16 +16,28 @@ subCategories: [ "Communication" ]
 
 [float]
 === Description
-Used for communication between the Arduino board and a computer or other devices. All Arduino boards have at least one serial port (also known as a UART or USART): Serial. It communicates on digital pins 0 (RX) and 1 (TX) as well as with the computer via USB. Thus, if you use these functions, you cannot also use pins 0 and 1 for digital input or output. +
+Used for communication between the Arduino board and a computer or other devices. All Arduino boards have at least one serial port (also known as a UART or USART), and some have several.
+[options="header"]
+|================================================================================================================================================
+| Board                | USB CDC name                     | Serial pins                   | Serial1 pins     | Serial2 pins      | Serial3 pins
+| Uno, Nano, Mini      |                                  | 0(RX), 1(TX)                  |                  |                   |
+| Mega                 |                                  | 0(RX), 1(TX)                  | 19(RX), 18(TX)   | 16(RX), 17(TX)    | 15(RX), 14(TX)
+| Leonardo, Micro, Yún | Serial                           | 0(RX), 1(TX)                  |                  |                   |
+| Uno WiFi Rev.2       |                                  | Connected to USB              | 0(RX), 1(TX)     | Connected to NINA |
+| MKR boards           | Serial                           |                               | 13(RX), 14(TX)   |                   |
+| Zero                 | SerialUSB (Native USB Port only) | Connected to Programming Port | 0(RX), 1(TX)     |                   |
+| Due                  | SerialUSB (Native USB Port only) | 0(RX), 1(TX)                  | 19(RX), 18(TX)   | 16(RX), 17(TX)    | 15(RX), 14(TX)
+| 101                  | Serial                           |                               | 0(RX), 1(TX)     |                   |
+|================================================================================================================================================
+
+On Uno, Nano, Mini, and Mega, pins 0 and 1 are used for communication with the computer. Connecting anything to these pins can interfere with that communication, including causing failed uploads to the board.
+[%hardbreaks]
 You can use the Arduino environment's built-in serial monitor to communicate with an Arduino board. Click the serial monitor button in the toolbar and select the same baud rate used in the call to `begin()`.
 [%hardbreaks]
 Serial communication on pins TX/RX uses TTL logic levels (5V or 3.3V depending on the board). Don't connect these pins directly to an RS232 serial port; they operate at +/- 12V and can damage your Arduino board.
 [%hardbreaks]
-The *Arduino Mega* has three additional serial ports: `Serial1` on pins 19 (RX) and 18 (TX), `Serial2` on pins 17 (RX) and 16 (TX), `Serial3` on pins 15 (RX) and 14 (TX). To use these pins to communicate with your personal computer, you will need an additional USB-to-serial adaptor, as they are not connected to the Mega's USB-to-serial adaptor. 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 Mega to your device's ground.
-[%hardbreaks]
-The *Arduino DUE* has three additional 3.3V TTL serial ports: `Serial1` on pins 19 (RX) and 18 (TX); `Serial2` on pins 17 (RX) and 16 (TX), `Serial3` on pins 15 (RX) and 14 (TX). Pins 0 and 1 are also connected to the corresponding pins of the ATmega16U2 USB-to-TTL Serial chip, which is connected to the USB debug port. Additionally, there is a native USB-serial port on the SAM3X chip, SerialUSB'.
+To use these extra serial ports to communicate with your personal computer, you will need an additional USB-to-serial adaptor, as they are not connected to the Mega's USB-to-serial adaptor. 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 Mega to your device's ground.
 [%hardbreaks]
-The *Arduino Leonardo* board uses `Serial1` to communicate via TTL (5V) serial on pins 0 (RX) and 1 (TX). `Serial` is reserved for USB CDC communication. For more information, refer to the Leonardo getting started page and hardware page.
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/Communication/Serial/available.adoc

@@ -17,18 +17,11 @@ Get the number of bytes (characters) available for reading from the serial port.
 
 [float]
 === Syntax
-`Serial.available()`
-
-_Arduino Mega only:_
-
-`Serial1.available()` +
-`Serial2.available()` +
-`Serial3.available()`
-
+`_Serial_.available()`
 
 [float]
 === Parameters
-None
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/availableForWrite.adoc

@@ -20,18 +20,12 @@ Get the number of bytes (characters) available for writing in the serial buffer
 
 [float]
 === Syntax
-`Serial.availableForWrite()`
-
-_Arduino Mega only:_
-
-`Serial1.availableForWrite()` +
-`Serial2.availableForWrite()` +
-`Serial3.availableForWrite()`
+`_Serial_.availableForWrite()`
 
 
 [float]
 === Parameters
-Nothing
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/begin.adoc

@@ -22,22 +22,15 @@ An optional second argument configures the data, parity, and stop bits. The defa
 
 [float]
 === Syntax
-`Serial.begin(speed)`
-`Serial.begin(speed, config)`
-
-_Arduino Mega only:_
-
-`Serial1.begin(speed)` +
-`Serial2.begin(speed)` +
-`Serial3.begin(speed)` +
-`Serial1.begin(speed, config)` +
-`Serial2.begin(speed, config)` +
-`Serial3.begin(speed, config)`
+`_Serial_.begin(speed)` +
+`_Serial_.begin(speed, config)`
 
 
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
+
 `speed`: in bits per second (baud) - `long`
 
 `config`: sets data, parity, and stop bits. Valid values are

Language/Functions/Communication/Serial/end.adoc

@@ -20,18 +20,12 @@ Disables serial communication, allowing the RX and TX pins to be used for genera
 
 [float]
 === Syntax
-`Serial.end()`
-
-_Arduino Mega only:_
-
-`Serial1.end()` +
-`Serial2.end()` +
-`Serial3.end()` +
+`_Serial_.end()`
 
 
 [float]
 === Parameters
-Nothing
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/find.adoc

@@ -22,11 +22,13 @@ Serial.find() inherits from the link:../../stream[stream] utility class.
 
 [float]
 === Syntax
-`Serial.find(target)` +
-`Serial.find(target, length)`
+`_Serial_.find(target)` +
+`_Serial_.find(target, length)`
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
+
 `target` : the string to search for (char)
 
 `length` : length of the target (size_t)

Language/Functions/Communication/Serial/findUntil.adoc

@@ -24,12 +24,13 @@ The function returns true if the target string is found, false if it times out.
 
 [float]
 === Syntax
-`Serial.findUntil(target, terminal)`
+`_Serial_.findUntil(target, terminal)`
 
 
 [float]
 === Parameters
-`target` : the string to search for (char)
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
+`target` : the string to search for (char) +
 `terminal` : the terminal string in the search (char)
 
 [float]

Language/Functions/Communication/Serial/flush.adoc

@@ -22,18 +22,12 @@ Waits for the transmission of outgoing serial data to complete. (Prior to Arduin
 
 [float]
 === Syntax
-`Serial.flush()`
-
-_Arduino Mega only:_
-
-`Serial1.flush()` +
-`Serial2.flush()` +
-`Serial3.flush()`
+`_Serial_.flush()`
 
 
 [float]
 === Parameters
-Nothing
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/ifSerial.adoc

@@ -16,28 +16,16 @@ title: if(Serial)
 === Description
 Indicates if the specified Serial port is ready.
 
-On the Leonardo, `if (Serial)` indicates whether or not the USB CDC serial connection is open. For all other instances, including `if (Serial1)` on the Leonardo, this will always return true.
+On the boards with native USB, `if (Serial)` (or `if(SerialUSB)` on the Due) indicates whether or not the USB CDC serial connection is open. For all other boards, and the non-USB CDC ports, this will always return true.
 
 This was introduced in Arduino IDE 1.0.1.
 [%hardbreaks]
 
 
 [float]
 === Syntax
-_All boards:_
-
 `if (Serial)`
 
-_Arduino Leonardo specific:_
-
-`if (Serial1)`
-
-_Arduino Mega specific:_
-
-`if (Serial1)` +
-`if (Serial2)` +
-`if (Serial3)`
-
 [float]
 === Parameters
 Nothing

Language/Functions/Communication/Serial/parseFloat.adoc

@@ -22,12 +22,12 @@ title: Serial.parseFloat()
 
 [float]
 === Syntax
-`Serial.parseFloat()`
+`_Serial_.parseFloat()`
 
 
 [float]
 === Parameters
-Nothing
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/parseInt.adoc

@@ -27,18 +27,13 @@ In particular:
 
 [float]
 === Syntax
-`Serial.parseInt()`
-`Serial.parseInt(char skipChar)`
-
-_Arduino Mega only:_
-
-`Serial1.parseInt()` +
-`Serial2.parseInt()` +
-`Serial3.parseInt()`
+`_Serial_.parseInt()` +
+`_Serial_.parseInt(char skipChar)`
 
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
 `skipChar`: used to skip the indicated char in the search. Used for example to skip thousands divider.
 
 [float]

Language/Functions/Communication/Serial/peek.adoc

@@ -20,18 +20,12 @@ Returns the next byte (character) of incoming serial data without removing it fr
 
 [float]
 === Syntax
-`Serial.peek()`
-
-_Arduino Mega only:_
-
-`Serial1.peek()` +
-`Serial2.peek()` +
-`Serial3.peek()`
+`_Serial_.peek()`
 
 
 [float]
 === Parameters
-Nothing
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/print.adoc

@@ -42,12 +42,13 @@ To send data without conversion to its representation as characters, use link:..
 
 [float]
 === Syntax
-`Serial.print(val)` +
-`Serial.print(val, format)`
+`_Serial_.print(val)` +
+`_Serial_.print(val, format)`
 
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
 `val`: the value to print - any data type
 
 [float]

Language/Functions/Communication/Serial/println.adoc

@@ -20,12 +20,14 @@ Prints data to the serial port as human-readable ASCII text followed by a carria
 
 [float]
 === Syntax
-`Serial.println(val)` +
-`Serial.println(val, format)`
+`_Serial_.println(val)` +
+`_Serial_.println(val, format)`
 
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
+
 `val`: the value to print - any data type
 
 `format`: specifies the number base (for integral data types) or number of decimal places (for floating point types)

Language/Functions/Communication/Serial/read.adoc

@@ -20,18 +20,12 @@ Reads incoming serial data. read() inherits from the link:../../stream[Stream] u
 
 [float]
 === Syntax
-`Serial.read()`
-
-_Arduino Mega only:_
-
-`Serial1.read()` +
-`Serial2.read()` +
-`Serial3.read()`
+`_Serial_.read()`
 
 
 [float]
 === Parameters
-Nothing
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/readBytes.adoc

@@ -24,11 +24,13 @@ title: Serial.readBytes()
 
 [float]
 === Syntax
-`Serial.readBytes(buffer, length)`
+`_Serial_.readBytes(buffer, length)`
 
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
+
 `buffer`: the buffer to store the bytes in (`char[]` or `byte[]`)
 
 `length` : the number of bytes to read (`int`)

Language/Functions/Communication/Serial/readBytesUntil.adoc

@@ -24,11 +24,13 @@ Serial.readBytesUntil() reads characters from the serial buffer into an array. T
 
 [float]
 === Syntax
-`Serial.readBytesUntil(character, buffer, length)`
+`_Serial_.readBytesUntil(character, buffer, length)`
 
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
+
 `character` : the character to search for (`char`)
 
 `buffer`: the buffer to store the bytes in (`char[]` or `byte[]`)

Language/Functions/Communication/Serial/readString.adoc

@@ -23,12 +23,12 @@ This function is part of the Stream class, and is called by any class that inher
 
 [float]
 === Syntax
-`Serial.readString()`
+`_Serial_.readString()`
 
 
 [float]
 === Parameters
-Nothing
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page].
 
 [float]
 === Returns

Language/Functions/Communication/Serial/readStringUntil.adoc

@@ -23,11 +23,12 @@ This function is part of the Stream class, and is called by any class that inher
 
 [float]
 === Syntax
-`Serial.readStringUntil(terminator)`
+`_Serial_.readStringUntil(terminator)`
 
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
 `terminator` : the character to search for (`char`)
 
 [float]

Language/Functions/Communication/Serial/serialEvent.adoc

@@ -29,7 +29,7 @@ void serialEvent(){
 //statements
 }
 ----
-Arduino Mega only:
+For boards with additional serial ports (see the list of available serial ports for each board on the link:../../serial[Serial main page]):
 [source,arduino]
 ----
 void serialEvent1(){

Language/Functions/Communication/Serial/setTimeout.adoc

@@ -22,10 +22,11 @@ title: Serial.setTimeout()
 
 [float]
 === Syntax
-`Serial.setTimeout(time)`
+`_Serial_.setTimeout(time)`
 
 [float]
 === Parameters
+`_Serial_`: serial port object. See the list of available serial ports for each board on the link:../../serial[Serial main page]. +
 `time` : timeout duration in milliseconds (`long`).
 
 [float]