Serial events (#337)

* added "serial->on data received"

* updated info

* updated docs

* added readline to read entire buffer

* lazy initialize of serial buffers

* init async on event

* updated docs

docs/reference/serial.md

@@ -7,8 +7,11 @@ serial.writeLine("");
 serial.writeNumber(0);
 serial.writeValue("x", 0);
 serial.writeString("");
+serial.readUntil(",");
 serial.readLine();
+serial.readString();
 serial.redirect(SerialPin.P0, SerialPin.P0, BaudRate.BaudRate115200);
+serial.onDataReceived(",", () => {})
 ```
 
 ### See Also

docs/reference/serial/on-data-received.md

@@ -0,0 +1,29 @@
+# Serial On Data Received
+
+Registers an event to be fired when one of the delimiter is matched.
+
+
+```sig
+serial.onDataReceived(",", () => {})
+```
+
+### Parameters
+
+* `delimiters` is a [string](/reference/types/string) containing any of the character to match
+
+### Example
+
+Read values separated by `,`:
+
+```blocks
+serial.onDataReceived(serial.delimiters(Delimiters.Comma), () => {
+    basic.showString(serial.readUntil(serial.delimiters(Delimiters.Comma)))
+})
+```
+
+### See also
+
+[serial](/device/serial),
+[serial write line](/reference/serial/write-line),
+[serial write value](/reference/serial/write-value)
+

docs/reference/serial/read-string.md

@@ -0,0 +1,27 @@
+# Serial Read String
+
+Read the buffered serial data as a string
+
+```sig
+serial.readString();
+```
+
+### Returns
+
+* a [string](/reference/types/string) containing input from the serial port. Empty if no data available.
+
+### Example
+
+The following program scrolls text on the screen as it arrives from serial.
+
+```blocks
+basic.forever(() => {
+    basic.showString(serial.readString());
+});
+```
+
+### See also
+
+[serial](/device/serial),
+[serial write line](/reference/serial/write-line),
+[serial write value](/reference/serial/write-value)

libs/core/_locales/core-jsdoc-strings.json

@@ -238,8 +238,10 @@
   "pins.spiWrite|param|value": "Data to be sent to the SPI slave",
   "serial": "Reading and writing data over a serial connection.",
   "serial.delimiters": "Returns the delimiter corresponding string",
-  "serial.onLineReceived": "Registers an event to be fired when a line has been received",
+  "serial.onDataReceived": "Registers an event to be fired when one of the delimiter is matched.",
+  "serial.onDataReceived|param|delimiters": "the characters to match received characters against.",
   "serial.readLine": "Reads a line of text from the serial port.",
+  "serial.readString": "Reads the buffered received data as a string",
   "serial.readUntil": "Reads a line of text from the serial port and returns the buffer when the delimiter is met.",
   "serial.readUntil|param|delimiter": "text delimiter that separates each text chunk",
   "serial.redirect": "Dynamically configuring the serial instance to use pins other than USBTX and USBRX.",

libs/core/_locales/core-strings.json

@@ -181,7 +181,9 @@
   "pins.spiWrite|block": "spi write %value",
   "pins|block": "pins",
   "serial.delimiters|block": "%del",
+  "serial.onDataReceived|block": "serial|on data received %delimiters=serial_delimiter_conv",
   "serial.readLine|block": "serial|read line",
+  "serial.readString|block": "serial|read string",
   "serial.readUntil|block": "serial|read until %delimiter=serial_delimiter_conv",
   "serial.redirect|block": "serial|redirect to|TX %tx|RX %rx|at baud rate %rate",
   "serial.writeLine|block": "serial|write line %text",

libs/core/serial.cpp

@@ -51,24 +51,27 @@ namespace serial {
     }
 
     /**
-     * Reads a line of text from the serial port.
+    * Reads the buffered received data as a string
-     */
+    */
-    //% help=serial/read-line
+    //% blockId=serial_read_buffer block="serial|read string"
-    //% blockId=serial_read_line block="serial|read line"
+    //% weight=18
-    //% weight=20 blockGap=8
+    StringData* readString() {
-    StringData* readLine() {
+      int n = uBit.serial.getRxBufferSize();
-      return readUntil(ManagedString("\n").leakData());
+      if (n == 0) return ManagedString("").leakData();
+      return ManagedString(uBit.serial.read(n, MicroBitSerialMode::ASYNC)).leakData();
     }
 
     /**
-    * Registers an event to be fired when one of the delimiter is matched
+    * Registers an event to be fired when one of the delimiter is matched.
-    * @param delimiters the characters to match received characters against. eg:"\n"
+    * @param delimiters the characters to match received characters against.
     */
-    // help=serial/on-data-received
+    //% help=serial/on-data-received
-    // weight=18
+    //% weight=18 blockId=serial_on_data_received block="serial|on data received %delimiters=serial_delimiter_conv"
     void onDataReceived(StringData* delimiters, Action body) {
       uBit.serial.eventOn(ManagedString(delimiters));
       registerWithDal(MICROBIT_ID_SERIAL, MICROBIT_SERIAL_EVT_DELIM_MATCH, body);
+      // lazy initialization of serial buffers
+      uBit.serial.read(MicroBitSerialMode::ASYNC);
     }
 
     /**

libs/core/serial.ts

@@ -38,20 +38,20 @@ namespace serial {
     }
 
     /**
-    * Registers an event to be fired when a line has been received
+     * Reads a line of text from the serial port.
-    */
+     */
-    // help=serial/on-line-received
+    //% help=serial/read-line
-    // blockId=serial_on_line_received block="serial on line received"
+    //% blockId=serial_read_line block="serial|read line"
-    // weight=21 blockGap=8
+    //% weight=20 blockGap=8
-    export function onLineReceived(body: Action): void {
+    export function readLine(): string {
-       // serial.onDataReceived("\n", body);
+        return serial.readUntil(delimiters(Delimiters.NewLine));
     }
 
     /**
      * Returns the delimiter corresponding string
      */
     //% blockId="serial_delimiter_conv" block="%del"
-    //% weight=1
+    //% weight=1 blockHidden=true
     export function delimiters(del: Delimiters): string {
         // even though it might not look like, this is more
         // (memory) efficient than the C++ implementation, because the

libs/core/shims.d.ts

@@ -715,12 +715,19 @@ declare namespace serial {
     function readUntil(delimiter: string): string;
 
     /**
-     * Reads a line of text from the serial port.
+     * Reads the buffered received data as a string
      */
-    //% help=serial/read-line
+    //% blockId=serial_read_buffer block="serial|read string"
-    //% blockId=serial_read_line block="serial|read line"
+    //% weight=18 shim=serial::readString
-    //% weight=20 blockGap=8 shim=serial::readLine
+    function readString(): string;
-    function readLine(): string;
+
+    /**
+     * Registers an event to be fired when one of the delimiter is matched.
+     * @param delimiters the characters to match received characters against.
+     */
+    //% help=serial/on-data-received
+    //% weight=18 blockId=serial_on_data_received block="serial|on data received %delimiters=serial_delimiter_conv" shim=serial::onDataReceived
+    function onDataReceived(delimiters: string, body: () => void): void;
 
     /**
      * Sends a piece of text through Serial connection.

sim/state/serial.ts

@@ -35,18 +35,14 @@ namespace pxsim.serial {
         board().writeSerial(s);
     }
 
+    export function readUntil(del: string): string {
+        return readString();
+    }
+
     export function readString(): string {
         return board().serialState.readSerial();
     }
 
-    export function readLine(): string {
-        return board().serialState.readSerial();
-    }
-
-    export function readUntil(del: string): string {
-        return readLine();
-    }
-
     export function onDataReceived(delimiters: string, handler: RefAction) {
         let b = board();
         b.bus.listen(DAL.MICROBIT_ID_SERIAL, DAL.MICROBIT_SERIAL_EVT_DELIM_MATCH, handler);