Conversation
Deploying rmk-rs with
|
| Latest commit: |
e33ef73
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7d16592c.rmk-4a2.pages.dev |
| Branch Preview URL: | https://feat-rynk.rmk-4a2.pages.dev |
Size Report
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0d170130ff
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
HaoboGu
force-pushed
the
feat/rynk
branch
11 times, most recently
from
July 19, 2026 13:58
c56fde3 to
aa3398e
Compare
Contributor
|
I tested the Rynk USB path from this PR at CDC OUT worked: the firmware received and decoded requests. CDC IN did not complete on the host, even though the firmware's write future returned successfully. I tried asserting DTR, starting the host read before sending, direct libusb access, 64-byte packets, and changing interface/endpoint order and numbers; none changed the result. Using Rynk's existing 32-byte HID framing on the same build worked reliably. I could read all eight 6×14 keymap layers, and the split central and peripheral both remained connected. This may be specific to the nRF52840/Embassy CDC path rather than Rynk itself, so I don't think the PR should simply replace CDC everywhere. Would a selectable USB HID transport be useful here? I have the firmware and native Linux host changes working and can extract a small patch if that direction makes sense. |
Collaborator
Author
I think it might be a linux specific descriptor bug. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
HaoboGu
force-pushed
the
feat/rynk
branch
4 times, most recently
from
July 28, 2026 11:31
999e0fe to
e7f61ab
Compare
HaoboGu
force-pushed
the
feat/rynk
branch
3 times, most recently
from
July 30, 2026 14:13
ea6f7bc to
c09015e
Compare
Replace the placeholder rmk protocol module with the Rynk wire format: command, endpoint, and topic tables, error and message types, layout and system payloads, plus wire snapshots. Add tsify-based TypeScript type generation for host reuse.
…[keymap.layer]] Separate the physical key map from the keymap: drop the legacy matrix_map/keymap path and its codegen, and add the macro codegen for the new schema.
… handler Route USB and BLE host access through one handler and replace the vial_lock feature with host_lock.
Includes the lock gate, device-info and layout-blob endpoints, and keymap bulk transfer across layer boundaries.
Generates the TypeScript type bindings consumed by the web demo.
… examples Add rp2040_rynk and qemu-riscv-rynk, adapt example sources, and regenerate Cargo.lock files.
Signed-off-by: Haobo Gu <haobogu@outlook.com>
Store each tap-hold's timing profile as a u8 index into a small, deduplicated `taphold_profiles` table rather than an inline 4-byte `MorseProfile`. `KeyAction::TapHold` shrinks from 12 to 7 bytes, which also drops the u32's 4-byte alignment padding across every KeyAction-sized RAM buffer (keymap array, held-key buffer, combos, forks, morse cache). Measured on the nrf52840 example at a 5x14x5 (350-key) board: .bss -2408 bytes, .text -4 bytes (no flash cost). Savings scale with board size; the table cost (CAP*4, default CAP=16 -> 64 B) is fixed. - keyboard.toml: named profiles are interned automatically by the proc-macro; users keep referencing them by name. - pure-Rust: default macros (th!/mt!/lt!/tt!) are unchanged; the custom-profile macros (thp!/mtp!/ltp!/ttp!) now take a table index and the user populates `behavior.morse.taphold_profiles`. - Table capacity is configurable via `[rmk] taphold_profile_max_num`. - Vial wire format is unchanged (profile isn't carried); the stored KeyAction encoding changes but auto-migrates via the build-hash guard. Regenerated the rmk_protocol keymap endpoint snapshots (KeyAction schema change propagates to keymap/combo/encoder/fork endpoints).
* refactor: redesign core rynk traits, achieve full-duplex communication Signed-off-by: Haobo Gu <haobogu@outlook.com> * refactor: update rynk crates to use the new contract Signed-off-by: Haobo Gu <haobogu@outlook.com> * chore(rynk): trim comments * refactor(rynk): third simplification pass - rynk-wasm: drop the label round-trip (JS already owns the picker name) and the WebDevice wrapper — JsByteLink is a local wasm-bindgen type, so it implements RynkDevice directly; device.rs deleted - qemu_behavior: drop six request_raw calls duplicating the typed calls right above them (request delegates to request_raw, same code path) - driver/tests: drop three tests subsumed by supersets (cmd mismatch, topic-during-request, cancelled-request recovery) - rynk-serial: declare the tokio feature actually used (io-util, not time) Signed-off-by: Haobo Gu <haobogu@outlook.com> --------- Signed-off-by: Haobo Gu <haobogu@outlook.com>
Signed-off-by: Haobo Gu <haobogu@outlook.com>
Rebasing onto origin/main linearized away the merge commit 9b8d64c, which carried hand-made changes not present in either parent: the nrf54lm20_ble example tweaks, the rynk_loopback fixture downsize, and the rynk/Cargo.lock removal. Restore them to match the pre-rebase tree.
Signed-off-by: Haobo Gu <haobogu@outlook.com>
- features/rynk.md: drop the non-existent `bulk` Cargo feature (the `features = ["bulk"]` snippet failed to compile); bulk is always on with `rynk`, sized by `rynk_buffer_size`. Note the tool-author example needs `embassy-futures`. - migration/v08_v09.md: fix the fabricated `bulk_transfer` -> `bulk` rename (removed, folded into `rynk`); document the `KeyAction::TapHold` u8-index break, the removed `[rmk].protocol_max_bulk_size` key, and the new unknown-key strictness. - configuration/layout.md: remove the `PDF(n)` action (unsupported in keyboard.toml — the keymap grammar has no rule for it), document the `Trns` transparent form, and split two examples that shared one toml fence. - rmk/CHANGELOG.md: add the Rynk feature entry and the BREAKING `keyboard.toml` layout-schema change.
A USB bulk-IN transfer completes on the host only once it sees a packet shorter than the max packet size. A device-to-host frame whose length is a multiple of that size (64 at Full-Speed) ends on a full packet, so the host read stays pending. Wrap the CDC Sender in a small Write adapter that appends a zero-length packet after such a frame. Scoped to the USB transport; run_session, UART, and BLE are untouched. This is an independent robustness fix, not the root cause of the nRF52840 "CDC IN never completes" report — there even the short handshake response and raw libusb hung, which a ZLP cannot explain. Signed-off-by: Haobo Gu <haobogu@outlook.com>
Signed-off-by: Haobo Gu <haobogu@outlook.com>
run_session now mutes topics until the client requests GetCapabilities (b0c4ec7), so the topic loopback tests hung waiting for frames that were drained. Handshake first, as every real host does at connect. Signed-off-by: Haobo Gu <haobogu@outlook.com> Claude-Session: https://claude.ai/code/session_015SYk627CMYYUUoctAryhzP
Signed-off-by: Haobo Gu <haobogu@outlook.com>
* feat(rynk): use cobs encoding in Rynk protocol Signed-off-by: Haobo Gu <haobogu@outlook.com> * fix(rynk): complete COBS transport migration Signed-off-by: Haobo Gu <haobogu@outlook.com> * refactor(rynk): remove frame_capacity helper RYNK_FRAME_BUFFER_SIZE computes its size directly; the host and test call sites inline the one-line arithmetic. Claude-Session: https://claude.ai/code/session_01M6bs9ZKV8i61EYAAquxjYn Signed-off-by: Haobo Gu <haobogu@outlook.com> * refactor: improve frame encoding and deframer Signed-off-by: Haobo Gu <haobogu@outlook.com> * refactor: use physical buffer size in config Signed-off-by: Haobo Gu <haobogu@outlook.com> * test(rynk): reproduce concurrent request loss in QEMU * test(rynk): use unmodified QEMU transport Signed-off-by: Haobo Gu <haobogu@outlook.com> * fix(rynk): serve every frame of a coalesced read The session served one frame per read cycle and reset the Deframer, dropping any pipelined tail: a second request coalescing into the same read was silently lost and its caller hung forever (byte streams give no write boundaries, so even sequential reboot -> get_version hit this). - Deframer::park_pending/unpark_pending move the undecoded tail to the buffer end while the in-place reply encodes, so nothing is dropped - dispatch returns Result; error envelopes encode into a small stack buffer, so every request is answered even when a parked tail leaves almost no reply window - a reply that fails to encode beside a parked tail answers with the new RynkError::Busy instead of Internal - bulk GET pages size to the actual reply window, and answer Busy rather than an empty page when squeezed to zero (an empty page means EOF) * feat(rynk): route replies by SEQ for concurrent requests Replace the single-slot reply Signal with a slot pool: up to four requests run concurrently (no-alloc builds keep one slot), each reply is routed to the slot claiming its SEQ, and an unmatched reply — a cancelled request's late echo, a fire-and-forget answer — is dropped. SEQs are claimed before the frame is sent so a reply always finds its slot, and a dropped request future frees its slot on the way out, so cancellation needs no special casing. * style: add missing trailing newline in channel.rs * docs(rynk): add bulk throughput plan * refactor: optimize the throughput Signed-off-by: Haobo Gu <haobogu@outlook.com> * refactor: optimize Rynk host data reading flow Signed-off-by: Haobo Gu <haobogu@outlook.com> --------- Signed-off-by: Haobo Gu <haobogu@outlook.com>
Signed-off-by: Haobo Gu <haobogu@outlook.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
successor of #848, cleaned the commit history