From 68edb0dc4c874cb253c703440b80e43c910c7949 Mon Sep 17 00:00:00 2001 From: ykcheungab Date: Tue, 6 Oct 2026 14:27:56 +0800 Subject: [PATCH] =?UTF-8?q?=E5=8E=BB=E6=8E=89=E4=B8=8E=20examples/README.m?= =?UTF-8?q?d=20=E9=87=8D=E5=A4=8D=E7=9A=84=E7=A4=BA=E4=BE=8B=E8=B5=B0?= =?UTF-8?q?=E6=9F=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 本文件 L184-265 重复了 examples/README.md 已有的内容：示例清单、各产品入口、全部命令与参数、3dview 说明。删掉重复段落改为指向该文件，只保留首次运行所需的最短路径，并把 Windows/Ubuntu 的取 ID 步骤与运行结果合并，不再各写一遍。 验证：doc_count 1439/1775，doc_lint changed 与 --all 均干净。 --- docs/get_started.md | 77 +++++---------------------------------------- 1 file changed, 7 insertions(+), 70 deletions(-) diff --git a/docs/get_started.md b/docs/get_started.md index 2998848..b46e3d5 100644 --- a/docs/get_started.md +++ b/docs/get_started.md @@ -182,84 +182,21 @@ python examples/basic_pipeline.py -v 0 -c box --calibration-dir data/calibration 若该设备的标定文件不存在，SDK 不应用标定，力值保持 raw，也不会回退到产品默认标定。若文件存在，但其中的设备 ID、产品类型或测量设置与当前设备不匹配，SDK 会报错。FingerRuntime.open() 支持这两个参数，但 finger_pipeline.py 目前还没有对应的命令行参数。 ### 运行示例程序 -套件里面包含了多个例子。运行示例前，请先进入 SDK 示例所在的文件夹，建议在仓库根目录运行（即 `config/`、`examples/`、`assets/` 同级目录）。如果您是通过 PyPI 安装并且本地没有示例文件，可以从上方项目链接下载示例。按产品入口如下： -1. `examples/basic_pipeline.py`：ORY-BOX 复眼/拼接传感器基础 OpenCV 示例（默认配置 `box`） -2. `examples/mini_pipeline.py`：ORY-MINI 基础 OpenCV 示例（默认配置 `mini`） -3. `examples/finger_pipeline.py`：ORY-FINGER 2D 显示最小流程（默认配置 `finger`） -4. `examples/finger_pipeline_3dview.py`：ORY-FINGER Qt 3D 可视化界面（默认配置 `finger`） +示例的完整清单、每个产品对应的入口、全部命令与参数，见 [`examples/README.md`](../examples/README.md)。这里只给第一次运行的最短路径。 -`finger` 是当前 ORY-FINGER 的产品配置名。 +先在仓库根目录（即 `config/`、`examples/`、`assets/` 同级）确认传感器 ID： -下面先介绍最基础的 ORY-BOX 运行方式。 +- Windows：在 PowerShell 运行 `Get-PnpDevice -PresentOnly | Where-Object { $_.Class -match '^Camera' }`。若插上传感器后多出一行，ID 为 `1`，否则为 `0`。 +- Ubuntu：运行 `v4l2 --list-devices`，从新增的设备名取编号（`/dev/video0` 即 ID `0`）。 -#### Windows -1. 检查是否有其他正在连接的 USB 摄像头设备：打开 PowerShell，运行命令 `Get-PnpDevice -PresentOnly | Where-Object { $_.Class -match '^Camera' }`，如果没有的话不会有输出。 -2. 把传感器的 USB 头与电脑连接，再次运行步骤一的命令，会新增一行输出。 -3. 如果第一步没有输出，传感器的 ID 就是 `0`；如果第一步有一个设备，传感器的 ID 就是 `1`，如此类推。 -4. 在确定了传感器的 ID（下方例子假设为 `0`）后，打开 Anaconda Prompt，切换到工作路径，然后在命令行中输入： - ```bash - python examples/basic_pipeline.py -v 0 -c box - ``` -5. 程序会运行，并自动打开可视化窗口和打印资料。在窗口上按键盘 `q` 键可以停止运行，按 `r` 键可以重设数据。 - -#### Ubuntu -1. 检查是否有其他正在连接的 USB 摄像头设备：打开终端，运行命令 `v4l2 --list-devices`，如果没有的话不会有输出。 -2. 把传感器的 USB 头与电脑连接，再次运行步骤一的命令，会新增输出。 -3. 根据新增的输出，例如 `/dev/video0`，确定传感器的 ID 为 `0`；如果是 `/dev/video3`，ID 为 `3`，如此类推。 -4. 在确定了传感器的 ID（下方例子假设为 `0`）后，打开终端，激活相应的 Python 环境，切换到工作路径，然后在命令行中输入： - ```bash - python examples/basic_pipeline.py -v 0 -c box - ``` -5. 程序会运行，并自动打开可视化窗口和打印资料。在窗口上按键盘 `q` 键可以停止运行，按 `r` 键可以重设数据。 - -#### ORY-FINGER 示例 - -如果您使用的是 ORY-FINGER（配置名 `finger`），可运行： +然后运行（假设 ID 为 `0`）： ```bash -python examples/finger_pipeline.py --camera_id 0 --config finger +python examples/basic_pipeline.py -v 0 -c box ``` -如果输入来自视频文件，也可以改用： - -```bash -python examples/finger_pipeline.py --video ./data/sample.mp4 --config finger -``` - -该示例会： - -- 读取相机或视频源 -- 将图像展开到平面 -- 计算光流、法向/切向力和接触区域 -- 在 OpenCV 窗口中显示展开后的光流箭头图 - -常用参数： - -- `--verbose`：输出更详细的初始化日志 - -例如： - -```bash -python examples/finger_pipeline.py --camera_id 0 --config finger -``` - -#### ORY-FINGER 3D 可视化界面 - -如果要使用 GUI，先安装 GUI 依赖： -```bash -pip install "orisys[gui]" -``` -然后运行： -```bash -python examples/finger_pipeline_3dview.py --video 0 --config finger -``` - -该界面会提供： - -- 手指平面化光流箭头显示 -- 力曲线 -- 3D 视图 +窗口打开后按 `q` 停止，按 `r` 重设数据。若本地没有示例文件（例如通过 PyPI 安装），从项目链接下载。 ### 开发套件使用方法 参考开发套件附带的开发文档。 \ No newline at end of file