c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Enable help for serial readString() (#609)

Browse Source
This commit is contained in:
Galen Nickel 2018-01-30 08:54:42 -08:00 committed by Peli de Halleux
parent e20ac7f992
commit 79018d4f00
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/serial/read-string.md
View File

@ -1,6 +1,6 @@
# Serial Read String
Read the buffered serial data as a string
Read the buffered serial data as a string.
```sig
serial.readString();
@ -8,7 +8,7 @@ serial.readString();
## Returns
* a [string](/types/string) containing input from the serial port. Empty if no data available.
* a [string](/types/string) containing input from the serial port. The string is empty if no data is available.
## Example

1
libs/core/serial.cpp
View File

@ -75,6 +75,7 @@ namespace serial {
/**
* Reads the buffered received data as a string
*/
//% help=serial/read-string
//% blockId=serial_read_buffer block="serial|read string"
//% weight=18
StringData* readString() {