diff --git a/docs/en/source/camera_devices/4_application_guide/launch_parameters.md b/docs/en/source/camera_devices/4_application_guide/launch_parameters.md index 240ec27f..7c2f4a00 100644 --- a/docs/en/source/camera_devices/4_application_guide/launch_parameters.md +++ b/docs/en/source/camera_devices/4_application_guide/launch_parameters.md @@ -40,19 +40,19 @@ The following are the launch parameters available: * ROS 2 Message Quality of Service (QoS) settings. The possible values are `SYSTEM_DEFAULT`, `DEFAULT`, `PARAMETER_EVENTS`, `SERVICES_DEFAULT`, `PARAMETERS`, `SENSOR_DATA` and are case-insensitive. These correspond to `rmw_qos_profile_system_default`, `rmw_qos_profile_default`, `rmw_qos_profile_parameter_events`, `rmw_qos_profile_services_default`, `rmw_qos_profile_parameters`, and `SENSOR_DATA`, respectively. * **`color.image_raw.enable_pub_plugins`** * Enable Color image transport plugins. Default: `["image_transport/compressed", "image_transport/raw", "image_transport/theora"]`. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Versions**: Wrapper version 2.6.3 and above. * **`depth.image_raw.enable_pub_plugins`** * Enable Depth image transport plugins. Default: `["image_transport/compressedDepth", "image_transport/raw"]`. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Versions**: Wrapper version 2.6.3 and above. * **`left_ir.image_raw.enable_pub_plugins`** * Enable Left IR image transport plugins. Default: `["image_transport/compressed", "image_transport/raw", "image_transport/theora"]`. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Versions**: Wrapper version 2.6.3 and above. * **`right_ir.image_raw.enable_pub_plugins`** * Enable Right IR image transport plugins. Default: `["image_transport/compressed", "image_transport/raw", "image_transport/theora"]`. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Versions**: Wrapper version 2.6.3 and above. * **`point_cloud_decimation_filter_factor`** * Point cloud downsampling factor. Range: `1–8`. `1` means no downsampling. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Versions**: Wrapper version 2.6.3 and above. ### Sensor Controls @@ -90,7 +90,7 @@ The following are the launch parameters available: * Enable the Depth auto exposure priority. * **`mean_intensity_set_point`** * Set the target average intensity of the depth image when auto-exposure is turned on. For example: `mean_intensity_set_point:=100`. - > **Note:** In wrapper version 2.4.7 and later, this parameter replaces the deprecated `depth_brightness`, but `depth_brightness` will still be supported for backward compatibility. + > **Note:** In wrapper version 2.4.7 and later, this parameter replaces the deprecated `depth_brightness`, but `depth_brightness` will still be supported for backward compatibility. * **`enable_depth_scale`** * Whether to enable depth scaling after setting D2C. `true` means enabled, the default is `true`. * **`depth_precision`** @@ -142,50 +142,50 @@ The following are the launch parameters available: * Set net device's IP address and port (Usually `8090`). * **`force_ip_enable`** * Enable the Force IP function. **Default:** `false` - > **Supported Versions**: Wrapper version 2.5.4 and above. + > **Supported Versions**: Wrapper version 2.5.4 and above. * **`force_ip_mac`** * Target device MAC address when multiple cameras are connected (e.g., `"54:14:FD:06:07:DA"`). You can use the `list_devices_node` to find the MAC of each device. **Default:** `""` - > **Supported Versions**: Wrapper version 2.5.4 and above. + > **Supported Versions**: Wrapper version 2.5.4 and above. * **`force_ip_address`** * Static IP address to assign. **Default:** `192.168.1.10` - > **Supported Versions**: Wrapper version 2.5.4 and above. + > **Supported Versions**: Wrapper version 2.5.4 and above. * **`force_ip_subnet_mask`** * Subnet mask for the static IP. **Default:** `255.255.255.0` - > **Supported Versions**: Wrapper version 2.5.4 and above. + > **Supported Versions**: Wrapper version 2.5.4 and above. * **`force_ip_gateway`** * Gateway address for the static IP. **Default:** `192.168.1.1` - > **Supported Versions**: Wrapper version 2.5.4 and above. + > **Supported Versions**: Wrapper version 2.5.4 and above. > Used for [net camera](../5_advanced_guide/configuration/net_camera.md). #### Device-Specific * **`enable_gmsl_trigger`** / **`gmsl_trigger_fps`** * Enable the gmsl trigger out signal / set gmsl trigger fps. - > Only supports [gmsl camera](../5_advanced_guide/multi_camera/gmsl_camera.md). - > + > Only supports [gmsl camera](../5_advanced_guide/multi_camera/gmsl_camera.md). + > * **`enable_ptp_config`** * Enable PTP time synchronization. Requires `enable_sync_host_time` to be `false`. - > **Supported Modules**: Gemini 335Le - > **Supported Versions**: Wrapper version 2.3.4 and above. + > **Supported Modules**: Gemini 335Le + > **Supported Versions**: Wrapper version 2.3.4 and above. * **`preset_resolution_config`** * Preset resolution configuration for the camera device. Format: "width,height,ir_decimation_factor,depth_decimation_factor". Example: "1280,720,4,4". Leave empty to disable. - > **Supported Modules**: Gemini 435Le - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Modules**: Gemini 435Le + > **Supported Versions**: Wrapper version 2.6.3 and above. * **`ae_mode`** * `colorbased`: Automatic exposure based on color flow. `depthbased`: Automatic exposure based on depth flow. **Default:** `depthbased` - > **Supported Modules**: Gemini 305 - > **Supported Versions**: Wrapper version 2.7.2 and above. + > **Supported Modules**: Gemini 305 + > **Supported Versions**: Wrapper version 2.7.2 and above. * **`enalbe_sports_mode`** * Whether to enable sports mode. **Default:** `false` - > **Supported Modules**: Gemini 305 - > **Supported Versions**: Wrapper version 2.7.2 and above. + > **Supported Modules**: Gemini 305 + > **Supported Versions**: Wrapper version 2.7.2 and above. * **`depth_downscale`** / **`left_ir_downscale`** /**`right_ir_downscale`** * Set the downsampling multiple. You can use `ros2 run orbbec_camera list_camera_profile_mode_node` to view the settable resolution. **Default value:** `1` - > **Supported Modules**: Gemini 305 - > **Supported Versions**: Wrapper version 2.7.2 and above. + > **Supported Modules**: Gemini 305 + > **Supported Versions**: Wrapper version 2.7.2 and above. * **`enable_false_positive_filter`** * Enable this option to reduce ghosting noise. - > **Supported Modules**: DaBaiA / DaBaiAL / Gemini345 / Gemini345Lg - > **Supported Versions**: Wrapper version 2.7.6 and above; Firmware version 1.9.03 and above. + > **Supported Modules**: DaBaiA / DaBaiAL / Gemini345 / Gemini345Lg + > **Supported Versions**: Wrapper version 2.7.6 and above; Firmware version 1.9.03 and above. #### Disparity * **`disparity_to_depth_mode`** * `HW`: use hardware disparity to depth conversion. `SW`: use software disparity to depth conversion. @@ -214,7 +214,7 @@ The following are the launch parameters available: * `DEPTH`: Align color to depth. - **`intra_camera_sync_reference`** - Sets the reference point for intra-camera synchronization. Applicable for Gemini 330 series devices when `sync_mode` is set to **software** or **hardware trigger** mode. **Options:** `Start`, `Middle`, `End`. When set to empty, the long baseline device defaults to End, and the short baseline device defaults to Middle. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Versions**: Wrapper version 2.6.3 and above. ### Basic & General Parameters @@ -247,8 +247,8 @@ The following are the launch parameters available: * Select timestamp type: `device`, `global`, and `system`. * **`time_sync_period`** * Interval (in seconds) for synchronizing the camera time with the host system. - > **Note**: This parameter only needs to be set when `enable_sync_host_time = true` and `time_domain = device`. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Note**: This parameter only needs to be set when `enable_sync_host_time = true` and `time_domain = device`. + > **Supported Versions**: Wrapper version 2.6.3 and above. * **`enable_frame_sync`** * Enable the frame synchronization. @@ -258,7 +258,7 @@ The following are the launch parameters available: * SDK log level. Default is `info`. Optional values: `debug`, `info`, `warn`, `error`, `fatal`. * **`log_file_name`** * Saved SDK log file name. Effective when `log_level` is `debug`. - > **Supported Versions**: Wrapper version 2.6.3 and above. + > **Supported Versions**: Wrapper version 2.6.3 and above. * **`diagnostic_period`** * Diagnostic period in seconds. * **`enable_heartbeat`** diff --git a/docs/zh/source/camera_devices/4_application_guide/launch_parameters.md b/docs/zh/source/camera_devices/4_application_guide/launch_parameters.md index 320deb5d..cd983152 100644 --- a/docs/zh/source/camera_devices/4_application_guide/launch_parameters.md +++ b/docs/zh/source/camera_devices/4_application_guide/launch_parameters.md @@ -40,19 +40,19 @@ * ROS 2消息服务质量(QoS)设置。可能的值为 `SYSTEM_DEFAULT`、`DEFAULT`、`PARAMETER_EVENTS`、`SERVICES_DEFAULT`、`PARAMETERS`、`SENSOR_DATA`,不区分大小写。这些分别对应 `rmw_qos_profile_system_default`、`rmw_qos_profile_default`、`rmw_qos_profile_parameter_events`、`rmw_qos_profile_services_default`、`rmw_qos_profile_parameters` 和 `SENSOR_DATA`。 * **`color.image_raw.enable_pub_plugins`** * 启用彩色图像传输插件。默认值:`["image_transport/compressed", "image_transport/raw", "image_transport/theora"]`。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持版本**: wrapper version 2.6.3 及以上。 * **`depth.image_raw.enable_pub_plugins`** * 启用深度图像传输插件。默认值:`["image_transport/compressedDepth", "image_transport/raw"]`。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持版本**: wrapper version 2.6.3 及以上。 * **`left_ir.image_raw.enable_pub_plugins`** * 启用左红外图像传输插件。默认值:`["image_transport/compressed", "image_transport/raw", "image_transport/theora"]`。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持版本**: wrapper version 2.6.3 及以上。 * **`right_ir.image_raw.enable_pub_plugins`** * 启用右红外图像传输插件。默认值:`["image_transport/compressed", "image_transport/raw", "image_transport/theora"]`。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持版本**: wrapper version 2.6.3 及以上。 * **`point_cloud_decimation_filter_factor`** * 点云下采样因子。范围:`1–8`,`1`表示不下采样,数值越大下采样倍数越大。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持版本**: wrapper version 2.6.3 及以上。 ### 传感器控制 @@ -90,7 +90,7 @@ * 启用深度自动曝光优先级。 * **`mean_intensity_set_point`** * 设置开启自动曝光时深度图像的目标平均强度。例如:`mean_intensity_set_point:=100`。 - > **注意:** 在 2.4.7 版本之后,该参数取代已弃用的 `depth_brightness`,但为了向后兼容,仍会支持 `depth_brightness`。 + > **注意:** 在 2.4.7 版本之后,该参数取代已弃用的 `depth_brightness`,但为了向后兼容,仍会支持 `depth_brightness`。 * **`enable_depth_scale`** * 设置D2C后是否启用深度缩放。`true`表示启用,默认为`true`。 * **`depth_precision`** @@ -143,19 +143,19 @@ * 设置网络设备的IP地址和端口(通常为 `8090`)。 * **`force_ip_enable`** * 启用强制IP功能。**默认值:** `false` - > **支持版本**: wrapper version 2.5.4 及以上。 + > **支持版本**: wrapper version 2.5.4 及以上。 * **`force_ip_mac`** * 连接多个相机时的目标设备MAC地址(例如,`"54:14:FD:06:07:DA"`)。您可以使用 `list_devices_node` 查找每个设备的MAC。**默认值:** `""` - > **支持版本**: wrapper version 2.5.4 及以上。 + > **支持版本**: wrapper version 2.5.4 及以上。 * **`force_ip_address`** * 要分配的静态IP地址。**默认值:** `192.168.1.10` - > **支持版本**: wrapper version 2.5.4 及以上。 + > **支持版本**: wrapper version 2.5.4 及以上。 * **`force_ip_subnet_mask`** * 静态IP的子网掩码。**默认值:** `255.255.255.0` - > **支持版本**: wrapper version 2.5.4 及以上。 + > **支持版本**: wrapper version 2.5.4 及以上。 * **`force_ip_gateway`** * 静态IP的网关地址。**默认值:** `192.168.1.1` - > **支持版本**: wrapper version 2.5.4 及以上。 + > **支持版本**: wrapper version 2.5.4 及以上。 > 用于 [网络相机](../5_advanced_guide/configuration/net_camera.md)。 @@ -164,28 +164,28 @@ * 启用gmsl触发输出信号 / 设置gmsl触发fps。用于 [gmsl相机](../5_advanced_guide/multi_camera/gmsl_camera.md)。 * **`enable_ptp_config`** * 启用PTP时间同步。仅适用于Gemini 335Le。需要 `enable_sync_host_time` 设置为 `false`。 - > **支持模组**:Gemini 335Le。 - > **支持版本**: wrapper version 2.3.4 及以上。 + > **支持模组**:Gemini 335Le。 + > **支持版本**: wrapper version 2.3.4 及以上。 * **`preset_resolution_config`** * 摄像头设备的预设分辨率配置。格式: "width,height,ir_decimation_factor,depth_decimation_factor". Example: "1280,720,4,4". 留空禁用。 - > **支持模组**:Gemini 435Le。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持模组**:Gemini 435Le。 + > **支持版本**: wrapper version 2.6.3 及以上。 * **`ae_mode`** * `colorbased`:自动曝光基于彩色流。`depthbased`:自动曝光基于深度流。**默认值:** `depthbased` - > **支持模组**:Gemini 305。 - > **支持版本**: wrapper version 2.7.2 及以上。 + > **支持模组**:Gemini 305。 + > **支持版本**: wrapper version 2.7.2 及以上。 * **`enalbe_sports_mode`** * 是否开启运动模式。**默认值:** `false` - > **支持模组**:Gemini 305。 - > **支持版本**: wrapper version 2.7.2 及以上。 + > **支持模组**:Gemini 305。 + > **支持版本**: wrapper version 2.7.2 及以上。 * **`depth_downscale`** / **`left_ir_downscale`** /**`right_ir_downscale`** * 设置下采样倍数。可用`ros2 run orbbec_camera list_camera_profile_mode_node`查看可设置分辨率。**默认值:** `1` - > **支持模组**:Gemini 305。 - > **支持版本**: wrapper version 2.7.2 及以上。 + > **支持模组**:Gemini 305。 + > **支持版本**: wrapper version 2.7.2 及以上。 * **`enable_false_positive_filter`** * 启用鬼影滤波。可减少重影噪声。 - > **支持模组**: DaBaiA/DaBaiAL/Gemini345/Gemini345Lg. - > **支持版本**: wrapper version 2.7.6 及以上;firmware version 1.9.03 及以上。 + > **支持模组**: DaBaiA/DaBaiAL/Gemini345/Gemini345Lg. + > **支持版本**: wrapper version 2.7.6 及以上;firmware version 1.9.03 及以上。 #### 视差 * **`disparity_to_depth_mode`** @@ -215,7 +215,7 @@ * `DEPTH`:将彩色对齐到深度。 - **`intra_camera_sync_reference`** - 设置相机内同步的参考点。适用于Gemini 330系列设备,当 `sync_mode` 设置为**软件**或**硬件触发**模式时。**选项:** `Start`、`Middle`、`End`。设置为空时,长基线设备默认End,短基线设备默认Middle。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持版本**: wrapper version 2.6.3 及以上。 ### 基础与通用参数 @@ -248,8 +248,8 @@ * 选择时间戳类型:`device`、`global` 和 `system`。 * **`time_sync_period`** * 相机时间与主机系统同步的间隔(秒)。 - > **注意**:仅当 **`enable_sync_host_time = true`** 且 **`time_domain = device`** 时需要设置此参数。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **注意**:仅当 **`enable_sync_host_time = true`** 且 **`time_domain = device`** 时需要设置此参数。 + > **支持版本**: wrapper version 2.6.3 及以上。 * **`enable_frame_sync`** * 启用帧同步。 @@ -258,7 +258,7 @@ * SDK日志级别。默认为 `info`。可选值:`debug`、`info`、`warn`、`error`、`fatal`。 * **`log_file_name`** * 保存的SDK日志文件名。当`log_level`为`debug`时生效。 - > **支持版本**: wrapper version 2.6.3 及以上。 + > **支持版本**: wrapper version 2.6.3 及以上。 * **`diagnostic_period`** * 诊断周期(秒)。 * **`enable_heartbeat`**