Skip to content

Giraffe 指令集 ​

指令集使能开关:启用或禁用整个指令集通信功能,默认是关闭。

PC 模拟端口:用于 PC 端模拟调试的虚拟串口,仅在 PC 模拟运行时生效。

用户端口:实际硬件运行时使用的物理串口编号。-1 表示使用默认端口,非 -1 为指定端口号。

波特率:串口通信速率。

数据位:每帧数据包含的有效二进制位数,可选BIT_8和BIT_7。

奇偶校验位:校验方式,可选值:无校验、奇校验、偶校验。

停止位:帧结束标志位,通常为 1 位。

帧头高字节 (Hex):通信帧起始标志的高 8 位,用于帧同步。

帧头低字节 (Hex):通信帧起始标志的低 8 位,与高字节共同构成帧头。

缓冲区长度:收发数据缓冲区的大小(单位:字节)。

超时时间 (ms):等待下位机响应的最大时间,超时则判定通信失败。

写入指令返回报告:勾选后,上位机下发写入类指令时,会等待并校验下位机的返回结果,确保指令执行成功。

CRC 使能开关:启用后,通信帧将附加 CRC 校验码,用于检测数据传输过程中的错误,提升通信可靠性。

事件下发模式:用于配置控件事件上报的策略。

  • 0 无:不上发任何控件事件,仅执行基础通信。

  • 1 全部控件:所有控件产生的事件均上报给下位机,点击右边 “配置事件指令” 按钮后,会弹出事件配置窗口,用于精确选择需要上报的事件类型。

  • 2 自定义控件:仅上报单个控件通过控件属性中 “下发事件指令选择” 配置的事件类型。

当选择 “2 自定义控件” 模式时,事件上报不再是全局配置,而是需要在单个控件的属性界面中进行精确设置:

在控件属性的 特殊功能分类下,找到 下发事件指令选择 选项,点击 点击配置 按钮。

  • 跟随可触发事件:当勾选此选项后(默认勾选),控件上报给下位机的事件类型,将自动与可触发事件 中勾选的类型保持完全一致,若修改了可触发事件的勾选,下发事件指令选择的配置会自动同步更新。

取消勾选跟随可触发事件后,可以手动选择需要上报的事件类型,例如:控件可以响应 “控件按下” 和 “控件触摸抬起” 两个事件,但你可以只勾选上报 “控件触摸抬起”,从而减少不必要的通信流量。

Giraffe 详细指令 ​

指令介绍 ​

定义帧头数据长度读写指令类型指令数据CRC校验
字节个数21/21N22
数据5A A5该参数的所有数据11(读)/22(写)B0/B1/...控制指令+数据CRC16

数据长度: 指令类型:

数据长度 ​

第一个字节的最高位如果为1,即0x80时,代表该参数为2个字节,否则为1个字节(1-128)

读写说明 ​

指令以参数的形式进行读写,11(读)/22(写)

读取数据: TX : 帧头 + 数据长度 + 11 + 指令类型 + 控制指令 + (CRC16)
RX : 帧头 + 数据长度 + 11 + 指令类型 + 控制指令 + 数据 + (CRC16)

写入数据: TX : 帧头 + 数据长度 + 22 + 指令类型 + 控制指令 + 数据 + (CRC16)
RX : 帧头 + 数据长度 + 22 + 指令类型 + 控制指令 + 00/01 + (CRC16)

说明:接收到的数据 00 - 代表写入成功 / 非零 - 代表写入失败

例如:

  1. 读取驱动版本号
yml
TX : 5A A5 04 11 B0 00 02 
RX (读取成功) : 5A A5 0A 11 B0 00 02 31 2E 34 2E 35 00     //ver=1.3.5 
RX (读取失败) : 5A A5 0A 11 B0 00 02                         //读取失败,返回不带参数的原始命令
读取成功会返回对应参数,读取失败直接返回指令,无参数。例如读取驱动版本号失败,返回 RX : 5A A5 04 11 B0 00 02
  1. 写入背光亮度
yml
TX : 5A A5 04 22 B0 02 32                 //写入50亮度
RX : 5A A5 04 22 B0 02 00                 //00-写入成功,非零-写入失败, 可以关闭该返回值

CRC16 校验 ​

CRC16不包括帧头和数据长度,仅针对指令和数据。

示例代码 ​

C
u16 crc16_ccitt(u8 * tmp, u32 num)
{
    u16 CrcTmp = 0x0;
    u32  i = 0, j = 0;
    u16 s = 0;
    u16 tmpcrc = 0;

    for (i = 0; i < num; i++)
    {
        tmpcrc  = tmp[i] << 8;
        tmpcrc  &= 0xff00;
        CrcTmp  ^= tmpcrc;

        for (j = 0; j < 8; j++)
        {
            s = CrcTmp & 0x8000;
            CrcTmp <<= 1;
            CrcTmp  &= ~(0x0001);

            if(s){
                CrcTmp ^= 0x1021;
            }
        }
    }

    return CrcTmp;
}

约定文档描述规则 ​

参数类型说明 ​

定义标识符字节个数数据范围说明
字符串stringN字节个数不定,字符串以00结尾
有符号单字节s81-128 ~ 127具体范围以参数说明为准
无符号单字节u810 ~ 255具体范围以参数说明为准
有符号双字节s162-32,768 ~ 32,767具体范围以参数说明为准
无符号单字节u1620~65,535具体范围以参数说明为准
有符号四字节s324-$2^{31}$ ~ $2^{31}$-1具体范围以参数说明为准
无符号四字节u3240 ~ $2^{32}$具体范围以参数说明为准

参数描述规则 ​

  1. 一个指令可能会包括多个参数,会以param1,param2,...来描述
  2. 参数类型以param后的第一个括号来说明,例如 param1(string) 即为参数1为string类型,符合参数类型说明的字节个数和数据范围
  3. 数据范围以参数类型指定,但是有些参数取值会小于参数类型指定范围,文档会以参数第二个括号说明,例如param1(u8)(0-100) 即为,参数1为u8类型,取值范围为0-100,无第二个括号,即以类型范围为准
  4. 参数描述,在描述完类型和取值范围后,以冒号后说明参数功能
  5. 发送指令以参数序号顺序发送和获取

指令类型 ​

定义指令类型
系统指令B0
view 功能控制B1
ctrl 功能控制B2

指令内容 ​

系统指令(0xB0) ​

系统指令的指令数据 = 功能指令 + 输入参数+ 读写参数

定义R/W功能指令输入参数读写参数说明
获取版本号R00param1(u8)(00-02):版本号
00-APP版本;
01-UI版本;
02-驱动版本
param1(string):版本号用户设计代码版本
复位报告R01无param1(u16)(固定 AA BB):复位标识主动上报,当设备上电或者意外重启,屏幕会发送 AA BB 告知设备已经启动,用户可以检测到标识后重启用户主机
复位设备W01无param1(u16)(固定 CC DD):复位标识当发送CC DD,屏幕会自动复位.当客户主机意外重启,可以发送该指令同步屏幕重启
背光亮度W02无param1(u8)(0-100):亮度值
提示音(tone)W03无param1(u8):鸣响次数
param2(u16):每次鸣响间隔时间,单位ms
param3(u16):每次鸣响时间,单位ms
param3:蜂鸣器有效,该设置会同步到触摸提示音上
触摸配置R/W04 00无param1(u8):配置参数
bit0:1-触摸关闭,0-触摸打开
bit1:1-触摸时鸣响, 0-触摸时不响
bit2:1-触摸有效区域鸣响,0-触摸整个触摸区域鸣响
bit3:1-抬起鸣响,0-按下鸣响
bit4:1-按下上传坐标,0-按下不上传坐标
bit5:1-抬起上传坐标,0-抬起不上传坐标
bit6:1-一直按下时,每个100ms上传一次坐标,0-不上传坐标
bit7:1-在5秒内连续点击某个区域20下,屏幕进入触摸校准,0-禁止此功能
触摸坐标R04 01无param1(u8)(0-1):按下事件
0-抬起 1-按下
param1(u16)(0-4096):坐标X
param2(u16)(0-4096):坐标Y
主动上报
RTCR/W05无param1(u16)(1990-2099):年
param2(u8)(1-12):月
param3(u8)(1-31):日
param4(u8)(0-23):时
param5(u8)(0-59):分
param6(u8)(0-59):秒
待机参数配置R/W06 00无param1(u16):屏幕保护页面,0-无保护页面
param2(u16):待机时间,0-无待机,单位秒
param3(u8):待机亮度
param4(u16):关闭屏幕时间,0-不关闭屏幕,单位秒
param5(u8):关闭屏幕亮度
param6(u8):激活屏幕亮度
param7(u16):激活页面,0-使用进入待机前界面
1.如果有屏幕保护页面,第一次激活会亮屏显示屏保界面,再次点击进入激活页面
2.激活方式方式有串口(06 01)指令激活和触摸点击激活
3.直接切换页面和改变屏幕也可以退出待机进入激活状态
待机状态R/W06 01param1(u8):待机状态
1 - 进入待机状态
0 - 退出待机状态
语言选择W07 00param1(str):语言字符

View 视图指令(0xB1) ​

view 控制指令的指令数据 = 功能指令 + 输入参数 + 读写参数

定义R/W功能指令输入参数读写参数说明
显示视图W00无param1(u16):视图ID
获取当前显示的视图IDR01param1(u8)(0-2):图层
0 - UI图层;1 - 状态图层;2 - 顶层图层
param1(u16):视图ID
设置显示图层位置W02param1(u16):视图IDparam1(u8)(0-2):图层
0 - UI图层;1 - 状态图层;2 - 顶层图层
隐藏图层W03无param1(u8)(0-2):图层
0 - UI图层;1 - 状态图层;2 - 顶层图层
加载视图资源,但是不显示W04无param1(u16):视图ID
设置视图背景色W05param1(u16):视图ID
param1(u32):颜色
得到视图宽高R06无param1(u16):视图宽度 param2(u16):视图高度
设置视图背景图片W07param1(u16):视图IDparam1(str):图片名

Ctrl 控件指令(0xB2) ​

view 控制指令的 指令数据 = 控件类型指令+ 功能指令 + 页面ID + 控件ID + 输入参数 + 读写参数

控件类型指令 为 u8 单字节类型, 包括 公共指令(0xF0) 、label控件指令(0x00) 、button控件指令(0x01) 等控件类型指令

页面ID/ 控件ID 为u16 双字节类型

公共指令(0xF0) ​

定义R/W功能指令输入参数读写参数说明
设置控件是否隐藏W00无param1(u8)(0-1):是否隐藏
1 - 隐藏控件 ; 0 - 显示控件
获取控件宽度R01无param1(u16):控件宽度值
获取控件高度R02无param1(u16):控件高度值
设置控件显示位置W03无param1(s16):控件x轴坐标
param2(s16):控件y轴坐标
设置控件显示大小W04无param1(u16):控件宽度
param2(s16):控件高度
设置控件透明度W05无param1(u8):控件透明度
设置控件前置或后置W06无param1(u8)(0-1):控件前置或后置
1 - 控件前置 ; 0 - 控件后置
设置控件点击模式W07无param1(u8)(0-1):控件点击模式
1 - 可以点击 ; 0 - 禁止触摸
接收点击事件R87 00无自动发送
param1(u8):点击事件枚举
详细请查看event事件枚举值
扩大控件触摸点击范围W08无param1(u16):扩大范围值
设置控件之间的相对位置W09param1(u16):对齐的基准控件的编号param1(u8)(1-15):对齐方向
对齐方向
1 - 在控件内部顶端靠左对齐
2 - 在控件内部顶端中间对齐
3 - 在控件内部顶端靠右对齐
4 - 在控件内部底端靠左对齐
5 - 在控件内部底端中间对齐
6 - 在控件内部底端靠右对齐
7 - 在控件内部靠左居中对齐
8 - 在控件内部靠右居中对齐
9 - 居中对齐
A - 在控件外部顶端靠左对齐
B - 在控件外部顶端中间对齐
C - 在控件外部顶端靠右对齐
D - 在控件外部底端靠左对齐
E - 在控件外部底端中间对齐
F - 在控件外部底端靠右对齐
10 - 在控件外部靠左顶部对齐
11 - 在控件外部靠左居中对齐
12 - 在控件外部靠左底部对齐
13 - 在控件外部靠右顶部对齐
14 - 在控件外部靠右居中对齐
15 - 在控件外部靠右底部对齐(s16):x轴偏移(0直接对齐,小于0左移,大于0右移)
param1(s16):y轴偏移
获取控件的子控件数量R0A无param1(u16):子控件数量
获取控件的坐标R0B无param1(s16):x轴坐标 param1(s16):y轴坐标
设置控件的滚动量,可设置动画W0C无param1(u8)(0-1):是否开启动画 0 - 否 1- 是 param2(s16):x轴坐标 param3(s16):y轴坐标
获取控件的滚动量R0D无param1(s16):x轴坐标 param2(s16):y轴坐标

Label标签控件指令(0x00) ​

定义R/W功能指令输入参数读写参数说明
文本内容R/W00无param1(string):文本内容
设置文本颜色W01无param1(u32):文本颜色
设置文本大小W02无param1(u16):文本文字大小
设置长文本显示模式W03无param1(u8)(0-4):显示模式
0 - 控件宽不变,超过区域换行,改变高度
1 - 控件宽高不变,文本超过区域,显示...
2 - 控件宽高不变,文本超过区域,自动循环向前向后滚动文本
3 - 控件宽高不变,文本超过区域,自动循环环形滚动文本
4 - 控件宽高不变,超过的文本内容将会被剪切掉
设置长文本滚动速度W04无param1(u16):滚动速度
设置文本对齐方式W05无param1(u8):文本对齐方式(1-3,10,20,30)
1 - 文本内部水平方向左对齐
2 - 文本内部水平方向居中对齐
3 - 文本内部水平方向右对齐
10 - 文本内部竖直方向上对齐
20 - 文本内部竖直方向居中对齐
30 - 文本内部竖直方向下对齐
注:可相与调整对齐方式,比如 22 - 文本水平居中且竖直居中对齐,即居中对齐

Btn按钮控件指令(0x01) ​

定义R/W功能指令输入参数读写参数说明
按钮文本内容W00无param1(string):文本内容
按钮不同状态文本颜色W01无param1(u8):按钮状态
0 - 正常释放状态
1 - 切换或者选中
2 - 点击
4 - 聚焦
8 - 编辑
20 - 已按下
40 - 滚动状态
80 - 禁用
param2(u32):文本颜色
按钮文本大小W02无param1(u16):按钮文本文字大小
按钮显示模式W03无param1(u8)(0-1):模式
0 - 按钮模式
1 - 切换模式
按钮状态R/W04无param1(u8):按钮状态
0 - 正常释放状态
1 - 切换或者选中
2 - 点击
4 - 聚焦
8 - 编辑
20 - 已按下
40 - 滚动状态
80 - 禁用

Image图片控件指令(0x02) ​

定义R/W功能指令输入参数读写参数说明
显示和获取图片W/R00无param1(string):图片名和路径
旋转图片W01无param1(u16):图片旋转角度
设置旋转或缩放中心W02无param1(s16):x轴坐标
param2(s16):y轴坐标
设置图片缩放128缩小一倍,256原始大小,512放大一倍W03无param1(u16):缩放大小

Image Button图片按钮控件指令(0x03) ​

定义R/W功能指令输入参数读写参数说明
设置图片按钮文字W00无param1(string):文本内容
设置图片按钮文字颜色W01无param1(u8)(0-5):按钮状态
0 - 正常释放状态
1 - 正常按下状态
2 - 正常禁用
3 - 按钮的切换(Toggle)释放状态
4 - 按钮的切换(Toggle)按下状态
5 - 切换的禁用的状态
param2(u32):文字颜色
设置图片按钮文字大小W02无param1(U16):文字大小
设置图片按钮状态W03无param1(u8)(0-5):按钮状态
0 - 正常释放状态
1 - 正常按下状态
2 - 正常禁用
3 - 按钮的切换(Toggle)释放状态
4 - 按钮的切换(Toggle)按下状态
5 - 切换的禁用的状态
设置图片按钮不同状态的显示图片W03无param1(u8)(0-5):按钮状态
0 - 正常释放状态
1 - 正常按下状态
2 - 正常禁用
3 - 按钮的切换(Toggle)释放状态
4 - 按钮的切换(Toggle)按下状态
5 - 切换的禁用的状态 param2(string):图片名

Line线条控件指令(0x04) ​

定义R/W功能指令输入参数读写参数说明
设置线条显示样式W00无param1(u32):线条颜色
param2(u16):线条宽度
param3(u8):透明度
param4(u8):圆角

Arc弧形控件指令(0x05) ​

定义R/W功能指令输入参数读写参数说明
设置弧形显示样式W00param1(u8)样(0-1):样式部分
0-背景,1-前景
param1(u32):线条颜色
param2(u16):线条宽度
param3(u8):透明度
param4(u8):圆角
设置滑块颜色W01无param1(u32):颜色
设置值范围W02无param1(s16):最小值 param2(s16):最大值
当前值W/R03无param1(s16):当前值
设置旋转角度W04无param1(u16):旋转角度
设置起始角度和终止角度W05无param1(u16):起始角度 param2(u16):终止角度

Bar进度条控件指令(0x06) ​

定义R/W功能指令输入参数读写参数说明
设置进度条颜色W00无param1(u32):颜色
进度值W/R01无param1(s16):当前值
设置值范围W02无param1(s16):最小值 param2(s16):最大值

Slider滑块进度条控件指令(0x07) ​

定义R/W功能指令输入参数读写参数说明
设置进度条颜色W00无param1(u32):颜色
进度值W/R01无param1(s16):当前值
设置值范围W02无param1(s16):最小值 param2(s16):最大值

Sw开关控件指令(0x08) ​

定义R/W功能指令输入参数读写参数说明
开关状态W/R00无param1(u8)(0-1):0 - 关 1 - 开

Cb复选框控件指令(0x09) ​

定义R/W功能指令输入参数读写参数说明
设置显示的文字W00无param1(str)显示字符串
选中W/R01无param1(u8)(0-1):0 - 未选中 1 - 选中
禁用控件W/R02无param1(u8)(0-1):0 - 关 1 - 开

Mbox消息提示控件指令(0x0A) ​

定义R/W功能指令输入参数读写参数说明
标题显示内容W00无param1(string):文本内容
消息显示内容W01无param1(string):文本内容
延时自动关闭时间W02无param1(u16):延时时间(ms)
弹窗控制W03无param1(u8)(0-1):0 - 关闭弹窗 1 - 打开弹窗

Tileview平铺视图控件指令(0x0B) ​

定义R/W功能指令输入参数读写参数说明
根据id手动切换tileW00无param1(u8)(0-1):是否打开动画 0 - 关闭动画 1 - 开启动画
param2(u16):行id
param3(u16):列id

Txtbox文本框控件(0x0C) ​

定义R/W功能指令输入参数读写参数说明
添加字符串W00无param1(str):字符串
添加单个字符W01无param1(u32):字符
删除单个字符W02无param1(u8)(0-1):删除光标左右侧字符 0 - 光标左侧
1 - 光标右侧
文本内容W/R03无param1(str):字符串
切换文本密码显示模式W04无param1(u8)(0-1): 0 - 关闭
1 - 开启
光标移动一步W05无param1(u8)(0-3):
0 - 光标向右移动一步
1 - 光标向左移动一步
2 - 光标向下移动一步,文本域中有多行文本时才起作用
3 - 光标向上移动一步,文本域中有多行文本时才起作用

List列表控件(0x0D) ​

定义R/W功能指令输入参数读写参数说明
删除某个按钮W00无param1(u16):按钮编号
删除全部按钮W01无无
按钮文本W/R02param1(u16):按钮编号param1(string):文本内容

Droplist下拉列表控件(0x0E) ​

定义R/W功能指令输入参数读写参数说明
增加下拉菜单某一项W00param1(u16):按钮编号param1(string):文本内容
修改已有选项的文本W01param1(u16):按钮编号param1(string):文本内容
删除某一项W02无param1(u16):按钮编号
控制下拉框W03无param1(u8):展开或收缩 0 - 收缩 1 - 展开

Rollist滚轮列表控件(0x0F) ​

定义R/W功能指令输入参数读写参数说明
增加或者插入某个选项W00param1(u16):按钮编号param1(string):文本内容
修改已有选项的文本W01param1(u16):按钮编号param1(string):文本内容
删除某一项W02无param1(u16):按钮编号

GIF控件(0x10) ​

定义R/W功能指令输入参数读写参数说明
控制gifW00无param1(u8):控制选项 0 - GIF重置(重新开始播放)
1 - 暂停gif播放
2 - 恢复gif播放
设置播放次数W01无param1(u16):播放次数
设置gif图片W02无param1(str):路径名称

QRcode控件(0x11) ​

定义R/W功能指令输入参数读写参数说明
更新二维码数据W00无param1(str):二维码信息

Video视频控件(0x12) ​

定义R/W功能指令输入参数读写参数说明
设置视频资源W00无param1(str):路径名称
播放状态W/R01无param1(u8)(0-3):播放状态 0 - 开始播放
1 - 停止播放
2 - 暂停播放
3 - 恢复播放
设置音量W02无param1(u8):音量
设置视频位置大小W03无param1(u16):x轴坐标 param2(u16):y轴坐标 param3(u16):宽度 param4(u16):高度
设置视频循环W04无param1(u8)(0-1):是否循环
0 - 否
1 - 是

Keyboard键盘控件(0x13) ​

定义R/W功能指令输入参数读写参数说明
获取键盘活动按钮的编号R00无param1(u32):编号
通过编号获取键盘按钮的字符串R01param1(u16):按钮编号param1(str):按钮字符串

Spinbox数据框控件(0x14) ​

定义R/W功能指令输入参数读写参数说明
当前数值W/R00无param1(s32):数值
光标移动W01无param1(u8)(0-1):移动一格方向
0 - 左移 1 - 右移
光标位数据控制W02无param1(u8)(0-1):数据控制
0 - 减少一个单位 1 - 增加一个单位

Table表格框控件(0x15) ​

定义R/W功能指令输入参数读写参数说明
设置单元格内容W00无param1(u16):单元格所在的行数 param2(u16):单元格所在的列数 param3(str):文本内容
单独设置某一列表格宽度W01无param1(u16):设置列 param2(u16):宽度
合并右侧单元格W02无param1(u16):单元格所在行 param2(u16):单元格所在列
表格样式W03无param1(u32):表格线条颜色 param2(u8):宽度 param3(u8):透明度 param4(u8):内部填充透明度 param5(u32):颜色

Btnmatrix按钮矩阵控件(0x16) ​

定义R/W功能指令输入参数读写参数说明
通过编号获取键盘按钮的字符串R00param1(u16):按钮编号param1(str):按钮字符串
编号按钮控制选项W01无param1(u8)(0-1):设置
0 - 清除选项
1 - 设置选项
param2(u16):按钮编号 param3(u16):控制选项 10 - 将按钮设为隐藏
20 - 长按按钮时禁用重复
40 - 禁用按钮
80 - 按钮设置为切换模式
100 - 按钮设置为切换状态
200 - 启用:在点击时发送 LV_EVENT_VALUE_CHANGE ;禁用:在按下时发送 LV_EVENT_VALUE_CHANGE
400 - 按下此键时在弹出框中显示按钮标签
全部按钮控制选项W02无param1(u8)(0-1):设置
0 - 清除选项
1 - 设置选项 param3(u16):控制选项 10 - 将按钮设为隐藏
20 - 长按按钮时禁用重复
40 - 禁用按钮
80 - 按钮设置为切换模式
100 - 按钮设置为切换状态
200 - 启用:在点击时发送 LV_EVENT_VALUE_CHANGE ;禁用:在按下时发送 LV_EVENT_VALUE_CHANGE
400 - 按下此键时在弹出框中显示按钮标签
判断按钮是否有某个选项R03param1(u16):按钮编号
param2(u16):控制选项 10 - 将按钮设为隐藏
20 - 长按按钮时禁用重复
40 - 禁用按钮
80 - 按钮设置为切换模式
100 - 按钮设置为切换状态
200 - 启用:在点击时发送 LV_EVENT_VALUE_CHANGE ;禁用:在按下时发送 LV_EVENT_VALUE_CHANGE
400 - 按下此键时在弹出框中显示按钮标签
param1(u8)(0-1): 0 - 无 1 - 有
设置按钮宽度W04无param1(u8):宽度 param2(u16):按钮编号
矩阵中的按钮具有check唯一性W/R05无param1(u8)(0-1): 0 - 无 1 - 有