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

    • 快速上手
  • Stream Dock

    • 插件SDK
    • 图标包

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

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

    • 插件SDK
  • Linux StreamDock SDK

    • Cpp SDK

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

      • 概述
      • 依赖安装
      • 设备管理器
      • StreamDock 基类
      • StreamDock293
      • 示例
      • 源代码
  • Windows StreamDock SDK

    • WebSocket SDK

      • 概述
      • 快速上手
      • 发送的事件
      • 接收的事件
    • Cpp SDK

      • 概述
      • 依赖安装
      • 设备管理器
      • StreamDock 基类
      • StreamDock293
      • 通信传输
      • 示例
      • 源代码
  • 支持

    • 帮助和错误报告

通信传输

基础传输层,表示一个抽象的通信后端

打开设备

/*
@note:打开设备,使用设备路径打开
@param path :图片的路径
@return 成功返回1,如果出错返回-1
*/
int open(char *path);

获取设备的固件id

 /*
@note:获取设备的固件id
@param lenth :固件号长度(默认写512)
@return 成功返回1,如果出错返回-1
*/
unsigned char *getInputReport(int lenth);

读取设备的反馈信息

 /*
@note:读取设备的反馈信息 
按键事件
byte            内容        值         描述
data[0]     回复的格式      0x41-A     
data[1]     回复的格式      0x43-C  
data[2]     回复的格式      0x4B-K  
data[3-4]       预留
data[5]     回复的格式      0x4F-O  
data[6]     回复的格式      0x4B-K
data[7-8]       预留
data[9]     按键下标        0x01-0x0F
data[10]     按键事件       0x00-0x01  0x00 按键抬起,0x01按键按下  

应答消息  
data[0]     回复的格式      0x41-A     
data[1]     回复的格式      0x43-C  
data[2]     回复的格式      0x4B-K  
data[3-4]       预留
data[5]     回复的格式      0x4F-O  
data[6]     回复的格式      0x4B-K
data[7-8]       预留
data[9]     表示应答        0x00
data[10-13]     预留  
@param data :用来接受反馈信息的unsigned char 数组
@param lenth :数组长度
@return 成功返回1,如果出错返回-1
*/
int read(unsigned char *data,unsigned long lenth);

向设备下发信息

/*
@note:向设备下发信息
@param data:装有数据的unsigned char数组
@param lenth:数组长度
@return 成功返回1,如果出错返回-1
*/
int write(unsigned char *data,unsigned long lenth);

将enumerate返回的设备信息列表销毁

/*
@note:将enumerate返回的设备信息列表销毁
@param devs :装有设备信息的链表
@return 成功返回1,如果出错返回-1
*/
void freeEnumerate(hid_device_info *devs);

获取设备信息列表

/*
@note:获取设备信息列表
@param vid:设备vid
@param pid:设备pid
@return 成功返回1,如果出错返回-1
*/
hid_device_info *enumerate(int vid, int pid);

设置设备屏幕亮度 1-100

/*
@note:设置设备屏幕亮度 0-100
@param percent :亮度 0-100
@return 成功返回1,如果出错返回-1
*/
int setBrightness(int percent);

设置设备屏幕的背景图

/*
@note:设置设备屏幕的背景图
@param buffer:放有BGR数据的unsigned char数组地址
@param size:数组大小
@return 成功返回1,如果出错返回-1
*/
int setBackgroundImg(unsigned char *buffer);

设置设备某个按键的图标

/*
@note:设置设备某个按键的图标
@param path:图片路径
@param key:按键标号
@return 成功返回1,如果出错返回-1
*/
int setKeyImg(std::string path,int key);

设置设备某个按键的图标

/*
@note:设置设备某个按键的图标
@param buffer,装有图片信息的unsigned char 数组
@param key:按键标号
@param width: 图片长度
@param height:图片高度
@return 成功返回1,如果出错返回-1
*/
int setKeyImgdata(unsigned char* buffer, int key, int width, int height);

清空某个按键的图标 1-15

/*
@note:清空某个按键的图标
@param index :按键标号(1-15)
@return 成功返回1,如果出错返回-1
*/
int keyClear(int i);

清空所有按键的图标

/*
@note:清空所有按键的图标
@return 成功返回1,如果出错返回-1
*/
int keyAllClear();

唤醒屏幕

/*
@note:唤醒屏幕
@return 成功返回1,如果出错返回-1
*/
int wakeScreen();

在数据传输完成后可以用这个刷新显示

/*
@note:在数据传输完成后可以用这个刷新显示
@return 成功返回1,如果出错返回-1
*/
int refresh();

断开连接

/*
@note:断开连接
@return 成功返回1,如果出错返回-1
*/
int disconnected();

关闭设备

/*
@note:关闭设备
@return 成功返回1,如果出错返回-1
*/
void close();
Last Updated:
Contributors: Heart
Prev
StreamDock293
Next
示例