From bdcd299805969d5ae3fad1a880c2b7a832075302 Mon Sep 17 00:00:00 2001 From: Ron Hale-Evans Date: Wed, 13 Jul 2016 16:24:56 -0700 Subject: [PATCH] New Serial topic --- docs/reference/serial/read-line.md | 38 ++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/reference/serial/read-line.md diff --git a/docs/reference/serial/read-line.md b/docs/reference/serial/read-line.md new file mode 100644 index 00000000..eb38402b --- /dev/null +++ b/docs/reference/serial/read-line.md @@ -0,0 +1,38 @@ +# Serial Read Line + +Read a line of text from the serial port. + +```sig +serial.readLine(); +``` + +#### ~hint + +This function expects the line it reads to be terminated with the `\r` +character. If your terminal software does not terminate lines with +`\r`, this function will probably never return a value. + +#### ~ + +### Returns + +* a [string](/reference/types/string) containing input from the serial port, such as a response typed by a user + +### Example + +The following example requests the user's name, then repeats it to greet the user. + +```blocks +basic.forever(() => { + serial.writeLine("What is your name?"); + let answer = serial.readLine(); + serial.writeString("Hello,"); + serial.writeLine(answer); +}); +``` + +### See also + +[serial](/device/serial), +[serial write line](/reference/serial/write-line), +[serial write value](/reference/serial/write-value)