Skip to content

Commit

Permalink
GITBOOK-182: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
meteyou authored and gitbook-bot committed Feb 18, 2024
1 parent 2ced879 commit 5cc583e
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 0 deletions.
Binary file added .gitbook/assets/localhost_8080_config (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/localhost_8080_config (2).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/localhost_8080_config (3).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/localhost_8080_config (4).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/localhost_8080_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
* [Macro Prompts](overview/features/macro-prompts.md)
* [Presets](overview/features/presets.md)
* [Print History and Statistics](overview/features/print-history-and-statistics.md)
* [Query devices](overview/features/query-devices.md)
* [Themes](overview/features/themes/README.md)
* [Prepare](overview/features/themes/prepare.md)
* [Backgrounds](overview/features/themes/backgrounds.md)
Expand Down
41 changes: 41 additions & 0 deletions overview/features/query-devices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
description: >-
Mainsail can list different CAN / Serial / USB / Video devices to find the
right hardware path for your config.
---

# Query devices

## CAN devices

You can display "not connected" CAN nodes in this tab. Unfortunately, there is no more information except the application (Klipper/Katapult) and the related UUID.

<figure><img src="../../.gitbook/assets/localhost_8080_config.png" alt="Find devices dialog with CAN devices"><figcaption><p>Screenshot find devices dialog with CAN devices.</p></figcaption></figure>

{% hint style="warning" %}
An "unassigned" node is a CAN node that has not been activated by Katapult or Klipper. If either Klipper or Katapult has connected to the node, it will be assigned a Node ID and therefore will no longer respond to queries. A device reset is required to remove the assignment.

When multiple unassigned nodes are on the network, each responds to the query at roughly the same time. This results in arbitration errors. Nodes will retry the send until the response reports success. However, nodes track the count of arbitration errors, and once a specific threshold is reached they will go into a "bus off" state. A device reset is required to reset the counter and recover from "bus off".

For this reason, it is recommended that users only issue a query when a single unassigned node is on the network. If a user does wish to query multiple unassigned nodes it is vital that they reset all nodes on the network before running Klipper.\
\
Source: [https://moonraker.readthedocs.io/en/latest/web\_api/#query-unassigned-canbus-uuids](https://moonraker.readthedocs.io/en/latest/web\_api/#query-unassigned-canbus-uuids)
{% endhint %}

## Serial devices

This tab is essential for Klipper printers. The connections to the printer mainboard are displayed here.

<figure><img src="../../.gitbook/assets/localhost_8080_config (1).png" alt=""><figcaption><p>Screenshot find devices dialog with Serial devices.</p></figcaption></figure>

## USB devices

This tab is intended for debugging. Here, you can see whether the system recognizes the connected USB device.

<figure><img src="../../.gitbook/assets/localhost_8080_config (2).png" alt=""><figcaption><p>Screenshot find devices dialog with USB devices.</p></figcaption></figure>

## Video devices

All libcamera and V4L2 webcams are listed in this tab. Furthermore, all useable resolutions and video formats are displayed.

<figure><img src="../../.gitbook/assets/localhost_8080_config (4).png" alt=""><figcaption><p>Screenshot find devices dialog with Video devices.</p></figcaption></figure>

0 comments on commit 5cc583e

Please sign in to comment.