Studio RPC Infrastructure #2254
Open
Conversation
This file contains 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
petejohanson
added
enhancement
petejohanson
force-pushed
the
studio/rpc-infrastructure
branch
3 times, most recently
from
a873cb3
to
d79d916
Compare
petejohanson
force-pushed
the
studio/rpc-infrastructure
branch
2 times, most recently
from
377f159
to
13a6e9e
Compare
* For upcoming ZMK studio work, make a set of rich metadata available to provide a friendly name for a behavior, and allow super flexible descriptions of the parameters the behaviors take.
* Used for ZMK Studio even remappers to be sure the one RPC event listener subscribes to their mapped events.
* Add a new feature for tracking a given behavior by a new concept of a "behavior local ID" which is a stable 16-bit identifier for a given behavior, that is resilient to new behaviors being added and requires no additional work on the part of the behavior authors. * Add implementations for either settings lookup table, or CRC16 hashing of behavior device names for generating behavior local IDs.
petejohanson
force-pushed
the
studio/rpc-infrastructure
branch
from
13a6e9e
to
85add43
Compare
* UART and BLE/GATT transports for a protobuf encoded RPC request/response protocol. * Custom framing protocol is used to frame a give message. * Requests/responses are divided into major "subsystems" which handle requests and create response messages. * Notification support, including mapping local events to RPC notifications by a given subsystem. * Meta responses for "no response" and "unlock needed". * Initial basic lock state support in a new core section, and allow specifying if a given RPC callback requires unlocked state or not. * Add behavior subsystem with full metadata support and examples of using callback to serialize a repeated field without extra stack space needed.
* Add an easy snippet for enabling USB UART added to the `zephyr_udc0` standard node.
petejohanson
force-pushed
the
studio/rpc-infrastructure
branch
from
199d35b
to
e192575
Compare
|
Why not start with a cli tool, that handles the actual rpc calls, and layer studio gui ontop of it later? I'm not a maintainer, but it seems to me that the software isn't a part of the firmware. |
petejohanson
force-pushed
the
studio/rpc-infrastructure
branch
2 times, most recently
from
800011c
to
f4144f8
Compare
* Implement message framing. * Transports over Web Bluetooth/Serial. * Message types for serialize/deserialize generated with protoc.
petejohanson
force-pushed
the
studio/rpc-infrastructure
branch
from
f4144f8
to
d354d52
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Initial PR for the RPC infrastructure to be used by ZMK Studio.
This includes the behavior metadata commit from #2231 as it's used by the first really fleshed out behavior subsystem.
To Do