Psi-glove-sdk-docs

Appearance

2. SDK安装和配置方法 ​

2.1 系统要求 ​

  • Python 版本: 3.7 或更高版本
  • 操作系统: Linux / Windows / macOS
  • 依赖库: pyserial >= 3.5
  • 可选库: numpy >= 1.20（用于性能加速）、matplotlib >= 3.5（用于可视化）

2.2 安装方法 ​

方法 1: 从源码安装（推荐） ​

bash
# 进入 Python SDK 目录
cd psi-glove-SDK/python_sdk

# 以可编辑模式安装 SDK（会自动安装依赖）
pip3 install -e .

# 验证安装
python3 -c "import psi_glove_sdk; print('安装成功！版本:', psi_glove_sdk.__version__)"

方法 2: 仅安装依赖 ​

bash
cd psi-glove-SDK/python_sdk

# 安装基础依赖
pip3 install -r requirements.txt

# 可选：安装性能加速库
pip3 install numpy>=1.20

# 可选：安装可视化工具
pip3 install matplotlib>=3.5

2.3 SDK 可配置参数说明 ​

SDK 提供多个可配置参数以适应不同应用场景：

SerialInterface 构造函数参数 ​

参数名称类型默认值说明
portstr必填串口设备路径（如 /dev/ttyACM0, COM31）
baudrateint115200通信波特率，支持 115200、500000 等
timeoutfloat0.006读写超时时间（秒），建议 6ms
auto_connectboolFalse是否在创建时自动连接设备
mockboolFalse模拟模式，用于测试（无需实际硬件）

PSIGloveController 构造函数参数 ​

参数名称类型默认值说明
communication_interfaceCommunicationInterface必填通信接口实例（如 SerialInterface）
smoothing_window_sizeint10移动平均滤波窗口大小（样本数），值越大越平滑但延迟越高

参数选择建议：

  • 高频采集：baudrate=500000, smoothing_window_size=5
  • 稳定数据：baudrate=115200, smoothing_window_size=10
  • 低延迟：timeout=0.006, smoothing_window_size=3

2.4 典型配置示例 ​

python
from psi_glove_sdk import PSIGloveController, SerialInterface

# 配置 1: 标准配置（推荐）
serial = SerialInterface(
    port="/dev/ttyACM0",
    baudrate=115200,
    timeout=0.006,
    auto_connect=False,
    mock=False
)
controller = PSIGloveController(
    communication_interface=serial,
    smoothing_window_size=10
)

# 配置 2: 高速配置（低延迟）
serial_fast = SerialInterface(
    port="COM31",
    baudrate=500000,
    timeout=0.003,
    auto_connect=True
)
controller_fast = PSIGloveController(
    communication_interface=serial_fast,
    smoothing_window_size=5
)

# 配置 3: 模拟模式（用于测试）
serial_mock = SerialInterface(
    port="/dev/ttyUSB0",
    baudrate=115200,
    mock=True  # 启用模拟数据生成
)
controller_mock = PSIGloveController(
    communication_interface=serial_mock,
    smoothing_window_size=10
)