Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
225 changes: 130 additions & 95 deletions content/en/docs/releasenotes/workstation/_index.md

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions content/en/docs/workstation/client/wks-batch-registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ To bulk-register Workstation Clients, perform the following steps:

On Linux machines, you can use the following script: `mendix-workstation --registration-token {bulk registration token}`.

{{% alert color="info" %}}
The Client requires an unlocked keyring to encrypt its API key. If you run the script from an SSH session, the keyring may not be running or may be locked, and the Client does not start. In that case, unlock the keyring in the SSH session before you run the script. For more information, see [Troubleshooting the Workstation Client: Safe Storage Is Unavailable](/mendix-workstation/troubleshooting-workstation-client/#safe-storage-unavailable).
{{% /alert %}}

For more information about the options that the Workstation Client accepts on the command line, see [Command-Line Options](/mendix-workstation/use-client/#command-line-options).

After the command runs or the token is entered manually, the Workstation Clients display the status **Waiting for station assignment**. This indicates that the clients are registered, but not yet associated with a specific station.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ Before you install the Workstation Client, ensure that you fulfill the following

* Operating System - Windows 10 or Windows 11 (64-bit); Linux ARM64; macOS (Apple Silicon)
* Memory - Minimum 4 GB RAM (8 GB recommended for optimal performance)
* Disk Space - 400 MB of free disk space for installation
* Disk Space - 450 MB of free disk space for installation
* Secret Store - A secret store of the operating system, which the Client uses to encrypt its API key. It exists by default on Windows and macOS. On Linux, ensure that a keyring is installed and unlocked; otherwise, the Client does not start. For more information, see [Troubleshooting the Workstation Client: Safe Storage Is Unavailable](/mendix-workstation/troubleshooting-workstation-client/#safe-storage-unavailable).

### Access Requirements

Expand Down
30 changes: 30 additions & 0 deletions content/en/docs/workstation/client/wks-client-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ The **Devices** section shows a list of all devices currently associated with th
* 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.
* Camera - The Client checks the cameras attached to the computer. The device is available if the name of an attached camera contains the configured **Camera Name**, ignoring case. If no **Camera Name** is configured, the first camera that the Client finds is used.
* 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/IP client - The Client only checks that the host is defined and the port is valid. It cannot verify remote connectivity without actually connecting.
Expand All @@ -41,6 +42,35 @@ The **Devices** section shows a list of all devices currently associated with th

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).

### Testing Devices {#testing-devices}

When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, you can test a device directly in the Workstation Client, without a Mendix app. This works like the **Test Your Station** page in Workstation Management. To test a device, click the **test** icon (flask) next to the device in the **Devices** section.

The test view shows the following:

* The device type and device class.
* The availability, connection, and error status of the device.
* A log of the messages that are sent to the device (`<-`) and received from it (`->`), and of connection changes.

To communicate with the device, perform the following actions:

* Click **Connect** or **Disconnect** to open or close the connection to the device.
* Enter a message in the message field, and then click **Send** or press <kbd>Enter</kbd>. If the device is not connected yet, the Client connects first. If you send an empty message, the last message is sent again.

For the message syntax of each device type, see [Device Message Syntax](/mendix-workstation/device-syntax/).

#### Testing Cameras {#testing-cameras}

For camera devices, the test view also shows the following preconfigured test buttons, so you do not need to enter the commands manually:

* **Start camera** / **Stop camera** - Show or hide a live preview of the camera feed.
* **Scan barcode** - Scan the current frame for barcodes once. Only works when **Enable Barcode Detection** is enabled for the camera in Workstation Management.
* **Start barcode detection** / **Stop barcode detection** - Continuously report the barcodes that enter and leave the frame. Only works when **Enable Barcode Detection** is enabled for the camera in Workstation Management.
* **Start motion detection** / **Stop motion detection** - Report when motion starts and stops in the frame. Only works when **Enable Motion Detection** is enabled for the camera in Workstation Management.
* **Help** - Show the available camera commands.

If a detection capability is not enabled, its buttons are disabled. To enable barcode or motion detection, edit the camera device in Workstation Management. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera).

## Additional Actions

Click the **three dots** menu in the top right corner of the Workstation Client to perform any of the following actions:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,41 @@ Once subscribed, every notification from the device arrives as a response in the

Instead of building these messages by hand, you can call the `BLE_Subscribe`, `BLE_Unsubscribe`, `BLE_Read`, and `BLE_Write` nanoflows from [Workstation Commons](/mendix-workstation/commons/#bluetooth), which take `ServiceUUID` and `CharacteristicUUID` as plain parameters.

## Camera {#camera}

This device type requires the following messages and responses. Barcode commands are available only when **Enable Barcode Detection** is configured for the device, and motion commands only when **Enable Motion Detection** is configured. Send `H` to the camera to list all commands, and `B#H` to list the supported barcode types.

### Message

* `B#S` - Scan the next available frame for all barcode types.
* `B#S#Type1,Type2,...` - Scan the next available frame for the specified barcode types.
* `B#C#S` - Start continuous scanning for all barcode types.
* `B#C#S#Type1,Type2,...` - Add the specified barcode types to continuous scanning.
* `B#C#T` - Stop continuous scanning for all barcode types.
* `B#C#T#Type1,Type2,...` - Remove the specified barcode types from continuous scanning.
* `M#S` - Start motion detection.
* `M#T` - Stop motion detection.
* `H` - Show all camera commands. `B#H`, `M#H`, and `W#H` show the barcode, motion, and live preview commands.

### Response

* `B#S#Count#Type1:TextBase64,...` - The barcodes found in the scanned frame. Each barcode consists of its type and its content encoded in Base64.
* `B#C#S#Count#Type1:TextBase64,...` - During continuous scanning, the barcodes that entered the frame.
* `B#C#T#Count#Type1:TextBase64,...` - During continuous scanning, the barcodes that left the frame. A barcode is reported as left when it has not been detected for one second.
* `M#S#Score` - Motion started. `Score` is the share of changed pixels in the frame, between `0` and `1`.
* `M#T#Score` - Motion stopped.

Motion is reported only when it starts or stops for at least about 250 milliseconds, not for every frame.

### Barcode Types

Use the following values for `Type1,Type2,...` in the barcode commands. Values that start with `All` select a group of barcode types.

* Groups - `All`, `AllReadable`, `AllCreatable`, `AllLinear`, `AllMatrix`, `AllGS1`, `AllRetail`, `AllIndustrial`
* Linear barcodes - `Codabar`, `Code39`, `Code39Std`, `Code39Ext`, `Code32`, `PZN`, `Code93`, `Code128`, `ITF`, `ITF14`, `DataBar`, `DataBarOmni`, `DataBarStk`, `DataBarStkOmni`, `DataBarLtd`, `DataBarExp`, `DataBarExpStk`, `EANUPC`, `EAN13`, `EAN8`, `ISBN`, `UPCA`, `UPCE`, `Telepen`, `TelepenAlpha`, `TelepenNumeric`, `DXFilmEdge`
* Matrix barcodes - `PDF417`, `CompactPDF417`, `MicroPDF417`, `Aztec`, `AztecCode`, `AztecRune`, `QRCode`, `QRCodeModel1`, `QRCodeModel2`, `MicroQRCode`, `RMQRCode`, `DataMatrix`, `MaxiCode`
* Other - `OtherBarcode`

## Keyboard Wedge {#keyboard-wedge}

Keyboard wedge devices are input-only, so Mendix applications do not send messages to them. When the Workstation Client recognizes a complete message, it forwards the payload to the Workstation Connector with the prefix and suffix removed.
Expand Down
40 changes: 32 additions & 8 deletions content/en/docs/workstation/management/wks-management-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,27 +113,51 @@ From here, you can perform the following tasks:
* Manually refresh configuration to the client, forcing the Workstation Client on the registered computer to immediately pull the latest settings from Workstation Management.
* Configure advanced settings like **Detect Card Readers** and **Station Developer Mode**.
* Manage and configure all devices associated with this station.
* Retrieve diagnostics from the Workstation Client on the registered computer.

### Client Diagnostics {#client-diagnostics}

The Workstation Client scans the computer it runs on for connected peripherals and reports on its own state. You can retrieve that information from Workstation Management, which lets you check what a station has attached without asking the operator to read it off the computer.

To retrieve the diagnostics of a station, click **Diagnostics** on the **Station Detail** page. The diagnostics appear as JSON in a side panel next to the name of the registered computer, and cover the following:

* The serial ports, Bluetooth devices, card readers, printers, and cameras that the Workstation Client detects, with the metadata it has for each of them.
* System information about the computer and the Workstation Client, such as the operating system, the client type, the client version, and how long it has been running.
* A count of the log entries the Workstation Client has recorded per log level.

The **Diagnostics** button appears only when a computer is registered to the station and its Workstation Client is connected. This is the same condition as for the **Refresh on Computer** button. The diagnostics are pulled from the Workstation Client when you click the button, and discarded again when you close the panel. They therefore always reflect the current state of the computer rather than a stored snapshot. If the request fails, Workstation Management reports that it cannot retrieve the diagnostics for that computer.

Workstation Management retrieves a subset of the information on the **Diagnostics** page of the Workstation Client itself. The local file system paths that the client's own page shows are left out. For the client-side page, see the [Diagnostics](/mendix-workstation/troubleshooting-workstation-client/#diagnostics) section in *Troubleshooting the Workstation Client*.

## Advanced Station Settings

### Detect Card Readers

Card readers are handled uniquely within Workstation Management. They are not configured as separate devices in the Devices overview of a Station page. Instead, the Workstation Client automatically detects connected card readers.

Auto detecting card readers is enabled by default. You can toggle the **Detect Card Readers** setting on the **Station Detail Page** to **Off** if you do not want the Workstation Client to automatically detect smart card readers for this specific station.
The Workstation Client can automatically detect the card readers attached to the computer and add them to its device list. Alternatively, you can configure card readers as devices of the station. For more information, see [Configuring Devices: Card Readers](/mendix-workstation/management-devices/#card-readers).

### Developer Mode {#developer-mode}
Auto detecting card readers is disabled by default. To enable this feature, perform the following steps:

Developer mode can be configured on the **Station** page by selecting **Enable Developer Mode**.
1. In **Station** view, click the **three dots** icon.
2. Click **Edit Station**.
3. Select the **Detect Card Readers** check box.

Environments created with the Test environment type have developer mode enabled by default for easier testing. Changing the environment type after creation does not enable or disable developer mode. For more information about creating environments, see [Configuring Workspaces](/mendix-workstation/management-workspaces/).
### Developer Mode {#developer-mode}

When developer mode is enabled, users of the Workstation Client can perform the following actions:

* Quit the program from the Start menu.
* Deregister the Workstation Client, allowing it to be registered to another station.
* Debug level live logs displayed in the Logs pane of the Workstation Client, even if the workspace's log level is set to a different level.
* Access debug level live logs displayed in the Logs pane of the Workstation Client, even if the workspace's log level is set to a different level.

Environments created with the Test environment type have developer mode enabled by default for easier testing. Changing the environment type after creation does not enable or disable developer mode. For more information about creating environments, see [Configuring Workspaces](/mendix-workstation/management-workspaces/).

Disabling developer mode requires Workstation licenses. In a workspace without an entitlement, developer mode is enabled by default. Losing the entitlement does not re-enable developer mode on existing stations.

{{% alert color="info" %}}
For production environments, it is strongly recommended to disable Developer Mode. This prevents Workstation operators from accidentally quitting or deregistering the Workstation Client, and restricts access to debugging tools that are not needed in a live operational setting.
For production environments, it is strongly recommended to disable Developer Mode, which requires Workstation licenses. This prevents Workstation operators from accidentally quitting or deregistering the Workstation Client, and restricts access to debugging tools that are not needed in a live operational setting.
{{% /alert %}}

To configure developer mode, perform the following steps:
1. In **Station** view, click the **three dots** icon.
2. Click **Edit Station**.
3. Check or clear the **Developer Mode** check box.
Loading