深圳励研科技LED控制卡CL通讯协议Word格式.doc
《深圳励研科技LED控制卡CL通讯协议Word格式.doc》由会员分享，可在线阅读，更多相关《深圳励研科技LED控制卡CL通讯协议Word格式.doc（11页珍藏版）》请在冰点文库上搜索。
3.3 节目表结构 7
3.4 发送节目表 8
第四章 实时显示类命令 9
4.1 实时显示文字 9
4.2 保存文字串为XMPX图片文件 10
4.3 实时显示XMPX图片 10
第一章概述
本文中，DWORD为4字节数据，WORD为双字节数据，BYTE为单字节数据。
存储格式为小序，即4字节数据（32个bit）存储为：
d7-d0，d15-d8,d23-d16,d31-d24；
双字节数据（16个bit）存储为：
d7-d0,d15-d8。
用于节目播放的图片、文字和字库存储在控制卡上的FLASH芯片中，控制卡标准配置为1片2MB的FLASH芯片，可根据用户要求增加一片2MB芯片或者改为2片4MB的芯片。
FLASH芯片中每4096字节为1页，内容必须以页为单位占用存储，例如一张5000字节的图片要用2个FLASH页存储，即需要8192字节的存储空间。
CL3000系列控制卡支持串口和以太网通讯，网络通讯支持UDP/IP协议，不支持端口复用，即控制卡可以接收任意端口的数据，但是同一时刻只能接收一个主机的数据。
网络通讯的通讯包格式与串口通讯相同。
1.1 通讯数据包格式
CL3000的通讯数据包格式为：
7字节引导串+1字节屏号+1字节保留域+1字节包序号+4字节访问密钥+2字节数据长度+报文数据+2字节CRC
其中，
引导串：
ESC+“$LYMIN”（ESC的ASCII码值为0x1b）。
屏号：
控制卡地址。
出厂设置为0。
保留域：
备用，填0。
包序号：
从0开始编号，控制卡对该报文的响应报文将使用相同的编号，这样发送者可以判断响应报文所对应的发送报文。
密钥：
网络通讯用，串口通讯不使用填0xFFFFFFFF。
长度：
后面报文数据的长度。
数据：
发往控制卡的命令及数据。
各命令的数据格式在后面章节中详细说明。
CRC：
对报文数据部分进行16位CRC校验的结果，校验算法见1.2节。
响应报文采用与发送报文相同的格式，只是引导串为ESC+“$lymin”,访问密钥字节则保留。
响应报文数据域开头3个字节固定为：
命令+“OK”或“FL”，分别表示命令执行成功或失败的响应。
如果有响应数据则紧跟在后面。
第二章控制类命令
控制类命令包括复位控制卡、取运行状态、设定亮度、设定开关屏时间等。
2.1 复位控制卡
命令格式：
'
V'
+1字节复位类型+2字节参数
复位类型：
0:
重启播放流程1:
控制卡复位
2:
释放网络，允许其它网络主机访问
参数保留，填0
2.2 取运行状态
命令格式：
A'
+1字节0+2字节数据长度+4字节0
数据长度为运行状态数据结构RunningStateStru的长度，该结构在MiniLED.h中定义。
返回报文中的数据域为运行状态数据结构。
2.3 校对控制卡时间
C'
+1字节秒+1字节分+1字节时+1字节日+1字节月+1字节周+1字节年+1字节0
周0-6依次表示星期日，星期一到星期六。
年0-99表示2000年到2099年。
2.4 读取控制卡时间
E'
返回报文中的数据域格式为1字节秒+1字节分+1字节时+1字节日+1字节月+1字节周+1字节年+1字节0。
2.5 设定自动开关屏时间
B'
+1字节0+1字节数据长度4+1字节0+1字节自动开屏分+1字节自动开屏时+1字节自动关屏分+1字节自动关屏时
注意：
时间大于所设置的关屏时间才关屏。
2.6 暂停/继续节目播放
K'
+1字节控制标志+2字节参数
控制标志：
0暂停播放1恢复继续播放
2.7 设定屏体电源/开关模式
P'
+1字节模式
模式：
强行关屏1:
强行开屏2:
自动开关屏
2.8 设定亮度
Y'
+1字节设定亮度值
亮度值：
0-15依次表示亮度等级1/16,2/16,...16/16（全亮）。
16表示使用亮度传感器自动调整，17表示使用时段亮度表的设定。
其它值返回错误
2.9 发送时间段亮度表
+1字节1+1字节数据长度+1字节0+2字节时段1+…
每个时间段两个字节，格式为bit15保留填0，bit14..10小时，bit9..4分钟，bit3..0亮度。
值为0表示无效时段，则后面的时段设置忽略。
最多6个亮度时间段，即数据长度最大12个字节。
2.10切换当前播放的节目组
X'
+1字节标识+2字节节目组编号+16字节节目组播放参数
标识 ：
bit7=1保存当前选择的节目组（需要有电池）；
bit6=1设置新的节目组播放参数；
其它bit保留填0
节目组编号：
0-999，与节目表项Flag字段中的所属节目组号对应
节目组播放参数：
用于给节目组中的特殊节目传递参数，当标识字节中的bit6=1时才会起作用。
每个分区4个字节，从第一个分区开始依次排列。
第三章节目表控制播放类命令
节目表控制播放类命令涉及两个方面，一是播放的内容，即图片文件，另一是节目表，控制卡根据节目表设定的效果来播放图片。
3.1 图片文件结构
CL3000所使用的图片文件为自定义格式，其基本结构为：
文件头+图片点阵数据
文件头为12字节，其格式见《CL3000程序员手册》中的PicFileHdr结构定义。
图片点阵数据格式定义如下：
像素点按列的顺序进行存储，即先存储第一列像素，再存储第二列像素，…，如果是双色图片，则先存储红色的像素值，再存储绿色的像素值。
对于每一列像素，每8个像素存储在1个字节中，1位表示1个象素，0代表黑色，1代表红或绿色，行数较小的存储在字节中位序较小的位置。
最后1个字节的高几位bit可能会未用到，对于一个高度为H，宽度为W的单色图片，其像素点所占字节数为（H+7）/8*W，双色图片乘以2即可。
图片文件的宽度和高度应与其所在分区大小相同。
3.2 发送图片文件
'
L'
+1字节0+2字节图片文件索引+4字节图片文件内偏移量（512字节对齐）+2字节下载数据长度+图片文件数据。
图片文件索引：
从0开始编号，但是前4个图片（编号0-3）保留给实时版面做背景图片，因此普通图片文件的编号应从4开始。
下载数据长度：
不超过512字节，不能跨SPIFLASH页。
一般应以512字节为单位发送图片文件数据，直到最后如果剩下不到512字节则按剩余的长度发送。
本函数直接将发送的图片数据写入Flash，如果在写入时控制卡正在播放该图片，则屏幕可能会显示不正常，因此一般发送图片文件前应停止播放。
控制卡所允许的单个图片文件的最大长度跟所配置的显示屏大小、单/双色、各分区大小均有关系，可以通过RunningStateStru的PicFileSize域获取，控制卡以此为单位存储图片文件，图片文件存储区的总大小可以通过RunningStateStru的StorgePicSize域获得，所以控制卡可以存储图片的总数量可以通过计算得出：
StorgePicSize/PicFileSize。
3.3 节目表结构
控制卡存储节目表的FLASH区页大小为2048字节，共8页，每页的前16字节保留用于存储管理功能，一个节目表项为16字节，因此1页可存储的节目表项数为（2048–16）/16=127，8页共可存储8*127=1016个节目表项，最后16个节目表项保留，因此实际可用的节目表项为1000个。
每个节目表项的编号用一个WORD类型的数字表示，其中bit9-bit7为节目表项所在页的编号（0-7），bit6-bit0为该节目表项在页内编号（1-127，第7页为1-111），其余bit保留填0。
所有节目表项必须从第一个FLASH页开始连续存储，对于多分区的屏，则应按分区顺序排列，即先存储第一个分区的所有节目表项，再存储第二个分区的所有节目表项，…。
节目表项的结构见MiniLED.h中的ProgItemType结构定义。
3.4 发送节目表
R'
+1字节节目表项数目及开始/停止标记+2字节第一个节目表项编号+节目表项结构
节目表项数目中：
bit7为1表示是第一组节目表项，bit6为1表示是最后一组节目表项，系统收到第一组则擦除整个节目表区，收到最后一组则设置相应系统变量准备新的播放。
bit5-bit0：
节目表项数。
0则清除所有节目表项，实际最大不超过32项（不能超过内部Flash页大小），且不能跨页，所属组和区域应该按顺序排列
该命令自动暂停播放，用户需发送重新播放命令重新开始播放新的节目表。
区域之间可以预留若干项备用。
第四章实时显示类命令
4.1 实时显示文字
T'
+1字节标识+2字节Left+2字节Top+2字节区域宽+2字节区域高+2字节X+2字节Y+2字节颜色+文字串（0结尾）
标识：
bit7=1停止正在进行的节目播放
bit6..3保留，填0；
bit2..0文字编码:
0-单字节编码1-Unicode2-双（变）字节编码其它值保留
Left,Top,区域宽,高：
文字输出区域的左上角坐标及宽、高，该坐标相对于屏幕，屏幕左上角坐标为（0,0）
X,Y：
文字串第一个字符相对于文字输出区域左上角的坐标
颜色：
输出文字所用的缺省颜色0-黑，1-红，2-绿，3-黄
文字串：
要输出的文字串，零结尾。
最长不超过512字节。
缺省使用第一套能找到的合适的字库，缺省为横向从左向右显示。
可以在字符串中插入扩展显示码更改随后的显示方式，详见《CL3000程序员手册》5.1节实时显示文字函数中关于扩展显示码的说明。
该函数直接将文字显示到屏幕上，没有滚动等效果，要保证文字输出的区域没有带滚动等效果的节目在播放，否则滚动效果会将显示的文字覆盖掉。
在使用该命令时，如果不只是使用实时版面里的数字，则需要先上传字库到控制卡。
若字符串内部的扩展显示码格式有错误，命令仍然会返回成功，但是屏幕上不会有任何变化。
4.2 保存文字串为XMPX图片文件
t'
+1字节标识+2字节图片文件索引+2字节图片宽+2字节图片高+2字节颜色+文字串（0结尾）
bit7..5保留，填0；
bit4..3文字输出模式自上向下自左向右书写0-单行横向连续1-多行纵向连续2-单屏非连续3-保留
bit2..0文字编码:
要存储到的图片文件索引，从0开始，小于最多可存储的图片数。
前4个图片（编号0-3）保留给实时版面做背景图片，普通图片文件的编号从4开始。
图片宽,高：
要保存的图片的大小，应与要显示区域大小一致，否则可能无法显示
颜色：
输出文字所用的缺省颜色0：
黑，1：
红，2：
绿，3：
黄
缺省使用第一套能找到的合适的字库，缺省颜色为全色输出，缺省为从上往下从左向右显示。
该命令会阻塞节目播放流程，造成屏幕闪烁或者花屏，建议在发送该命令前关屏或暂停播放，命令执行成功后先清屏再开屏或重启播放流程。
4.3 实时显示XMPX图片
I'
+1字节标识+2字节Left+2字节Top+2字节图片宽+2字节图片高+4字节图片内偏移量+2字节数据长度+图片数据
bit7..1保留，填0；
bit1等于1表示更新显示区。
对于双色屏，XMPX图片红色和绿色是分开存放的，一般发送都是先发送红色部分再发送绿色部分，这样如果每发一个报文就更新显示的话，很容易出现屏幕上红色部分先更新，绿色部分后更新的情况。
因此应该先把所有数据发送完毕，在最后一个数据报文把标识置位更新显示区。
Left,Top,图片宽,高：
图片在屏幕上的显示位置（左上角坐标）及宽、高，该坐标相对于屏幕，屏幕左上角坐标为（0,0）。
图片内偏移量：
本数据包第一个字节在图片内的偏移量。
图片数据第一个字节偏移量为0
数据长度：
本数据包内图片数据的长度，不能超过512字节
图片数据：
图片点阵数据，XMPX格式，双色的话红色在前绿色在后。
该函数直接将图片显示到屏幕上，没有滚动等效果，要保证图片输出的区域没有带滚动等效果的节目在播放，否则滚动效果会将显示的图片覆盖掉。
升级会员 