Configure a Fake Base

Configure a fake base to test implementing a base component on your machine without any physical hardware:

Navigate to the CONFIGURE tab of your machine’s page in the Viam app. Click the + icon next to your machine part in the left-hand menu and select Component. Select the base type, then select the fake model. Enter a name or use the suggested name for your base and click Create.

An example configuration for a fake base in the Viam app Config Builder.
{
  "name": "<your-base-name>",
  "type": "base",
  "model": "fake",
  "namespace": "rdk",
  "attributes": {}
}

No attributes are available for fake bases. See GitHub for API call return specifications.

Test the base

After you configure the base, open the base’s TEST panel on the CONFIGURE or CONTROL tabs to view the controls to enable keyboard or discrete control over your machine’s movement.

The base component in control tab

In the Quick move section, you can toggle the keyboard control to active. With the Keyboard toggle active, use W and S to go forward and back, and A and D to arc and spin.

Try driving your base around using the WASD keyboard controls.

You can also move straight or spin from the base panel.

If you do not see the base card in the TEST panel, check the LOGS tab for possible setup or configuration errors.

Have questions, or want to meet other people working on robots? Join our Community Discord.

If you notice any issues with the documentation, feel free to file an issue or edit this file.