3D-printing/klipper
1
0
Fork 0
mirror of https://github.com/Klipper3d/klipper.git synced 2025-08-05 04:54:11 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: Minor updates to wording of some documents

Browse source 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2016-12-01 10:21:36 -05:00
parent d2ecc9d80c
commit babc9e7a1e
3 changed files with 15 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/Protocol.md
View file

@ -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