Skip to content

Commit 336b357

Browse files
committed
docs: enhance SDK JSON import guidance by clarifying structured configuration requirements
1 parent 3785953 commit 336b357

2 files changed

Lines changed: 4 additions & 0 deletions

File tree

‎docs/en/source/camera_devices/5_advanced_guide/configuration/sdk_json_config.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ Full launch files such as `gemini_330_series.launch.py` and `gemini_330_series_l
2020

2121
SDK JSON supports partial import. You can remove modules and parameters that are not needed and keep only the content to be imported. Configuration items omitted from the JSON file are not modified by that JSON import; their final values are still determined by launch / YAML parameters, the current device state, or defaults.
2222

23+
Note that ordinary fields under `parameters` can be removed as needed, but structured configurations such as ROI, `frame_interleave`, and `disparity_search` are handled as atomic units: once such a node is retained, all fields required by that node must be provided. For example, an ROI must contain `left`, `right`, `top`, and `bottom`; specifying only one or two coordinates is not supported. If you only want to change the lower-right corner, you must also provide the current upper-left coordinates.
24+
2325
It is recommended to minimize the JSON file for the actual use case. This reduces duplicate configuration and override relationships between JSON and launch / YAML parameters. For example, if only a depth preset and one depth post-processing filter are required, other sensor, point cloud, and unrelated filter configuration can be removed.
2426

2527
After removing modules or parameters, the file must remain valid JSON, and the hierarchy and field names that remain must conform to the SDK JSON format supported by the current device and firmware. Re-import the minimized file and verify the final effective configuration as described below.

‎docs/zh/source/camera_devices/5_advanced_guide/configuration/sdk_json_config.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ gemini_330_series_sdk_json.launch.py
2020

2121
SDK JSON 支持部分导入。可以从 JSON 中删除不需要配置的模块和参数,只保留本次需要导入的内容。未写入 JSON 的配置项不会由本次 JSON 导入修改,其最终值仍由 launch / YAML 参数、设备当前状态或默认配置决定。
2222

23+
需要注意,`parameters` 下的普通字段可以按需删除;但 ROI、`frame_interleave`、`disparity_search` 等结构化配置按整体单元处理:一旦保留该节点,就必须同时提供该节点要求的全部字段。例如,ROI 必须同时包含 `left`、`right`、`top`、`bottom`,不支持只配置其中一个或两个坐标;如果只想修改右下角,也必须同时提供左上角坐标的当前值。
24+
2325
建议根据实际需求精简 JSON,减少它与 launch / YAML 参数之间的重复配置和覆盖关系。例如,只需要配置 depth preset 和某个深度后处理滤波器时,可以删除其他传感器、点云及无关滤波器的配置。
2426

2527
删除模块或参数后,JSON 必须保持合法格式,保留内容的层级和字段名称也必须符合当前设备及固件支持的 SDK JSON 格式。精简后应重新导入,并按下文方法确认最终生效配置。

0 commit comments

Comments
 (0)