add example for STM32F4 chips

note that this is not part of the main `Cargo.toml` as it has to build
against a different target, which isn't supported if they are in the
same workspace.

Author: rursprung

.github/dependabot.yml

@@ -8,3 +8,7 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+  - package-ecosystem: "cargo"
+    directory: "/examples/stm32f4-event-printer"
+    schedule:
+      interval: "weekly"

.github/workflows/CI.yml

@@ -5,11 +5,8 @@ on:
     branches: [ "master" ]
   pull_request:
 
-env:
-  CARGO_TERM_COLOR: always
-
 jobs:
-  build:
+  lib:
     strategy:
       fail-fast: false
       matrix:
@@ -35,3 +32,31 @@ jobs:
         run: cargo clippy ${{ matrix.features }}
       - name: audit
         run: cargo audit
+
+  stm32f4-event-printer:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: install rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: thumbv7em-none-eabihf
+          components: rustfmt clippy
+      - name: Install flip-link
+        run: cargo install flip-link
+      - name: build
+        run: cargo build
+        working-directory: examples/stm32f4-event-printer
+      - name: check
+        run: cargo check
+        working-directory: examples/stm32f4-event-printer
+      # no tests available for now => no test step as it'd fail otherwise
+      - name: check formatting
+        run: cargo fmt --all -- --check
+        working-directory: examples/stm32f4-event-printer
+      - name: clippy
+        run: cargo clippy
+        working-directory: examples/stm32f4-event-printer
+      - name: audit
+        run: cargo audit
+        working-directory: examples/stm32f4-event-printer

.gitignore

@@ -1,5 +1,5 @@
-/target
+**/target
 /Cargo.lock
 
-.idea
-.vscode
+**/.idea
+**/.vscode

README.md

@@ -17,6 +17,9 @@ Note that this work is not affiliated with Adafruit.
   but you can opt to only select the event(s) you are interested in which will result in a small binary size.
   If other events are received, a `ProtocolParseError::DisabledControllerDataPackageType` will be returned.
 
+## Examples
+A simple example for the STM32F4 microcontrollers is [available](examples/stm32f4-event-printer/README.md).
+
 ## Changelog
 For the changelog please see the dedicated [CHANGELOG.md](CHANGELOG.md).
 

examples/stm32f4-event-printer/.cargo/config

@@ -0,0 +1,13 @@
+[target.thumbv7em-none-eabihf]
+runner = 'probe-run --chip STM32F401RE'
+rustflags = [
+    "-C", "link-arg=-Tlink.x",
+    "-C", "link-arg=-Tdefmt.x",
+    "-C", "linker=flip-link",
+]
+
+[build]
+target = "thumbv7em-none-eabihf"
+
+[env]
+DEFMT_LOG = "info"

examples/stm32f4-event-printer/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "weekly"

examples/stm32f4-event-printer/.github/workflows/CI.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install target
+        run: rustup target add thumbv7em-none-eabihf
+      - name: Install flip-link
+        run: cargo install flip-link
+      - uses: actions/checkout@v3
+      - name: Build
+        run: cargo build
+      # no tests available for now => no test step as it'd fail otherwise
+      - uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+      - uses: actions-rs/cargo@v1
+        with:
+          command: clippy