Configure a Wheeled Base

A wheeled base supports mobile robotic bases with drive motors on both sides (differential steering). To configure a wheeled base as a component of your machine, first configure the board controlling the base and any motors attached to the base.

Configure a wheeled base as follows:

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 wheeled model. Enter a name or use the suggested name for your base and click Create.

An example configuration for a wheeled base in the Viam app config builder, with Attributes & Depends On dropdowns and the option to add a frame.

Select the motors attached to the base as your right and left motors. Edit and fill in the attributes as applicable.

{
  "components": [
    {
      ... <INSERT YOUR BOARD COMPONENT CONFIGURATION>
    },
    {
      ... <INSERT YOUR LEFT MOTOR COMPONENT CONFIGURATION>
    },
    {
      ... <INSERT YOUR RIGHT MOTOR COMPONENT CONFIGURATION>
    },
    {
      "name": "<your-base-name>",
      "model": "wheeled",
      "type": "base",
      "namespace": "rdk",
      "attributes": {
        "left": [
          "<your-left-motor-name>" // <INSERT ANY ADDITIONAL LEFT MOTOR NAMES>
        ],
        "right": [
          "<your-right-motor-name>" // <INSERT ANY ADDITIONAL RIGHT MOTOR NAMES>
        ],
        "wheel_circumference_mm": <int>,
        "width_mm": <int>
      },
      "depends_on": []
    }
  ]
}

{
  "components": [
    {
      "name": "my-pi",
      "model": "pi",
      "type": "board",
      "namespace": "rdk",
      "attributes": {},
      "depends_on": []
    },
    {
      "name": "rightm",
      "model": "gpio",
      "type": "motor",
      "namespace": "rdk",
      "attributes": {
        "pins": {
          "dir": "16",
          "pwm": "15"
        },
        "board": "my-pi"
      },
      "depends_on": []
    },
    {
      "name": "leftm",
      "model": "gpio",
      "type": "motor",
      "namespace": "rdk",
      "attributes": {
        "pins": {
          "dir": "13",
          "pwm": "11"
        },
        "board": "my-pi"
      },
      "depends_on": []
    },
    {
      "name": "my-wheeled-base",
      "model": "wheeled",
      "type": "base",
      "namespace": "rdk",
      "attributes": {
        "width_mm": 195,
        "wheel_circumference_mm": 183,
        "left": ["leftm"],
        "right": ["rightm"]
      },
      "depends_on": []
    }
  ]
}
JSON configuration file for a wheeled base with annotations explaining some of the attributes.

The following attributes are available for wheeled bases:

NameTypeInclusionDescription
leftarrayRequiredArray with the name of any drive motors on the left side of the base.
rightarrayRequiredArray with the name of any drive motors on the right side of the base.
wheel_circumference_mmintRequiredThe outermost circumference of the drive wheels in millimeters. Used for odometry. Can be an approximation.
width_mmintRequiredWidth of the base in millimeters. In other words, the distance between the approximate centers of the right and left wheels. Can be an approximation.
spin_slip_factorfloatOptionalCan be used in steering calculations to correct for slippage between the wheels and the floor. If utilized, calibrated by the user.

Wire a wheeled base

An example wiring diagram for a base with one motor on each side:

Wiring diagram showing a Raspberry Pi, motor drivers, motors, power supply, and voltage regulator for the rover

Note that your base’s wiring will vary depending on your choice of board, motors, motor drivers, and power supply.

Test the base

After you configure the base, go to the CONTROL tab and expand the base component to view the controls to enable keyboard or discrete control over your machine’s movement. If your base makes use of a camera component, the CONTROL tab for your base will also display a Live Feeds section. This section contains buttons to toggle cameras on or off and to arrange how you view the camera feeds.

The base component in control tab


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.