Overview

Starting from firmware version 1.0.3, BATCAM FX supports generating overlay images internally and embedding them into the RTSP stream. This document provides a detailed explanation of the properties of each parameter related to this feature.

Supported Format Method Note
ROS 2 Action fx_stream_msgs/msg/OverlaySetting
REST API HTTP

Parameter Descriptions

Enable Overlay (Message Name: enable_overlay)

Controls whether to output overlay images.

When set to True, overlay content will be displayed on images transmitted via RTSP and ROS.

Min Max Step Note
False True Boolean (True / False)

Enable Source Find Mode (Message Name: enable_source_mode)

Controls the source detection mode. The overlay must be enabled beforehand.

When set to True, single or multiple source modes are activated based on the Number of sources value.

Refer to the corresponding section for configurable source quantities.

Min Max Step Note
False True Boolean (True / False)

Number of Sources (Message Name: number_of_sources)

Specifies the number of sources to be tracked simultaneously.

Up to 5 sources can be set, but using up to 3 is recommended.

Min Max Step Note
1 5 1