Configure a Fake Encoder

The fake encoder is an encoder model for testing code without any 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 encoder type, then select the fake model. Enter a name or use the suggested name for your encoder and click Create.

Configuration of a fake encoder in the Viam app config builder.

{
  "name": "<your-encoder-name>",
  "model": "fake",
  "type": "encoder",
  "namespace": "rdk",
  "attributes": {}
}

{
  "name": "myEncoder",
  "model": "fake",
  "type": "encoder",
  "namespace": "rdk",
  "attributes": {}
}

No attributes are available for fake encoders.

Test the encoder

Once your encoder is configured and your machine is connected, go to the CONTROL tab and click on the encoder’s dropdown panel. The ticks count is displayed.

Encoder control panel.



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.