refactor: rynk naming polish — EncoderPosition, GATT struct rename, blob doc#927
Open
HaoboGu wants to merge 1 commit into
Open
refactor: rynk naming polish — EncoderPosition, GATT struct rename, blob doc#927HaoboGu wants to merge 1 commit into
HaoboGu wants to merge 1 commit into
Conversation
…lob doc
Wire bytes are unchanged throughout (snapshot hex verified):
- GetEncoderRequest becomes EncoderPosition and SetEncoderRequest wraps
it as {position, action}, mirroring KeyPosition / SetKeyRequest;
postcard flattens the nested struct so the encoding is identical.
- The GATT service structs RynkService / VialService become
RynkGattService / VialGattService, ending the type-name collision
with the protocol services of the same names.
- Document that the layout blob has no version byte of its own — its
postcard schema rides the protocol-major rule like any response.
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
1 participant
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.
Naming/doc polish from the #848 branch review. Wire bytes are unchanged throughout — the snapshot diff shows only label changes, every hex column is byte-identical.
GetEncoderRequestbecomesEncoderPosition{encoder_id, layer}andSetEncoderRequestwraps it as{position, action}, mirroringKeyPosition/SetKeyRequest; postcard flattens the nested struct so the encoding is identicalRynkService/VialServicebecomeRynkGattService/VialGattService, ending the type-name collision with the protocol services of the same names (allpub(crate), field names unchanged)payload/layout.rsnow documents that the layout blob has no version byte of its own — its postcard schema rides the protocol-major rule like any response payloadVerification: rmk-types host suite (62), rmk rynk suite (617), rmk vial+BLE suite (546), rynk crate tests,
rynk-wasmcompiles forwasm32-unknown-unknown, examples build. Rebased onto the current branch head (post-#922) with snapshots regenerated.Part of the post-review follow-ups for #848.