A virtual camera to overlay the frames-per-second (FPS) of the get_image()
requests of the underlying camera
Before configuring your overlay-fps
camera, you must create a machine.
To use the overlay-fps
camera you also need to configure a webcam or another camera.
To use this module, follow these instructions to add a module from the Viam Registry and select the viam-labs:camera:overlay-fps
model from the overlay-fps
module.
Navigate to the Config tab of your machine's page in the Viam app.
Click on the Components subtab and click Create component.
Select the camera
type, then select the viam-labs:camera:overlay-fps
model.
Click Add module, then enter a name for your sensor and click Create.
On the new component panel, copy and paste the following attribute template into your camera’s Attributes box:
{
"camera_name": "<CAMERA-NAME>"
}
Provide your camera's name in the model config.
Note
For more information, see Configure a Machine.
The following attributes are available for the viam-labs:camera:overlay-fps
sensor:
Name | Type | Inclusion | Description |
---|---|---|---|
camera_name |
string | Required | The name of the camera to add the fps overlay to. |
{
"camera_name": "cam1"
}
To ensure the source camera starts up before the overlay-fps
camera, add the source camera in the Depends on drop down of the overlay-fps
camera.
The entire component configuration should resemble this:
{
"name": "my-overlay-cam",
"model": "viam-labs:camera:overlay-fps",
"type": "camera",
"namespace": "rdk",
"attributes": {
"camera_name": "my-webcam"
},
"depends_on": [
"my-webcam"
]
}
Go to the Control tab and enable the overlay-fps
camera.
You should now see the camera stream with the FPS overlay.
This module is written in Go.
go mod tidy
go build
Copyright 2021-2023 Viam Inc.
Apache 2.0