关于 physicalai-runtime-adding-a-camera-backend
这是为 physicalai 添加相机后端的开发技能,面向项目贡献者,涵盖实现、工厂注册、设备发现、可选依赖和测试。
主要功能
- 01实现 Camera 接口
- 02注册工厂类型
- 03配置设备发现
- 04处理可选厂商 SDK
- 05编写单元测试
适用场景
- 01支持新的相机硬件
- 02在 physicalai 中注册后端
- 03无需硬件测试相机代码
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openvinotoolkit/ physicalai --skill physicalai-runtime-adding-a-camera-backend安装后在 Claude Code 中输入/physicalai-runtime-adding-a-camera-backend确认已加载。
详细介绍
添加相机后端
相机通过实现 src/physicalai/capture/camera.py 中的 Camera 接口来构建。工厂入口:src/physicalai/capture/factory.py 中的 create_camera() 将小写类型名称(uvc、realsense、basler 等)映射到相应实现。参考目录:src/physicalai/capture/cameras/uvc/、src/physicalai/capture/cameras/realsense/、src/physicalai/capture/cameras/basler/。
工作流程
- 选择参考后端,选择与新硬件最接近的后端(UVC 适用于 USB 视频、RealSense 适用于 RGB-D、Basler 适用于 GenICam 工业相机)。
- 完成标准:你可以列出需要参照实现的模块(
_camera.py、_discover.py、__init__.py导出)。
- 完成标准:你可以列出需要参照实现的模块(
- 实现
Camera:实现connect()、disconnect()、read()/read_latest()、上下文管理器支持,以及Frame上的单调时间戳(src/physicalai/capture/frame.py)。- 完成标准:使用虚假设备或模拟设备的测试可以在没有硬件的情况下测试连接和读取。
- 如果设备可以枚举,则接入发现功能——在
src/physicalai/capture/discovery.py或后端专用的_discover.py下添加辅助函数。 - 在
src/physicalai/capture/factory.py中注册类型;如果该类面向用户,则从src/physicalai/capture/__init__.py导出。 - 对于厂商 SDK,可在
pyproject.toml中添加可选附加依赖;在相机模块中延迟导入,使pip install physicalai保持轻量。- 完成标准:没有安装附加依赖时,
import physicalai.capture仍可正常运行;缺少附加依赖时,导入相机类会失败并显示清晰的错误消息。
- 完成标准:没有安装附加依赖时,
- 在
tests/unit/capture/中添加测试,使用现有的虚假对象(tests/unit/capture/fake.py、conftest.py中的模式)。- 完成标准:
uv run pytest tests/unit/capture -k <backend>通过。
- 完成标准:
共享传输
对于多进程访问,create_camera(..., shared=True) 会使用 SharedCamera 包装相机(需要 physicalai[capture] / transport 附加依赖,即 iceoryx2)。仅在安装了传输附加依赖时,才记录共享模式。
必须检查的项目
- 如果
CameraType或工厂字符串对用户可见,则需在docs/reference/camera-api.md中记录。 - 帧的形状和数据类型需与 README 示例一致(RGB 为
(H, W, 3))。 - 导入时不得执行会阻塞的发现操作。
验证
uv run pytest tests/unit/capture -q
prek run --all-files
评论
支持 Markdown