ADD Serial.readStringUntil().adoc

Author: Akshay Sharma

Language/Functions/Communication/Serial/readStringUntil.adoc

@@ -0,0 +1,65 @@
+:source-highlighter: pygments
+:pygments-style: arduino
+:ext-relative: adoc
+
+
+= readStringUntil()
+
+
+// OVERVIEW SECTION STARTS
+[#overview]
+--
+
+[float]
+=== Description
+`readStringUntil()` reads characters from the serial buffer into a string. The function terminates if it times out (see link:setTimeout{ext-relative}[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{ext-relative}[Stream class] main page for more information.
+
+[%hardbreaks]
+
+
+[float]
+=== Syntax
+`Serial.readString(terminator)`
+
+
+[float]
+=== Parameters
+`terminator` : the character to search for (`char`)
+
+[float]
+=== Returns
+The entire string read from the serial buffer, until the terminator character is detected
+
+--
+// OVERVIEW SECTION ENDS
+
+
+
+
+// HOW TO USE SECTION STARTS
+[#howtouse]
+--
+
+[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="language"]
+* #LANGUAGE# link:../serial{ext-relative}[Serial] +
+* #LANGUAGE# link:begin{ext-relative}[begin()] +
+* #LANGUAGE# link:end{ext-relative}[end()] +
+* #LANGUAGE# link:available{ext-relative}[available()] +
+* #LANGUAGE# link:read{ext-relative}[read()] +
+* #LANGUAGE# link:peek{ext-relative}[peek()] +
+* #LANGUAGE# link:flush{ext-relative}[flush()] +
+* #LANGUAGE# link:print{ext-relative}[print()] +
+* #LANGUAGE# link:println{ext-relative}[println()] +
+* #LANGUAGE# link:write{ext-relative}[write()] +
+* #LANGUAGE# link:serialEvent{ext-relative}[SerialEvent()] +
+* #LANGUAGE# link:../Stream/streamParsefloat{ext-relative}[Stream.parseFloat()]
+
+--
+// HOW TO USE SECTION ENDS