Merge branch 'main' into 14-add-a-class-for-udp-client

Author: eigen-value

.github/workflows/arduino-lint.yml

@@ -0,0 +1,27 @@
+name: Arduino Lint
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Arduino Lint
+        uses: arduino/arduino-lint-action@v2
+        with:
+          compliance: specification
+          library-manager: update # Change to 'update' once the library is published.
+          official: true # Always use this setting for official repositories.
+          project-type: library

.github/workflows/compile-examples.yml

@@ -0,0 +1,75 @@
+# Source: https://github.com/per1234/.github/blob/main/workflow-templates/compile-examples-private.md
+name: Compile Examples
+
+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+on:
+  push:
+    paths:
+      - ".github/workflows/compile-examples.ya?ml"
+      - "library.properties"
+      - "examples/**"
+      - "src/**"
+  pull_request:
+    paths:
+      - ".github/workflows/compile-examples.ya?ml"
+      - "library.properties"
+      - "examples/**"
+      - "src/**"
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms).
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+env:
+  UNIVERSAL_SKETCH_PATHS: |
+        - examples
+  SKETCHES_REPORTS_PATH: sketches-reports
+  SKETCHES_REPORTS_ARTIFACT_NAME: sketches-reports
+
+jobs:
+  build:
+    name: ${{ matrix.board.fqbn }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        board:
+          - fqbn: arduino:zephyr:unoq
+            platforms: |
+              - name: arduino:zephyr
+            artifact-name-suffix: arduino-uno_q
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Compile examples
+        uses: arduino/compile-sketches@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          fqbn: ${{ matrix.board.fqbn }}
+          platforms: ${{ matrix.board.platforms }}
+          libraries: |
+            # Install the library from the local path.
+            - source-path: ./
+            - name: Arduino_RPClite
+            # Additional library dependencies can be listed here.
+            # See: https://github.com/arduino/compile-sketches#libraries
+          sketch-paths: |
+            ${{ env.UNIVERSAL_SKETCH_PATHS }}
+            ${{ matrix.board.additional-sketch-paths }}
+          enable-deltas-report: true
+          sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}
+
+      - name: Save sketches report as workflow artifact
+        uses: actions/upload-artifact@v5
+        with:
+          if-no-files-found: error
+          name: sketches-report-${{ matrix.board.artifact-name-suffix }}
+          path: ${{ env.SKETCHES_REPORTS_PATH }}

.github/workflows/report-size-deltas.yml

@@ -0,0 +1,24 @@
+name: Report Size Deltas
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+  push:
+    paths:
+      - ".github/workflows/report-size-deltas.yml"
+  schedule:
+    # Run at the minimum interval allowed by GitHub Actions.
+    # Note: GitHub Actions periodically has outages which result in workflow failures.
+    # In this event, the workflows will start passing again once the service recovers.
+    - cron: "*/5 * * * *"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  report:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment size deltas reports to PRs
+        uses: arduino/report-size-deltas@v1
+        with:
+          # Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow
+          sketches-reports-source: ^sketches-report-.+

library.json

@@ -6,11 +6,14 @@
     "type": "git",
     "url": "https://github.com/arduino-libraries/Arduino_RouterBridge"
   },
-  "authors": {
-    "name": "Arduino",
-    "url": "https://github.com/arduino-libraries/Arduino_RouterBridge",
-    "maintainer": true
-  },
+  "authors":
+  [
+    {
+      "name": "Arduino",
+      "url": "https://github.com/arduino-libraries/Arduino_RouterBridge",
+      "maintainer": true
+    }
+  ],
   "version": "0.2.2",
   "license": "MPL2.0",
   "frameworks": "arduino",

library.properties

@@ -5,6 +5,6 @@ maintainer=Arduino
 sentence=A RPC bridge for Arduino UNO Q boards
 paragraph=This library provides a simple RPC bridge for Arduino UNO Q boards, allowing communication between the board and other devices using MsgPack serialization.
 category=Communication
-url=https://www.arduino.cc/
+url=https://github.com/arduino-libraries/Arduino_RouterBridge
 architectures=*
 depends=Arduino_RPClite

src/bridge.h

@@ -275,7 +275,7 @@ class BridgeClassUpdater {
     BridgeClassUpdater() = delete; // prevents instantiation
 };
 
-BridgeClass Bridge(Serial1);
+inline BridgeClass Bridge(Serial1);
 
 inline void updateEntryPoint(void *, void *, void *){
     while (true) {
@@ -291,7 +291,7 @@ static void safeUpdate(){
 }
 
 // leave as is
-void __loopHook(void){
+void __attribute__((weak)) __loopHook(void){
     k_yield();
     safeUpdate();
 }

src/hci.h

@@ -149,7 +149,7 @@ template<size_t BufferSize=HCI_BUFFER_SIZE> class BridgeHCI {
 extern BridgeClass Bridge;
 
 namespace RouterBridge {
-    BridgeHCI<> HCI(Bridge);
+    inline BridgeHCI<> HCI(Bridge);
 }
 
 // Make available in global namespace for backward compatibility

src/monitor.h

@@ -156,6 +156,7 @@ class BridgeMonitor: public Stream {
 };
 
 extern BridgeClass Bridge;
-BridgeMonitor<> Monitor(Bridge);
+
+inline BridgeMonitor<> Monitor(Bridge);
 
 #endif // BRIDGE_MONITOR_H