Add a large number of convenience functions to Control and cleanup ru…

…nner patterns

.github/workflows/lint.yml → .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Lint
+name: CI
 
 on:
   push:
@@ -10,9 +10,6 @@ defaults:
   run:
     shell: bash
 
-env:
-  CLIPPY_PARAMS: -W clippy::all -W clippy::pedantic -W clippy::nursery -W clippy::cargo
-
 jobs:
   rustfmt:
     name: rustfmt
@@ -35,33 +32,6 @@ jobs:
           command: fmt
           args: --all -- --check --verbose
 
-  # tomlfmt:
-  #   name: tomlfmt
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - name: Checkout source code
-  #       uses: actions/checkout@v2
-
-  #     - name: Install Rust
-  #       uses: actions-rs/toolchain@v1
-  #       with:
-  #         profile: minimal
-  #         toolchain: nightly
-  #         override: true
-
-  #     - name: Install tomlfmt
-  #       uses: actions-rs/[email protected]
-  #       with:
-  #         crate: cargo-tomlfmt
-  #         version: latest
-  #         use-tool-cache: true
-
-  #     - name: Run Tomlfmt
-  #       uses: actions-rs/cargo@v1
-  #       with:
-  #         command: tomlfmt
-  #         args: --dryrun
-
   clippy:
     name: clippy
     runs-on: ubuntu-latest
@@ -81,4 +51,31 @@ jobs:
         uses: actions-rs/clippy-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: -- ${{ env.CLIPPY_PARAMS }}
+          args: --features odin-w2xx,ppp
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v2
+
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          target: thumbv7m-none-eabi
+          override: true
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --all --target thumbv7m-none-eabi --features odin-w2xx,ppp
+
+      - name: Test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --lib --features odin-w2xx,ppp

.vscode/settings.json

@@ -7,7 +7,7 @@
     "rust-analyzer.check.allTargets": false,
     "rust-analyzer.linkedProjects": [],
     "rust-analyzer.cargo.features": [
-        "odin_w2xx",
+        "odin-w2xx",
         // "internal-network-stack"
         "ppp"
     ],

Cargo.toml

@@ -20,7 +20,7 @@ atat = { version = "0.23", features = ["derive", "bytes"] }
 heapless = { version = "^0.8", features = ["serde"] }
 no-std-net = { version = "0.6", features = ["serde"] }
 serde = { version = "^1", default-features = false, features = ["derive"] }
-# ublox-sockets = { version = "0.5", features = ["edm"], optional = true }
+# ublox-sockets = { version = "0.5", optional = true }
 ublox-sockets = { git = "https://github.com/BlackbirdHQ/ublox-sockets", rev = "9f7fe54", optional = true }
 portable-atomic = "1.6"
 
@@ -50,6 +50,8 @@ default = ["socket-tcp", "socket-udp"]
 internal-network-stack = ["dep:ublox-sockets", "edm"]
 edm = ["ublox-sockets?/edm"]
 
+ipv6 = ["embassy-net?/proto-ipv6"]
+
 # PPP mode requires UDP sockets enabled, to be able to do AT commands over UDP port 23
 ppp = ["dep:embassy-net-ppp", "dep:embassy-net", "socket-udp"]
 
@@ -66,12 +68,13 @@ defmt = [
 ]
 log = ["dep:log", "ublox-sockets?/log", "atat/log"]
 
-odin_w2xx = []
-nina_w1xx = []
-nina_b1xx = []
-anna_b1xx = []
-nina_b2xx = []
-nina_b3xx = []
+# Supported Ublox modules
+odin-w2xx = []
+nina-w1xx = []
+nina-b1xx = []
+anna-b1xx = []
+nina-b2xx = []
+nina-b3xx = []
 
 [workspace]
 members = []
@@ -81,4 +84,5 @@ exclude = ["examples"]
 
 [patch.crates-io]
 no-std-net = { git = "https://github.com/rushmorem/no-std-net", branch = "issue-15" }
-atat = { path = "../atat/atat" }
+atat = { git = "https://github.com/BlackbirdHQ/atat", rev = "a466836" }
+# atat = { path = "../atat/atat" }

README.md

@@ -13,12 +13,12 @@
 A driver crate for AT-command based serial ublox short range modules, built on top of [atat].
 The driver aims to be compatible with the ublox short range modules:
 
-- odin_w2xx
-- nina_w1xx
-- nina_b1xx
-- anna_b1xx
-- nina_b2xx
-- nina_b3xx
+- odin-w2xx
+- nina-w1xx
+- nina-b1xx
+- anna-b1xx
+- nina-b2xx
+- nina-b3xx
 
 [atat]: https://crates.io/crates/atat
 
@@ -48,12 +48,12 @@ The samples can be built using `cargo build -p linux_example --target x86_64-unk
 ## Features
 
 - device selection (must select one, and only one!):
-  - `odin_w2xx`
-  - `nina_w1xx`
-  - `nina_b1xx`
-  - `anna_b1xx`
-  - `nina_b2xx`
-  - `nina_b3xx`
+  - `odin-w2xx`
+  - `nina-w1xx`
+  - `nina-b1xx`
+  - `anna-b1xx`
+  - `nina-b2xx`
+  - `nina-b3xx`
 - `socket-tcp`: Enabled by default. Adds TCP socket capabilities, and implements [`TcpStack`] trait.
 - `socket-udp`: Enabled by default. Adds UDP socket capabilities, and implements [`UdpStack`] trait.
 - `defmt-default`: Disabled by default. Add log statements on trace (dev) or info (release) log levels to aid debugging.

examples/rpi-pico/Cargo.toml

@@ -5,7 +5,7 @@ edition = "2021"
 
 
 [dependencies]
-ublox-short-range-rs = { path = "../../", features = ["odin_w2xx", "defmt"] }
+ublox-short-range-rs = { path = "../../", features = ["odin-w2xx", "defmt"] }
 embassy-executor = { version = "0.5", features = [
     "defmt",
     "integrated-timers",

src/asynch/at_udp_socket.rs

@@ -1,6 +1,8 @@
 use embassy_net::{udp::UdpSocket, Ipv4Address};
 use embedded_io_async::{Read, Write};
 
+use crate::config::Transport;
+
 pub struct AtUdpSocket<'a>(pub(crate) UdpSocket<'a>);
 
 impl<'a> AtUdpSocket<'a> {
@@ -32,6 +34,16 @@ impl<'a> Write for &AtUdpSocket<'a> {
     }
 }
 
+impl<'a> Transport for AtUdpSocket<'a> {
+    fn set_baudrate(&mut self, _baudrate: u32) {
+        // Nothing to do here
+    }
+
+    fn split_ref(&mut self) -> (impl Write, impl Read) {
+        (&*self, &*self)
+    }
+}
+
 impl<'a> embedded_io_async::ErrorType for AtUdpSocket<'a> {
     type Error = core::convert::Infallible;
 }