Configure a Fake Movement Sensor

You can use the fake movement sensor model to test movement sensor code without connecting to any actual hardware.

The fake model supports all movement sensor methods: Accuracy, AngularVelocity, CompassHeading, LinearAcceleration, LinearVelocity, Orientation, Position, Properties, and Readings. Note that this model does not get any actual readings, so it supports these methods by returning placeholder data.

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 movement-sensor type, then select the fake model. Enter a name or use the suggested name for your movement sensor and click Create.

Creation of an `fake` movement sensor in the Viam app config builder.

Edit and fill in the attributes as applicable.

{
  "components": [
    {
      "name": <sensor_name>,
      "model": "fake",
      "type": "movement_sensor",
      "namespace": "rdk",
      "attributes": {},
      "depends_on": []
    }
  ]
}
{
  "components": [
    {
      "name": "myFakeSensor",
      "model": "fake",
      "type": "movement_sensor",
      "namespace": "rdk"
    }
  ]
}

Test the movement sensor

After you configure your movement sensor, navigate to the Control tab and select the dedicated movement sensor dropdown panel. This panel presents the data collected by the movement sensor. The sections in the panel include the position, orientation, angular velocity, linear velocity, and linear acceleration.

The movement sensor component in the control tab

Troubleshooting

If your movement sensor is not working as expected, follow these steps:

  1. Check your machine logs on the LOGS tab to check for errors.
  2. Review this movement sensor model’s documentation to ensure you have configured all required attributes.
  3. Click on the TEST panel on the CONFIGURE or CONTROL tab and test if you can use the movement sensor 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.