mirror of
https://github.com/Klipper3d/klipper.git
synced 2025-12-24 08:38:34 -07:00
2848 lines
No EOL
86 KiB
HTML
2848 lines
No EOL
86 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
<link rel="icon" href="img/favicon.ico">
|
|
<meta name="generator" content="mkdocs-1.2.4, mkdocs-material-8.1.3">
|
|
|
|
|
|
|
|
<title>Status reference - Klipper documentation</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="assets/stylesheets/main.edf004c2.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="assets/stylesheets/palette.e6a45f82.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_klipper3d/css/extra.css">
|
|
|
|
<script>__md_scope=new URL(".",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-VEN1PGNQL4"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&>ag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-VEN1PGNQL4",{page_path:e.pathname})})})</script>
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-VEN1PGNQL4"></script>
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="blue">
|
|
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)</script>
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#status-reference" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href="." title="Klipper documentation" class="md-header__button md-logo" aria-label="Klipper documentation" data-md-component="logo">
|
|
|
|
<img src="img/klipper.svg" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
Klipper documentation
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Status reference
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="blue" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1z"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="grey" data-md-color-accent="light-blue" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5z"/></svg>
|
|
</label>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
<div class="md-header__option">
|
|
<div class="md-select">
|
|
|
|
<button class="md-header__button md-icon" aria-label="Select language">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.36 14c.08-.66.14-1.32.14-2 0-.68-.06-1.34-.14-2h3.38c.16.64.26 1.31.26 2s-.1 1.36-.26 2m-5.15 5.56c.6-1.11 1.06-2.31 1.38-3.56h2.95a8.03 8.03 0 0 1-4.33 3.56M14.34 14H9.66c-.1-.66-.16-1.32-.16-2 0-.68.06-1.35.16-2h4.68c.09.65.16 1.32.16 2 0 .68-.07 1.34-.16 2M12 19.96c-.83-1.2-1.5-2.53-1.91-3.96h3.82c-.41 1.43-1.08 2.76-1.91 3.96M8 8H5.08A7.923 7.923 0 0 1 9.4 4.44C8.8 5.55 8.35 6.75 8 8m-2.92 8H8c.35 1.25.8 2.45 1.4 3.56A8.008 8.008 0 0 1 5.08 16m-.82-2C4.1 13.36 4 12.69 4 12s.1-1.36.26-2h3.38c-.08.66-.14 1.32-.14 2 0 .68.06 1.34.14 2M12 4.03c.83 1.2 1.5 2.54 1.91 3.97h-3.82c.41-1.43 1.08-2.77 1.91-3.97M18.92 8h-2.95a15.65 15.65 0 0 0-1.38-3.56c1.84.63 3.37 1.9 4.33 3.56M12 2C6.47 2 2 6.5 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2z"/></svg>
|
|
</button>
|
|
<div class="md-select__inner">
|
|
<ul class="md-select__list">
|
|
|
|
<li class="md-select__item">
|
|
<a href="/" hreflang="en" class="md-select__link">
|
|
English
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-select__item">
|
|
<a href="/zh/" hreflang="zh" class="md-select__link">
|
|
简体中文
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-select__item">
|
|
<a href="/zh-Hant/" hreflang="zh-Hant" class="md-select__link">
|
|
繁體中文
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-select__item">
|
|
<a href="/hu/" hreflang="hu" class="md-select__link">
|
|
Magyar
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-select__item">
|
|
<a href="/it/" hreflang="it" class="md-select__link">
|
|
Italiano
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-select__item">
|
|
<a href="/fr/" hreflang="fr" class="md-select__link">
|
|
Français
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<a href="javascript:void(0)" class="md-search__icon md-icon" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7 0-.24-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91 1.61 0 2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08z"/></svg>
|
|
</a>
|
|
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://github.com/Klipper3d/klipper/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
Klipper3d/klipper
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="." title="Klipper documentation" class="md-nav__button md-logo" aria-label="Klipper documentation" data-md-component="logo">
|
|
|
|
<img src="img/klipper.svg" alt="logo">
|
|
|
|
</a>
|
|
Klipper documentation
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/Klipper3d/klipper/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
Klipper3d/klipper
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Overview.html" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Features.html" class="md-nav__link">
|
|
Features
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="FAQ.html" class="md-nav__link">
|
|
Frequently Asked Questions
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Releases.html" class="md-nav__link">
|
|
Releases
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Config_Changes.html" class="md-nav__link">
|
|
Configuration Changes
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Contact.html" class="md-nav__link">
|
|
Contact
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7">
|
|
Installation and Configuration
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Installation and Configuration" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Installation and Configuration
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7_1">
|
|
Installation
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Installation" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_7_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Installation
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Installation.html" class="md-nav__link">
|
|
Installation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="OctoPrint.html" class="md-nav__link">
|
|
OctoPrint for Klipper
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_2" type="checkbox" id="__nav_7_2" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7_2">
|
|
Configuration Reference
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Configuration Reference" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_7_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Configuration Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Config_Reference.html" class="md-nav__link">
|
|
Configuration reference
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Rotation_Distance.html" class="md-nav__link">
|
|
Rotation distance
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Config_checks.html" class="md-nav__link">
|
|
Configuration checks
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_4" type="checkbox" id="__nav_7_4" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7_4">
|
|
Bed Level
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Bed Level" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_7_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Bed Level
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Bed_Level.html" class="md-nav__link">
|
|
Bed leveling
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Delta_Calibrate.html" class="md-nav__link">
|
|
Delta calibration
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Probe_Calibrate.html" class="md-nav__link">
|
|
Probe calibration
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="BLTouch.html" class="md-nav__link">
|
|
BL-Touch
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Manual_Level.html" class="md-nav__link">
|
|
Manual leveling
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Bed_Mesh.html" class="md-nav__link">
|
|
Bed Mesh
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Endstop_Phase.html" class="md-nav__link">
|
|
Endstop phase
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Axis_Twist_Compensation.html" class="md-nav__link">
|
|
Axis Twist Compensation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_5" type="checkbox" id="__nav_7_5" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7_5">
|
|
Resonance Compensation
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Resonance Compensation" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_7_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Resonance Compensation
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Resonance_Compensation.html" class="md-nav__link">
|
|
Resonance Compensation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Measuring_Resonances.html" class="md-nav__link">
|
|
Measuring Resonances
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Pressure_Advance.html" class="md-nav__link">
|
|
Pressure advance
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="G-Codes.html" class="md-nav__link">
|
|
G-Codes
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_8" type="checkbox" id="__nav_7_8" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7_8">
|
|
Command templates
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Command templates" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_7_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Command templates
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Command_Templates.html" class="md-nav__link">
|
|
Commands templates
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
Status reference
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="Status_Reference.html" class="md-nav__link md-nav__link--active">
|
|
Status reference
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#angle" class="md-nav__link">
|
|
angle
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bed_mesh" class="md-nav__link">
|
|
bed_mesh
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bed_screws" class="md-nav__link">
|
|
bed_screws
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#canbus_stats" class="md-nav__link">
|
|
canbus_stats
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#configfile" class="md-nav__link">
|
|
configfile
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#display_status" class="md-nav__link">
|
|
display_status
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#endstop_phase" class="md-nav__link">
|
|
endstop_phase
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#exclude_object" class="md-nav__link">
|
|
exclude_object
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#extruder_stepper" class="md-nav__link">
|
|
extruder_stepper
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#fan" class="md-nav__link">
|
|
fan
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#filament_switch_sensor" class="md-nav__link">
|
|
filament_switch_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#filament_motion_sensor" class="md-nav__link">
|
|
filament_motion_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#firmware_retraction" class="md-nav__link">
|
|
firmware_retraction
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode" class="md-nav__link">
|
|
gcode
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode_button" class="md-nav__link">
|
|
gcode_button
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode_macro" class="md-nav__link">
|
|
gcode_macro
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode_move" class="md-nav__link">
|
|
gcode_move
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#hall_filament_width_sensor" class="md-nav__link">
|
|
hall_filament_width_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#heater" class="md-nav__link">
|
|
heater
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#heaters" class="md-nav__link">
|
|
heaters
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#idle_timeout" class="md-nav__link">
|
|
idle_timeout
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#led" class="md-nav__link">
|
|
led
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#load_cell" class="md-nav__link">
|
|
load_cell
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#load_cell_probe" class="md-nav__link">
|
|
load_cell_probe
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#manual_probe" class="md-nav__link">
|
|
manual_probe
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#mcu" class="md-nav__link">
|
|
mcu
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#motion_report" class="md-nav__link">
|
|
motion_report
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#output_pin" class="md-nav__link">
|
|
output_pin
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#palette2" class="md-nav__link">
|
|
palette2
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pause_resume" class="md-nav__link">
|
|
pause_resume
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#print_stats" class="md-nav__link">
|
|
print_stats
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#probe" class="md-nav__link">
|
|
probe
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pwm_cycle_time" class="md-nav__link">
|
|
pwm_cycle_time
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#quad_gantry_level" class="md-nav__link">
|
|
quad_gantry_level
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#query_endstops" class="md-nav__link">
|
|
query_endstops
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#screws_tilt_adjust" class="md-nav__link">
|
|
screws_tilt_adjust
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#servo" class="md-nav__link">
|
|
servo
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#skew_correctionpy" class="md-nav__link">
|
|
skew_correction.py
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#stepper_enable" class="md-nav__link">
|
|
stepper_enable
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system_stats" class="md-nav__link">
|
|
system_stats
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#temperature-sensors" class="md-nav__link">
|
|
temperature sensors
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#temperature_fan" class="md-nav__link">
|
|
temperature_fan
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#temperature_sensor" class="md-nav__link">
|
|
temperature_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tmc-drivers" class="md-nav__link">
|
|
tmc drivers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#toolhead" class="md-nav__link">
|
|
toolhead
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#dual_carriage" class="md-nav__link">
|
|
dual_carriage
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#virtual_sdcard" class="md-nav__link">
|
|
virtual_sdcard
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#webhooks" class="md-nav__link">
|
|
webhooks
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#z_thermal_adjust" class="md-nav__link">
|
|
z_thermal_adjust
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#z_tilt" class="md-nav__link">
|
|
z_tilt
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#accessing-coordinates" class="md-nav__link">
|
|
Accessing Coordinates
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="TMC_Drivers.html" class="md-nav__link">
|
|
TMC drivers
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Multi_MCU_Homing.html" class="md-nav__link">
|
|
Multiple Micro-controller Homing and Probing
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Slicers.html" class="md-nav__link">
|
|
Slicers
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Skew_Correction.html" class="md-nav__link">
|
|
Skew correction
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Exclude_Object.html" class="md-nav__link">
|
|
Exclude Objects
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Using_PWM_Tools.html" class="md-nav__link">
|
|
Using PWM tools
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_8">
|
|
Developer Documentation
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Developer Documentation" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Developer Documentation
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Code_Overview.html" class="md-nav__link">
|
|
Code overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Kinematics.html" class="md-nav__link">
|
|
Kinematics
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Protocol.html" class="md-nav__link">
|
|
Protocol
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="API_Server.html" class="md-nav__link">
|
|
API server
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="MCU_Commands.html" class="md-nav__link">
|
|
MCU commands
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="CANBUS_protocol.html" class="md-nav__link">
|
|
CANBUS protocol
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Debugging.html" class="md-nav__link">
|
|
Debugging
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Benchmarks.html" class="md-nav__link">
|
|
Benchmarks
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="CONTRIBUTING.html" class="md-nav__link">
|
|
Contributing to Klipper
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Packaging.html" class="md-nav__link">
|
|
Packaging Klipper
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_9">
|
|
Device Specific Documents
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Device Specific Documents" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_9">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Device Specific Documents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Example_Configs.html" class="md-nav__link">
|
|
Example configurations
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="SDCard_Updates.html" class="md-nav__link">
|
|
SDCard updates
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="RPi_microcontroller.html" class="md-nav__link">
|
|
RPi microcontroller
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Beaglebone.html" class="md-nav__link">
|
|
Beaglebone
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Bootloaders.html" class="md-nav__link">
|
|
Bootloaders
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Bootloader_Entry.html" class="md-nav__link">
|
|
Bootloader Entry
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="CANBUS.html" class="md-nav__link">
|
|
CANBUS
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="CANBUS_Troubleshooting.html" class="md-nav__link">
|
|
CANBUS Troubleshooting
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="TSL1401CL_Filament_Width_Sensor.html" class="md-nav__link">
|
|
TSL1401CL filament width sensor
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Hall_Filament_Width_Sensor.html" class="md-nav__link">
|
|
Hall filament width sensor
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Eddy_Probe.html" class="md-nav__link">
|
|
Eddy Current Inductive probe
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Load_Cell.html" class="md-nav__link">
|
|
Load Cells
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="Sponsors.html" class="md-nav__link">
|
|
Sponsors
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#angle" class="md-nav__link">
|
|
angle
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bed_mesh" class="md-nav__link">
|
|
bed_mesh
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bed_screws" class="md-nav__link">
|
|
bed_screws
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#canbus_stats" class="md-nav__link">
|
|
canbus_stats
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#configfile" class="md-nav__link">
|
|
configfile
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#display_status" class="md-nav__link">
|
|
display_status
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#endstop_phase" class="md-nav__link">
|
|
endstop_phase
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#exclude_object" class="md-nav__link">
|
|
exclude_object
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#extruder_stepper" class="md-nav__link">
|
|
extruder_stepper
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#fan" class="md-nav__link">
|
|
fan
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#filament_switch_sensor" class="md-nav__link">
|
|
filament_switch_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#filament_motion_sensor" class="md-nav__link">
|
|
filament_motion_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#firmware_retraction" class="md-nav__link">
|
|
firmware_retraction
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode" class="md-nav__link">
|
|
gcode
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode_button" class="md-nav__link">
|
|
gcode_button
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode_macro" class="md-nav__link">
|
|
gcode_macro
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gcode_move" class="md-nav__link">
|
|
gcode_move
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#hall_filament_width_sensor" class="md-nav__link">
|
|
hall_filament_width_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#heater" class="md-nav__link">
|
|
heater
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#heaters" class="md-nav__link">
|
|
heaters
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#idle_timeout" class="md-nav__link">
|
|
idle_timeout
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#led" class="md-nav__link">
|
|
led
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#load_cell" class="md-nav__link">
|
|
load_cell
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#load_cell_probe" class="md-nav__link">
|
|
load_cell_probe
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#manual_probe" class="md-nav__link">
|
|
manual_probe
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#mcu" class="md-nav__link">
|
|
mcu
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#motion_report" class="md-nav__link">
|
|
motion_report
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#output_pin" class="md-nav__link">
|
|
output_pin
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#palette2" class="md-nav__link">
|
|
palette2
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pause_resume" class="md-nav__link">
|
|
pause_resume
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#print_stats" class="md-nav__link">
|
|
print_stats
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#probe" class="md-nav__link">
|
|
probe
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#pwm_cycle_time" class="md-nav__link">
|
|
pwm_cycle_time
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#quad_gantry_level" class="md-nav__link">
|
|
quad_gantry_level
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#query_endstops" class="md-nav__link">
|
|
query_endstops
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#screws_tilt_adjust" class="md-nav__link">
|
|
screws_tilt_adjust
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#servo" class="md-nav__link">
|
|
servo
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#skew_correctionpy" class="md-nav__link">
|
|
skew_correction.py
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#stepper_enable" class="md-nav__link">
|
|
stepper_enable
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system_stats" class="md-nav__link">
|
|
system_stats
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#temperature-sensors" class="md-nav__link">
|
|
temperature sensors
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#temperature_fan" class="md-nav__link">
|
|
temperature_fan
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#temperature_sensor" class="md-nav__link">
|
|
temperature_sensor
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tmc-drivers" class="md-nav__link">
|
|
tmc drivers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#toolhead" class="md-nav__link">
|
|
toolhead
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#dual_carriage" class="md-nav__link">
|
|
dual_carriage
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#virtual_sdcard" class="md-nav__link">
|
|
virtual_sdcard
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#webhooks" class="md-nav__link">
|
|
webhooks
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#z_thermal_adjust" class="md-nav__link">
|
|
z_thermal_adjust
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#z_tilt" class="md-nav__link">
|
|
z_tilt
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#accessing-coordinates" class="md-nav__link">
|
|
Accessing Coordinates
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
<a href="https://github.com/Klipper3d/klipper/blob/master/docs/Status_Reference.md" title="Edit this page" class="md-content__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
|
|
</a>
|
|
|
|
|
|
<h1 id="status-reference">Status reference<a class="headerlink" href="#status-reference" title="Permanent link">¶</a></h1>
|
|
<p>This document is a reference of printer status information available
|
|
in Klipper <a href="Command_Templates.html">macros</a>,
|
|
<a href="Config_Reference.html#display">display fields</a>, and via the
|
|
<a href="API_Server.html">API Server</a>.</p>
|
|
<p>The fields in this document are subject to change - if using an
|
|
attribute be sure to review the
|
|
<a href="Config_Changes.html">Config Changes document</a> when upgrading the
|
|
Klipper software.</p>
|
|
<h2 id="angle">angle<a class="headerlink" href="#angle" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#angle">angle some_name</a> objects:</p>
|
|
<ul>
|
|
<li><code>temperature</code>: The last temperature reading (in Celsius) from a
|
|
tle5012b magnetic hall sensor. This value is only available if the
|
|
angle sensor is a tle5012b chip and if measurements are in progress
|
|
(otherwise it reports <code>None</code>).</li>
|
|
</ul>
|
|
<h2 id="bed_mesh">bed_mesh<a class="headerlink" href="#bed_mesh" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#bed_mesh">bed_mesh</a> object:</p>
|
|
<ul>
|
|
<li><code>profile_name</code>, <code>mesh_min</code>, <code>mesh_max</code>, <code>probed_matrix</code>,
|
|
<code>mesh_matrix</code>: Information on the currently active bed_mesh.</li>
|
|
<li><code>profiles</code>: The set of currently defined profiles as setup
|
|
using BED_MESH_PROFILE.</li>
|
|
</ul>
|
|
<h2 id="bed_screws">bed_screws<a class="headerlink" href="#bed_screws" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#bed_screws">bed_screws</a> object:</p>
|
|
<ul>
|
|
<li><code>is_active</code>: Returns True if the bed screws adjustment tool is currently
|
|
active.</li>
|
|
<li><code>state</code>: The bed screws adjustment tool state. It is one of
|
|
the following strings: "adjust", "fine".</li>
|
|
<li><code>current_screw</code>: The index for the current screw being adjusted.</li>
|
|
<li><code>accepted_screws</code>: The number of accepted screws.</li>
|
|
</ul>
|
|
<h2 id="canbus_stats">canbus_stats<a class="headerlink" href="#canbus_stats" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>canbus_stats
|
|
some_mcu_name</code> object (this object is automatically available if an
|
|
mcu is configured to use canbus):</p>
|
|
<ul>
|
|
<li><code>rx_error</code>: The number of receive errors detected by the
|
|
micro-controller canbus hardware.</li>
|
|
<li><code>tx_error</code>: The number of transmit errors detected by the
|
|
micro-controller canbus hardware.</li>
|
|
<li><code>tx_retries</code>: The number of transmit attempts that were retried due
|
|
to bus contention or errors.</li>
|
|
<li><code>bus_state</code>: The status of the interface (typically "active" for a
|
|
bus in normal operation, "warn" for a bus with recent errors,
|
|
"passive" for a bus that will no longer transmit canbus error
|
|
frames, or "off" for a bus that will no longer transmit or receive
|
|
messages).</li>
|
|
</ul>
|
|
<p>Note that only the rp2XXX micro-controllers report a non-zero
|
|
<code>tx_retries</code> field and the rp2XXX micro-controllers always report
|
|
<code>tx_error</code> as zero and <code>bus_state</code> as "active".</p>
|
|
<h2 id="configfile">configfile<a class="headerlink" href="#configfile" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>configfile</code> object
|
|
(this object is always available):</p>
|
|
<ul>
|
|
<li><code>settings.<section>.<option></code>: Returns the given config file setting
|
|
(or default value) during the last software start or restart. (Any
|
|
settings changed at run-time will not be reflected here.)</li>
|
|
<li><code>config.<section>.<option></code>: Returns the given raw config file
|
|
setting as read by Klipper during the last software start or
|
|
restart. (Any settings changed at run-time will not be reflected
|
|
here.) All values are returned as strings.</li>
|
|
<li><code>save_config_pending</code>: Returns true if there are updates that a
|
|
<code>SAVE_CONFIG</code> command may persist to disk.</li>
|
|
<li><code>save_config_pending_items</code>: Contains the sections and options that
|
|
were changed and would be persisted by a <code>SAVE_CONFIG</code>.</li>
|
|
<li><code>warnings</code>: A list of warnings about config options. Each entry in
|
|
the list will be a dictionary containing a <code>type</code> and <code>message</code>
|
|
field (both strings). Additional fields may be available depending
|
|
on the type of warning.</li>
|
|
</ul>
|
|
<h2 id="display_status">display_status<a class="headerlink" href="#display_status" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>display_status</code> object
|
|
(this object is automatically available if a
|
|
<a href="Config_Reference.html#display">display</a> config section is defined):</p>
|
|
<ul>
|
|
<li><code>progress</code>: The progress value of the last <code>M73</code> G-Code command (or
|
|
<code>virtual_sdcard.progress</code> if no recent <code>M73</code> received).</li>
|
|
<li><code>message</code>: The message contained in the last <code>M117</code> G-Code command.</li>
|
|
</ul>
|
|
<h2 id="endstop_phase">endstop_phase<a class="headerlink" href="#endstop_phase" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#endstop_phase">endstop_phase</a> object:</p>
|
|
<ul>
|
|
<li><code>last_home.<stepper name>.phase</code>: The phase of the stepper motor at
|
|
the end of the last home attempt.</li>
|
|
<li><code>last_home.<stepper name>.phases</code>: The total number of phases
|
|
available on the stepper motor.</li>
|
|
<li><code>last_home.<stepper name>.mcu_position</code>: The position (as tracked by
|
|
the micro-controller) of the stepper motor at the end of the last
|
|
home attempt. The position is the total number of steps taken in a
|
|
forward direction minus the total number of steps taken in the
|
|
reverse direction since the micro-controller was last restarted.</li>
|
|
</ul>
|
|
<h2 id="exclude_object">exclude_object<a class="headerlink" href="#exclude_object" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Exclude_Object.html">exclude_object</a> object:</p>
|
|
<ul>
|
|
<li>
|
|
<p><code>objects</code>: An array of the known objects as provided by the
|
|
<code>EXCLUDE_OBJECT_DEFINE</code> command. This is the same information provided by
|
|
the <code>EXCLUDE_OBJECT VERBOSE=1</code> command. The <code>center</code> and <code>polygon</code> fields will
|
|
only be present if provided in the original <code>EXCLUDE_OBJECT_DEFINE</code></p>
|
|
<p>Here is a JSON sample:</p>
|
|
</li>
|
|
</ul>
|
|
<div class="highlight"><pre><span></span><code>[
|
|
{
|
|
"polygon": [
|
|
[ 156.25, 146.2511675 ],
|
|
[ 156.25, 153.7488325 ],
|
|
[ 163.75, 153.7488325 ],
|
|
[ 163.75, 146.2511675 ]
|
|
],
|
|
"name": "CYLINDER_2_STL_ID_2_COPY_0",
|
|
"center": [ 160, 150 ]
|
|
},
|
|
{
|
|
"polygon": [
|
|
[ 146.25, 146.2511675 ],
|
|
[ 146.25, 153.7488325 ],
|
|
[ 153.75, 153.7488325 ],
|
|
[ 153.75, 146.2511675 ]
|
|
],
|
|
"name": "CYLINDER_2_STL_ID_1_COPY_0",
|
|
"center": [ 150, 150 ]
|
|
}
|
|
]
|
|
</code></pre></div>
|
|
|
|
<ul>
|
|
<li><code>excluded_objects</code>: An array of strings listing the names of excluded objects.</li>
|
|
<li><code>current_object</code>: The name of the object currently being printed.</li>
|
|
</ul>
|
|
<h2 id="extruder_stepper">extruder_stepper<a class="headerlink" href="#extruder_stepper" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available for extruder_stepper objects (as well as
|
|
<a href="Config_Reference.html#extruder">extruder</a> objects):</p>
|
|
<ul>
|
|
<li><code>pressure_advance</code>: The current <a href="Pressure_Advance.html">pressure advance</a> value.</li>
|
|
<li><code>smooth_time</code>: The current pressure advance smooth time.</li>
|
|
<li><code>motion_queue</code>: The name of the extruder that this extruder stepper is
|
|
currently synchronized to. This is reported as <code>None</code> if the extruder stepper
|
|
is not currently associated with an extruder.</li>
|
|
</ul>
|
|
<h2 id="fan">fan<a class="headerlink" href="#fan" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#fan">fan</a>,
|
|
<a href="Config_Reference.html#heater_fan">heater_fan some_name</a> and
|
|
<a href="Config_Reference.html#controller_fan">controller_fan some_name</a>
|
|
objects:</p>
|
|
<ul>
|
|
<li><code>speed</code>: The fan speed as a float between 0.0 and 1.0.</li>
|
|
<li><code>rpm</code>: The measured fan speed in rotations per minute if the fan has
|
|
a tachometer_pin defined.</li>
|
|
</ul>
|
|
<h2 id="filament_switch_sensor">filament_switch_sensor<a class="headerlink" href="#filament_switch_sensor" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#filament_switch_sensor">filament_switch_sensor some_name</a>
|
|
objects:</p>
|
|
<ul>
|
|
<li><code>enabled</code>: Returns True if the switch sensor is currently enabled.</li>
|
|
<li><code>filament_detected</code>: Returns True if the sensor is in a triggered
|
|
state.</li>
|
|
</ul>
|
|
<h2 id="filament_motion_sensor">filament_motion_sensor<a class="headerlink" href="#filament_motion_sensor" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#filament_motion_sensor">filament_motion_sensor some_name</a>
|
|
objects:</p>
|
|
<ul>
|
|
<li><code>enabled</code>: Returns True if the motion sensor is currently enabled.</li>
|
|
<li><code>filament_detected</code>: Returns True if the sensor is in a triggered
|
|
state.</li>
|
|
</ul>
|
|
<h2 id="firmware_retraction">firmware_retraction<a class="headerlink" href="#firmware_retraction" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#firmware_retraction">firmware_retraction</a> object:</p>
|
|
<ul>
|
|
<li><code>retract_length</code>, <code>retract_speed</code>, <code>unretract_extra_length</code>,
|
|
<code>unretract_speed</code>: The current settings for the firmware_retraction
|
|
module. These settings may differ from the config file if a
|
|
<code>SET_RETRACTION</code> command alters them.</li>
|
|
</ul>
|
|
<h2 id="gcode">gcode<a class="headerlink" href="#gcode" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>gcode</code> object:</p>
|
|
<ul>
|
|
<li><code>commands</code>: Returns a list of all currently available commands. For each
|
|
command, if a help string is defined it will also be provided.</li>
|
|
</ul>
|
|
<h2 id="gcode_button">gcode_button<a class="headerlink" href="#gcode_button" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#gcode_button">gcode_button some_name</a> objects:</p>
|
|
<ul>
|
|
<li><code>state</code>: The current button state returned as "PRESSED" or "RELEASED"</li>
|
|
</ul>
|
|
<h2 id="gcode_macro">gcode_macro<a class="headerlink" href="#gcode_macro" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#gcode_macro">gcode_macro some_name</a> objects:</p>
|
|
<ul>
|
|
<li><code><variable></code>: The current value of a
|
|
<a href="Command_Templates.html#variables">gcode_macro variable</a>.</li>
|
|
</ul>
|
|
<h2 id="gcode_move">gcode_move<a class="headerlink" href="#gcode_move" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>gcode_move</code> object
|
|
(this object is always available):</p>
|
|
<ul>
|
|
<li><code>gcode_position</code>: The current position of the toolhead relative to
|
|
the current G-Code origin. That is, positions that one might
|
|
directly send to a <code>G1</code> command. This value is encoded as a
|
|
<a href="#accessing-coordinates">coordinate</a>.</li>
|
|
<li><code>position</code>: The last commanded position of the toolhead using the
|
|
coordinate system specified in the config file. This value is
|
|
encoded as a <a href="#accessing-coordinates">coordinate</a>.</li>
|
|
<li><code>homing_origin</code>: The origin of the gcode coordinate system (relative
|
|
to the coordinate system specified in the config file) to use after
|
|
a <code>G28</code> command. The <code>SET_GCODE_OFFSET</code> command can alter this
|
|
position. This value is encoded as a
|
|
<a href="#accessing-coordinates">coordinate</a>.</li>
|
|
<li><code>speed</code>: The last speed set in a <code>G1</code> command (in mm/s).</li>
|
|
<li><code>speed_factor</code>: The "speed factor override" as set by an <code>M220</code>
|
|
command. This is a floating point value such that 1.0 means no
|
|
override and, for example, 2.0 would double requested speed.</li>
|
|
<li><code>extrude_factor</code>: The "extrude factor override" as set by an <code>M221</code>
|
|
command. This is a floating point value such that 1.0 means no
|
|
override and, for example, 2.0 would double requested extrusions.</li>
|
|
<li><code>absolute_coordinates</code>: This returns True if in <code>G90</code> absolute
|
|
coordinate mode or False if in <code>G91</code> relative mode.</li>
|
|
<li><code>absolute_extrude</code>: This returns True if in <code>M82</code> absolute extrude
|
|
mode or False if in <code>M83</code> relative mode.</li>
|
|
<li><code>axis_map</code>: Provides a mechanism for finding the coordinate
|
|
component for a given G-Code id that is used in <code>G1</code> commands. See
|
|
the <a href="#accessing-coordinates">Accessing Coordinates</a> section for
|
|
details.</li>
|
|
</ul>
|
|
<h2 id="hall_filament_width_sensor">hall_filament_width_sensor<a class="headerlink" href="#hall_filament_width_sensor" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#hall_filament_width_sensor">hall_filament_width_sensor</a>
|
|
object:</p>
|
|
<ul>
|
|
<li>all items from
|
|
<a href="Status_Reference.html#filament_switch_sensor">filament_switch_sensor</a></li>
|
|
<li><code>is_active</code>: Returns True if the sensor is currently active.</li>
|
|
<li><code>Diameter</code>: The last reading from the sensor in mm.</li>
|
|
<li><code>Raw</code>: The last raw ADC reading from the sensor.</li>
|
|
</ul>
|
|
<h2 id="heater">heater<a class="headerlink" href="#heater" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available for heater objects such as
|
|
<a href="Config_Reference.html#extruder">extruder</a>,
|
|
<a href="Config_Reference.html#heater_bed">heater_bed</a>, and
|
|
<a href="Config_Reference.html#heater_generic">heater_generic</a>:</p>
|
|
<ul>
|
|
<li><code>temperature</code>: The last reported temperature (in Celsius as a float)
|
|
for the given heater.</li>
|
|
<li><code>target</code>: The current target temperature (in Celsius as a float) for
|
|
the given heater.</li>
|
|
<li><code>power</code>: The last setting of the PWM pin (a value between 0.0 and
|
|
1.0) associated with the heater.</li>
|
|
<li><code>can_extrude</code>: If extruder can extrude (defined by <code>min_extrude_temp</code>),
|
|
available only for <a href="Config_Reference.html#extruder">extruder</a></li>
|
|
</ul>
|
|
<h2 id="heaters">heaters<a class="headerlink" href="#heaters" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>heaters</code> object (this
|
|
object is available if any heater is defined):</p>
|
|
<ul>
|
|
<li><code>available_heaters</code>: Returns a list of all currently available
|
|
heaters by their full config section names, e.g. <code>["extruder",
|
|
"heater_bed", "heater_generic my_custom_heater"]</code>.</li>
|
|
<li><code>available_sensors</code>: Returns a list of all currently available
|
|
temperature sensors by their full config section names,
|
|
e.g. <code>["extruder", "heater_bed", "heater_generic my_custom_heater",
|
|
"temperature_sensor electronics_temp"]</code>.</li>
|
|
<li><code>available_monitors</code>: Returns a list of all currently available
|
|
temperature monitors by their full config section names,
|
|
e.g. <code>["tmc2240 stepper_x"]</code>. While a temperature sensor is always
|
|
available to read, a temperature monitor may not be available and
|
|
will return null in such case.</li>
|
|
</ul>
|
|
<h2 id="idle_timeout">idle_timeout<a class="headerlink" href="#idle_timeout" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#idle_timeout">idle_timeout</a> object (this object
|
|
is always available):</p>
|
|
<ul>
|
|
<li><code>state</code>: The current state of the printer as tracked by the
|
|
idle_timeout module. It is one of the following strings: "Idle",
|
|
"Printing", "Ready".</li>
|
|
<li><code>printing_time</code>: The amount of time (in seconds) the printer has
|
|
been in the "Printing" state (as tracked by the idle_timeout
|
|
module).</li>
|
|
<li><code>idle_timeout</code>: The current 'timeout' (in seconds)
|
|
to wait for the gcode to be triggered.
|
|
(as set by <a href="G-Codes.html#set_idle_timeout">SET_IDLE_TIMEOUT</a>)</li>
|
|
</ul>
|
|
<h2 id="led">led<a class="headerlink" href="#led" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available for each <code>[led led_name]</code>,
|
|
<code>[neopixel led_name]</code>, <code>[dotstar led_name]</code>, <code>[pca9533 led_name]</code>, and
|
|
<code>[pca9632 led_name]</code> config section defined in printer.cfg:</p>
|
|
<ul>
|
|
<li><code>color_data</code>: A list of color lists containing the RGBW values for a
|
|
led in the chain. Each value is represented as a float from 0.0 to
|
|
1.0. Each color list contains 4 items (red, green, blue, white) even
|
|
if the underlying LED supports fewer color channels. For example,
|
|
the blue value (3rd item in color list) of the second neopixel in a
|
|
chain could be accessed at
|
|
<code>printer["neopixel <config_name>"].color_data[1][2]</code>.</li>
|
|
</ul>
|
|
<h2 id="load_cell">load_cell<a class="headerlink" href="#load_cell" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available for each <code>[load_cell name]</code>:</p>
|
|
<ul>
|
|
<li>'is_calibrated': True/False is the load cell calibrated</li>
|
|
<li>'counts_per_gram': The number of raw sensor counts that equals 1 gram of force</li>
|
|
<li>'reference_tare_counts': The reference number of raw sensor counts for 0 force</li>
|
|
<li>'tare_counts': The current number of raw sensor counts for 0 force</li>
|
|
<li>'force_g': The force in grams, averaged over the last polling period.</li>
|
|
<li>'min_force_g': The minimum force in grams, over the last polling period.</li>
|
|
<li>'max_force_g': The maximum force in grams, over the last polling period.</li>
|
|
</ul>
|
|
<h2 id="load_cell_probe">load_cell_probe<a class="headerlink" href="#load_cell_probe" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available for <code>[load_cell_probe]</code>:</p>
|
|
<ul>
|
|
<li>all items from <a href="Status_Reference.html#load_cell">load_cell</a></li>
|
|
<li>all items from <a href="Status_Reference.html#probe">probe</a></li>
|
|
<li>'endstop_tare_counts': the load cell probe keeps a tare value independent of
|
|
the load cell. This re-set at the start of each probe.</li>
|
|
<li>'last_trigger_time': timestamp of the last homing trigger</li>
|
|
</ul>
|
|
<h2 id="manual_probe">manual_probe<a class="headerlink" href="#manual_probe" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<code>manual_probe</code> object:</p>
|
|
<ul>
|
|
<li><code>is_active</code>: Returns True if a manual probing helper script is currently
|
|
active.</li>
|
|
<li><code>z_position</code>: The current height of the nozzle (as the printer currently
|
|
understands it).</li>
|
|
<li><code>z_position_lower</code>: Last probe attempt just lower than the current height.</li>
|
|
<li><code>z_position_upper</code>: Last probe attempt just greater than the current height.</li>
|
|
</ul>
|
|
<h2 id="mcu">mcu<a class="headerlink" href="#mcu" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#mcu">mcu</a> and
|
|
<a href="Config_Reference.html#mcu-my_extra_mcu">mcu some_name</a> objects:</p>
|
|
<ul>
|
|
<li><code>mcu_version</code>: The Klipper code version reported by the
|
|
micro-controller.</li>
|
|
<li><code>mcu_build_versions</code>: Information on the build tools used to
|
|
generate the micro-controller code (as reported by the
|
|
micro-controller).</li>
|
|
<li><code>mcu_constants.<constant_name></code>: Compile time constants reported by
|
|
the micro-controller. The available constants may differ between
|
|
micro-controller architectures and with each code revision.</li>
|
|
<li><code>last_stats.<statistics_name></code>: Statistics information on the
|
|
micro-controller connection.</li>
|
|
</ul>
|
|
<h2 id="motion_report">motion_report<a class="headerlink" href="#motion_report" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>motion_report</code> object
|
|
(this object is automatically available if any stepper config section
|
|
is defined):</p>
|
|
<ul>
|
|
<li><code>live_position</code>: The requested toolhead position interpolated to the
|
|
current time. This value is encoded as a
|
|
<a href="#accessing-coordinates">coordinate</a>.</li>
|
|
<li><code>live_velocity</code>: The requested toolhead velocity (in mm/s) at the
|
|
current time.</li>
|
|
<li><code>live_extruder_velocity</code>: The requested extruder velocity (in mm/s)
|
|
at the current time.</li>
|
|
</ul>
|
|
<h2 id="output_pin">output_pin<a class="headerlink" href="#output_pin" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#output_pin">output_pin some_name</a> and
|
|
<a href="Config_Reference.html#pwm_tool">pwm_tool some_name</a> objects:</p>
|
|
<ul>
|
|
<li><code>value</code>: The "value" of the pin, as set by a <code>SET_PIN</code> command.</li>
|
|
</ul>
|
|
<h2 id="palette2">palette2<a class="headerlink" href="#palette2" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#palette2">palette2</a> object:</p>
|
|
<ul>
|
|
<li><code>ping</code>: Amount of the last reported Palette 2 ping in percent.</li>
|
|
<li><code>remaining_load_length</code>: When starting a Palette 2 print, this will
|
|
be the amount of filament to load into the extruder.</li>
|
|
<li><code>is_splicing</code>: True when the Palette 2 is splicing filament.</li>
|
|
</ul>
|
|
<h2 id="pause_resume">pause_resume<a class="headerlink" href="#pause_resume" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#pause_resume">pause_resume</a> object:</p>
|
|
<ul>
|
|
<li><code>is_paused</code>: Returns true if a PAUSE command has been executed
|
|
without a corresponding RESUME.</li>
|
|
</ul>
|
|
<h2 id="print_stats">print_stats<a class="headerlink" href="#print_stats" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>print_stats</code> object
|
|
(this object is automatically available if a
|
|
<a href="Config_Reference.html#virtual_sdcard">virtual_sdcard</a> config section is
|
|
defined):</p>
|
|
<ul>
|
|
<li><code>filename</code>, <code>total_duration</code>, <code>print_duration</code>, <code>filament_used</code>,
|
|
<code>state</code>, <code>message</code>: Estimated information about the current print when a
|
|
virtual_sdcard print is active.</li>
|
|
<li><code>info.total_layer</code>: The total layer value of the last <code>SET_PRINT_STATS_INFO
|
|
TOTAL_LAYER=<value></code> G-Code command.</li>
|
|
<li><code>info.current_layer</code>: The current layer value of the last
|
|
<code>SET_PRINT_STATS_INFO CURRENT_LAYER=<value></code> G-Code command.</li>
|
|
</ul>
|
|
<h2 id="probe">probe<a class="headerlink" href="#probe" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#probe">probe</a> object (this object is also
|
|
available if a <a href="Config_Reference.html#bltouch">bltouch</a> config section
|
|
is defined):</p>
|
|
<ul>
|
|
<li><code>name</code>: Returns the name of the probe in use.</li>
|
|
<li><code>last_query</code>: Returns True if the probe was reported as "triggered"
|
|
during the last QUERY_PROBE command. Note, if this is used in a
|
|
macro, due to the order of template expansion, the QUERY_PROBE
|
|
command must be run prior to the macro containing this reference.</li>
|
|
<li><code>last_z_result</code>: Returns the Z result value of the last PROBE
|
|
command. Note, if this is used in a macro, due to the order of
|
|
template expansion, the PROBE (or similar) command must be run prior
|
|
to the macro containing this reference.</li>
|
|
</ul>
|
|
<h2 id="pwm_cycle_time">pwm_cycle_time<a class="headerlink" href="#pwm_cycle_time" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#pwm_cycle_time">pwm_cycle_time some_name</a>
|
|
objects:</p>
|
|
<ul>
|
|
<li><code>value</code>: The "value" of the pin, as set by a <code>SET_PIN</code> command.</li>
|
|
</ul>
|
|
<h2 id="quad_gantry_level">quad_gantry_level<a class="headerlink" href="#quad_gantry_level" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>quad_gantry_level</code> object
|
|
(this object is available if quad_gantry_level is defined):</p>
|
|
<ul>
|
|
<li><code>applied</code>: True if the gantry leveling process has been run and completed
|
|
successfully.</li>
|
|
</ul>
|
|
<h2 id="query_endstops">query_endstops<a class="headerlink" href="#query_endstops" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>query_endstops</code> object
|
|
(this object is available if any endstop is defined):</p>
|
|
<ul>
|
|
<li><code>last_query["<endstop>"]</code>: Returns True if the given endstop was
|
|
reported as "triggered" during the last QUERY_ENDSTOP command. Note,
|
|
if this is used in a macro, due to the order of template expansion,
|
|
the QUERY_ENDSTOP command must be run prior to the macro containing
|
|
this reference.</li>
|
|
</ul>
|
|
<h2 id="screws_tilt_adjust">screws_tilt_adjust<a class="headerlink" href="#screws_tilt_adjust" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>screws_tilt_adjust</code>
|
|
object:</p>
|
|
<ul>
|
|
<li><code>error</code>: Returns True if the most recent <code>SCREWS_TILT_CALCULATE</code>
|
|
command included the <code>MAX_DEVIATION</code> parameter and any of the probed
|
|
screw points exceeded the specified <code>MAX_DEVIATION</code>.</li>
|
|
<li><code>max_deviation</code>: Return the last <code>MAX_DEVIATION</code> value of the most
|
|
recent <code>SCREWS_TILT_CALCULATE</code> command.</li>
|
|
<li><code>results["<screw>"]</code>: A dictionary containing the following keys:<ul>
|
|
<li><code>z</code>: The measured Z height of the screw location.</li>
|
|
<li><code>sign</code>: A string specifying the direction to turn to screw for the
|
|
necessary adjustment. Either "CW" for clockwise or "CCW" for
|
|
counterclockwise.</li>
|
|
<li><code>adjust</code>: The number of screw turns to adjust the screw, given in
|
|
the format "HH:MM," where "HH" is the number of full screw turns
|
|
and "MM" is the number of "minutes of a clock face" representing
|
|
a partial screw turn. (E.g. "01:15" would mean to turn the screw
|
|
one and a quarter revolutions.)</li>
|
|
<li><code>is_base</code>: Returns True if this is the base screw.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h2 id="servo">servo<a class="headerlink" href="#servo" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#servo">servo some_name</a> objects:</p>
|
|
<ul>
|
|
<li><code>printer["servo <config_name>"].value</code>: The last setting of the PWM
|
|
pin (a value between 0.0 and 1.0) associated with the servo.</li>
|
|
</ul>
|
|
<h2 id="skew_correctionpy">skew_correction.py<a class="headerlink" href="#skew_correctionpy" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>skew_correction</code> object (this
|
|
object is available if any skew_correction is defined):</p>
|
|
<ul>
|
|
<li><code>current_profile_name</code>: Returns the name of the currently loaded SKEW_PROFILE.</li>
|
|
</ul>
|
|
<h2 id="stepper_enable">stepper_enable<a class="headerlink" href="#stepper_enable" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>stepper_enable</code> object (this
|
|
object is available if any stepper is defined):</p>
|
|
<ul>
|
|
<li><code>steppers["<stepper>"]</code>: Returns True if the given stepper is enabled.</li>
|
|
</ul>
|
|
<h2 id="system_stats">system_stats<a class="headerlink" href="#system_stats" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>system_stats</code> object
|
|
(this object is always available):</p>
|
|
<ul>
|
|
<li><code>sysload</code>, <code>cputime</code>, <code>memavail</code>: Information on the host operating
|
|
system and process load.</li>
|
|
</ul>
|
|
<h2 id="temperature-sensors">temperature sensors<a class="headerlink" href="#temperature-sensors" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in</p>
|
|
<p><a href="Config_Reference.html#bmp280bme280bme680-temperature-sensor">bme280 config_section_name</a>,
|
|
<a href="Config_Reference.html#htu21d-sensor">htu21d config_section_name</a>,
|
|
<a href="Config_Reference.html#sht31-sensor">sht3x config_section_name</a>,
|
|
<a href="Config_Reference.html#lm75-temperature-sensor">lm75 config_section_name</a>,
|
|
<a href="Config_Reference.html#host-temperature-sensor">temperature_host config_section_name</a>
|
|
and
|
|
<a href="Config_Reference.html#combined-temperature-sensor">temperature_combined config_section_name</a>
|
|
objects:</p>
|
|
<ul>
|
|
<li><code>temperature</code>: The last read temperature from the sensor.</li>
|
|
<li><code>humidity</code>, <code>pressure</code>, <code>gas</code>: The last read values from the sensor
|
|
(only on bme280, htu21d, sht3x and lm75 sensors).</li>
|
|
</ul>
|
|
<h2 id="temperature_fan">temperature_fan<a class="headerlink" href="#temperature_fan" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#temperature_fan">temperature_fan some_name</a>
|
|
objects:</p>
|
|
<ul>
|
|
<li><code>temperature</code>: The last read temperature from the sensor.</li>
|
|
<li><code>target</code>: The target temperature for the fan.</li>
|
|
</ul>
|
|
<h2 id="temperature_sensor">temperature_sensor<a class="headerlink" href="#temperature_sensor" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#temperature_sensor">temperature_sensor some_name</a>
|
|
objects:</p>
|
|
<ul>
|
|
<li><code>temperature</code>: The last read temperature from the sensor.</li>
|
|
<li><code>measured_min_temp</code>, <code>measured_max_temp</code>: The lowest and highest
|
|
temperature seen by the sensor since the Klipper host software was
|
|
last restarted.</li>
|
|
</ul>
|
|
<h2 id="tmc-drivers">tmc drivers<a class="headerlink" href="#tmc-drivers" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#tmc-stepper-driver-configuration">TMC stepper driver</a>
|
|
objects (eg, <code>[tmc2208 stepper_x]</code>):</p>
|
|
<ul>
|
|
<li><code>mcu_phase_offset</code>: The micro-controller stepper position
|
|
corresponding with the driver's "zero" phase. This field may be null
|
|
if the phase offset is not known.</li>
|
|
<li><code>phase_offset_position</code>: The "commanded position" corresponding to
|
|
the driver's "zero" phase. This field may be null if the phase
|
|
offset is not known.</li>
|
|
<li><code>drv_status</code>: The results of the last driver status query. (Only
|
|
non-zero fields are reported.) This field will be null if the driver
|
|
is not enabled (and thus is not periodically queried).</li>
|
|
<li><code>temperature</code>: The internal temperature reported by the driver. This
|
|
field will be null if the driver is not enabled or if the driver
|
|
does not support temperature reporting.</li>
|
|
<li><code>run_current</code>: The currently set run current.</li>
|
|
<li><code>hold_current</code>: The currently set hold current.</li>
|
|
</ul>
|
|
<h2 id="toolhead">toolhead<a class="headerlink" href="#toolhead" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>toolhead</code> object
|
|
(this object is always available):</p>
|
|
<ul>
|
|
<li><code>position</code>: The last commanded position of the toolhead relative to
|
|
the coordinate system specified in the config file. This value is
|
|
encoded as a <a href="#accessing-coordinates">coordinate</a>.</li>
|
|
<li><code>extruder</code>: The name of the currently active extruder. For example,
|
|
in a macro one could use <code>printer[printer.toolhead.extruder].target</code>
|
|
to get the target temperature of the current extruder.</li>
|
|
<li><code>homed_axes</code>: The current cartesian axes considered to be in a
|
|
"homed" state. This is a string containing one or more of "x", "y",
|
|
"z".</li>
|
|
<li><code>axis_minimum</code>, <code>axis_maximum</code>: The axis travel limits (mm) after
|
|
homing. This value is encoded as a
|
|
<a href="#accessing-coordinates">coordinate</a>.</li>
|
|
<li>For Delta printers the <code>cone_start_z</code> is the max z height at
|
|
maximum radius (<code>printer.toolhead.cone_start_z</code>).</li>
|
|
<li><code>max_velocity</code>, <code>max_accel</code>, <code>minimum_cruise_ratio</code>,
|
|
<code>square_corner_velocity</code>: The current printing limits that are in
|
|
effect. This may differ from the config file settings if a
|
|
<code>SET_VELOCITY_LIMIT</code> (or <code>M204</code>) command alters them at run-time.</li>
|
|
<li><code>stalls</code>: The total number of times (since the last restart) that
|
|
the printer had to be paused because the toolhead moved faster than
|
|
moves could be read from the G-Code input.</li>
|
|
<li><code>extra_axes</code>: Provides a mechanism for finding the coordinate
|
|
component for extra axes available in standard <code>G1</code> type move
|
|
commands. See the <a href="#accessing-coordinates">Accessing Coordinates</a>
|
|
section for details.</li>
|
|
</ul>
|
|
<h2 id="dual_carriage">dual_carriage<a class="headerlink" href="#dual_carriage" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in
|
|
<a href="Config_Reference.html#dual_carriage">dual_carriage</a>
|
|
on a cartesian, hybrid_corexy or hybrid_corexz robot</p>
|
|
<ul>
|
|
<li><code>carriage_0</code>: The mode of the carriage 0. Possible values are:
|
|
"INACTIVE" and "PRIMARY".</li>
|
|
<li><code>carriage_1</code>: The mode of the carriage 1. Possible values are:
|
|
"INACTIVE", "PRIMARY", "COPY", and "MIRROR".</li>
|
|
</ul>
|
|
<p>On a <code>generic_cartesian</code> kinematic, the following information is
|
|
available in <code>dual_carriage</code>:</p>
|
|
<ul>
|
|
<li><code>carriages["<carriage>"]</code>: The mode of the carriage <code><carriage></code>. Possible
|
|
values are "INACTIVE" and "PRIMARY" for the primary carriage and "INACTIVE",
|
|
"PRIMARY", "COPY", and "MIRROR" for the dual carriage.</li>
|
|
</ul>
|
|
<h2 id="virtual_sdcard">virtual_sdcard<a class="headerlink" href="#virtual_sdcard" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the
|
|
<a href="Config_Reference.html#virtual_sdcard">virtual_sdcard</a> object:</p>
|
|
<ul>
|
|
<li><code>is_active</code>: Returns True if a print from file is currently active.</li>
|
|
<li><code>progress</code>: An estimate of the current print progress (based of file
|
|
size and file position).</li>
|
|
<li><code>file_path</code>: A full path to the file of currently loaded file.</li>
|
|
<li><code>file_position</code>: The current position (in bytes) of an active print.</li>
|
|
<li><code>file_size</code>: The file size (in bytes) of currently loaded file.</li>
|
|
</ul>
|
|
<h2 id="webhooks">webhooks<a class="headerlink" href="#webhooks" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>webhooks</code> object (this
|
|
object is always available):</p>
|
|
<ul>
|
|
<li><code>state</code>: Returns a string indicating the current Klipper
|
|
state. Possible values are: "ready", "startup", "shutdown", "error".</li>
|
|
<li><code>state_message</code>: A human readable string giving additional context
|
|
on the current Klipper state.</li>
|
|
</ul>
|
|
<h2 id="z_thermal_adjust">z_thermal_adjust<a class="headerlink" href="#z_thermal_adjust" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>z_thermal_adjust</code> object (this
|
|
object is available if <a href="Config_Reference.html#z_thermal_adjust">z_thermal_adjust</a>
|
|
is defined).</p>
|
|
<ul>
|
|
<li><code>enabled</code>: Returns True if adjustment is enabled.</li>
|
|
<li><code>temperature</code>: Current (smoothed) temperature of the defined sensor. [degC]</li>
|
|
<li><code>measured_min_temp</code>: Minimum measured temperature. [degC]</li>
|
|
<li><code>measured_max_temp</code>: Maximum measured temperature. [degC]</li>
|
|
<li><code>current_z_adjust</code>: Last computed Z adjustment [mm].</li>
|
|
<li><code>z_adjust_ref_temperature</code>: Current reference temperature used for calculation
|
|
of Z <code>current_z_adjust</code> [degC].</li>
|
|
</ul>
|
|
<h2 id="z_tilt">z_tilt<a class="headerlink" href="#z_tilt" title="Permanent link">¶</a></h2>
|
|
<p>The following information is available in the <code>z_tilt</code> object (this
|
|
object is available if z_tilt is defined):</p>
|
|
<ul>
|
|
<li><code>applied</code>: True if the z-tilt leveling process has been run and completed
|
|
successfully.</li>
|
|
</ul>
|
|
<h2 id="accessing-coordinates">Accessing Coordinates<a class="headerlink" href="#accessing-coordinates" title="Permanent link">¶</a></h2>
|
|
<p>Some status fields provide a "coordinate". For macro users these
|
|
fields may be accessed by component name
|
|
(eg,<code>{printer.toolhead.position.x}</code>), where the component name may be
|
|
"x", "y", or "z".</p>
|
|
<p>For developers using the Klipper API Server these fields are
|
|
transmitted as a list - for example: <code>{"toolhead": {"position": [1.0,
|
|
2.0, 3.0, 7.3, 19.2]}}</code> . The first three components of the list
|
|
correspond with the x, y, and z axes.</p>
|
|
<p>A coordinate will typically have at least 3 components (x, y, and z),
|
|
however there may also be additional components. Care should be taken
|
|
when accessing any of these additional components as the ordering and
|
|
number of components may change at run-time.</p>
|
|
<p>One may use <code>{printer.gcode_move.axis_map}</code> and/or
|
|
<code>{printer.toolhead.extra_axes}</code> to determine the number of components
|
|
and the ordering of components. For example, to access the "E"
|
|
component one could use
|
|
<code>{printer.toolhead.position[printer.gcode_move.axis_map.E]}</code>. Or, if
|
|
one wanted to find the component associated with the "extruder"
|
|
object, one could use
|
|
<code>{printer.toolhead.position[printer.toolhead.extra_axes.extruder]}</code>.</p>
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
|
|
<a href="#" class="md-top md-icon" data-md-component="top" data-md-state="hidden">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg>
|
|
Back to top
|
|
</a>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer">
|
|
|
|
|
|
<a href="Command_Templates.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Commands templates" rel="prev">
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
Commands templates
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="TMC_Drivers.html" class="md-footer__link md-footer__link--next" aria-label="Next: TMC drivers" rel="next">
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
TMC drivers
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.top", "search.suggest", "search.highlight", "search.share"], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.0bbba5b5.min.js"}</script>
|
|
|
|
|
|
<script src="assets/javascripts/bundle.e1a181d9.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |