Merge pull request #27 from bcmi-labs/pretty-the-horse-up

Cleanup and refactor library

Author: aentinger

.github/workflows/compile-examples.yml

@@ -26,19 +26,14 @@ env:
 
 jobs:
   compile-test:
-    name: compile for ${{ matrix.fqbn }}
+    name: ${{ matrix.board.fqbn }}
     runs-on: ubuntu-latest
 
     env:
       # libraries to install for all boards
       UNIVERSAL_LIBRARIES: |
-        # Install the ArduinoThreads library from the repository
+        # Install the Arduino_Threads library from the repository
         - source-path: ./
-        - name: Arduino_LSM9DS1
-        - name: Arduino_APDS9960
-        - name: ArduinoECCX08
-        - name: Arduino_HTS221
-        - name: OneWire
       # sketch paths to compile (recursive) for all boards
       UNIVERSAL_SKETCH_PATHS: |
         - examples
@@ -49,10 +44,19 @@ jobs:
       fail-fast: false
 
       matrix:
-        fqbn:
-          - "arduino:mbed:nano33ble"
-          # - "arduino:mbed:envie_m4"
-          - "arduino:mbed:envie_m7"
+        board:
+          - fqbn: arduino:mbed_nano:nano33ble
+            platforms: |
+              - name: arduino:mbed_nano
+          - fqbn: arduino:mbed_nano:nanorp2040connect
+            platforms: |
+              - name: arduino:mbed_nano
+          - fqbn: arduino:mbed_portenta:envie_m4
+            platforms: |
+              - name: arduino:mbed_portenta
+          - fqbn: arduino:mbed_portenta:envie_m7
+            platforms: |
+              - name: arduino:mbed_portenta
 
     steps:
       - name: Checkout
@@ -83,15 +87,10 @@ jobs:
         uses: arduino/compile-sketches@v1
         with:
           cli-version: 'arduino_threads'
-          fqbn: ${{ matrix.fqbn }}
+          fqbn: ${{ matrix.board.fqbn }}
           libraries: |
             ${{ env.UNIVERSAL_LIBRARIES }}
-          platforms: |
-            # Use Board Manager to install the latest release of Arduino mbed Boards to get the toolchain
-            - name: "arduino:mbed"
-            # Overwrite the Board Manager installation with the local platform
-            - source-path: "extras/ArduinoCore-mbed"
-              name: "arduino:mbed"
+          platforms: ${{ matrix.board.platforms }}
           sketch-paths: |
             ${{ env.UNIVERSAL_SKETCH_PATHS }}
           enable-deltas-report: 'true'

examples/Blocks/Blocks.ino

@@ -0,0 +1,7 @@
+void setup() {
+
+}
+
+void loop() {
+  Serial.println(counter);
+}

examples/Blocks/data_reader.inot

@@ -0,0 +1,13 @@
+void setup()
+{
+  Serial.begin(115200);
+  while (!Serial) { }
+
+  Producer.start();
+  Consumer.start();
+}
+
+void loop()
+{
+  rtos::ThisThread::yield();
+}

examples/Blocks/data_writer.inot

@@ -0,0 +1,10 @@
+void setup() {
+
+}
+
+void loop() {
+  static int i = 0;
+  counter = i;
+  i++;
+  delay(100);
+}

examples/Demo_Shared_Counter/Consumer.inot

@@ -0,0 +1 @@
+SHARED(counter, int);

examples/Demo_Shared_Counter/Demo_Shared_Counter.ino

@@ -0,0 +1,11 @@
+SINK(counter, int);
+
+void setup()
+{
+
+}
+
+void loop()
+{
+  Serial.println(counter.read());
+}

examples/Demo_Shared_Counter/Producer.inot

@@ -0,0 +1,16 @@
+/*
+ * This examples demonstrates the SOURCE/SINK abstraction.
+ * Each thread may have any number of SOURCES and SINKS that can be connected
+ * together using the "connectTo" method.
+ */
+
+void setup()
+{
+  Producer.counter.connectTo(Consumer.counter);
+  Producer.start();
+  Consumer.start();
+}
+
+void loop() {
+  rtos::ThisThread::yield();
+}

examples/Demo_Shared_Counter/SharedVariables.h

@@ -0,0 +1,13 @@
+SOURCE(counter, int);
+
+void setup()
+{
+
+}
+
+void loop()
+{
+  static int i = 0;
+  counter.write(i);
+  i++;
+}

examples/Demo_Source_Sink_Counter/Consumer.inot

@@ -0,0 +1,15 @@
+/*
+ * This examples demonstrates the SOURCE/SINK abstraction.
+ * Each thread may have any number of SOURCES and SINKS that can be connected
+ * together using the "connectTo" method.
+ */
+
+void setup() {
+  Source_Thread.led.connectTo(Sink_Thread.led);
+  Sink_Thread.start();
+  Source_Thread.start();
+}
+
+void loop() {
+  rtos::ThisThread::yield();
+}

examples/Demo_Source_Sink_Counter/Demo_Source_Sink_Counter.ino

@@ -0,0 +1,21 @@
+
+/*
+ * An 'bool' SINK with a size of '0'. This kind of SINK has no buffer so the reading thread
+ * will block until the writing thread has written something, or vice versa.
+ */
+SINK(led, bool);
+
+void setup()
+{
+  pinMode(LED_BUILTIN, OUTPUT);
+}
+
+void loop()
+{
+  /* Read a 'bool' from the SINK and discard it. Since there is basically no delay in the loop
+   * this call will surely block until something comes from the connected SOURCE. In this case
+   * the pace is dictated by the SOURCE that sends data every 100 ms.
+   */
+  bool led_on = led.read();
+  digitalWrite(LED_BUILTIN, led_on);
+}

examples/Demo_Source_Sink_Counter/Producer.inot

@@ -0,0 +1,15 @@
+/* The output SOURCE, it sends 'bool' values. */
+SOURCE(led, bool);
+
+void setup()
+{
+
+}
+
+void loop()
+{
+  led.write(true);
+  delay(100);
+  led.write(false);
+  delay(100);
+}