Skip to content

Commit a4d7d33

Browse files
committed
Use same description as pulseInLong() for pulseIn()
pulseIn() and pulseInLong() work the same and thus the descriptions should also be the same. - Correct explanation of how the timeout works. The timeout applies to the entire duration of the function call, not only to the start of the pulse. - Consistent formatting.
1 parent 971576d commit a4d7d33

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
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]

0 commit comments

Comments
 (0)