pyorbbecsdk 项目安装与使用教程

pyorbbecsdk 项目安装与使用教程

项目地址:https://gitcode.com/gh_mirrors/py/pyorbbecsdk

1. 项目的目录结构及介绍

pyorbbecsdk 项目的目录结构如下：

pyorbbecsdk/
├── CMakeLists.txt
├── LICENSE
├── README.md
├── docs/
│   └── README.md
├── examples/
│   ├── depth_viewer.py
│   ├── net_device.py
│   └── README.md
├── scripts/
│   ├── install_udev_rules.sh
│   └── obsensor_metadata_win10.ps1
├── src/
│   └── pyorbbecsdk/
│       ├── __init__.py
│       └── ...
├── stubs/
├── test/
├── requirements.txt
└── setup.py

目录结构介绍

• CMakeLists.txt: 项目的 CMake 配置文件，用于构建项目。
• LICENSE: 项目的开源许可证文件，本项目使用 Apache-2.0 许可证。
• README.md: 项目的主 README 文件，包含项目的概述和基本使用说明。
• docs/: 包含项目的文档文件，README.md 文件提供了详细的文档说明。
• examples/: 包含项目的示例代码，如 depth_viewer.py 和 net_device.py，README.md 文件提供了示例代码的详细说明。
• scripts/: 包含项目的脚本文件，如 install_udev_rules.sh 用于安装 udev 规则，obsensor_metadata_win10.ps1 用于在 Windows 上配置设备时间戳。
• src/pyorbbecsdk/: 包含项目的源代码，__init__.py 是 Python 包的初始化文件。
• stubs/: 包含项目的 Python 存根文件，用于 IDE 的智能提示。
• test/: 包含项目的测试代码。
• requirements.txt: 项目的依赖文件，列出了项目所需的 Python 包。
• setup.py: 项目的安装脚本，用于生成 Python 包。

2. 项目的启动文件介绍

项目的启动文件主要位于 examples/ 目录下，以下是两个主要的启动文件：

examples/depth_viewer.py

该文件是一个示例程序，用于显示 Orbbec 设备的深度图像。启动该文件的命令如下：

python3 examples/depth_viewer.py

examples/net_device.py

该文件是一个示例程序，用于通过网络连接 Orbbec 设备并显示图像。启动该文件的命令如下：

python3 examples/net_device.py

3. 项目的配置文件介绍

CMakeLists.txt

CMakeLists.txt 是项目的 CMake 配置文件，用于配置项目的构建过程。以下是一些关键配置项：

# 设置项目名称和版本
project(pyorbbecsdk VERSION 1.0.0)

# 查找 Python3 和 pybind11
find_package(Python3 REQUIRED COMPONENTS Interpreter Development)
find_package(pybind11 REQUIRED)

# 添加源文件
add_subdirectory(src/pyorbbecsdk)

requirements.txt

requirements.txt 文件列出了项目所需的 Python 包，以下是一个示例：

numpy
opencv-python
pybind11

setup.py

setup.py 是项目的安装脚本，用于生成 Python 包。以下是一些关键配置项：

from setuptools import setup, find_packages

setup(
    name='pyorbbecsdk',
    version='1.0.0',
    packages=find_packages(),
    install_requires=[
        'numpy',
        'opencv-python',
        'pybind11'
    ],
    entry_points={
        'console_scripts': [
            'depth_viewer=examples.depth_viewer:main',
            'net_device=examples.net_device:main'
        ]
    }
)

通过以上配置，可以生成并安装 pyorbbecsdk 的 Python 包。

pyorbbecsdk OrbbecSDK python binding 项目地址: https://gitcode.com/gh_mirrors/py/pyorbbecsdk