Edit

Configure a Fake Camera (viam-micro-server)

A fake camera is a camera model for testing. The camera always returns the same image, which is an image of a circle inside a diamond.

Software requirements

To use this model, you must follow the viam-micro-server Development Setup, which enables you to install and activate the ESP-IDF. At the step Generate a new project from a template where you create a new project with cargo generate, select the option to include camera module traits when prompted. Finish the viam-micro-server Development Setup and return to this guide.

Config Builder
JSON Template

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

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

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

View the camera stream

Once your camera is configured, expand the TEST section on the configuration pane. You will see the live video feed from your camera. You can change the refresh frequency as needed to change bandwidth.

Troubleshooting

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

Check your machine logs on the LOGS tab to check for errors.
Review this camera model’s documentation to ensure you have configured all required attributes.
Click on the TEST panel on the CONFIGURE or CONTROL tab and test if you can use the camera there.

If none of these steps work, reach out to us on the Community Discord and we will be happy to help.

Common errors

Failed to find the best driver that fits the constraints

When working with a camera component, depending on the camera, you may need to explicitly provide some camera-specific configuration parameters.

Solution: Check the specifications for your camera, and manually provide configuration parameters such as width and height to the camera component configuration page on the Viam app. On the CONFIGURE page, find your camera, then fill in your camera’s specific configuration either using the Show more button to show the relevant configuration options, or the {} (Switch to Advanced) button in the top right of the component panel to enter these attributes manually. Provide at least the width and height values to start.

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.

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!