cono

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: cargo
+  directory: "/"
+  schedule:
+    interval: daily
+  ignore:
+    - dependency-name: "embedded-hal"
+      versions: ["^0.2"]
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily

.github/workflows/deploy.yml

@@ -9,13 +9,34 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - uses: actions-rs/toolchain@v1.0.1
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+        ref: ${{ github.event.repository.default_branch }}
+    - uses: actions-rs/toolchain@v1.0.7
       with:
         toolchain: stable
         override: true
     - name: Build
       run: cargo build
-    - uses: katyo/publish-crates@v1
-      with:
-        registry-token: ${{ secrets.CARGO }}
+    - name: Extract version from tag
+      id: get_version
+      run: echo "::set-output name=version::${GITHUB_REF/refs\/tags\//}"
+    - name: Commit version changes
+      run: |
+        git config --global user.name 'github-actions[bot]'
+        git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com'
+    - name: Set and publish workspace crates
+      env:
+        CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO }}
+      run: |
+        cargo install cargo-workspaces
+        cargo workspaces version custom ${{ steps.get_version.outputs.version }} \
+          --exact --yes --no-git-tag --no-git-push \
+          -m "Commit new release ${{ steps.get_version.outputs.version }}" --force "mavlink-*"
+        cargo publish -p mavlink-core --no-verify
+        cargo publish -p mavlink-bindgen --no-verify
+        cargo publish -p mavlink --no-verify
+    - name: Push commit
+      run: |
+        git push origin ${{ github.event.repository.default_branch }}

.github/workflows/test.yml

@@ -3,81 +3,133 @@ name: Test all targets
 on: [push, pull_request]
 
 jobs:
-  quick-tests:
+  formatting:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - uses: actions-rs/toolchain@v1.0.1
-      with:
-        toolchain: stable
-        target: ${{ matrix.TARGET }}
-        override: true
-    - name: Check Type
-      run: cargo fmt -- --check
-    - name: Run internal tests
-      run: cargo test --verbose --features all-dialects -- --nocapture
-    - name: Build mavlink-dump
-      run: cargo build --verbose --bin mavlink-dump --features ardupilotmega
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - name: Run rustfmt
+        run: cargo fmt --all -- --check
+
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          components: clippy
+      - uses: actions-rs-plus/clippy-check@v2
+        with:
+          args: --all --all-targets --features format-generated-code --features mav2-message-signing --features tokio
+
+  internal-tests:
+    runs-on: ubuntu-latest
+    strategy:
+        fail-fast: false
+        matrix:
+          dialect: ["dialect-all", "dialect-ardupilotmega", "dialect-asluav", "dialect-matrixpilot", "dialect-minimal", "dialect-paparazzi", "dialect-python_array_test", "dialect-standard", "dialect-test", "dialect-ualberta", "dialect-uavionix", "dialect-icarous", "dialect-common", "dialect-storm32", "dialect-csairlink", "dialect-loweheiser", "dialect-marsh", "dialect-stemstudios"]
+          signing: ["", "--features mav2-message-signing"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - name: Run internal tests
+        run: cargo test --verbose --features arbitrary,${{ matrix.dialect }} ${{ matrix.signing }} -- --nocapture
+
+  mavlink-dump:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Build mavlink-dump
+        run: cargo build --verbose --example mavlink-dump
+
+  msrv:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        features: ["", "--features serde,tokio", "--features mav2-message-signing"]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: taiki-e/install-action@cargo-hack
+      - run: cargo hack --no-dev-deps --rust-version check --package mavlink ${{ matrix.features }}
 
   build:
-    needs: quick-tests
+    needs: [formatting, linting, internal-tests, mavlink-dump, msrv]
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
         include:
-        - os: macos-latest
-          TARGET: x86_64-apple-darwin
-          FEATURES: --features all-dialects
+          - os: macos-latest
+            TARGET: x86_64-apple-darwin
+            FLAGS: --features dialect-ardupilotmega
 
-        - os: ubuntu-latest
-          TARGET: arm-unknown-linux-musleabihf
-          FLAGS: --features ardupilotmega
+          - os: ubuntu-latest
+            TARGET: arm-unknown-linux-musleabihf
+            FLAGS: --features dialect-ardupilotmega
 
-        - os: ubuntu-latest
-          TARGET: armv7-unknown-linux-musleabihf
-          FLAGS: --features ardupilotmega
+          - os: ubuntu-latest
+            TARGET: armv7-unknown-linux-musleabihf
+            FLAGS: --features dialect-ardupilotmega
 
-        - os: ubuntu-latest
-          TARGET: x86_64-unknown-linux-musl
-          FLAGS: --features all-dialects
+          - os: ubuntu-latest
+            TARGET: x86_64-unknown-linux-musl
+            FLAGS: --features dialect-ardupilotmega
 
-        - os: ubuntu-latest
-          TARGET: x86_64-unknown-linux-musl
-          FLAGS: --features all-dialects,emit-extensions
+          - os: ubuntu-latest
+            TARGET: x86_64-unknown-linux-musl
+            FLAGS: --features dialect-ardupilotmega,mav2-message-extensions
 
-        - os: ubuntu-latest
-          TARGET: thumbv7m-none-eabi
-          FLAGS: --no-default-features --features embedded
+          - os: ubuntu-latest
+            TARGET: thumbv7m-none-eabi
+            FLAGS: --no-default-features --features embedded
 
-        - os: windows-latest
-          TARGET: x86_64-pc-windows-msvc
-          FLAGS: --features all-dialects
+          - os: windows-latest
+            TARGET: x86_64-pc-windows-msvc
+            FLAGS: --features dialect-ardupilotmega
 
     steps:
-    - name: Building ${{ matrix.TARGET }}
-      run: echo "${{ matrix.TARGET }}"
-    - uses: actions/checkout@master
-    - uses: actions-rs/toolchain@v1.0.1
-      with:
-        toolchain: stable
-        target: ${{ matrix.TARGET }}
-        override: true
-    - uses: actions-rs/cargo@v1
-      with:
-        use-cross: true
-        command: build
-        args: --verbose --release --target=${{ matrix.TARGET }} ${{ matrix.FLAGS }}
+      - name: Building ${{ matrix.TARGET }}
+        run: echo "${{ matrix.TARGET }}"
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          target: ${{ matrix.TARGET }}
+      - uses: actions-rs/cargo@v1
+        with:
+          use-cross: true
+          command: build
+          args: --verbose --release --package=mavlink --target=${{ matrix.TARGET }} ${{ matrix.FLAGS }}
 
   test-embedded-size:
     needs: build
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - uses: actions-rs/toolchain@v1.0.1
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          target: thumbv7em-none-eabihf
+      - name: Build
+        working-directory: ./mavlink/examples/embedded
+        run: cargo +nightly build --artifact-dir $PWD/../../.. --release -Z unstable-options
+
+  docs:
+    needs: internal-tests
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - uses: dtolnay/rust-toolchain@nightly
+      with:
+        components: rustfmt
+    - name: Build docs
+      run: RUSTDOCFLAGS=--cfg=docsrs cargo doc --no-deps --all-features
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: ${{ github.ref == 'refs/heads/master' }}
       with:
-        toolchain: nightly
-        target: thumbv7em-none-eabihf
-        override: true
-    - name: Build
-      run: cargo +nightly build --target thumbv7em-none-eabihf --manifest-path examples/embedded/Cargo.toml --out-dir $PWD --release -Z unstable-options
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./target/doc

.gitignore

@@ -1,2 +1,24 @@
+## Editor
+*.swp
+*.swo
+Session.vim
+.cproject
+.idea
+*.iml
+.vscode
+.project
+.vim/
+.helix/
+.zed/
+.favorites.json
+.settings/
+.vs/
+.dir-locals.el
+
+## Rust
 target
 Cargo.lock
+
+
+# Typescript message generation
+mavlink/bindings

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "mavlink"]
-	path = mavlink
+[submodule "mavlink/mavlink"]
+	path = mavlink/mavlink
 	url = https://github.com/mavlink/mavlink

Cargo.toml

@@ -1,82 +1,24 @@
+[workspace]
+members = ["mavlink", "mavlink-bindgen", "mavlink-core"]
+resolver = "1"
 
-[package]
-name = "mavlink"
-version = "0.10.1"
-authors = ["Todd Stellanova", "Michal Podhradsky", "Kevin Mehall", "Tim Ryan", "Patrick José Pereira", "Ibiyemi Abiodun"]
-build = "build/main.rs"
-description = "Implements the MAVLink data interchange format for UAVs."
-readme = "README.md"
-license = "MIT/Apache-2.0"
-repository = "https://github.com/mavlink/rust-mavlink"
-edition = "2018"
-
-[build-dependencies]
-crc-any = "2.3.0"
-bytes = { version = "1.0", default-features = false }
-xml-rs = "0.2"
-quote = "0.3"
-lazy_static = "1.2.0"
-serde = { version = "1.0.115", optional = true, features = ["derive"] }
-
-[[bin]]
-name = "mavlink-dump"
-required-features = ["ardupilotmega"]
-
-[dependencies]
-crc-any = "2.3.5"
-bytes = { version = "1.0", default-features = false }
+[workspace.dependencies]
+crc-any = { version = "2.3.5", default-features = false }
 num-traits = { version = "0.2", default-features = false }
-num-derive = "0.3.2"
-bitflags = "1.2.1"
-serial = { version = "0.4", optional = true }
-serde = { version = "1.0.115", optional = true, features = ["derive"] }
+num-derive = "0.4"
+bitflags = { version = "2.9.1", default-features = false }
 byteorder = { version = "1.3.4", default-features = false }
-embedded-hal = { version = "0.2", optional = true }
-nb = { version = "0.1", optional = true }
-
-[features]
-"ardupilotmega" = ["common", "icarous", "uavionix"]
-"asluav" = ["common"]
-"autoquad" = ["common"]
-"matrixpilot" = ["common"]
-"minimal" = []
-"paparazzi" = ["common"]
-"python_array_test" = ["common"]
-"slugs" = ["common"]
-"standard" = ["common"]
-"test" = []
-"ualberta" = ["common"]
-"uavionix" = ["common"]
-"icarous" = []
-"common" = []
-
-"all-dialects" = [
-    "ardupilotmega",
-    "asluav",
-    "autoquad",
-    "matrixpilot",
-    "minimal",
-    "paparazzi",
-    "python_array_test",
-    "slugs",
-    "standard",
-    "test",
-    "ualberta",
-    "uavionix",
-    "icarous",
-    "common",
-]
-
-"emit-description" = []
-"emit-extensions" = []
-"std" = ["byteorder/std"]
-"udp" = []
-"tcp" = []
-"direct-serial" = []
-"embedded" = ["embedded-hal", "nb"]
-default= ["std", "tcp", "udp", "direct-serial", "serial", "serde", "common"]
 
-# build with all features on docs.rs so that users viewing documentation
-# can see everything
-[package.metadata.docs.rs]
-features = ["default", "all-dialects"]
+[workspace.package]
+edition = "2024"
+rust-version = "1.85.0"
+keywords = ["mavlink", "parser", "protocol", "embedded"]
+categories = ["aerospace", "aerospace::protocols", "parsing", "embedded"]
+
+[workspace.lints.clippy]
+cargo = { level = "warn", priority = -1 }
+multiple_crate_versions  = "allow"
+semicolon_if_nothing_returned = "warn"
+unnecessary_semicolon = "warn"
+uninlined_format_args = "warn"
+use_self = "warn"

MAINTAINERS.md

@@ -0,0 +1,18 @@
+Maintainers
+===========
+
+**Active Maintainers**
+
+| Name                 | GitHub                                                            | email                          |
+|----------------------|-------------------------------------------------------------------|--------------------------------|
+| Patrick José Pereira | [@patrickelectric](https://github.com/patrickelectric)            | <patrickelectric@gmail.com>    |
+| João Antônio Cardoso | [@joaoantoniocardoso](https://github.com/joaoantoniocardoso)      | <joao.maker@gmail.com>         |
+| Ramón Roche          | [@mrpollo](https://github.com/mrpollo)                            | <rroche@linuxfoundation.org>   |
+| Onur Özkan           | [@onur-ozkan](https://github.com/onur-ozkan)                      | <onur@orkavian.com>            |
+
+**Release Managers**
+
+| Name                 | GitHub                                                            | email                          |
+|----------------------|-------------------------------------------------------------------|--------------------------------|
+| Patrick José Pereira | [@patrickelectric](https://github.com/patrickelectric)            | <patrickelectric@gmail.com>    |
+| Onur Özkan           | [@onur-ozkan](https://github.com/onur-ozkan)                      | <onur@orkavian.com>            |