Configure a Single Encoder

A single encoder sends a signal from the rotating encoder over a single wire to one pin on the board. The direction of spin is dictated by the motor that has this encoder’s name in its encoder attribute field.

To be able to test the encoder as you configure it, connect the encoder to your machine’s computer and power both on. Then, configure the encoder:

{
  "name": "<your-encoder-name>",
  "model": "single",
  "type": "encoder",
  "namespace": "rdk",
  "attributes": {
    "board": "<your-board-name>",
    "pins": {
      "i": "<your-pin-number-on-board>"
    }
  }
}

The following attributes are available for single encoders:

Viam also supports a model of encoder called "incremental" which uses two pins.

Test the encoder

Once your encoder is configured and connected, open the encoders’s TEST panel on the CONFIGURE or CONTROL tabs. The ticks count is displayed. Try moving the encoder (for example, by turning a motor it is attached to) and check whether the count increases as expected.

If the encoder 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.

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: