fake

Configure a fake arm to test different models of robotic arms without any physical hardware:

{
  "name": "<arm_name>",
  "model": "fake",
  "api": "rdk:component:arm",
  "attributes": {
    "arm-model": "<your_arm_model>",
    "model-path": "<path_to_arm_model>"
  },
  "depends_on": []
}

{
  "name": "my-fake-arm",
  "model": "fake",
  "api": "rdk:component:arm",
  "attributes": {
    "arm-model": "ur5e"
  },
  "depends_on": []
}

The following attributes are available for fake arms:

NameTypeRequired?Description
arm-modelstringOptionalModel name of the robotic arm model you want your fake arm to act as. See built-in arm models for supported model names.
model-pathstringOptionalThe path to the kinematic configuration file of the arm driver you want your fake arm to act as. This path should point to the exact location where the file is located on your computer running viam-server.

Test the arm

Once your arm is configured and connected, open the arm’s TEST panel on the CONFIGURE or CONTROL tabs.

Use the buttons to move the end position or the joints and check whether it moves as expected.

Arm test panel.

If the arm does not appear on the TEST panel, or if you notice unexpected behavior, check your machine’s LOGS tab for errors, and review the configuration.