CreatorCreator
首页
快速上手
  • 中文简体
  • English
首页
快速上手
  • 中文简体
  • English
  • Creator

    • 快速上手
  • Stream Dock

    • 插件SDK
    • 图标包

      • 概述
      • 术语
      • 创建图标包
      • 图标规格
    • 场景配置

      • 什么是场景配置?
      • 导出
      • 使用案例
  • mPanel

    • 插件SDK
  • Cpp SDK

    • 概述
    • 依赖安装
    • 设备管理器
    • StreamDock 基类
    • 通信传输
    • 示例
    • API参考
    • 源代码
  • Python SDK

    • 概述
    • 依赖安装
    • 设备管理器
    • StreamDock 基类
    • API 参考
    • 示例
    • 源代码
  • Windows-WebSocket SDK

    • 概述
    • 快速上手
    • 发送的事件
    • 接收的事件
    • 源代码
  • 支持

    • 帮助和错误报告

概述

Python StreamDock SDK 是用于在多个平台上(包括 Windows、macOS 和 Linux)绕过软件直接控制 StreamDock 设备的SDK,您可以通过本SDK轻松实现对设备的直接控制。

Python StreamDock SDK

SDK 架构

Python StreamDock SDK 采用分层架构设计,主要包含以下组件:

  • 设备管理层:DeviceManager 类负责设备的枚举、检测和监听
  • 传输层:LibUSBHIDAPI 类负责与设备的底层通信
  • 设备抽象层:StreamDock 基类定义了所有设备的通用接口
  • 具体设备实现:各种型号设备的特定实现,如 StreamDock293、StreamDockN3 等
  • 图像处理层:PILHelper 类提供图像转换和处理功能

支持的设备型号

SDK 支持以下 StreamDock 设备型号:

  • StreamDock 293 系列:293、293s、293V3
  • StreamDock N 系列:N1、N3、N4、N4Pro
  • StreamDock M 系列:M3、M18(包括多个版本)
  • StreamDock XL
  • K1 Pro

Python StreamDock SDK 如何与设备通信

Python StreamDock SDK 使用 HIDAPI 与设备通信,HIDAPI 是一个用于与 HID 设备通信的简单跨平台库,查看详情

SDK 通过以下方式与设备交互:

  1. 设备枚举:使用 USB Vendor ID 和 Product ID 识别连接的 StreamDock 设备
  2. 数据传输:通过 HID 接口发送命令和接收设备反馈
  3. 图像处理:将图像转换为设备兼容的格式并传输到设备
  4. 事件监听:监听按键事件和设备状态变化

主要功能

  • 设备管理:自动检测连接的设备,支持热插拔
  • 屏幕控制:设置背景图像、调整亮度、唤醒屏幕
  • 按键控制:设置按键图标、清除按键图标、监听按键事件
  • 图像处理:自动转换图像格式以适应不同设备
  • 多线程支持:支持异步事件处理和回调函数

TIP

系统要求:

  • Python 版本:推荐 3.7 或更高版本
  • 支持的操作系统:Windows、macOS、Linux(推荐 Ubuntu 20.04+)
  • USB 端口:用于连接 StreamDock 设备
Last Updated:
Contributors: JKWTCN
Next
依赖安装