Configure a linux-supported gamepad

Configuring a gamepad input controller allows you to use a Linux-supported gamepad as a device to communicate with your robot. Linux supports most standard gamepads, such as PlayStation or Xbox type game controllers, as well as many joysticks, racing wheels, and more.

Configuration

Refer to the following example configuration for an input controller of model gamepad:

Config Builder
JSON Template

What an example configuration for a linux-based gamepad input controller component looks like in the Viam App config builder.

{
  "components": [
    {
      "name":  <your-gamepad-input-controller>,
      "type": "input_controller",
      "model": "gamepad",
      "attributes": {
        "dev_file": <string>,
        "auto_reconnect": <boolean>
      }
    }
}

The following attributes are available for gamepad input controllers:

Name	Inclusion	Description
`dev_file`	Optional	If `dev_file` is left blank or not included, `viam-server` will search and use the first gamepad it finds that’s connected to the computer controlling your robot. If you want to specify a device, give the absolute path to the input device event file. For example: `/dev/input/event42`.
`auto_reconnect`	Optional	Applies to both remote (gRPC) and local (bluetooth or direct USB connected) devices. If set to `true`, `viam-server` tries to (re)connect the device automatically. It waits for a device to connect during a robot’s start-up. If set to false (default) then start-up fails if a device is not already connected.

Usage

Connect your controller to your computer. Follow the instructions included with your gamepad to make this connection.

If you haven’t done so already, create a robot in the Viam app, and follow the instructions in the SETUP tab to start viam-server on your computer and connect to the robot.

Then, click on the robot’s CONFIG tab and configure an input_controller component of model gamepad, as shown above. Save the config.

Next, navigate to the CONTROL tab. You should see a drop-down menu with the name of your gamepad. Click on the drop-down menu to expand it.

Now, you should see the Controls on your input controller appear:

The dropdown as a table of controls available and their inputs in the Control tab of the Viam app.

You should now be able to see the row of Controls respond to your button presses and stick toggles.

For example, this is what the row of inputs above looks like after pressing the circle (west) button on the button pad of a PS4 controller connected as a webgamepad :

The dropdown as a table of controls available for a web-based gamepad and their inputs in the Control tab of the Viam app. This is for a WebGamepad model.

Note

The Enable toggle shown in this example is only shown for the webgamepad and not shown when a linux-supported gamepad model is directly connected.

Work in Progress Models

Mappings are currently available for a wired XBox 360 controller, and wireless XBox Series X|S, along with the 8bitdo Pro 2 bluetooth gamepad (which works great with the Raspberry Pi).

The XBox controllers emulate an XBox 360 gamepad when in wired mode, as does the 8bitdo.

Because of that, any unknown gamepad is mapped as an XBox 360.

If you have another controller that you want to use to control your robot, feel free to submit a PR on Github with new mappings.

Troubleshooting

If you are not able to see a drop-down menu with the name of your controller appear in the Control tab, try specifying the dev_file attribute to match the exact path to your device. You can also try setting auto_reconnect to True.

You can find additional assistance in the Troubleshooting section.

You can also ask questions in the Community Discord and we will be happy to help.