Skip to content

Device status updates #11722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
katarzyna-koltun-mx wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Device status updates #11722

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion content/en/docs/workstation/client/wks-client-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,23 @@ The top section of the Workstation Client shows the following information:

## Devices

The **Devices** section shows a list of all devices currently associated with the station through this Workstation Client. For each device, the section shows the availability, connection status, and any errors captured for this device. You can also expand each device to see more information about its connection parameters (for example, the host or port of a TCP/IP server).
The **Devices** section shows a list of all devices currently associated with the station through this Workstation Client. For each device, the section shows the following information:

* Availability - When a device shows as **Available**, it is likely connectable. The specifics depend on the device type:

* Bluetooth - Bluetooth devices are scanned continuously. They are considered available if seen, and unavailable if not seen for 30 seconds.
* Printer - The Client polls the system printer list. The scan only checks that the device exists, not its status, configuration, or connectivity.
* Serial device - The Client polls the system port list. The scan only checks that the device exists, not its connectivity.
* TCP/IPT client - The Client only checks that the host is defined and the port is valid. It cannot verify remote connectivity without actually connecting.

@liamcmitchell liamcmitchell Aug 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: TCP/IP


* Connection status - When the device shows as **Connected**, it means that the device connection has been successfully established and not yet closed. The device is available and is not throwing any errors.
* Errors - Any errors captured for this device. Devices that have thrown an error can be available, but cannot be connected, because the current connection is closed on error. The following error types may be logged:

* `Open_By_Other` - The connection was closed to allow connection by another Client.
* `Connection_Error` - The connection was closed unexpectedly.
* `Device_Error` - There was a device error.
Comment on lines +40 to +44

@liamcmitchell liamcmitchell Aug 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Errors - Any errors captured for this device. Devices that have thrown an error can be available, but cannot be connected, because the current connection is closed on error. The following error types may be logged:
* `Open_By_Other` - The connection was closed to allow connection by another Client.
* `Connection_Error` - The connection was closed unexpectedly.
* `Device_Error` - There was a device error.
* Error status - Shows any error captured for this device. Error status is reset on config change or reconnect.

Errors don't necessarily prevent reconnect. The important thing is that devices cannot have status connected and errored at the same time. I don't think that's very important for our users to know, more for us.

The listed error types are only relevant for the connector. From the client POV, it only considers errors coming from the device and there is only a device error or no device error. The client doesn't consider an app connector disconnecting as an error but the connector does treat that as Connection_Error.


You can also expand each device to see more information about its connection parameters (for example, the host or port of a TCP/IP server).

## Additional Actions

Expand Down