h3n3/klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

heaters: Add "heaters/set_target_temperature" API endpoint

Browse Source 
Add a mechanism for api clients to asynchronously set a target
temperature.  That is, a mechanism to set the temperature without
needing to wait for G-Code commands to complete.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor
2024-08-05 00:12:31 -04:00
parent 36b5595290
commit c1feb47dbd
2 changed files with 42 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/API_Server.md
View File

@@ -282,6 +282,22 @@ window" interface. Parsing content from the G-Code terminal output is
discouraged. Use the "objects/subscribe" endpoint to obtain updates on
Klipper's state.
### heaters/set_target_temperature
This endpoint is used to asynchronously set the target temperature for
a heater. For example:
`{"id": 123, "method": "heaters/set_target_temperature", "params":
{"heater":"heater_generic my_heater", "target": 100.3}}`
This endpoint is similar to the `SET_HEATER_TEMPERATURE` G-Code
command, but the target temperature takes effect immediately. It does
not wait for pending G-Code commands to complete.
If this endpoint is issued for a heater while a `WAIT_TEMPERATURE`
command (or `M109`, `M190`) is pending for that heater, then the
requested target temperature will be set and the `WAIT_TEMPERATURE`
command will exit with an error.
### motion_report/dump_stepper
This endpoint is used to subscribe to Klipper's internal stepper