diff --git a/Language/Functions/Advanced IO/tone.adoc b/Language/Functions/Advanced IO/tone.adoc index c890b0631..bb7e3fe25 100644 --- a/Language/Functions/Advanced IO/tone.adoc +++ b/Language/Functions/Advanced IO/tone.adoc @@ -65,7 +65,7 @@ If you want to play different pitches on multiple pins, you need to call `noTone [role="language"] * #LANGUAGE# link:noTone{ext-relative}[noTone()] + -* #LANGUAGE# link:analogWrite{ext-relative}[analogWrite()] +* #LANGUAGE# link:../Analod%20IO/analogWrite{ext-relative}[analogWrite()] [role="example"] * #EXAMPLE# http://arduino.cc/en/Tutorial/Tone[Tone^] + diff --git a/Language/Functions/Analog IO/analogRead.adoc b/Language/Functions/Analog IO/analogRead.adoc index 07408ec88..a9e05cb29 100644 --- a/Language/Functions/Analog IO/analogRead.adoc +++ b/Language/Functions/Analog IO/analogRead.adoc @@ -78,7 +78,7 @@ If the analog input pin is not connected to anything, the value returned by anal [role="language"] * #LANGUAGE# link:analogReference{ext-relative}[analogreference()] + -* #LANGUAGE# link:analogReadResolution{ext-relative}[analogReadResolution()] + +* #LANGUAGE# link:../Arduino%20DUE%20only/analogReadResolution{ext-relative}[analogReadResolution()] + * #LANGUAGE# http://arduino.cc/en/Tutorial/AnalogInputPins[Tutorial: Analog Input Pins] diff --git a/Language/Functions/Analog IO/analogWrite.adoc b/Language/Functions/Analog IO/analogWrite.adoc index 6d67f08b3..e96ca0ebf 100644 --- a/Language/Functions/Analog IO/analogWrite.adoc +++ b/Language/Functions/Analog IO/analogWrite.adoc @@ -81,7 +81,7 @@ The PWM outputs generated on pins 5 and 6 will have higher-than-expected duty cy === See also [role="language"] * #LANGUAGE# link:analogRead{ext-relative}[analogRead()] -* #LANGUAGE# link:analogWriteResolution{ext-relative}[analogWriteResolution()] +* #LANGUAGE# link:../Arduino%20DUE%20only/analogWriteResolution{ext-relative}[analogWriteResolution()] [role="definition"] * #DEFINITION# http://arduino.cc/en/Tutorial/PWM[PWM^] diff --git a/Language/Functions/Arduino DUE only/analogReadResolution.adoc b/Language/Functions/Arduino DUE only/analogReadResolution.adoc index a89830750..e14c10fe4 100644 --- a/Language/Functions/Arduino DUE only/analogReadResolution.adoc +++ b/Language/Functions/Arduino DUE only/analogReadResolution.adoc @@ -103,7 +103,7 @@ Using a 16 bit resolution (or any resolution *higher* than actual hardware capab * #EXAMPLE# http://arduino.cc/en/Tutorial/AnalogInputPins[Description of the analog input pins] [role="language"] -* #LANGUAGE# link:analofRead{ext-relative}[analogRead()] +* #LANGUAGE# link:../Analog%20IO/analofRead{ext-relative}[analogRead()] -- diff --git a/Language/Functions/Arduino DUE only/analogWriteResolution.adoc b/Language/Functions/Arduino DUE only/analogWriteResolution.adoc index 712a0f2fb..f58d35bf8 100644 --- a/Language/Functions/Arduino DUE only/analogWriteResolution.adoc +++ b/Language/Functions/Arduino DUE only/analogWriteResolution.adoc @@ -111,9 +111,9 @@ If you set the `analogWriteResolution()` value to a value lower than your board' * #EXAMPLE# http://arduino.cc/en/Tutorial/AnalogInputPins[Description of the analog input pins] [role="language"] -* #LANGUAGE# link:analogWrite{ext-relative}[analogWrite()] + -* #LANGUAGE# link:analogRead{ext-relative}[analogRead()] + -* #LANGUAGE# link:map{ext-relative}[map()] +* #LANGUAGE# link:../Analog%20IO/analogWrite{ext-relative}[analogWrite()] + +* #LANGUAGE# link:../Analog%20IO/analogRead{ext-relative}[analogRead()] + +* #LANGUAGE# link:../Math/map{ext-relative}[map()] -- diff --git a/Language/Functions/Bits and Bytes/highByte.adoc b/Language/Functions/Bits and Bytes/highByte.adoc index 0afe4f2be..27b15f268 100644 --- a/Language/Functions/Bits and Bytes/highByte.adoc +++ b/Language/Functions/Bits and Bytes/highByte.adoc @@ -47,7 +47,7 @@ byte [role="language"] * #LANGUAGE# link:lowByte{ext-relative}[lowByte()] + -* #LANGUAGE# link:word{ext-relative}[word()] +* #LANGUAGE# link:../../Variable/Data%20Types/word{ext-relative}[word()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Bits and Bytes/lowByte.adoc b/Language/Functions/Bits and Bytes/lowByte.adoc index 1cab5efbd..64d0b570c 100644 --- a/Language/Functions/Bits and Bytes/lowByte.adoc +++ b/Language/Functions/Bits and Bytes/lowByte.adoc @@ -46,7 +46,7 @@ byte [role="language"] * #LANGUAGE# link:highByte{ext-relative}[highByte()] + -* #LANGUAGE# link:word{ext-relative}[word()] +* #LANGUAGE# link:../../Variable/Data%20Types/word{ext-relative}[word()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Serial/find.adoc b/Language/Functions/Communication/Serial/find.adoc index c5723a68e..a83d02c88 100644 --- a/Language/Functions/Communication/Serial/find.adoc +++ b/Language/Functions/Communication/Serial/find.adoc @@ -46,8 +46,8 @@ Serial.find() inherits from the link:stream{ext-relative}[Stream] utility class. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] + -* #LANGUAGE# link:streamFind{ext-relative}[stream.find()] +* #LANGUAGE# link:../stream{ext-relative}[stream] + +* #LANGUAGE# link:../Stream/streamFind{ext-relative}[stream.find()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Serial/findUntil.adoc b/Language/Functions/Communication/Serial/findUntil.adoc index 09c10f067..be7320b72 100644 --- a/Language/Functions/Communication/Serial/findUntil.adoc +++ b/Language/Functions/Communication/Serial/findUntil.adoc @@ -54,8 +54,8 @@ The function returns true if the target string is found, false if it times out. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] + -* #LANGUAGE# link:streamFindUntil{ext-relative}[stream.findUntil()] +* #LANGUAGE# link:../stream{ext-relative}[stream] + +* #LANGUAGE# link:../Stream/streamFindUntil{ext-relative}[stream.findUntil()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Serial/flush.adoc b/Language/Functions/Communication/Serial/flush.adoc index 9e4c0a1fd..3837af163 100644 --- a/Language/Functions/Communication/Serial/flush.adoc +++ b/Language/Functions/Communication/Serial/flush.adoc @@ -63,7 +63,7 @@ Nothing * #LANGUAGE# link:println{ext-relative}[println()] + * #LANGUAGE# link:write{ext-relative}[write()] + * #LANGUAGE# link:serialEvent{ext-relative}[SerialEvent()] + -* #LANGUAGE# link:streamFlush{ext-relative}[Stream.flush()] +* #LANGUAGE# link:../Stream/streamFlush{ext-relative}[Stream.flush()] -- // HOW TO USE SECTION ENDSp diff --git a/Language/Functions/Communication/Serial/parseFloat.adoc b/Language/Functions/Communication/Serial/parseFloat.adoc index c27e36692..efd55fbc8 100644 --- a/Language/Functions/Communication/Serial/parseFloat.adoc +++ b/Language/Functions/Communication/Serial/parseFloat.adoc @@ -47,8 +47,8 @@ Nothing // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream()] + -* #LANGUAGE# link:streamParsefloat{ext-relative}[Stream.parseFloat()] +* #LANGUAGE# link:../stream{ext-relative}[stream()] + +* #LANGUAGE# link:../Stream/streamParsefloat{ext-relative}[Stream.parseFloat()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Serial/parseInt.adoc b/Language/Functions/Communication/Serial/parseInt.adoc index 503706c92..3b0cdbfdc 100644 --- a/Language/Functions/Communication/Serial/parseInt.adoc +++ b/Language/Functions/Communication/Serial/parseInt.adoc @@ -64,7 +64,7 @@ Nothing * #LANGUAGE# link:println{ext-relative}[println()] + * #LANGUAGE# link:write{ext-relative}[write()] + * #LANGUAGE# link:serialEvent{ext-relative}[SerialEvent()] + -* #LANGUAGE# link:streamParsefloat{ext-relative}[Stream.parseFloat()] +* #LANGUAGE# link:../Stream/streamParsefloat{ext-relative}[Stream.parseFloat()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Serial/peek.adoc b/Language/Functions/Communication/Serial/peek.adoc index 9301d4839..f0817c7a8 100644 --- a/Language/Functions/Communication/Serial/peek.adoc +++ b/Language/Functions/Communication/Serial/peek.adoc @@ -61,7 +61,7 @@ The first byte of incoming serial data available (or -1 if no data is available) * #LANGUAGE# link:println{ext-relative}[println()] + * #LANGUAGE# link:write{ext-relative}[write()] + * #LANGUAGE# link:serialEvent{ext-relative}[SerialEvent()] + -* #LANGUAGE# link:streamPeek{ext-relative}[Stream.peek()] +* #LANGUAGE# link:../Stream/streamPeek{ext-relative}[Stream.peek()] -- diff --git a/Language/Functions/Communication/Serial/readBytes.adoc b/Language/Functions/Communication/Serial/readBytes.adoc index 1282b5f60..e3523e91d 100644 --- a/Language/Functions/Communication/Serial/readBytes.adoc +++ b/Language/Functions/Communication/Serial/readBytes.adoc @@ -52,8 +52,8 @@ // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] + -* #LANGUAGE# link:streamReadByte{ext-relative}[stream.readByte()] +* #LANGUAGE# link:../stream{ext-relative}[stream] + +* #LANGUAGE# link:../Stream/streamReadByte{ext-relative}[stream.readByte()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Serial/readBytesUntil.adoc b/Language/Functions/Communication/Serial/readBytesUntil.adoc index ff062d49c..62eeed613 100644 --- a/Language/Functions/Communication/Serial/readBytesUntil.adoc +++ b/Language/Functions/Communication/Serial/readBytesUntil.adoc @@ -53,7 +53,7 @@ Serial.readBytesUntil() reads characters from the serial buffer into an array. T // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] + -* #LANGUAGE# link:streamReadByteUntil{ext-relative}[stream.readByteUntil()] +* #LANGUAGE# link:../stream{ext-relative}[stream] + +* #LANGUAGE# link:../Stream/streamReadByteUntil{ext-relative}[stream.readByteUntil()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Serial/setTimeout.adoc b/Language/Functions/Communication/Serial/setTimeout.adoc index 4d0fa03f6..5e85820f7 100644 --- a/Language/Functions/Communication/Serial/setTimeout.adoc +++ b/Language/Functions/Communication/Serial/setTimeout.adoc @@ -46,8 +46,8 @@ Nothing // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] + -* #LANGUAGE# link:streamSetTimeout{ext-relative}[stream.setTimeout()] +* #LANGUAGE# link:../stream{ext-relative}[stream] + +* #LANGUAGE# link:../Stream/streamSetTimeout{ext-relative}[stream.setTimeout()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamAvailable.adoc b/Language/Functions/Communication/Stream/streamAvailable.adoc index c268edbe6..e020c4667 100644 --- a/Language/Functions/Communication/Stream/streamAvailable.adoc +++ b/Language/Functions/Communication/Stream/streamAvailable.adoc @@ -47,7 +47,7 @@ This function is part of the Stream class, and is called by any class that inher // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamFind.adoc b/Language/Functions/Communication/Stream/streamFind.adoc index 0438d357f..fe4102f64 100644 --- a/Language/Functions/Communication/Stream/streamFind.adoc +++ b/Language/Functions/Communication/Stream/streamFind.adoc @@ -53,6 +53,6 @@ This function is part of the Stream class, and is called by any class that inher // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamFindUntil.adoc b/Language/Functions/Communication/Stream/streamFindUntil.adoc index eb480d84c..d6880f6aa 100644 --- a/Language/Functions/Communication/Stream/streamFindUntil.adoc +++ b/Language/Functions/Communication/Stream/streamFindUntil.adoc @@ -53,6 +53,6 @@ This function is part of the Stream class, and is called by any class that inher // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamFlush.adoc b/Language/Functions/Communication/Stream/streamFlush.adoc index 5ea22db6d..b6d5975d2 100644 --- a/Language/Functions/Communication/Stream/streamFlush.adoc +++ b/Language/Functions/Communication/Stream/streamFlush.adoc @@ -47,7 +47,7 @@ This function is part of the Stream class, and is called by any class that inher // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamParseFloat.adoc b/Language/Functions/Communication/Stream/streamParseFloat.adoc index 4c9a098d4..21bbaa894 100644 --- a/Language/Functions/Communication/Stream/streamParseFloat.adoc +++ b/Language/Functions/Communication/Stream/streamParseFloat.adoc @@ -53,6 +53,6 @@ This function is part of the Stream class, and is called by any class that inher // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamParseInt.adoc b/Language/Functions/Communication/Stream/streamParseInt.adoc index 7daf2efcd..3248d049b 100644 --- a/Language/Functions/Communication/Stream/streamParseInt.adoc +++ b/Language/Functions/Communication/Stream/streamParseInt.adoc @@ -53,6 +53,6 @@ This function is part of the Stream class, and is called by any class that inher // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamRead.adoc b/Language/Functions/Communication/Stream/streamRead.adoc index e83ad1630..29db329fd 100644 --- a/Language/Functions/Communication/Stream/streamRead.adoc +++ b/Language/Functions/Communication/Stream/streamRead.adoc @@ -47,7 +47,7 @@ The first byte of incoming data available (or -1 if no data is available). // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamReadBytes.adoc b/Language/Functions/Communication/Stream/streamReadBytes.adoc index 944d411aa..8012e7995 100644 --- a/Language/Functions/Communication/Stream/streamReadBytes.adoc +++ b/Language/Functions/Communication/Stream/streamReadBytes.adoc @@ -57,7 +57,7 @@ The number of bytes placed in the buffer. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamReadBytesUntil.adoc b/Language/Functions/Communication/Stream/streamReadBytesUntil.adoc index f91478118..eeb1b2c74 100644 --- a/Language/Functions/Communication/Stream/streamReadBytesUntil.adoc +++ b/Language/Functions/Communication/Stream/streamReadBytesUntil.adoc @@ -59,6 +59,6 @@ The number of bytes placed in the buffer. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamReadString.adoc b/Language/Functions/Communication/Stream/streamReadString.adoc index 5dfd0a7ca..56513d3ed 100644 --- a/Language/Functions/Communication/Stream/streamReadString.adoc +++ b/Language/Functions/Communication/Stream/streamReadString.adoc @@ -51,6 +51,6 @@ A string read from a stream. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamReadStringUntil.adoc b/Language/Functions/Communication/Stream/streamReadStringUntil.adoc index f066e4a85..b32d841ba 100644 --- a/Language/Functions/Communication/Stream/streamReadStringUntil.adoc +++ b/Language/Functions/Communication/Stream/streamReadStringUntil.adoc @@ -51,6 +51,6 @@ The entire string read from a stream, until the terminator character is detected // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamSetTimeout.adoc b/Language/Functions/Communication/Stream/streamSetTimeout.adoc index 861cb8d66..11c6997af 100644 --- a/Language/Functions/Communication/Stream/streamSetTimeout.adoc +++ b/Language/Functions/Communication/Stream/streamSetTimeout.adoc @@ -50,6 +50,6 @@ Nothing // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:stream{ext-relative}[stream] +* #LANGUAGE# link:../stream{ext-relative}[stream] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Communication/serial.adoc b/Language/Functions/Communication/serial.adoc index fa1a708b7..c4083f5e7 100644 --- a/Language/Functions/Communication/serial.adoc +++ b/Language/Functions/Communication/serial.adoc @@ -32,24 +32,24 @@ The *Arduino Leonardo* board uses `Serial1` to communicate via TTL (5V) serial o [float] === Functions -link:IfSerial{ext-relative}[If] (Serial) + -link:Available{ext-relative}[available()] + -link:Begin{ext-relative}[begin()] + -link:End{ext-relative}[end()] + -link:Find{ext-relative}[find()] + -link:FindUntil{ext-relative}[findUntil()] + -link:Flush{ext-relative}[flush()] + -link:ParseFloat{ext-relative}[parseFloat()] + -link:ParseInt{ext-relative}[parseInt()] + -link:Peek{ext-relative}[peek()] + -link:Print{ext-relative}[print()] + -link:PrintLn{ext-relative}[println()] + -link:Read{ext-relative}[read()] + -link:ReadBytes{ext-relative}[readBytes()] + -link:ReadBytesUntil{ext-relative}[readBytesUntil()] + -link:SetTimeout{ext-relative}[setTimeout()] + -link:Write{ext-relative}[write()] + -link:SerialEvent{ext-relative}[serialEvent()] +link:/Serial/IfSerial{ext-relative}[If] (Serial) + +link:/Serial/Available{ext-relative}[available()] + +link:/Serial/Begin{ext-relative}[begin()] + +link:/Serial/End{ext-relative}[end()] + +link:/Serial/Find{ext-relative}[find()] + +link:/Serial/FindUntil{ext-relative}[findUntil()] + +link:/Serial/Flush{ext-relative}[flush()] + +link:/Serial/ParseFloat{ext-relative}[parseFloat()] + +link:/Serial/ParseInt{ext-relative}[parseInt()] + +link:/Serial/Peek{ext-relative}[peek()] + +link:/Serial/Print{ext-relative}[print()] + +link:/Serial/PrintLn{ext-relative}[println()] + +link:/Serial/Read{ext-relative}[read()] + +link:/Serial/ReadBytes{ext-relative}[readBytes()] + +link:/Serial/ReadBytesUntil{ext-relative}[readBytesUntil()] + +link:/Serial/SetTimeout{ext-relative}[setTimeout()] + +link:/Serial/Write{ext-relative}[write()] + +link:/Serial/SerialEvent{ext-relative}[serialEvent()] ''' diff --git a/Language/Functions/Interrupts/interrupts.adoc b/Language/Functions/Interrupts/interrupts.adoc index 4b570ec6c..e5a3c692c 100644 --- a/Language/Functions/Interrupts/interrupts.adoc +++ b/Language/Functions/Interrupts/interrupts.adoc @@ -66,8 +66,8 @@ void loop() // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] * #LANGUAGE# link:noInterrupts{ext-relatives}[noInterrupts()] + -* #LANGUAGE# link:attachInterrupts{ext-relatives}[attachInterrupts()] + -* #LANGUAGE# link:detachInterrupts{ext-relatives}[detachInterrupts()] +* #LANGUAGE# link:../External Interrupts/attachInterrupts{ext-relatives}[attachInterrupts()] + +* #LANGUAGE# link:../External Interrupts/detachInterrupts{ext-relatives}[detachInterrupts()] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Math/pow.adoc b/Language/Functions/Math/pow.adoc index 5207ea058..d16e9a60b 100644 --- a/Language/Functions/Math/pow.adoc +++ b/Language/Functions/Math/pow.adoc @@ -23,13 +23,13 @@ Calculates the value of a number raised to a power. `Pow()` can be used to raise [float] === Parameters -`base`: the number (float) +`base`: the number (`float`) -`exponent`: the power to which the base is raised (float) +`exponent`: the power to which the base is raised (`float`) [float] === Returns -The result of the exponentiation. (double) +The result of the exponentiation. (`double`) -- // OVERVIEW SECTION ENDS @@ -53,9 +53,11 @@ See the (http://arduino.cc/playground/Main/Fscale[fscale]) function in the code // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:sqrt{ext-relative}[sqrt()] + -* #LANGUAGE# link:float{ext-relative}[float] + -* #LANGUAGE# link:double{ext-relative}[double] +* #LANGUAGE# link:sqrt{ext-relative}[sqrt()] + +[role="definition"] +* #DEFINITION# link:../../Variables/Data%20Types/float{ext-relative}[float] + +* #DEFENITION# link:../../Variables/Data%20Types/double{ext-relative}[double] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Trigonometry/cos.adoc b/Language/Functions/Trigonometry/cos.adoc index a40e869f8..32fe36015 100644 --- a/Language/Functions/Trigonometry/cos.adoc +++ b/Language/Functions/Trigonometry/cos.adoc @@ -47,7 +47,7 @@ The cos of the angle (`double`). [role="language"] * #LANGUAGE# link:sin{ext-relative}[sin()] + * #LANGUAGE# link:tan{ext-relative}[tan()] + -* #LANGUAGE# link:float{ext-relative}[float] + -* #LANGUAGE# link:double{ext-relative}[double] +* #LANGUAGE# link:../../Variables/Data%20Types/float{ext-relative}[float] + +* #LANGUAGE# link:../../Variables/Data%20Types/double{ext-relative}[double] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Trigonometry/sin.adoc b/Language/Functions/Trigonometry/sin.adoc index 781b9114d..a7726455c 100644 --- a/Language/Functions/Trigonometry/sin.adoc +++ b/Language/Functions/Trigonometry/sin.adoc @@ -47,7 +47,7 @@ The sine of the angle (`double`). [role="language"] * #LANGUAGE# link:cos{ext-relative}[cos()] + * #LANGUAGE# link:tan{ext-relative}[tan()] + -* #LANGUAGE# link:float{ext-relative}[float] + -* #LANGUAGE# link:double{ext-relative}[double] +* #LANGUAGE# link:../../Variables/Data%20Types/float{ext-relative}[float] + +* #LANGUAGE# link:../../Variables/Data%20Types/double{ext-relative}[double] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/Trigonometry/tan.adoc b/Language/Functions/Trigonometry/tan.adoc index c8b1286b3..adb8e7871 100644 --- a/Language/Functions/Trigonometry/tan.adoc +++ b/Language/Functions/Trigonometry/tan.adoc @@ -47,7 +47,7 @@ The tangent of the angle (`double`). [role="language"] * #LANGUAGE# link:sin{ext-relative}[sin()] + * #LANGUAGE# link:cos{ext-relative}[cos()] + -* #LANGUAGE# link:float{ext-relative}[float] + -* #LANGUAGE# link:double{ext-relative}[double] +* #LANGUAGE# link:../../Variables/Data%20Types/float{ext-relative}[float] + +* #LANGUAGE# link:../../Variables/Data%20Types/double{ext-relative}[double] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardBegin.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardBegin.adoc index 4bfae2deb..8814a48b0 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardBegin.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardBegin.adoc @@ -79,6 +79,6 @@ void loop() { * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardEnd.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardEnd.adoc index a36b92a71..e5a643f9c 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardEnd.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardEnd.adoc @@ -76,6 +76,6 @@ void loop() { * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPress.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPress.adoc index c1183f52f..1e8159ac6 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPress.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPress.adoc @@ -93,6 +93,6 @@ void loop() { * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrint.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrint.adoc index afc562a3c..fb650f832 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrint.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrint.adoc @@ -85,6 +85,6 @@ When you use the `Keyboard.print()` command, the Arduino takes over your keyboar * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrintln.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrintln.adoc index 64c893240..6fbdba7c0 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrintln.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardPrintln.adoc @@ -85,6 +85,6 @@ When you use the Keyboard.println() command, the Arduino takes over your keyboar * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardRelease.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardRelease.adoc index dd5253184..1b046f14d 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardRelease.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardRelease.adoc @@ -93,6 +93,6 @@ void loop() { * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardReleaseAll.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardReleaseAll.adoc index b868dfd23..fc5235a05 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardReleaseAll.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardReleaseAll.adoc @@ -92,6 +92,6 @@ void loop() { * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardWrite.adoc b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardWrite.adoc index 05648b30c..31614c087 100644 --- a/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardWrite.adoc +++ b/Language/Functions/USB (Leonardo and DUE only)/Keyboard/keyboardWrite.adoc @@ -93,6 +93,6 @@ When you use the Keyboard.write() command, the Arduino takes over your keyboard! * #LANGUAGE# link:keyboardPrintln{ext-relative}[keyboard.println] + * #LANGUAGE# link:keyboardRelease{ext-relative}[keyboard.release] + * #LANGUAGE# link:keyboardReleaseAll{ext-relative}[keyboard.releaseAll] + -* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] + +* #LANGUAGE# link:keyboardWrite{ext-relative}[keyboard.write] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Conversion/byteCast.adoc b/Language/Variables/Conversion/byteCast.adoc index 66c5236e6..073e4cb8e 100644 --- a/Language/Variables/Conversion/byteCast.adoc +++ b/Language/Variables/Conversion/byteCast.adoc @@ -45,7 +45,7 @@ Converts a value to the link:byte{ext-relative}[byte] data type. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:byte{ext-relative}[byte] +* #LANGUAGE# link:../Data%20Types/byte{ext-relative}[byte] -- diff --git a/Language/Variables/Conversion/charCast.adoc b/Language/Variables/Conversion/charCast.adoc index 2762a5519..8da612156 100644 --- a/Language/Variables/Conversion/charCast.adoc +++ b/Language/Variables/Conversion/charCast.adoc @@ -45,7 +45,7 @@ Converts a value to the link:char{ext-relative}[char] data type. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:char{ext-relative}[char] +* #LANGUAGE# link:../Data%20Types/char{ext-relative}[char] -- diff --git a/Language/Variables/Conversion/floatCast.adoc b/Language/Variables/Conversion/floatCast.adoc index 858910265..346a415b7 100644 --- a/Language/Variables/Conversion/floatCast.adoc +++ b/Language/Variables/Conversion/floatCast.adoc @@ -49,7 +49,7 @@ See the reference for link:float{ext-relative}[float] for details about the prec // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ -* #LANGUAGE# link:float{ext-relative}[float] +* #LANGUAGE# link:../Data%20Types/float{ext-relative}[float] -- diff --git a/Language/Variables/Conversion/intCast.adoc b/Language/Variables/Conversion/intCast.adoc index 4d6f749d4..93e585158 100644 --- a/Language/Variables/Conversion/intCast.adoc +++ b/Language/Variables/Conversion/intCast.adoc @@ -45,7 +45,7 @@ Converts a value to the link:int{ext-relative}[int] data type. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:int{ext-relative}[int] +* #LANGUAGE# link:../Data%20Types/int{ext-relative}[int] -- diff --git a/Language/Variables/Conversion/longCast.adoc b/Language/Variables/Conversion/longCast.adoc index 7fce1a5e6..373358e92 100644 --- a/Language/Variables/Conversion/longCast.adoc +++ b/Language/Variables/Conversion/longCast.adoc @@ -45,7 +45,7 @@ Converts a value to the link:long{ext-relative}[long] data type. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:long{ext-relative}[long] +* #LANGUAGE# link:../Data%20Types/long{ext-relative}[long] -- diff --git a/Language/Variables/Conversion/wordcast.adoc b/Language/Variables/Conversion/wordcast.adoc index 74f3b4a67..72eae3f30 100644 --- a/Language/Variables/Conversion/wordcast.adoc +++ b/Language/Variables/Conversion/wordcast.adoc @@ -48,7 +48,7 @@ Converts a value to the link:word{ext-relative}[word] data type. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:word{ext-relative}[word] +* #LANGUAGE# link:../Data%20Types/word{ext-relative}[word] -- diff --git a/Language/Variables/Data Types/array.adoc b/Language/Variables/Data Types/array.adoc index b06c948d7..d1d7f1de4 100644 --- a/Language/Variables/Data Types/array.adoc +++ b/Language/Variables/Data Types/array.adoc @@ -93,8 +93,8 @@ For a complete program that demonstrates the use of arrays, see the (http://www. // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="definition"] -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] + -* #DEFINITION# link:PROGMEM{ext-relative}[PROGMEM] +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] + +* #DEFINITION# link:../Utilities/PROGMEM{ext-relative}[PROGMEM] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/boolean.adoc b/Language/Variables/Data Types/boolean.adoc index 0baccff01..8979c3fa9 100644 --- a/Language/Variables/Data Types/boolean.adoc +++ b/Language/Variables/Data Types/boolean.adoc @@ -67,7 +67,7 @@ void loop() [role="definition"] * #DEFINITION# link:constants{ext-relative}[constants] + * #DEFINITION# link:boolean{ext-relative}[boolean operators] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/byte.adoc b/Language/Variables/Data Types/byte.adoc index eb5706722..e784d409f 100644 --- a/Language/Variables/Data Types/byte.adoc +++ b/Language/Variables/Data Types/byte.adoc @@ -47,7 +47,7 @@ A byte stores an 8-bit unsigned number, from 0 to 255. // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="definition"] * #DEFINITION# link:word{ext-relative}[word] + -* #DEFINITION# link:byteCast{ext-relative}[byte()] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../Conversion/byteCast{ext-relative}[byte()] + +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/char.adoc b/Language/Variables/Data Types/char.adoc index add0e3f84..10a96f7c9 100644 --- a/Language/Variables/Data Types/char.adoc +++ b/Language/Variables/Data Types/char.adoc @@ -54,7 +54,7 @@ The char datatype is a signed type, meaning that it encodes numbers from -128 to * #DEFINITION# link:array{ext-relative}[array] [role="language"] -* #LANGUAGE# link:println{ext-relative}[Serial.println] +* #LANGUAGE# link:../../Functions/Communication/Serial/println{ext-relative}[Serial.println] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/float.adoc b/Language/Variables/Data Types/float.adoc index acd9486a3..4a999f93c 100644 --- a/Language/Variables/Data Types/float.adoc +++ b/Language/Variables/Data Types/float.adoc @@ -71,7 +71,7 @@ If doing math with floats, you need to add a decimal point, otherwise it will be [role="definition"] * #DEFINITION# link:int{ext-relative}[int] + * #DEFINITION# link:double{ext-relative}[double] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/int.adoc b/Language/Variables/Data Types/int.adoc index 5b6bbe5d7..df7ea51e9 100644 --- a/Language/Variables/Data Types/int.adoc +++ b/Language/Variables/Data Types/int.adoc @@ -76,7 +76,7 @@ int x; * #DEFINITION# link:unsignedInt{ext-relative}[unsigned int] + * #DEFINITION# link:Long{ext-relative}[long] + * #DEFINITION# link:unsignedLong{ext-relative}[unsigned long] + -* #DEFINITION# link:integerConstant{ext-relative}[Integer Constants] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../Constants/integerConstant{ext-relative}[Integer Constants] + +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/long.adoc b/Language/Variables/Data Types/long.adoc index af6e9386b..5e25c9f1f 100644 --- a/Language/Variables/Data Types/long.adoc +++ b/Language/Variables/Data Types/long.adoc @@ -57,8 +57,8 @@ If doing math with integers, at least one of the numbers must be followed by an * #DEFINITION# link:int{ext-relative}[int] + * #DEFINITION# link:unsignedInt{ext-relative}[unsigned int] + * #DEFINITION# link:unsignedLong{ext-relative}[unsigned long] + -* #DEFINITION# link:integerConstant{ext-relative}[Integer Constants] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../Constants/integerConstant{ext-relative}[Integer Constants] + +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/short.adoc b/Language/Variables/Data Types/short.adoc index 70d0ef245..bc69a1c0c 100644 --- a/Language/Variables/Data Types/short.adoc +++ b/Language/Variables/Data Types/short.adoc @@ -56,8 +56,8 @@ On all Arduinos (ATMega and ARM based) a short stores a 16-bit (2-byte) value. T * #DEFINITION# link:unsignedInt{ext-relative}[unsigned int] + * #DEFINITION# link:long{ext-relative}[long] + * #DEFINITION# link:unsignedLong{ext-relative}[unsigned long] + -* #DEFINITION# link:integerConstant{ext-relative}[Integer Constants] + +* #DEFINITION# link:../Constants/integerConstant{ext-relative}[Integer Constants] + * #DEFINITION# link:unsignedInt{ext-relative}[unsigned int] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/string.adoc b/Language/Variables/Data Types/string.adoc index 07e74a1cb..849fa9702 100644 --- a/Language/Variables/Data Types/string.adoc +++ b/Language/Variables/Data Types/string.adoc @@ -1 +1,113 @@ -// still to write +:source-highlighter: pygments +:pygments-style: arduino +:ext-relative: adoc + + += string + + +// OVERVIEW SECTION STARTS +[#overview] +-- + +[float] +=== Description +Text strings can be represented in two ways. you can use the String data type, which is part of the core as of version 0019, or you can make a string out of an array of type char and null-terminate it. This page described the latter method. For more details on the String object, which gives you more functionality at the cost of more memory, see the link:stringObject{ext-relative}[String object] page. +[%hardbreaks] + +[float] +=== Syntax +All of the following are valid declarations for strings. + +`char Str1[15];` + +`char Str2[8] = {'a', 'r', 'd', 'u', 'i', 'n', 'o'};` + +`char Str3[8] = {'a', 'r', 'd', 'u', 'i', 'n', 'o', '\0'};` + +`char Str4[ ] = "arduino";` + +`char Str5[8] = "arduino";` + +`char Str6[15] = "arduino";` + +*Possibilities for declaring strings* + +* Declare an array of chars without initializing it as in Str1 +* Declare an array of chars (with one extra char) and the compiler will add the required null character, as in Str2 +* Explicitly add the null character, Str3 +* Initialize with a string constant in quotation marks; the compiler will size the array to fit the string constant and a terminating null character, Str4 +* Initialize the array with an explicit size and string constant, Str5 +* Initialize the array, leaving extra space for a larger string, Str6 + +*Null termination* + +Generally, strings are terminated with a null character (ASCII code 0). This allows functions (like `Serial.print()`) to tell where the end of a string is. Otherwise, they would continue reading subsequent bytes of memory that aren't actually part of the string. + +This means that your string needs to have space for one more character than the text you want it to contain. That is why Str2 and Str5 need to be eight characters, even though "arduino" is only seven - the last position is automatically filled with a null character. Str4 will be automatically sized to eight characters, one for the extra null. In Str3, we've explicitly included the null character (written '\0') ourselves. + +Note that it's possible to have a string without a final null character (e.g. if you had specified the length of Str2 as seven instead of eight). This will break most functions that use strings, so you shouldn't do it intentionally. If you notice something behaving strangely (operating on characters not in the string), however, this could be the problem. + +*Single quotes or double quotes?* + +Strings are always defined inside double quotes ("Abc") and characters are always defined inside single quotes('A'). + +*Wrapping long strings* + +You can wrap long strings like this: + +[source,arduino] +---- +char myString[] = "This is the first line" +" this is the second line" +" etcetera"; +---- + +*Arrays of strings* + +It is often convenient, when working with large amounts of text, such as a project with an LCD display, to setup an array of strings. Because strings themselves are arrays, this is in actually an example of a two-dimensional array. + +In the code below, the asterisk after the datatype `char` "`char*`" indicates that this is an array of "`pointers`". All array names are actually pointers, so this is required to make an array of arrays. Pointers are one of the more esoteric parts of C for beginners to understand, but it isn't necessary to understand pointers in detail to use them effectively here. + +-- +// OVERVIEW SECTION ENDS + + + + +// HOW TO USE SECTION STARTS +[#howtouse] +-- + +[float] +=== Example Code +// Describe what the example code is all about and add relevant code ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ + + +[source,arduino] +---- +char* myStrings[]={"This is string 1", "This is string 2", "This is string 3", +"This is string 4", "This is string 5","This is string 6"}; + +void setup(){ +Serial.begin(9600); +} + +void loop(){ +for (int i = 0; i < 6; i++){ + Serial.println(myStrings[i]); + delay(500); + } +} +---- +[%hardbreaks] + + +[float] +=== See also +// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), +// definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials +// (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ +[role="definition"] +* #DEFINITION# link:array{ext-relative}[array] + +* #DEFINITION# link:../Utilities/PROGMEM{ext-relative}[PROGMEM] + +* #DEFINITION# link:unsignedInt{ext-relative}[unsigned int] + + +* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +-- +// HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/stringObject.adoc b/Language/Variables/Data Types/stringObject.adoc index 897cf85dc..a48ab6f6e 100644 --- a/Language/Variables/Data Types/stringObject.adoc +++ b/Language/Variables/Data Types/stringObject.adoc @@ -54,7 +54,7 @@ For reference, character arrays are referred to as strings with a small s, and i // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="definition"] * #DEFINITION# link:string{ext-relative}[string] :character arrays + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/unsignedChar.adoc b/Language/Variables/Data Types/unsignedChar.adoc index 2685ec48c..a3909a6a4 100644 --- a/Language/Variables/Data Types/unsignedChar.adoc +++ b/Language/Variables/Data Types/unsignedChar.adoc @@ -52,7 +52,7 @@ unsigned char myChar = 240; * #DEFINITION# link:array{ext-relative}[array] [role="language"] -* #LANGUAGE# link:println{ext-relative}[Serial.println] +* #LANGUAGE# link:../../Functions/Communication/Serial/println{ext-relative}[Serial.println] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/unsignedInt.adoc b/Language/Variables/Data Types/unsignedInt.adoc index 1857ae5a2..87ac48a6d 100644 --- a/Language/Variables/Data Types/unsignedInt.adoc +++ b/Language/Variables/Data Types/unsignedInt.adoc @@ -68,8 +68,8 @@ unsigned int x * #DEFINITION# link:int{ext-relative}[int] + * #DEFINITION# link:Long{ext-relative}[long] + * #DEFINITION# link:unsignedLong{ext-relative}[unsigned long] + -* #DEFINITION# link:integerConstant{ext-relative}[Integer Constants] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../Constants/integerConstant{ext-relative}[Integer Constants] + +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/unsignedLong.adoc b/Language/Variables/Data Types/unsignedLong.adoc index 4f535eb79..8ed645b43 100644 --- a/Language/Variables/Data Types/unsignedLong.adoc +++ b/Language/Variables/Data Types/unsignedLong.adoc @@ -12,7 +12,7 @@ [float] === Description -Unsigned long variables are extended size variables for number storage, and store 32 bits (4 bytes). Unlike standard longs unsigned longs won't store negative numbers, making their range from 0 to 4,294,967,295 (2^32 - 1). +Unsigned long variables are extended size variables for number storage, and store 32 bits (4 bytes). Unlike standard longs unsigned longs won't store negative numbers, making their range from 0 to 4,294,967,295 (2^32 - 1). [%hardbreaks] [float] @@ -21,7 +21,7 @@ Unsigned long variables are extended size variables for number storage, and stor `unsigned long var = val;` `var` - your long variable name -`val` - the value you assign to that variable +`val` - the value you assign to that variable [%hardbreaks] -- @@ -62,7 +62,7 @@ void loop() [float] === See also -// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), +// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ @@ -70,8 +70,8 @@ void loop() * #DEFINITION# link:int{ext-relative}[int] + * #DEFINITION# link:unsignedInt{ext-relative}[unsigned int] + * #DEFINITION# link:long{ext-relative}[long] + -* #DEFINITION# link:integerConstant{ext-relative}[Integer Constants] + -* #DEFINITION# link:variableDeclaration{ext-relative}[Variable Declaration] +* #DEFINITION# link:../Constants/integerConstant{ext-relative}[Integer Constants] + +* #DEFINITION# link:../variableDeclaration{ext-relative}[Variable Declaration] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Data Types/void.adoc b/Language/Variables/Data Types/void.adoc index 49a459811..2d2fad68b 100644 --- a/Language/Variables/Data Types/void.adoc +++ b/Language/Variables/Data Types/void.adoc @@ -54,7 +54,7 @@ void loop() // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="definition"] -* #DEFINITION# link:functionDeclaration{ext-relative}[function declaration] +* #DEFINITION# link:../../Functions/functionDeclaration{ext-relative}[function declaration] -- diff --git a/Language/Variables/Utilities/PROGMEM.adoc b/Language/Variables/Utilities/PROGMEM.adoc index e82a9c811..93b12fdf6 100644 --- a/Language/Variables/Utilities/PROGMEM.adoc +++ b/Language/Variables/Utilities/PROGMEM.adoc @@ -29,7 +29,7 @@ const dataType variableName[] PROGMEM = {data0, data1, data3...};` `dataType` - any variable type `variableName` - the name for your array of data -Note that because PROGMEM is a variable modifier, there is no hard and fast rule about where it should go, so the Arduino compiler accepts all of the definitions below, which are also synonymous. However experiments have indicated that, in various versions of Arduino (having to do with GCC version), PROGMEM may work in one location and not in another. The "string table" example below has been tested to work with Arduino 13. Earlier versions of the IDE may work better if PROGMEM is included after the variable name. +Note that because PROGMEM is a variable modifier, there is no hard and fast rule about where it should go, so the Arduino compiler accepts all of the definitions below, which are also synonymous. However experiments have indicated that, in various versions of Arduino (having to do with GCC version), PROGMEM may work in one location and not in another. The "string table" example below has been tested to work with Arduino 13. Earlier versions of the IDE may work better if PROGMEM is included after the variable name. `const dataType variableName[] PROGMEM = {}; // use this form` + `const PROGMEM dataType variableName[] = {}; // or this one`+ @@ -179,7 +179,7 @@ void loop() * #EXAMPLE# http://www.arduino.cc/playground/Learning/Memory[Types of memory available on an Arduino board] [role="definition"] -* #DEFINITION# link:array{ext-relative}[array] + -* #DEFINITION# link:string{ext-relative}[string] +* #DEFINITION# link:../Data%20Types/array{ext-relative}[array] + +* #DEFINITION# link:../Data%20Types/string{ext-relative}[string] -- // HOW TO USE SECTION ENDS diff --git a/Language/Variables/Variable Scope & Qualifiers/const.adoc b/Language/Variables/Variable Scope & Qualifiers/const.adoc index 076d197b4..465d68469 100644 --- a/Language/Variables/Variable Scope & Qualifiers/const.adoc +++ b/Language/Variables/Variable Scope & Qualifiers/const.adoc @@ -61,7 +61,7 @@ You can use either `const` or `#define` for creating numeric or string constants // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:define{ext-relative}[[#define] + +* #LANGUAGE# link:../../Structures/Further%20Syntax/define{ext-relative}[[#define] + * #LANGUAGE# link:voletile{ext-relative}[voletile] diff --git a/Language/Variables/Variable Scope & Qualifiers/voletile.adoc b/Language/Variables/Variable Scope & Qualifiers/voletile.adoc index 6a8abe6c1..2f96c9721 100644 --- a/Language/Variables/Variable Scope & Qualifiers/voletile.adoc +++ b/Language/Variables/Variable Scope & Qualifiers/voletile.adoc @@ -69,7 +69,7 @@ void blink() // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ [role="language"] -* #LANGUAGE# link:attachInterrupt{ext-relative}[attachInterrupt] +* #LANGUAGE# link:../../Functions/External%20Interrupts/attachInterrupt{ext-relative}[attachInterrupt] --