docs: remove export_config_json_file_path reference from SDK JSON configuration documentation

This commit is contained in:
ob-yalian
2026-07-09 11:34:11 +08:00
parent f560b0bd18
commit 9aa21d3071
2 changed files with 2 additions and 24 deletions
@@ -14,7 +14,7 @@ gemini_330_series_sdk_json.launch.py
This launch file is designed for SDK JSON workflows. It keeps only the parameters required for ROS2 runtime and device management, reducing the chance that default camera parameters from launch override the JSON configuration. This launch file is designed for SDK JSON workflows. It keeps only the parameters required for ROS2 runtime and device management, reducing the chance that default camera parameters from launch override the JSON configuration.
Full launch files such as `gemini_330_series.launch.py` and `gemini_330_series_low_cpu.launch.py` also provide `load_config_json_file_path` and `export_config_json_file_path`, but they contain many camera parameters. When parameters conflict, launch or YAML parameters that have already been passed to the node take precedence over the corresponding configuration in the JSON file. Full launch files such as `gemini_330_series.launch.py` and `gemini_330_series_low_cpu.launch.py` also provide `load_config_json_file_path`, but they contain many camera parameters. When parameters conflict, launch or YAML parameters that have already been passed to the node take precedence over the corresponding configuration in the JSON file.
## Parameter Priority ## Parameter Priority
@@ -104,17 +104,6 @@ Exported config json file path: /tmp/orbbec_camera_config.json
If the path is empty or export fails, the service returns failure information and the log contains the error reason. If the path is empty or export fails, the service returns failure information and the log contains the error reason.
## Export Automatically at Startup
In addition to the runtime service, you can set `export_config_json_file_path` at startup. The node exports the current configuration once after initialization:
```bash
ros2 launch orbbec_camera gemini_330_series_sdk_json.launch.py \
export_config_json_file_path:=/tmp/orbbec_camera_config.json
```
During field debugging, it is usually better to start the node, confirm the camera state, and then export with `/camera/export_config_json`, so the saved file reflects a confirmed configuration.
## Condensed Field Mapping ## Condensed Field Mapping
The table below lists common SDK JSON fields and their related ROS2 parameters. It is intended to help understand conflicts and overrides; it does not mean every field should be configured through launch. The table below lists common SDK JSON fields and their related ROS2 parameters. It is intended to help understand conflicts and overrides; it does not mean every field should be configured through launch.
@@ -14,7 +14,7 @@ gemini_330_series_sdk_json.launch.py
该启动文件面向 SDK JSON 使用场景,只保留 ROS2 运行和设备管理所需参数,尽量避免 launch 默认相机参数覆盖 JSON 中的配置。 该启动文件面向 SDK JSON 使用场景,只保留 ROS2 运行和设备管理所需参数,尽量避免 launch 默认相机参数覆盖 JSON 中的配置。
`gemini_330_series.launch.py`、`gemini_330_series_low_cpu.launch.py` 等完整启动文件也提供 `load_config_json_file_path` 和 `export_config_json_file_path` 参数,但这些启动文件包含较多相机参数。参数冲突时,launch 或 YAML 中已经传入节点的参数会优先于 JSON 中的对应配置。 `gemini_330_series.launch.py`、`gemini_330_series_low_cpu.launch.py` 等完整启动文件也提供 `load_config_json_file_path` 参数,但这些启动文件包含较多相机参数。参数冲突时,launch 或 YAML 中已经传入节点的参数会优先于 JSON 中的对应配置。
## 参数优先级 ## 参数优先级
@@ -104,17 +104,6 @@ Exported config json file path: /tmp/orbbec_camera_config.json
如果路径为空或导出失败,服务会返回失败信息,并在日志中输出错误原因。 如果路径为空或导出失败,服务会返回失败信息,并在日志中输出错误原因。
## 启动时自动导出
除运行时 service 外,也可以在启动时通过 `export_config_json_file_path` 指定导出路径。节点初始化完成后会自动导出一次当前配置:
```bash
ros2 launch orbbec_camera gemini_330_series_sdk_json.launch.py \
export_config_json_file_path:=/tmp/orbbec_camera_config.json
```
现场调试时更推荐先启动节点并确认相机状态,再使用 `/camera/export_config_json` 导出,避免在配置尚未确认时保存文件。
## 精简字段映射 ## 精简字段映射
下表列出常见 SDK JSON 字段与 ROS2 参数的关系。它用于理解冲突和覆盖关系,不表示所有字段都需要通过 launch 配置。 下表列出常见 SDK JSON 字段与 ROS2 参数的关系。它用于理解冲突和覆盖关系,不表示所有字段都需要通过 launch 配置。