feat(rynk): add host-side client implementation

Add a runtime-free host client crate for the Rynk protocol, plus native serial and BLE transport crates.

Extend firmware-side Rynk protocol handling for host clients and cover the wire format, loopback path, hardware validation example, and host CI checks.

Signed-off-by: Haobo Gu <haobogu@outlook.com>

Author: HaoboGu

.github/ci/_lib.sh

@@ -33,17 +33,27 @@ log_section() {
 }
 
 # Feature-set matrix for rmk check/clippy/test. An empty entry means
-# `--no-default-features` with no extra features on top. Kept here so
-# check.sh and test.sh stay in lockstep — a set added for check is also
-# exercised by tests, and vice versa.
+# `--no-default-features` with no extra features on top. This is the single
+# source of truth: check.sh, test.sh, and scripts/test_all.sh all consume it,
+# so a set added here is checked, clippy'd, and tested everywhere.
 RMK_FEATURESETS=(
     ""
     "log,std"
     "storage"
     "async_matrix,storage"
+    "vial,storage"
+    "vial,_ble"
+    "split,async_matrix"
+    "split,async_matrix,_ble"
+    "split,vial,async_matrix"
+    "split,vial,async_matrix,_ble"
     "split,vial,storage"
     "passkey_entry"
     "split,vial,storage,passkey_entry"
+    "vial,storage,steno"
+    "split,vial,storage,async_matrix,_ble,steno"
+    "rynk,bulk,_ble,split,storage,async_matrix"
+    "rynk,storage"
 )
 
 # Examples auto-discovery skiplist. Reasons:

.github/ci/format.sh

@@ -8,6 +8,9 @@ for crate in rmk rmk-config rmk-macro rmk-types; do
     cargo +nightly fmt --manifest-path "$crate/Cargo.toml" --check
 done
 
+log_section "Formatting host tooling"
+cargo +nightly fmt --manifest-path rynk/Cargo.toml --all --check
+
 log_section "Formatting examples"
 while IFS= read -r manifest; do
     cargo +nightly fmt --manifest-path "$manifest" --check

.github/ci/host.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -euo pipefail
+# shellcheck source=_lib.sh
+source "$(dirname "${BASH_SOURCE[0]}")/_lib.sh"
+
+# The host tooling is its own cargo workspace.
+cd "$repo_root/rynk"
+
+export CARGO_TERM_COLOR=always
+export CARGO_TARGET_DIR="${CARGO_TARGET_DIR:-$target_root/host}"
+mkdir -p "$CARGO_TARGET_DIR"
+
+log_section "Tests"
+cargo +stable test --workspace --lib --tests
+
+log_section "Wasm smoke check"
+cargo +stable check -p rynk --lib --target wasm32-unknown-unknown
+
+log_section "Clippy"
+cargo +stable clippy --workspace --lib --tests --examples -- -D warnings

.github/ci/test.sh

@@ -16,10 +16,9 @@ nx=(nextest run --config-file "$nextest_cfg" --profile ci)
 log_section "Running tests"
 cargo +stable "${nx[@]}" --manifest-path rmk-config/Cargo.toml
 cargo +stable "${nx[@]}" --manifest-path rmk-types/Cargo.toml
-# Exercise the rmk_protocol module (gated behind `rmk_protocol`) so the wire-format
-# snapshot tests under rmk-types/src/protocol/rmk/snapshots/ run in CI. `host`
-# enables rmk_protocol + bulk + _ble + split, covering every snapshot.
+# Exercise the rynk protocol module (gated behind `rynk`).
 cargo +stable "${nx[@]}" --manifest-path rmk-types/Cargo.toml --features host
+cargo +stable "${nx[@]}" --manifest-path rmk-types/Cargo.toml --features steno
 cargo +stable "${nx[@]}" --manifest-path rmk-macro/Cargo.toml
 for feats in "${RMK_FEATURESETS[@]}"; do
     if [[ -z "$feats" ]]; then

.github/workflows/ci.yml

@@ -78,6 +78,22 @@ jobs:
         run: cargo install --locked cargo-expand
       - run: .github/ci/test.sh
 
+  # Host tooling lives in its own workspace, so it gets its own job.
+  host:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+          targets: wasm32-unknown-unknown
+      - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: ci-host
+          cache-directories: |
+            target/ci
+      - run: .github/ci/host.sh
+
   # Discover buildable examples for the matrix
   discover:
     runs-on: ubuntu-latest

.gitignore

@@ -15,6 +15,7 @@ rmk/Cargo.lock
 rmk-macro/Cargo.lock
 rmk-config/Cargo.lock
 rmk-types/Cargo.lock
+rynk/Cargo.lock
 
 # esp idf build files
 .embuild

examples/use_rust/nrf54lm20_ble/Cargo.toml

@@ -10,7 +10,14 @@ edition = "2024"
 license = "MIT OR Apache-2.0"
 
 [dependencies]
-rmk = { path = "../../../rmk", features = ["async_matrix", "nrf54lm20_ble"] }
+rmk = { path = "../../../rmk", default-features = false, features = [
+    "rynk",
+    "async_matrix",
+    "nrf54lm20_ble",
+    "storage",
+    "defmt",
+    "watchdog",
+] }
 nrf-sdc = { git = "https://github.com/alexmoon/nrf-sdc", rev = "131ff2088ed2bb4f6e50ba49e4976aced21fe7ba", default-features = false, features = [
     "defmt",
     "peripheral",

examples/use_rust/nrf54lm20_ble/src/main.rs

@@ -1,7 +1,6 @@
 #![no_std]
 #![no_main]
 
-mod vial;
 #[macro_use]
 mod macros;
 mod keymap;
@@ -23,7 +22,7 @@ use panic_probe as _;
 use rand_chacha::ChaCha12Rng;
 use rand_core::SeedableRng;
 use rmk::ble::{BleTransport, build_ble_stack};
-use rmk::config::{BehaviorConfig, DeviceConfig, PositionalConfig, RmkConfig, StorageConfig, VialConfig};
+use rmk::config::{BehaviorConfig, DeviceConfig, PositionalConfig, RmkConfig, StorageConfig};
 use rmk::debounce::default_debouncer::DefaultDebouncer;
 use rmk::host::HostService;
 use rmk::keyboard::Keyboard;
@@ -32,7 +31,6 @@ use rmk::processor::builtin::wpm::WpmProcessor;
 use rmk::usb::UsbTransport;
 use rmk::{DefaultPacketPool, HostResources, KeymapData, PacketPool, initialize_keymap_and_storage, run_all};
 use static_cell::StaticCell;
-use vial::{VIAL_KEYBOARD_DEF, VIAL_KEYBOARD_ID};
 
 type RandomSource = cracen::Cracen<'static, Blocking>;
 
@@ -58,8 +56,6 @@ const FLASH_SECTORS: u8 = 6;
 const L2CAP_TXQ: u8 = 4;
 const L2CAP_RXQ: u8 = 4;
 
-const UNLOCK_KEYS: &[(u8, u8)] = &[(0, 0), (0, 1)];
-
 fn build_sdc<'d, const N: usize>(
     p: nrf_sdc::Peripherals<'d>,
     rng: &'d mut RandomSource,
@@ -189,15 +185,13 @@ async fn main(spawner: Spawner) {
         product_name: "RMK nRF54LM20A",
         serial_number: "vial:f64c2b3c:000054",
     };
-    let vial_config = VialConfig::new(VIAL_KEYBOARD_ID, VIAL_KEYBOARD_DEF, UNLOCK_KEYS);
     let storage_config = StorageConfig {
         start_addr: FLASH_START_ADDR,
         num_sectors: FLASH_SECTORS,
         ..Default::default()
     };
     let rmk_config = RmkConfig {
         device_config: keyboard_device_config,
-        vial_config,
         storage_config,
         ..Default::default()
     };

rmk-config/src/lib.rs

@@ -1172,7 +1172,7 @@ mod tests {
 
         assert_eq!(config.led_indicator.channel_size, 2);
         assert_eq!(config.led_indicator.pubs, 2);
-        assert_eq!(config.led_indicator.subs, 3);
+        assert_eq!(config.led_indicator.subs, 4);
 
         assert_eq!(config.pointing.channel_size, 8);
         assert_eq!(config.pointing.subs, 2);

rmk-types/Cargo.toml

@@ -38,10 +38,8 @@ rynk = []
 # Enables multi-element bulk keymap/combo/morse endpoints and BULK_SIZE constant.
 bulk = ["rynk"]
 # Host tool: uses protocol ceiling values for Vec capacities.
-# Enables all optional endpoint groups so the host can talk to any firmware.
-host = ["rynk", "bulk", "_ble", "split"]
+host = ["rynk", "bulk", "_ble", "split", "steno"]
 # Build-time only features: forwarded from rmk to control constant generation in build.rs.
-# Also used as `#[cfg(feature = "...")]` guards for protocol endpoint/topic gating.
 _ble = []
 split = []
 display = []