feat(openthread): onReceice example

Author: SuGlider

libraries/OpenThread/examples/onReceive/ci.json

@@ -0,0 +1,9 @@
+{
+    "targets": {
+      "esp32": false,
+      "esp32c2": false,
+      "esp32c3": false,
+      "esp32s2": false,
+      "esp32s3": false
+    }
+  }

libraries/OpenThread/examples/onReceive/onReceive.ino

@@ -0,0 +1,37 @@
+/*
+   OpenThread.begin() will automatically start a node in a Thread Network
+   This will demonstrate how to capture the CLI response in a callback function
+   The device state shall change from "disabled" to valid Thread states along time
+*/
+
+#include "OThreadCLI.h"
+
+// reads all the lines sent by CLI, one by one
+// ignores some lines that are just a sequence of \r\n
+void otReceivedLine() {
+  String line = "";
+  while (OThreadCLI.available() > 0) {
+    char ch = OThreadCLI.read();
+    if (ch != '\r' && ch != '\n') {
+      line += ch;
+    }
+  }
+  // ignores empty lines, usually EOL sequence 
+  if (line.length() > 0) {
+    Serial.print("OpenThread CLI RESP===> ");
+    Serial.println(line.c_str());
+  }
+}
+
+void setup() {
+  Serial.begin(115200);
+  OThreadCLI.begin(); // AutoStart 
+  OThreadCLI.onReceive(otReceivedLine);
+}
+
+void loop() {
+  // sends the "state" command to the CLI every second
+  // the onReceive() Callback Function will read and process the response
+  OThreadCLI.println("state");
+  delay(1000);
+}

libraries/OpenThread/src/OThreadCLI.cpp

@@ -99,6 +99,11 @@ static int ot_cli_output_callback(void *context, const char *format, va_list arg
         for (int i = 0; i < ret; i++) {
           xQueueSend(rx_queue, &buf[i], 0);
         }
+        // if there is a user callback function in place, it shall have the priority
+        // to process/consume the Stream data received from OpenThread CLI, which is available in its RX Buffer
+        if (otConsole.responseCallBack != NULL) {
+          otConsole.responseCallBack();
+        }
       }
     }
   }
@@ -144,13 +149,8 @@ static void ot_cli_console_worker(void *context) {
       if (c == '\n' && lastReadChar != '\n') {
         // wait for the OpenThread CLI to finish processing the command
         xTaskNotifyWait(0, 0, NULL, portMAX_DELAY);
-        // if there is a user callback function in place, it shall have the priority
-        // to process/consume the Stream data received from OpenThread CLI, which is available in its RX Buffer
-        if (cli->responseCallBack != NULL) {
-          cli->responseCallBack();
-        }
         // read response from OpenThread CLI and send it to the Stream
-        while (OThreadCLI.available()) {
+        while (OThreadCLI.available() > 0) {
           char c = OThreadCLI.read();
           // echo it back to the console
           if (cli->echoback) {
@@ -182,7 +182,7 @@ void OpenThreadCLI::setStream(Stream& otStream) {
   otConsole.cliStream = &otStream;
 }
 
-void onReceive(OnReceiveCb_t func) {
+void OpenThreadCLI::onReceive(OnReceiveCb_t func) {
   otConsole.responseCallBack = func; // NULL will set it off
 }