aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Protocol.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2016-12-01 10:21:36 -0500
committerKevin O'Connor <kevin@koconnor.net>2016-12-01 10:21:36 -0500
commitbabc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a (patch)
treeb06367c363ad63bac52e8d3b79a0b47914a74604 /docs/Protocol.md
parentd2ecc9d80c749454b3d14d547d8ec71c0c124fd1 (diff)
downloadkutter-babc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a.tar.gz
kutter-babc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a.tar.xz
kutter-babc9e7a1e2d6a8dc7a826ff66c0a11b8a1e556a.zip
docs: Minor updates to wording of some documents
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Protocol.md')
-rw-r--r--docs/Protocol.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/Protocol.md b/docs/Protocol.md
index 9ae12784..5eccdb4f 100644
--- a/docs/Protocol.md
+++ b/docs/Protocol.md
@@ -28,19 +28,19 @@ DECL_COMMAND(command_set_digital_out, "set_digital_out pin=%u value=%c");
The above declares a command named "set_digital_out". This allows the
host to "invoke" this command which would cause the
-command_set_digital_out() C function will be executed in the
+command_set_digital_out() C function to be executed in the
firmware. The above also indicates that the command takes two integer
parameters. When the command_set_digital_out() C code is executed, it
will be passed an array containing these two integers - the first
corresponding to the 'pin' and the second corresponding to the
'value'.
-In general, the parameters are described with printf() style
-parameters (eg, "%u"). In the above example, "value=" is a parameter
-name and "%c" indicates the parameter is an integer. The parameter
-name is used as documentation. In this example, the "%c" is used as
-documentation to indicate the expected integer is 1 byte in size (the
-declared integer size does not impact the parsing or encoding).
+In general, the parameters are described with printf() style syntax
+(eg, "%u"). In the above example, "value=" is a parameter name and
+"%c" indicates the parameter is an integer. The parameter name is used
+as documentation. In this example, the "%c" is used as documentation
+to indicate the expected integer is 1 byte in size (the declared
+integer size does not impact the parsing or encoding).
At firmware compile time, the build will collect all commands declared
with DECL_COMMAND(), determine their parameters, and arrange for them