API文档

📚 API 文档
本文档提供了 pyvitaisdk 的完整 API 参考，包括设备管理和传感器数据采集的所有功能。

---

🎯 功能概览

pyvitaisdk 主要提供以下两大类功能：

🔍 设备管理

通过 VTSDeviceFinder 类查找、列举和管理连接的视触觉传感器设备

📊 数据采集

通过 VTSensor 类采集图像、深度图、Marker 位移、滑动状态等多维数据

---

📖 API 目录

🔍 VTSDeviceFinder 类 - 设备管理

用于查找和管理纬钛视触觉传感器设备的核心类。

方法名	说明	返回类型
VTSDeviceFinder()	实例化设备查找器类	VTSDeviceFinder
get_devices	获取所有连接的设备列表	List[VTSDeviceConfig]
count	获取当前连接的设备数量	int
indexes	获取所有设备的索引列表	List[int]
get_sns	获取所有设备的序列号列表	List[str]
get_device_by_sn	根据序列号获取指定设备	Optional[VTSDeviceConfig]

📊 VTSensor 类 - 传感器操作

用于操作纬钛视触觉传感器的核心类，提供数据采集和处理功能。

方法名	说明	返回类型
VTSensor	实例化 VTSensor 传感器类	VTSensor
calibrate	执行传感器校准	None
collect_sensor_data	采集传感器的视触觉数据	dict
release	释放传感器实例占用的资源	None

---

🚀 快速开始示例

基础示例：查找设备并采集数据

from pyvitaisdk import VTSDeviceFinder, VTSensor, VTSDataType

# 1. 查找设备
finder = VTSDeviceFinder()
devices = finder.get_devices()

if not devices:
    print("❌ 未找到设备")
    exit(1)

print(f"✅ 找到 {len(devices)} 个设备")

# 2. 初始化传感器
sensor = VTSensor(devices[0])

# 3. 校准传感器
print("📸 正在校准传感器...")
sensor.calibrate()

# 4. 采集数据
data = sensor.collect_sensor_data(
    VTSDataType.WARPED_IMG,
    VTSDataType.DEPTH_MAP,
    VTSDataType.SLIP_STATE
)

# 5. 处理数据
warped_img = data[VTSDataType.WARPED_IMG]
depth_map = data[VTSDataType.DEPTH_MAP]
slip_state = data[VTSDataType.SLIP_STATE]

print(f"图像尺寸: {warped_img.shape}")
print(f"滑动状态: {slip_state.name}")

# 6. 释放资源
sensor.release()
print("✅ 完成")

高级示例：多设备管理

from pyvitaisdk import VTSDeviceFinder, VTSensor

# 查找所有设备
finder = VTSDeviceFinder()

# 获取设备序列号
serial_numbers = finder.get_sns()
print(f"设备序列号: {serial_numbers}")

# 使用特定序列号的设备
if serial_numbers:
    device = finder.get_device_by_sn(serial_numbers[0])
    sensor = VTSensor(device)
    sensor.calibrate()
    # ... 使用传感器 ...
    sensor.release()

---

💡 使用技巧

最佳实践

• 异常处理：始终使用 try-finally 确保 release() 被调用
• 按需采集：只请求需要的数据类型以提高性能

性能优化

• 在循环采集数据时，避免重复创建和释放传感器实例
• 使用合适的输出分辨率平衡性能和精度
• 考虑使用多进程处理多个传感器

常见陷阱

• 忘记调用 calibrate() 会导致数据不准确
• 未调用 release() 可能导致设备无法再次打开
• 校准时传感器表面必须无接触

---

📚 详细文档

点击上方 API 目录中的任意方法名，查看详细的参数说明、返回值、示例代码和注意事项。

---

🆘 获取帮助

如果您在使用过程中遇到问题：

1. 查看 API 文档 - 点击具体方法了解详细用法
2. 查看示例代码 - 每个 API 都提供了完整的示例
3. 联系技术支持 - 通过官网获取帮助

🎉 开始使用
现在您已经了解了 API 的基本结构，点击上方的方法名称查看详细文档，开始您的开发之旅！