docs: add pyorbbecsdk installation instructions

Online/offline install, platform requirements, driver setup for Windows and Linux, based on official docs and GitHub README. Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
2026-04-21 15:46:29 +08:00
parent 821a88a3c7
commit fe2cf3f210
1 changed files with 53 additions and 7 deletions
@@ -24,16 +24,62 @@

 ## 环境依赖

-```
-pyorbbecsdk
-numpy
-opencv-python
-```
+| 包 | 版本 |
+|----|------|
+| Python | 3.8 ~ 3.13 |
+| pyorbbecsdk | 2.x |
+| numpy | — |
+| opencv-python | — |

-安装：
 ```bash
 pip install numpy opencv-python
-# pyorbbecsdk 参考官方安装说明
+```
+
+### 安装 pyorbbecsdk
+
+> 官方文档：https://orbbec.github.io/pyorbbecsdk/source/2_installation/install_the_package.html  
+> GitHub：https://github.com/orbbec/pyorbbecsdk
+
+**支持平台：** Windows 10 x64 / Ubuntu 18.04·20.04·22.04 x64 / ARM64
+
+#### 方式一：在线安装（推荐）
+
+```bash
+# Windows / Linux
+pip install pyorbbecsdk2
+```
+
+> 无论在线（`pyorbbecsdk2`）还是离线安装，最终包目录名均为 `pyorbbecsdk`，`import pyorbbecsdk` 均可正常使用。
+
+#### 方式二：离线安装（.whl）
+
+1. 前往 [Releases](https://github.com/orbbec/pyorbbecsdk/releases) 下载与 Python 版本和平台匹配的 `.whl` 文件  
+   （例：Python 3.11 / Windows → `pyorbbecsdk-2.x.x-cp311-cp311-win_amd64.whl`）
+2. 安装：
+   ```bash
+   pip install pyorbbecsdk-2.x.x-cp311-cp311-win_amd64.whl
+   ```
+
+#### 安装后验证
+
+```bash
+pip show pyorbbecsdk
+```
+
+#### 设备驱动配置
+
+**Windows**（管理员 PowerShell）：
+```powershell
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+.\obsensor_metadata_win10.ps1 -op install_all
+```
+
+**Linux**：
+```bash
+cd pyorbbecsdk/scripts/env_setup
+sudo chmod +x ./install_udev_rules.sh
+sudo ./install_udev_rules.sh
+sudo udevadm control --reload && sudo udevadm trigger
 ```

 ---