Skip to content

Latest commit

 

History

History
61 lines (54 loc) · 9.19 KB

command_ref.md

File metadata and controls

61 lines (54 loc) · 9.19 KB

KTCC - Command Reference

#f03c15 #c5f015 #1589F0 Basic Toolchanger functionality

Command Description                                     Parameters                                    
TOOL_LOCK Lock the tool to the toolhead.
TOOL_UNLOCK Unlock the toolhead from tool.
Tn Activates heater, pick up and readyy the tool. If tool is mapped to another one then that tool will be selected instead. RESTORE_AXIS=[XYZ] Restore specified axis position to the latest saved.
TOOL_DROPOFF_ALL Unloads and parks the current tool without picking up another tool, leaving the toolhead free and unlocked. Actual active extruder eill still be last used one as Klipper needs an active extruder.
SET_TOOL_TEMPERATURE Set tool temperature. If TOOL parameter is omited then current tool is set. TOOL=[0..n] Optional if other than current loaded tool
ACTV_TMP=... Set Active temperature, optional
STDB_TMP =... Standby temperature, optional
CHNG_STATE=[0|1|2] Change Heater State, optional:
(0 = Off) | (1 = Standby) | (2 = Active)
SHTDWN_TIMEOUT=... Time in seconds to wait with the heater in standby before changing it to off, optional.
STDB_TIMEOUT=... Time in seconds to linger at Active temp. after setting the heater to standby when the standby temperature is lower than current tool temperature, optional.
SHTDWN_TIMEOUT is used for example so a tool used only on first few layers shuts down after 30 minutes of inactivity and won't stay at 175*C standby for the rest of a 72h print.
STDB_TIMEOUT= Time to linger at Active temp. after setting the heater to standby. Could be used for a tool with long heatup times and is only put in standby short periods of thme throughout a print and should stay at active temperature longer time.
SET_AND_SAVE_PARTFAN_SPEED Set the partcooling fan speed current or specified tool. Fan speed is carried over between toolchanges. S=[0-255 | 0-1] Fan speed with either a maximum of 255 or 1.
P=[0-n] Tool number if not current tool to set fan to.
TEMPERATURE_WAIT_WITH_TOLERANCE Waits for all temperatures, or a specified tool or heater's temperature. This command can be used without any additional parameters and then waits for bed and current extruder. Only one of either TOOL or HEATER may be used. Only waits if target temperature is >40*C TOOL=[0-n] Tool number to wait for, optional.
HEATER=[0-n] Heater number. 0="heater_bed", 1="extruder", 2="extruder1", 3="extruder2", etc. Only works if named as default, this way, optional.
TOLERANCE=[0-50] Tolerance in degC. Defaults to 1*C. Wait will wait until heater is in range of set temperature +/- tolerance.

#f03c15 #c5f015 #1589F0 Offset commands

Command Description                             Parameters                           &nbsp
SET_GLOBAL_OFFSET Set a global offset that can be applied to all tools. Can use absolute offset or adjust relative to current offset. X=... Set the new offset for the axis.
Y=... As above.
Z=... As above.
----------
X_ADJUST=... Adjust the offset position incramentally.
Y_ADJUST=... As above.
Z_ADJUST=... As above.
SET_TOOL_OFFSET Set the offset of an individual tool. Can use absolute offset or adjust relative to current offset. TOOL=[0-n] Tool number, optional. If not provided, the current tool is used.
----------
X=... Set the new offset for the axis.
Y=... As above.
Z=... As above.
----------
X_ADJUST=... Adjust the offset position incramentally.
Y_ADJUST=... As above.
Z_ADJUST=... As above.
KTCC_SET_GCODE_OFFSET_FOR_CURRENT_TOOL Sets the Klipper G-Code offset to the one for the current tool. MOVE=[0|1] Wheteher to move the toolhead to the new offset. ( 0 = Do not move, default ) ( 1 = Move )

#f03c15 #c5f015 #1589F0 Position saving and restoring commands

Command Description                             Parameters                           &nbsp
SAVE_POSITION Save the specified G-Code position for later restore. Without parameters it will set to not restoring axis. X=... Set the restore position and set this axis to be restored.
Y=... As above.
Z=... As above.
SAVE_CURRENT_POSITION Save the current G-Code position for later restore. Without parameters it will save previousley saved axis. RESTORE_POSITION_TYPE=[XYZ] or [0|1|2] Axis to save or tyoe ( 0 = No restore ), ( 1 = Restore XY ), ( 2 = Restore XYZ )
RESTORE_POSITION Restore a previously saved G-Code position. With no parameters it will Restore to previousley saved type. RESTORE_POSITION_TYPE=[XYZ] or [0|1|2] Axis to save or tyoe ( 0 = No restore ), ( 1 = Restore XY ), ( 2 = Restore XYZ )

#f03c15 #c5f015 #1589F0 Tool remapping commands

Command Description Parameters
KTCC_DISPLAY_TOOL_MAP Dump the current mapping of tools to other KTCC tools.
KTCC_REMAP_TOOL Remap a tool to another one. RESET=[0|1] If 1 the stored tooö remap will be reset.
TOOL=[0-n] The toolnumber to remap.
SET=[0-n] The toolnumber to remap to.

#f03c15 #c5f015 #1589F0 Advanced commands, rarely used

Command Description Parameters
KTCC_SAVE_CURRENT_TOOL Set the current loaded tool manually to the specified. When loading a tool manually T=[-2-n] Tool to set as current. ( -2 = Unknown tool ), ( -1 = Toollock unlocked without tool )
KTCC_SET_PURGE_ON_TOOLCHANGE Sets a global variable that can disable all purging (can be used in macros) when loading/unloading tools. For example for automated tool alignement such as TAMV/ZTATP. VALUE=[0|1] If enabled or disabled.
KTCC_ENDSTOP_QUERY Wait for a ENDSTOP untill it is in the specified state indefinitly or for maximum atempts if specified. Checking state once a second. ENDSTOP=... Name of the endstop to wait for.
TRIGGERED=[0|1] If should be waiting for it to be triggered (1) or open (0).
ATEMPTS=... Number of atempts to make, indefinitly if not specified.
KTCC_SET_ALL_TOOL_HEATERS_OFF Turns off all heaters configured for tools and saves changes made to be resumed later by KTCC_RESUME_ALL_TOOL_HEATERS. This does not affect heated beds or other heaters not defined as aan extruder in tools.
KTCC_RESUME_ALL_TOOL_HEATERS Resumes all heaters previously turned off by KTCC_SET_ALL_TOOL_HEATERS_OFF. MSG=... The message to be sent

#f03c15 #c5f015 #1589F0 Status, Logging and Persisted state

Command Description Parameters
KTCC_DUMP_STATS Dump the KTCC statistics to console.
KTCC_RESET_STATS Reset all the KTCC statistics. SUERE=[yes|no] If "yes" the stored statistics will be reset.
KTCC_INIT_PRINT_STATS Run at start of a print to initialize and reset the KTCC print statistics
KTCC_DUMP_PRINT_STATS Run at end of a print to dump statistics since last print reset to console.
KTCC_SET_LOG_LEVEL Set the log level for the KTCC LEVEL=[0-3] How much to log to console: ( 0 = Only the Always messages ) ( 1 = Info messages and above ) ( 2 = Debug messages and above ) ( 3 = Trace messages and above )
LOGFILE=[0-3] How much to log to file. Levels as above.
KTCC_LOG_TRACE Send a message to log at this logging level MSG=... The message to be sent
KTCC_LOG_DEBUG Send a message to log at this logging level MSG=... The message to be sent
KTCC_LOG_INFO Send a message to log at this logging level MSG=... The message to be sent
KTCC_LOG_ALWAYS Send a message to log at this logging level MSG=... The message to be sent