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

build: Define DECL_CONSTANT mechanism for defining exported constants

Browse source 
Add a DECL_CONSTANT macro to allow the firmware to define constants
that are to be exported to the host during the "identify" phase.  This
replaces the existing hardcoded mechanism of scanning the Kconfig
header file for certain constants.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2016-12-22 23:47:46 -05:00
parent 4e8674d5df
commit fe95ea221b
11 changed files with 54 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/Protocol.md
View file

@ -109,6 +109,19 @@ to generate and format arbitrary messages for human consumption. It is
a wrapper around sendf() and as with sendf() it should not be called
from interrupts or timers.
Declaring constants
-------------------
The firmware can also define constants to be exported. For example,
the following:
```
DECL_CONSTANT(SERIAL_BAUD, 250000);
```
would export a constant named "SERIAL_BAUD" with a value of 250000
from the firmware to the host.
Low-level message encoding
==========================
@ -262,8 +275,8 @@ dictionary. Once all chunks are obtained the host will assemble the
chunks, uncompress the data, and parse the contents.
In addition to information on the communication protocol, the data
dictionary also contains firmware version, configuration, and other
useful information.
dictionary also contains firmware version, constants (as defined by
DECL_CONSTANT), and static strings.
Static Strings
--------------