Joystick support

You can use most USB joysticks with the Desktop Client to control PTZ cameras and navigate the client. This article explains which joysticks work within the VMS, which platforms are supported, and what to check if a joystick doesn't respond.

How joystick support works

Since version 5.1, the Desktop Client includes generic USB joystick support. We don't keep a list of certified joystick models, and we no longer add integrations for specific models. Most USB joysticks work if they meet the requirements in this article.

Because support is generic, some joysticks might not have every feature available. For example, some buttons or extra controls might not map to a function in the Desktop Client.

Supported platforms

• Windows: Supported.
• macOS: Experimental. Not officially supported.
• Linux: Experimental. Not officially supported.

Joystick requirements

A joystick works with the Desktop Client if it meets all of these requirements:

• It connects to the client computer over USB.
• It identifies itself to the operating system as a joystick or game controller. Devices that identify as a keyboard or another input device don't work as a joystick.
• It's used with a current release of the Desktop Client. 

If you're choosing a new joystick, test it on one workstation with your Site before you deploy it widely.

Set up a joystick

For setup steps, button mapping, and the PTZ functions you can control with a joystick, see the Using Joysticks section of the User Manual. 

Troubleshooting

The Desktop Client doesn't detect the joystick

1. Check that the operating system detects the joystick as a game controller. On Windows, press Win+R, enter joy.cpl, and press Enter. The joystick appears in the Game Controllers list.
2. If the joystick isn't in the list, check the manufacturer's documentation for a mode or setting that makes it report as a joystick.
3. If the client computer runs macOS or Linux, test the joystick on a Windows computer. Joystick support on macOS and Linux is experimental.

The joystick still doesn't work

If you've completed the troubleshooting steps above and the joystick still doesn't work, collect information for Nx Support:

1. Reproduce the issue and collect the Desktop Client logs. For the steps, see:
   How to change software logging level and how to get logs.
2. Share the joystick brand and model, the client operating system, and the Desktop Client version.
3. Submit a ticket through the support portal and attach the logs and details. If you're an end user, contact your reseller to escalate the issue.