Merge branch 'master' of https://github.com/arduino/reference-en

Author: robsoncouto

Language/Functions/Advanced IO/pulseIn.adoc

@@ -17,7 +17,7 @@ subCategories: [ "Advanced I/O" ]
 
 [float]
 === Description
-Reads a pulse (either HIGH or LOW) on a pin. For example, if *value* is *HIGH*, `pulseIn()` waits for the pin to go *HIGH*, starts timing, then waits for the pin to go *LOW* and stops timing. Returns the length of the pulse in microseconds. Gives up and returns 0 if no pulse starts within a specified time out.
+Reads a pulse (either `HIGH` or `LOW`) on a pin. For example, if `value` is `HIGH`, `pulseIn()` waits for the pin to go from `LOW` to `HIGH`, starts timing, then waits for the pin to go `LOW` and stops timing. Returns the length of the pulse in microseconds or gives up and returns 0 if no complete pulse was received within the timeout.
 
 The timing of this function has been determined empirically and will probably show errors in longer pulses. Works on pulses from 10 microseconds to 3 minutes in length.
 [%hardbreaks]

Language/Functions/Advanced IO/pulseInLong.adoc

@@ -17,9 +17,11 @@ subCategories: [ "Advanced I/O" ]
 
 [float]
 === Description
-Reads a pulse (either HIGH or LOW) on a pin. For example, if value is HIGH, `pulseInLong()` waits for the pin to go `HIGH`, starts timing, then waits for the pin to go `LOW` and stops timing. Returns the length of the pulse in microseconds or 0 if no complete pulse was received within the timeout.
+`pulseInLong()` is an alternative to link:../pulsein[pulseIn()] which is better at handling long pulse and interrupt affected scenarios.
 
-The timing of this function has been determined empirically and will probably show errors in shorter pulses. Works on pulses from 10 microseconds to 3 minutes in length. Please also note that if the pin is already high when the function is called, it will wait for the pin to go LOW and then HIGH before it starts counting. This routine can be used only if interrupts are activated. Furthermore the highest resolution is obtained with large intervals.
+Reads a pulse (either `HIGH` or `LOW`) on a pin. For example, if `value` is `HIGH`, `pulseInLong()` waits for the pin to go from `LOW` to `HIGH`, starts timing, then waits for the pin to go `LOW` and stops timing. Returns the length of the pulse in microseconds or gives up and returns 0 if no complete pulse was received within the timeout.
+
+The timing of this function has been determined empirically and will probably show errors in shorter pulses. Works on pulses from 10 microseconds to 3 minutes in length. This routine can be used only if interrupts are activated. Furthermore the highest resolution is obtained with large intervals.
 [%hardbreaks]
 
 

Language/Functions/Communication/Serial.adoc

@@ -55,6 +55,8 @@ link:../serial/println[println()] +
 link:../serial/read[read()] +
 link:../serial/readbytes[readBytes()] +
 link:../serial/readbytesuntil[readBytesUntil()] +
+link:../serial/readstring[readString()] +
+link:../serial/readstringuntil[readStringUntil()] +
 link:../serial/settimeout[setTimeout()] +
 link:../serial/write[write()] +
 link:../serial/serialevent[serialEvent()]

Language/Functions/Communication/Serial/find.adoc

@@ -30,7 +30,7 @@ Serial.find() inherits from the link:../../stream[stream] utility class.
 
 [float]
 === Returns
-`boolean`
+`bool`
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/Communication/Serial/findUntil.adoc

@@ -34,7 +34,7 @@ The function returns true if the target string is found, false if it times out.
 
 [float]
 === Returns
-`boolean`
+`bool`
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/Communication/Serial/ifSerial.adoc

@@ -44,7 +44,7 @@ Nothing
 
 [float]
 === Returns
-`boolean` : returns true if the specified serial port is available. This will only return false if querying the Leonardo's USB CDC serial connection before it is ready.
+`bool` : returns true if the specified serial port is available. This will only return false if querying the Leonardo's USB CDC serial connection before it is ready.
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/Communication/Serial/print.adoc

@@ -19,23 +19,23 @@ Prints data to the serial port as human-readable ASCII text. This command can ta
 * `Serial.print(78) gives "78"` +
 * `Serial.print(1.23456) gives "1.23"` +
 * `Serial.print('N') gives "N"` +
-* `Serial.print("Hello world.") gives "Hello world." `
+* `Serial.print("Hello world.") gives "Hello world."`
 
 An optional second parameter specifies the base (format) to use; permitted values are `BIN(binary, or base 2)`, `OCT(octal, or base 8)`, `DEC(decimal, or base 10)`, `HEX(hexadecimal, or base 16)`. For floating point numbers, this parameter specifies the number of decimal places to use. For example-
 
 * `Serial.print(78, BIN) gives "1001110"` +
 * `Serial.print(78, OCT) gives "116"` +
 * `Serial.print(78, DEC) gives "78"` +
 * `Serial.print(78, HEX) gives "4E"` +
-* `Serial.println(1.23456, 0) gives "1"` +
-* `Serial.println(1.23456, 2) gives "1.23"` +
-* `Serial.println(1.23456, 4) gives "1.2346"`
+* `Serial.print(1.23456, 0) gives "1"` +
+* `Serial.print(1.23456, 2) gives "1.23"` +
+* `Serial.print(1.23456, 4) gives "1.2346"`
 
-You can pass flash-memory based strings to Serial.print() by wrapping them with F(). For example:
+You can pass flash-memory based strings to Serial.print() by wrapping them with link:../../../../variables/utilities/progmem[F()]. For example:
 
 `Serial.print(F(“Hello World”))`
 
-To send a single byte, use link:../write[Serial.write()].
+To send data without conversion to its representation as characters, use link:../write[Serial.write()].
 [%hardbreaks]
 
 
@@ -71,18 +71,16 @@ To send a single byte, use link:../write[Serial.write()].
 [source,arduino]
 ----
 /*
-Uses a FOR loop for data and prints a number in various formats.
+Uses a for loop to print numbers in various formats.
 */
-int x = 0;    // variable
-
 void setup() {
   Serial.begin(9600);      // open the serial port at 9600 bps:
 }
 
 void loop() {
   // print labels
-  Serial.print("NO FORMAT");       // prints a label
-  Serial.print("\t");              // prints a tab
+  Serial.print("NO FORMAT");  // prints a label
+  Serial.print("\t");      // prints a tab
 
   Serial.print("DEC");
   Serial.print("\t");
@@ -94,10 +92,9 @@ void loop() {
   Serial.print("\t");
 
   Serial.print("BIN");
-  Serial.println("\t");           // carriage return after the last label 
-
-  for(x=0; x< 64; x++){    // only part of the ASCII chart, change to suit
+  Serial.println();        // carriage return after the last label
 
+  for (int x = 0; x < 64; x++) { // only part of the ASCII chart, change to suit
     // print it out in many formats:
     Serial.print(x);       // print as an ASCII-encoded decimal - same as "DEC"
     Serial.print("\t\t");  // prints two tabs to accomodate the label lenght
@@ -112,10 +109,10 @@ void loop() {
     Serial.print("\t");    // prints a tab
 
     Serial.println(x, BIN);  // print as an ASCII-encoded binary
-    //                             then adds the carriage return with "println"
+    // then adds the carriage return with "println"
     delay(200);            // delay 200 milliseconds
   }
-  Serial.println("");      // prints another carriage return
+  Serial.println();        // prints another carriage return
 }
 ----
 [%hardbreaks]

Language/Functions/Communication/Serial/readStringUntil.adoc

@@ -14,7 +14,7 @@ title: Serial.readStringUntil()
 
 [float]
 === Description
-`readStringUntil()` reads characters from the serial buffer into a string. The function terminates if it times out (see link:../setTimeout[setTimeout()]).
+`readStringUntil()` reads characters from the serial buffer into a string. The function terminates if it times out (see link:../settimeout[setTimeout()]).
 
 This function is part of the Stream class, and is called by any class that inherits from it (Wire, Serial, etc). See the link:../../stream[Stream class] main page for more information.
 
@@ -56,8 +56,8 @@ The entire String read from the serial buffer, until the terminator character is
 * #LANGUAGE# link:../print[print()]
 * #LANGUAGE# link:../println[println()]
 * #LANGUAGE# link:../write[write()]
-* #LANGUAGE# link:../serialEvent[SerialEvent()]
-* #LANGUAGE# link:../../stream/streamParseFloat[stream.parseFloat()]
+* #LANGUAGE# link:../serialevent[SerialEvent()]
+* #LANGUAGE# link:../../stream/streamparsefloat[stream.parseFloat()]
 
 --
 // SEE ALSO SECTION ENDS

Language/Functions/Communication/Stream/streamFind.adoc

@@ -33,7 +33,7 @@ This function is part of the Stream class, and is called by any class that inher
 
 [float]
 === Returns
-`boolean`
+`bool`
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/Communication/Stream/streamFindUntil.adoc

@@ -33,7 +33,7 @@ This function is part of the Stream class, and is called by any class that inher
 
 [float]
 === Returns
-`boolean`
+`bool`
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/Communication/Stream/streamFlush.adoc

@@ -31,7 +31,7 @@ This function is part of the Stream class, and is called by any class that inher
 
 [float]
 === Returns
-`boolean`
+Nothing
 
 --
 // OVERVIEW SECTION ENDS

Language/Functions/External Interrupts/attachInterrupt.adoc

@@ -60,23 +60,25 @@ For more information on interrupts, see http://gammon.com.au/interrupts[Nick Gam
 
 [float]
 === Syntax
-`attachInterrupt(digitalPinToInterrupt(pin), ISR, mode);`	(recommended) +
-`attachInterrupt(interrupt, ISR, mode);`	(not recommended) + 
-`attachInterrupt(pin, ISR, mode);`	(not recommended Arduino Due, Zero, MKR1000, 101 only)
+`attachInterrupt(digitalPinToInterrupt(pin), ISR, mode);` (recommended) +
+`attachInterrupt(interrupt, ISR, mode);` (not recommended) +
+`attachInterrupt(pin, ISR, mode);` (not recommended Arduino Due, Zero, MKR1000, 101 only)
 
 
 [float]
 === Parameters
-`interrupt`: 	the number of the interrupt (`int`) +
-`pin`: 	      the pin number 	            _(Arduino Due, Zero, MKR1000 only)_ +
-`ISR`: 	      the ISR to call when the interrupt occurs; this function must take no parameters and return nothing. This function is sometimes referred to as an interrupt service routine. +
-`mode`: 	     defines when the interrupt should be triggered. Four constants are predefined as valid values: +
+`interrupt`: the number of the interrupt (`int`) +
+`pin`: the pin number _(Arduino Due, Zero, MKR1000 only)_ +
+`ISR`: the ISR to call when the interrupt occurs; this function must take no parameters and return nothing. This function is sometimes referred to as an interrupt service routine. +
+`mode`: defines when the interrupt should be triggered. Four constants are predefined as valid values: +
 
 * *LOW* to trigger the interrupt whenever the pin is low, +
 * *CHANGE* to trigger the interrupt whenever the pin changes value +
 * *RISING* to trigger when the pin goes from low to high, +
 * *FALLING* for when the pin goes from high to low. +
- The Due, Zero and MKR1000 boards allows also: +
+
+The Due, Zero and MKR1000 boards allows also: +
+
 * *HIGH* to trigger the interrupt whenever the pin is high.
 
 [float]
@@ -126,10 +128,10 @@ Note that in the table below, the interrupt numbers refer to the number to be pa
 
 [options="header"]
 |===================================================
-|Board                          | int.0   | int.1   | int.2   | int.3   | int.4   | int.5
-|Uno, Ethernet                  | 2 | 3 | | | |
-|Mega2560                       | 2 | 3 | 21 | 20 | 19 | 18
-|32u4 based (e.g Leonardo, Micro) | 3 | 2 | 0 | 1 | 7 | 
+|Board                            | int.0 | int.1 | int.2 | int.3 | int.4 | int.5
+|Uno, Ethernet                    | 2 | 3 | | | |
+|Mega2560                         | 2 | 3 | 21 | 20 | 19 | 18
+|32u4 based (e.g Leonardo, Micro) | 3 | 2 | 0 | 1 | 7 |
 |===================================================
 For Due, Zero, MKR1000 and 101 boards the *interrupt number = pin number*.
 

Language/Functions/USB/Mouse/mouseIsPressed.adoc

@@ -37,7 +37,7 @@ When there is no value passed, it checks the status of the left mouse button.
 
 [float]
 === Returns
-`boolean` : reports whether a button is pressed or not.
+`bool` : reports whether a button is pressed or not.
 
 --
 // OVERVIEW SECTION ENDS

Language/Structure/Control Structure/goto.adoc

@@ -46,7 +46,7 @@ goto label; // sends program flow to the label
 [source,arduino]
 ----
 for(byte r = 0; r < 255; r++){
-    for(byte g = 255; g > -1; g--){
+    for(byte g = 255; g > 0; g--){
         for(byte b = 0; b < 255; b++){
             if (analogRead(0) > 250){ goto bailout;}
             // more statements ...