Skip to content

Commit 18c6df6

Browse files
authored
Merge branch 'master' into patch-7
2 parents ee9827a + ed27068 commit 18c6df6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+543
-326
lines changed

Language/Functions/Advanced IO/pulseIn.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ subCategories: [ "Advanced I/O" ]
1717

1818
[float]
1919
=== Description
20-
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.
20+
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.
2121

2222
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.
2323
[%hardbreaks]

Language/Functions/Advanced IO/pulseInLong.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,11 @@ subCategories: [ "Advanced I/O" ]
1717

1818
[float]
1919
=== Description
20-
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.
20+
`pulseInLong()` is an alternative to link:../pulsein[pulseIn()] which is better at handling long pulse and interrupt affected scenarios.
2121

22-
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.
22+
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.
23+
24+
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.
2325
[%hardbreaks]
2426

2527

Language/Functions/Advanced IO/shiftOut.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Shifts out a byte of data one bit at a time. Starts from either the most (i.e. t
1717

1818
Note- if you're interfacing with a device that's clocked by rising edges, you'll need to make sure that the clock pin is low before the call to `shiftOut()`, e.g. with a call to `digitalWrite(clockPin, LOW)`.
1919

20-
This is a software implementation; see also the linkhttps://www.arduino.cc/en/Reference/SPI[SPI library], which provides a hardware implementation that is faster but works only on specific pins.
20+
This is a software implementation; see also the https://www.arduino.cc/en/Reference/SPI[SPI library], which provides a hardware implementation that is faster but works only on specific pins.
2121
[%hardbreaks]
2222

2323

@@ -54,7 +54,7 @@ Nothing
5454
[float]
5555
=== Example Code
5656
// Describe what the example code is all about and add relevant code ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
57-
For accompanying circuit, see the http://arduino.cc/en/Tutorial/ShiftOut[tutorial on controlling a 74HC595 shift register].
57+
For accompanying circuit, see the https://arduino.cc/en/Tutorial/ShiftOut[tutorial on controlling a 74HC595 shift register].
5858

5959
[source,arduino]
6060
----

Language/Functions/Advanced IO/tone.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Nothing
5959

6060
[float]
6161
=== Notes and Warnings
62-
If you want to play different pitches on multiple pins, you need to call `noTone()` on one pin before calling `tone() on the next pin.
62+
If you want to play different pitches on multiple pins, you need to call `noTone()` on one pin before calling `tone()` on the next pin.
6363
[%hardbreaks]
6464

6565
--

Language/Functions/Characters/isHexadecimalDigit.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
---
1+
---
22
title: "isHexadecimalDigit()"
33
categories: [ "Functions" ]
44
subCategories: [ "Characters" ]
@@ -25,7 +25,9 @@ Analyse if a char is an hexadecimal digit (A-F, 0-9). Returns true if thisChar c
2525
=== Syntax
2626
[source,arduino]
2727
----
28-
isHexadecilamDigit(thisChar)
28+
29+
isHexadecimalDigit(thisChar)
30+
2931
----
3032

3133
[float]

Language/Functions/Characters/isPrintable.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Analyse if a char is printable (that is any character that produces an output, e
2525
=== Syntax
2626
[source,arduino]
2727
----
28-
`isAlpha(thisChar)`
28+
`isPrintable(thisChar)`
2929
----
3030

3131
[float]

Language/Functions/Characters/isWhitespace.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,8 @@ Returns true if thisChar contains a white space.
2525
[float]
2626
=== Syntax
2727
[source,arduino]
28-
----
2928
`isWhitespace(thisChar)`
30-
----
29+
3130

3231
[float]
3332
=== Parameters
@@ -80,4 +79,4 @@ else
8079
* #LANGUAGE# link:../../communication/serial/read[read()]
8180

8281
--
83-
// SEE ALSO SECTION ENDS
82+
// SEE ALSO SECTION ENDS

Language/Functions/Communication/serial.adoc renamed to Language/Functions/Communication/Serial.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: serial
2+
title: Serial
33
categories: [ "Functions" ]
44
subCategories: [ "Communication" ]
55
---
@@ -55,6 +55,8 @@ link:../serial/println[println()] +
5555
link:../serial/read[read()] +
5656
link:../serial/readbytes[readBytes()] +
5757
link:../serial/readbytesuntil[readBytesUntil()] +
58+
link:../serial/readstring[readString()] +
59+
link:../serial/readstringuntil[readStringUntil()] +
5860
link:../serial/settimeout[setTimeout()] +
5961
link:../serial/write[write()] +
6062
link:../serial/serialevent[serialEvent()]

Language/Functions/Communication/Serial/available.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ void loop() {
8282
// read from port 0, send to port 1:
8383
if (Serial.available()) {
8484
int inByte = Serial.read();
85-
Serial1.print(inByte, BYTE);
85+
Serial1.print(inByte, DEC);
8686
8787
}
8888
// read from port 1, send to port 0:
8989
if (Serial1.available()) {
9090
int inByte = Serial1.read();
91-
Serial.print(inByte, BYTE);
91+
Serial.print(inByte, DEC);
9292
}
9393
}
9494
----

Language/Functions/Communication/Serial/availableForWrite.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Nothing
3535

3636
[float]
3737
=== Returns
38-
The number of bytes available to read .
38+
The number of bytes available to write.
3939
--
4040
// OVERVIEW SECTION ENDS
4141

0 commit comments

Comments
 (0)