diff --git a/Language/Functions/Communication/Serial/getTimeout.adoc b/Language/Functions/Communication/Serial/getTimeout.adoc new file mode 100644 index 000000000..1d5d12c04 --- /dev/null +++ b/Language/Functions/Communication/Serial/getTimeout.adoc @@ -0,0 +1,60 @@ +--- +title: Serial.getTimeout() +--- + + + + += Serial.getTimeout() + + +// OVERVIEW SECTION STARTS +[#overview] +-- + +[float] +=== Description +`Serial.getTimeout()` returns the timeout value set by `Serial.setTimeout()`. + +`Serial.getTimeout()` inherits from the link:../../stream[Stream] utility class. +[%hardbreaks] + + +[float] +=== Syntax +`_Serial_.getTimeout()` + +[float] +=== Parameters +None + +[float] +=== Returns +The timeout value set by `Serial.setTimeout()` (unsigned long) + +-- +// OVERVIEW SECTION ENDS + + +// HOW TO USE SECTION STARTS +[#howtouse] +-- + +-- +// HOW TO USE SECTION ENDS + + +// SEE ALSO SECTION +[#see_also] +-- + +[float] +=== See also + +[role="language"] +* #LANGUAGE# link:../../stream[stream] +* #LANGUAGE# link:../../stream/streamsettimeout[stream.setTimeout()] +* #LANGUAGE# link:../../stream/streamgettimeout[stream.getTimeout()] + +-- +// SEE ALSO SECTION ENDS diff --git a/Language/Functions/Communication/Stream/streamGetTimeout.adoc b/Language/Functions/Communication/Stream/streamGetTimeout.adoc new file mode 100644 index 000000000..2a7ca316a --- /dev/null +++ b/Language/Functions/Communication/Stream/streamGetTimeout.adoc @@ -0,0 +1,43 @@ +--- +title: Stream.getTimeout() +--- + + + + += getTimeout() + + +// OVERVIEW SECTION STARTS +[#overview] +-- + +[float] +=== Description +`getTimeout()` returns the timeout value set by `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. +[%hardbreaks] + + +[float] +=== Syntax +`stream.getTimeout()` + + +[float] +=== Parameters +None + +[float] +=== Returns +The timeout value set by `stream.setTimeout()` (unsigned long) + +-- +// OVERVIEW SECTION ENDS + + +// HOW TO USE SECTION STARTS +[#howtouse] +-- + +-- +// HOW TO USE SECTION ENDS