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.

Troubleshooting

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

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

Encoder API

Give commands for getting the position of a motor or a joint in ticks or degrees.

Configure a machine

Create a machine in a few steps using Viam's modular system of components and services without writing much or any code.

Write control code for your machine

Write code to control machines and run it on the machine or remotely.

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.