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, spin, set power or set velocity 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.

Troubleshooting

  1. Check your machine logs on the LOGS tab to check for errors.
  2. Review this base model’s documentation to ensure you have configured all required attributes.
  3. Review your configuration for any motors that are components of the base. Check that the names of the motor components match the list of motors you configured on the base.
  4. If a motor is spinning in an unexpected direction, try using the dir_flip attribute in its config, or try swapping the wires running to the motor to change its direction.
  5. Check that all wires are securely attached to the correct pins.
  6. If you are using a battery to power the base, check that it is adequately charged. If the motors are drawing more power than the battery can supply, the single-board computer may be power cycling. Consider using a wall power supply for testing purposes to rule out this issue.
  7. Click on the TEST panel on the CONFIGURE or CONTROL tab and test if you can use the base there.

If none of these steps work, reach out to us on the Community Discord and we will be happy to help.

Next steps

For more configuration and usage info, see:

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.