Deploying to gh-pages from @ Klipper3d/klipper@14a83103c3 🚀

This commit is contained in:
KevinOConnor
2024-09-06 00:04:39 +00:00
parent 6478486f2c
commit 6d8124a0cc
303 changed files with 23968 additions and 2228 deletions

View File

@@ -449,8 +449,8 @@
<li class="md-nav__item">
<a href="OctoPrint.md" class="md-nav__link">
None
<a href="OctoPrint.html" class="md-nav__link">
OctoPrint for Klipper
</a>
</li>
@@ -1174,6 +1174,20 @@
angle/dump_angle
</a>
</li>
<li class="md-nav__item">
<a href="#hx71xdump_hx71x" class="md-nav__link">
hx71x/dump_hx71x
</a>
</li>
<li class="md-nav__item">
<a href="#ads1220dump_ads1220" class="md-nav__link">
ads1220/dump_ads1220
</a>
</li>
<li class="md-nav__item">
@@ -1202,6 +1216,13 @@
query_endstops/status
</a>
</li>
<li class="md-nav__item">
<a href="#bed_meshdump_mesh" class="md-nav__link">
bed_mesh/dump_mesh
</a>
</li>
</ul>
@@ -1482,8 +1503,8 @@
<li class="md-nav__item">
<a href="Eddy_Probe.md" class="md-nav__link">
None
<a href="Eddy_Probe.html" class="md-nav__link">
Eddy Current Inductive probe
</a>
</li>
@@ -1676,6 +1697,20 @@
angle/dump_angle
</a>
</li>
<li class="md-nav__item">
<a href="#hx71xdump_hx71x" class="md-nav__link">
hx71x/dump_hx71x
</a>
</li>
<li class="md-nav__item">
<a href="#ads1220dump_ads1220" class="md-nav__link">
ads1220/dump_ads1220
</a>
</li>
<li class="md-nav__item">
@@ -1704,6 +1739,13 @@
query_endstops/status
</a>
</li>
<li class="md-nav__item">
<a href="#bed_meshdump_mesh" class="md-nav__link">
bed_mesh/dump_mesh
</a>
</li>
</ul>
@@ -1825,6 +1867,12 @@ gcode:
<p>Ce point de terminaison est utilisé pour s'abonner aux <a href="Config_Reference.html#angle">données du capteur d'angle</a>. L'obtention de ces mises à jour de mouvement de bas niveau peut être utile à des fins de diagnostic et de débogage. L'utilisation de ce point de terminaison peut augmenter la charge système de Klipper.</p>
<p>Une requête peut ressembler à : <code>{"id": 123, "method":"angle/dump_angle", "params": {"sensor": "my_angle_sensor", "response_template": {}}}</code> et peut renvoyer : <code>{"id": 123,"result":{"header":["time","angle"]}}</code> et peut produire ultérieurement des messages asynchrones tels que : <code>{ "params":{"position_offset":3.151562,"errors":0, "data":[[1290.951905,-5063],[1290.952321,-5065]]}}</code></p>
<p>Le champ "en-tête" dans la réponse initiale à la requête est utilisé pour décrire les champs présents dans les réponses "données" ultérieures.</p>
<h3 id="hx71xdump_hx71x">hx71x/dump_hx71x<a class="headerlink" href="#hx71xdump_hx71x" title="Permanent link">&para;</a></h3>
<p>This endpoint is used to subscribe to raw HX711 and HX717 ADC data. Obtaining these low-level ADC updates may be useful for diagnostic and debugging purposes. Using this endpoint may increase Klipper's system load.</p>
<p>A request may look like: <code>{"id": 123, "method":"hx71x/dump_hx71x", "params": {"sensor": "load_cell", "response_template": {}}}</code> and might return: <code>{"id": 123,"result":{"header":["time","counts","value"]}}</code> and might later produce asynchronous messages such as: <code>{"params":{"data":[[3292.432935, 562534, 0.067059278], [3292.4394937, 5625322, 0.670590639]]}}</code></p>
<h3 id="ads1220dump_ads1220">ads1220/dump_ads1220<a class="headerlink" href="#ads1220dump_ads1220" title="Permanent link">&para;</a></h3>
<p>This endpoint is used to subscribe to raw ADS1220 ADC data. Obtaining these low-level ADC updates may be useful for diagnostic and debugging purposes. Using this endpoint may increase Klipper's system load.</p>
<p>A request may look like: <code>{"id": 123, "method":"ads1220/dump_ads1220", "params": {"sensor": "load_cell", "response_template": {}}}</code> and might return: <code>{"id": 123,"result":{"header":["time","counts","value"]}}</code> and might later produce asynchronous messages such as: <code>{"params":{"data":[[3292.432935, 562534, 0.067059278], [3292.4394937, 5625322, 0.670590639]]}}</code></p>
<h3 id="pause_resumecancel">pause_resume/cancel<a class="headerlink" href="#pause_resumecancel" title="Permanent link">&para;</a></h3>
<p>Ce point final est similaire à l'exécution de la commande G-Code "PRINT_CANCEL". Par exemple : <code>{"id": 123, "method": "pause_resume/cancel"}</code></p>
<p>Comme pour le point de terminaison "gcode/script", ce point de terminaison ne se termine qu'après la fin de toutes les commandes G-Code en attente.</p>
@@ -1837,6 +1885,119 @@ gcode:
<h3 id="query_endstopsstatus">query_endstops/status<a class="headerlink" href="#query_endstopsstatus" title="Permanent link">&para;</a></h3>
<p>Ce point de terminaison interrogera les fins de course actifs et renverra leur état. Par exemple : <code>{"id": 123, "method": "query_endstops/status"}</code> peut renvoyer : <code>{"id": 123, "result": {"y": "open ", "x": "open", "z": "TRIGGERED"}}</code></p>
<p>Comme pour le point de terminaison "gcode/script", ce point de terminaison ne se termine qu'après la fin de toutes les commandes G-Code en attente.</p>
<h3 id="bed_meshdump_mesh">bed_mesh/dump_mesh<a class="headerlink" href="#bed_meshdump_mesh" title="Permanent link">&para;</a></h3>
<p>Dumps the configuration and state for the current mesh and all saved profiles.</p>
<p>For example: <code>{"id": 123, "method": "bed_mesh/dump_mesh"}</code></p>
<p>might return:</p>
<div class="highlight"><pre><span></span><code>{
&quot;current_mesh&quot;: {
&quot;name&quot;: &quot;eddy-scan-test&quot;,
&quot;probed_matrix&quot;: [...],
&quot;mesh_matrix&quot;: [...],
&quot;mesh_params&quot;: {
&quot;x_count&quot;: 9,
&quot;y_count&quot;: 9,
&quot;mesh_x_pps&quot;: 2,
&quot;mesh_y_pps&quot;: 2,
&quot;algo&quot;: &quot;bicubic&quot;,
&quot;tension&quot;: 0.5,
&quot;min_x&quot;: 20,
&quot;max_x&quot;: 330,
&quot;min_y&quot;: 30,
&quot;max_y&quot;: 320
}
},
&quot;profiles&quot;: {
&quot;default&quot;: {
&quot;points&quot;: [...],
&quot;mesh_params&quot;: {
&quot;min_x&quot;: 20,
&quot;max_x&quot;: 330,
&quot;min_y&quot;: 30,
&quot;max_y&quot;: 320,
&quot;x_count&quot;: 9,
&quot;y_count&quot;: 9,
&quot;mesh_x_pps&quot;: 2,
&quot;mesh_y_pps&quot;: 2,
&quot;algo&quot;: &quot;bicubic&quot;,
&quot;tension&quot;: 0.5
}
},
&quot;eddy-scan-test&quot;: {
&quot;points&quot;: [...],
&quot;mesh_params&quot;: {
&quot;x_count&quot;: 9,
&quot;y_count&quot;: 9,
&quot;mesh_x_pps&quot;: 2,
&quot;mesh_y_pps&quot;: 2,
&quot;algo&quot;: &quot;bicubic&quot;,
&quot;tension&quot;: 0.5,
&quot;min_x&quot;: 20,
&quot;max_x&quot;: 330,
&quot;min_y&quot;: 30,
&quot;max_y&quot;: 320
}
},
&quot;eddy-rapid-test&quot;: {
&quot;points&quot;: [...],
&quot;mesh_params&quot;: {
&quot;x_count&quot;: 9,
&quot;y_count&quot;: 9,
&quot;mesh_x_pps&quot;: 2,
&quot;mesh_y_pps&quot;: 2,
&quot;algo&quot;: &quot;bicubic&quot;,
&quot;tension&quot;: 0.5,
&quot;min_x&quot;: 20,
&quot;max_x&quot;: 330,
&quot;min_y&quot;: 30,
&quot;max_y&quot;: 320
}
}
},
&quot;calibration&quot;: {
&quot;points&quot;: [...],
&quot;config&quot;: {
&quot;x_count&quot;: 9,
&quot;y_count&quot;: 9,
&quot;mesh_x_pps&quot;: 2,
&quot;mesh_y_pps&quot;: 2,
&quot;algo&quot;: &quot;bicubic&quot;,
&quot;tension&quot;: 0.5,
&quot;mesh_min&quot;: [
20,
30
],
&quot;mesh_max&quot;: [
330,
320
],
&quot;origin&quot;: null,
&quot;radius&quot;: null
},
&quot;probe_path&quot;: [...],
&quot;rapid_path&quot;: [...]
},
&quot;probe_offsets&quot;: [
0,
25,
0.5
],
&quot;axis_minimum&quot;: [
0,
0,
-5,
0
],
&quot;axis_maximum&quot;: [
351,
358,
330,
0
]
}
</code></pre></div>
<p>The <code>dump_mesh</code> endpoint takes one optional parameter, <code>mesh_args</code>. This parameter must be an object, where the keys and values are parameters available to <a href="#bed_mesh_calibrate">BED_MESH_CALIBRATE</a>. This will update the mesh configuration and probe points using the supplied parameters prior to returning the result. It is recommended to omit mesh parameters unless it is desired to visualize the probe points and/or travel path before performing <code>BED_MESH_CALIBRATE</code>.</p>
</article>