diff options
author | Kevin O'Connor <kevin@koconnor.net> | 2018-10-20 11:53:00 -0400 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2018-10-20 11:53:32 -0400 |
commit | b903f84c8068c86833671b7ccde1a2183d5b07b0 (patch) | |
tree | 7f0e7a00270d2c0edd82f25c68c5d1e90e3d1baa /docs/Protocol.md | |
parent | 7efbc021a5107b3066b7f19c9672fd07b1d1c955 (diff) | |
download | kutter-b903f84c8068c86833671b7ccde1a2183d5b07b0.tar.gz kutter-b903f84c8068c86833671b7ccde1a2183d5b07b0.tar.xz kutter-b903f84c8068c86833671b7ccde1a2183d5b07b0.zip |
docs: Replace get_status example with get_clock in Protocol.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Protocol.md')
-rw-r--r-- | docs/Protocol.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/Protocol.md b/docs/Protocol.md index 57d274b3..f4fbe57a 100644 --- a/docs/Protocol.md +++ b/docs/Protocol.md @@ -174,20 +174,20 @@ message block: set_digital_out pin=86 value=1 set_digital_out pin=85 value=0 get_config -get_status +get_clock ``` and encoded into the following eight VLQ integers: ``` -<id_set_digital_out><86><1><id_set_digital_out><85><0><id_get_config><id_get_status> +<id_set_digital_out><86><1><id_set_digital_out><85><0><id_get_config><id_get_clock> ``` In order to encode and parse the message contents, both the host and micro-controller must agree on the command ids and the number of parameters each command has. So, in the above example, both the host and micro-controller would know that "id_set_digital_out" is always -followed by two parameters, and "id_get_config" and "id_get_status" +followed by two parameters, and "id_get_config" and "id_get_clock" have zero parameters. The host and micro-controller share a "data dictionary" that maps the command descriptions (eg, "set_digital_out pin=%u value=%c") to their integer command-ids. When processing the |