Configure a Fake Arm
Configure a fake
arm to test different models of robotic arms without any physical hardware:
Navigate to the Config tab of your robot’s page in the Viam app.
Click on the Components subtab and click Create component.
Select the arm
type, then select the fake
model.
Enter a name for your arm and click Create.
Edit and fill in the attributes as applicable.
This example sets the fake
arm to act as a ur5e
arm.
{
"name": "<arm_name>",
"type": "arm",
"model": "fake",
"attributes": {
"arm-model": "<your_arm_model>"
}
}
The following attributes are available for fake
arms:
Name | Type | Inclusion | Description |
---|---|---|---|
arm-model | string | Optional | name of the robotic arm model you want your fake arm to act as. See built-in arm models for supported model names. |
model-path | string | Optional | The 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 . |
Important
At least one of these attributes must be supplied for your fake
arm to work.
If neither are specified, an error is thrown asking for specification.
If both attributes are specified, an error is thrown stating “can only populate either ArmModel or ModelPath - not both”.
Refer to the following JSON examples for differences in configuration between the two attributes available:
{
"name": "<arm-name>",
"type": "arm",
"model": "fake",
"attributes": {
"arm-model": "ur5e"
}
}
{
"name": "<arm-name>",
"type": "arm",
"model": "fake",
"attributes": {
"model-path": "</Users/<YOUR-USERNAME>/downloads/universalrobots/ur5e.json>"
}
}
Have questions, or want to meet other people working on robots? Join our Community Discord.
Was this page helpful?
Glad to hear it! If you have any other feedback please let us know:
We're sorry about that. To help us improve, please tell us what we can do better:
Thank you!