Skip to content

Document functions affected by setTimeout() #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion Language/Functions/Communication/Serial/setTimeout.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Serial.setTimeout()

[float]
=== Description
`Serial.setTimeout()` sets the maximum milliseconds to wait for serial data when using link:../readbytesuntil[serial.readBytesUntil()] or link:../readbytes[serial.readBytes()]. It defaults to 1000 milliseconds.
`Serial.setTimeout()` sets the maximum milliseconds to wait for serial data. It defaults to 1000 milliseconds.

`Serial.setTimeout()` inherits from the link:../../stream[Stream] utility class.
[%hardbreaks]
Expand All @@ -37,6 +37,29 @@ Nothing
// OVERVIEW SECTION ENDS


// HOW TO USE SECTION STARTS
[#howtouse]
--

[float]
=== Notes and Warnings
Serial functions that use the timeout value set via `_Serial_.setTimeout()`:

* `_Serial_.find()`
* `_Serial_.findUntil()`
* `_Serial_.parseInt()`
* `_Serial_.parseFloat()`
* `_Serial_.readBytes()`
* `_Serial_.readBytesUntil()`
* `_Serial_.readString()`
* `_Serial_.readStringUntil()`

[%hardbreaks]

--
// HOW TO USE SECTION ENDS


// SEE ALSO SECTION
[#see_also]
--
Expand Down
25 changes: 24 additions & 1 deletion Language/Functions/Communication/Stream/streamSetTimeout.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,27 @@ title: Stream.setTimeout()
Nothing

--
// OVERVIEW SECTION ENDS
// OVERVIEW SECTION ENDS


// HOW TO USE SECTION STARTS
[#howtouse]
--

[float]
=== Notes and Warnings
Stream functions that use the timeout value set via `setTimeout()`:

* `find()`
* `findUntil()`
* `parseInt()`
* `parseFloat()`
* `readBytes()`
* `readBytesUntil()`
* `readString()`
* `readStringUntil()`

[%hardbreaks]

--
// HOW TO USE SECTION ENDS