深圳勵(lì)研科技LED控制卡CL3000通訊協(xié)議

CL3000系列異步控制系統(tǒng)通訊協(xié)議v1.0目錄======第一章 概述 2§1.1 通訊數(shù)據(jù)包格式 2§1.2 CRC校驗(yàn)和算法 3第二章 控制類命令 4§2.1 復(fù)位控制卡 4§2.2 取運(yùn)行狀態(tài) 4§2.3 校對(duì)控制卡時(shí)間 4§2.4 讀取控制卡時(shí)間 5§2.5 設(shè)定自動(dòng)開關(guān)屏?xí)r間 5§2.6 暫停/繼續(xù)節(jié)目播放 5§2.7 設(shè)定屏體電源/開關(guān)模式 5§2.8 設(shè)定亮度 5§2.9 發(fā)送時(shí)間段亮度表 5§2.10切換當(dāng)前播放的節(jié)目組 6第三章 節(jié)目表控制播放類命令 6§3.1 圖片文件結(jié)構(gòu) 6§3.2 發(fā)送圖片文件 7§3.3 節(jié)目表結(jié)構(gòu) 7§3.4 發(fā)送節(jié)目表 8第四章 實(shí)時(shí)顯示類命令 9§4.1 實(shí)時(shí)顯示文字 9§4.2 保存文字串為XMPX圖片文件 10§4.3 實(shí)時(shí)顯示XMPX圖片 10

概述 本文中，DWORD為4字節(jié)數(shù)據(jù)，WORD為雙字節(jié)數(shù)據(jù)，BYTE為單字節(jié)數(shù)據(jù)。存儲(chǔ)格式為小序，即4字節(jié)數(shù)據(jù)(32個(gè)bit)存儲(chǔ)為：d7-d0，d15-d8,d23-d16,d31-d24；雙字節(jié)數(shù)據(jù)(16個(gè)bit)存儲(chǔ)為：d7-d0,d15-d8。用于節(jié)目播放的圖片、文字和字庫存儲(chǔ)在控制卡上的FLASH芯片中，控制卡標(biāo)準(zhǔn)配置為1片2MB的FLASH芯片，可根據(jù)用戶要求增加一片2MB芯片或者改為2片4MB的芯片。FLASH芯片中每4096字節(jié)為1頁，內(nèi)容必須以頁為單位占用存儲(chǔ)，例如一張5000字節(jié)的圖片要用2個(gè)FLASH頁存儲(chǔ)，即需要8192字節(jié)的存儲(chǔ)空間。CL3000系列控制卡支持串口和以太網(wǎng)通訊，網(wǎng)絡(luò)通訊支持UDP/IP協(xié)議，不支持端口復(fù)用，即控制卡可以接收任意端口的數(shù)據(jù)，但是同一時(shí)刻只能接收一個(gè)主機(jī)的數(shù)據(jù)。網(wǎng)絡(luò)通訊的通訊包格式與串口通訊相同。§1.1 通訊數(shù)據(jù)包格式CL3000的通訊數(shù)據(jù)包格式為：7字節(jié)引導(dǎo)串+1字節(jié)屏號(hào)+1字節(jié)保留域+1字節(jié)包序號(hào)+4字節(jié)訪問密鑰+2字節(jié)數(shù)據(jù)長(zhǎng)度+報(bào)文數(shù)據(jù)+2字節(jié)CRC 其中， 引導(dǎo)串：ESC+“$LYMIN”(ESC的ASCII碼值為0x1b)。 屏號(hào)：控制卡地址。出廠設(shè)置為0。 保留域：備用，填0。 包序號(hào)：從0開始編號(hào)，控制卡對(duì)該報(bào)文的響應(yīng)報(bào)文將使用相同的編號(hào)，這樣發(fā)送者可以判斷響應(yīng)報(bào)文所對(duì)應(yīng)的發(fā)送報(bào)文。 密鑰：網(wǎng)絡(luò)通訊用，串口通訊不使用填0xFFFFFFFF。 長(zhǎng)度：后面報(bào)文數(shù)據(jù)的長(zhǎng)度。 數(shù)據(jù)：發(fā)往控制卡的命令及數(shù)據(jù)。各命令的數(shù)據(jù)格式在后面章節(jié)中詳細(xì)說明。 CRC：對(duì)報(bào)文數(shù)據(jù)部分進(jìn)行16位CRC校驗(yàn)的結(jié)果，校驗(yàn)算法見1.2節(jié)。§2.4 讀取控制卡時(shí)間 命令格式：'E' 返回報(bào)文中的數(shù)據(jù)域格式為1字節(jié)秒+1字節(jié)分+1字節(jié)時(shí)+1字節(jié)日+1字節(jié)月+1字節(jié)周+1字節(jié)年+1字節(jié)0。§2.5 設(shè)定自動(dòng)開關(guān)屏?xí)r間 命令格式：'B'+1字節(jié)0+1字節(jié)數(shù)據(jù)長(zhǎng)度4+1字節(jié)0+1字節(jié)自動(dòng)開屏分+1字節(jié)自動(dòng)開屏?xí)r+1字節(jié)自動(dòng)關(guān)屏分+1字節(jié)自動(dòng)關(guān)屏?xí)r 注意：時(shí)間大于所設(shè)置的關(guān)屏?xí)r間才關(guān)屏?！?.6 暫停/繼續(xù)節(jié)目播放 命令格式：'K'+1字節(jié)控制標(biāo)志+2字節(jié)參數(shù)控制標(biāo)志：0暫停播放1恢復(fù)繼續(xù)播放參數(shù)保留，填0§2.7 設(shè)定屏體電源/開關(guān)模式 命令格式：'P'+1字節(jié)模式模式：0:強(qiáng)行關(guān)屏1:強(qiáng)行開屏2:自動(dòng)開關(guān)屏§2.8 設(shè)定亮度 命令格式：'Y'+1字節(jié)設(shè)定亮度值亮度值：0-15依次表示亮度等級(jí)1/16,2/16,...16/16(全亮)。16表示使用亮度傳感器自動(dòng)調(diào)整，17表示使用時(shí)段亮度表的設(shè)定。其它值返回錯(cuò)誤§2.9 發(fā)送時(shí)間段亮度表 命令格式：'B'+1字節(jié)1+1字節(jié)數(shù)據(jù)長(zhǎng)度+1字節(jié)0+2字節(jié)時(shí)段1+…每個(gè)時(shí)間段兩個(gè)字節(jié)，格式為bit15保留填0，bit14..10小時(shí)，bit9..4分鐘，bit3..0亮度。值為0表示無效時(shí)段，則后面的時(shí)段設(shè)置忽略。最多6個(gè)亮度時(shí)間段，即數(shù)據(jù)長(zhǎng)度最大12個(gè)字節(jié)。§2.10切換當(dāng)前播放的節(jié)目組 命令格式：'X'+1字節(jié)標(biāo)識(shí)+2字節(jié)節(jié)目組編號(hào)+16字節(jié)節(jié)目組播放參數(shù)標(biāo)識(shí) ：bit7=1保存當(dāng)前選擇的節(jié)目組（需要有電池）；bit6=1設(shè)置新的節(jié)目組播放參數(shù)；其它bit保留填0節(jié)目組編號(hào)：0-999，與節(jié)目表項(xiàng)Flag字段中的所屬節(jié)目組號(hào)對(duì)應(yīng)節(jié)目組播放參數(shù)：用于給節(jié)目組中的特殊節(jié)目傳遞參數(shù)，當(dāng)標(biāo)識(shí)字節(jié)中的bit6=1時(shí)才會(huì)起作用。每個(gè)分區(qū)4個(gè)字節(jié)，從第一個(gè)分區(qū)開始依次排列。節(jié)目表控制播放類命令節(jié)目表控制播放類命令涉及兩個(gè)方面，一是播放的內(nèi)容，即圖片文件，另一是節(jié)目表，控制卡根據(jù)節(jié)目表設(shè)定的效果來播放圖片。§3.1 圖片文件結(jié)構(gòu) CL3000所使用的圖片文件為自定義格式，其基本結(jié)構(gòu)為：文件頭+圖片點(diǎn)陣數(shù)據(jù)文件頭為12字節(jié)，其格式見《CL3000程序員手冊(cè)》中的PicFileHdr結(jié)構(gòu)定義。圖片點(diǎn)陣數(shù)據(jù)格式定義如下：像素點(diǎn)按列的順序進(jìn)行存儲(chǔ)，即先存儲(chǔ)第一列像素，再存儲(chǔ)第二列像素，…，如果是雙色圖片，則先存儲(chǔ)紅色的像素值，再存儲(chǔ)綠色的像素值。對(duì)于每一列像素，每8個(gè)像素存儲(chǔ)在1個(gè)字節(jié)中，1位表示1個(gè)象素，0代表黑色，1代表紅或綠色，行數(shù)較小的存儲(chǔ)在字節(jié)中位序較小的位置。最后1個(gè)字節(jié)的高幾位bit可能會(huì)未用到，對(duì)于一個(gè)高度為H，寬度為W的單色圖片，其像素點(diǎn)所占字節(jié)數(shù)為(H+7)/8*W，雙色圖片乘以2即可。圖片文件的寬度和高度應(yīng)與其所在分區(qū)大小相同?！?.2 發(fā)送圖片文件命令格式：'L'+1字節(jié)0+2字節(jié)圖片文件索引+4字節(jié)圖片文件內(nèi)偏移量(512字節(jié)對(duì)齊)+2字節(jié)下載數(shù)據(jù)長(zhǎng)度+圖片文件數(shù)據(jù)。圖片文件索引：從0開始編號(hào)，但是前4個(gè)圖片（編號(hào)0-3）保留給實(shí)時(shí)版面做背景圖片，因此普通圖片文件的編號(hào)應(yīng)從4開始。下載數(shù)據(jù)長(zhǎng)度：不超過512字節(jié)，不能跨SPIFLASH頁。一般應(yīng)以512字節(jié)為單位發(fā)送圖片文件數(shù)據(jù)，直到最后如果剩下不到512字節(jié)則按剩余的長(zhǎng)度發(fā)送。本函數(shù)直接將發(fā)送的圖片數(shù)據(jù)寫入Flash，如果在寫入時(shí)控制卡正在播放該圖片，則屏幕可能會(huì)顯示不正常，因此一般發(fā)送圖片文件前應(yīng)停止播放。控制卡所允許的單個(gè)圖片文件的最大長(zhǎng)度跟所配置的顯示屏大小、單/雙色、各分區(qū)大小均有關(guān)系，可以通過RunningStateStru的PicFileSize域獲取，控制卡以此為單位存儲(chǔ)圖片文件，圖片文件存儲(chǔ)區(qū)的總大小可以通過RunningStateStru的StorgePicSize域獲得，所以控制卡可以存儲(chǔ)圖片的總數(shù)量可以通過計(jì)算得出：StorgePicSize/PicFileSize?！?.3 節(jié)目表結(jié)構(gòu)控制卡存儲(chǔ)節(jié)目表的FLASH區(qū)頁大小為2048字節(jié)，共8頁，每頁的前16字節(jié)保留用于存儲(chǔ)管理功能，一個(gè)節(jié)目表項(xiàng)為16字節(jié)，因此1頁可存儲(chǔ)的節(jié)目表項(xiàng)數(shù)為(2048–16)/16=127，8頁共可存儲(chǔ)8*127=1016個(gè)節(jié)目表項(xiàng)，最后16個(gè)節(jié)目表項(xiàng)保留，因此實(shí)際可用的節(jié)目表項(xiàng)為1000個(gè)。每個(gè)節(jié)目表項(xiàng)的編號(hào)用一個(gè)WORD類型的數(shù)字表示，其中bit9-bit7為節(jié)目表項(xiàng)所在頁的編號(hào)(0-7)，bit6-bit0為該節(jié)目表項(xiàng)在頁內(nèi)編號(hào)(1-127，第7頁為1-111)，其余bit保留填0。所有節(jié)目表項(xiàng)必須從第一個(gè)FLASH頁開始連續(xù)存儲(chǔ)，對(duì)于多分區(qū)的屏，則應(yīng)按分區(qū)順序排列，即先存儲(chǔ)第一個(gè)分區(qū)的所有節(jié)目表項(xiàng)，再存儲(chǔ)第二個(gè)分區(qū)的所有節(jié)目表項(xiàng)，…。節(jié)目表項(xiàng)的結(jié)構(gòu)見MiniLED.h中的ProgItemType結(jié)構(gòu)定義。§3.4 發(fā)送節(jié)目表命令格式：'R'+1字節(jié)節(jié)目表項(xiàng)數(shù)目及開始/停止標(biāo)記+2字節(jié)第一個(gè)節(jié)目表項(xiàng)編號(hào)+節(jié)目表項(xiàng)結(jié)構(gòu)節(jié)目表項(xiàng)數(shù)目中：bit7為1表示是第一組節(jié)目表項(xiàng)，bit6為1表示是最后一組節(jié)目表項(xiàng)，系統(tǒng)收到第一組則擦除整個(gè)節(jié)目表區(qū)，收到最后一組則設(shè)置相應(yīng)系統(tǒng)變量準(zhǔn)備新的播放。bit5-bit0：節(jié)目表項(xiàng)數(shù)。0則清除所有節(jié)目表項(xiàng)，實(shí)際最大不超過32項(xiàng)（不能超過內(nèi)部Flash頁大?。?，且不能跨頁，所屬組和區(qū)域應(yīng)該按順序排列該命令自動(dòng)暫停播放，用戶需發(fā)送重新播放命令重新開始播放新的節(jié)目表。區(qū)域之間可以預(yù)留若干項(xiàng)備用。

實(shí)時(shí)顯示類命令§4.1 實(shí)時(shí)顯示文字命令格式：'T'+1字節(jié)標(biāo)識(shí)+2字節(jié)Left+2字節(jié)Top+2字節(jié)區(qū)域?qū)?2字節(jié)區(qū)域高+2字節(jié)X+2字節(jié)Y+2字節(jié)顏色+文字串(0結(jié)尾）標(biāo)識(shí)：bit7=1停止正在進(jìn)行的節(jié)目播放bit6..3保留，填0；bit2..0文字編碼:0-單字節(jié)編碼1-Unicode2-雙(變)字節(jié)編碼其它值保留Left,Top,區(qū)域?qū)?高：文字輸出區(qū)域的左上角坐標(biāo)及寬、高，該坐標(biāo)相對(duì)于屏幕，屏幕左上角坐標(biāo)為(0,0)X,Y：文字串第一個(gè)字符相對(duì)于文字輸出區(qū)域左上角的坐標(biāo)顏色：輸出文字所用的缺省顏色0-黑，1-紅，2-綠，3-黃文字串：要輸出的文字串，零結(jié)尾。最長(zhǎng)不超過512字節(jié)。缺省使用第一套能找到的合適的字庫，缺省為橫向從左向右顯示?？梢栽谧址胁迦霐U(kuò)展顯示碼更改隨后的顯示方式，詳見《CL3000程序員手冊(cè)》5.1節(jié)實(shí)時(shí)顯示文字函數(shù)中關(guān)于擴(kuò)展顯示碼的說明。該函數(shù)直接將文字顯示到屏幕上，沒有滾動(dòng)等效果，要保證文字輸出的區(qū)域沒有帶滾動(dòng)等效果的節(jié)目在播放，否則滾動(dòng)效果會(huì)將顯示的文字覆蓋掉。在使用該命令時(shí)，如果不只是使用實(shí)時(shí)版面里的數(shù)字，則需要先上傳字庫到控制卡。若字符串內(nèi)部的擴(kuò)展顯示碼格式有錯(cuò)誤，命令仍然會(huì)返回成功，但是屏幕上不會(huì)有任何變化?！?.2 保存文字串為XMPX圖片文件命令格式：'t'+1字節(jié)標(biāo)識(shí)+2字節(jié)圖片文件索引+2字節(jié)圖片寬+2字節(jié)圖片高+2字節(jié)顏色+文字串(0結(jié)尾）標(biāo)識(shí)：bit7..5保留，填0；bit4..3文字輸出模式自上向下自左向右書寫0-單行橫向連續(xù)1-多行縱向連續(xù)2-單屏非連續(xù)3-保留bit2..0文字編碼:0-單字節(jié)編碼1-Unicode2-雙(變)字節(jié)編碼其它值保留圖片文件索引：要存儲(chǔ)到的圖片文件索引，從0開始，小于最多可存儲(chǔ)的圖片數(shù)。前4個(gè)圖片（編號(hào)0-3）保留給實(shí)時(shí)版面做背景圖片，普通圖片文件的編號(hào)從4開始。圖片寬,高：要保存的圖片的大小，應(yīng)與要顯示區(qū)域大小一致，否則可能無法顯示顏色：輸出文字所用的缺省顏色0：黑，1：紅，2：綠，3：黃文字串：要輸出的文字串，零結(jié)尾。最長(zhǎng)不超過512字節(jié)。缺省使用第一套能找到的合適的字庫，缺省顏色為全色輸出，缺省為從上往下從左向右顯示。可以在字符串中插入擴(kuò)展顯示碼更改隨后的顯示方式，詳見《CL3000程序員手冊(cè)》5.1節(jié)實(shí)時(shí)顯示文字函數(shù)中關(guān)于擴(kuò)展顯示碼的說明。該命令會(huì)阻塞節(jié)目播放流程，造成屏幕閃爍或者花屏，建議在發(fā)送該命令前關(guān)屏或暫停播放，命令執(zhí)行成功后先清屏再開屏或重啟播放流程。§4.3 實(shí)時(shí)顯示XMPX圖片命令格式：'I'+1字節(jié)標(biāo)識(shí)+2字節(jié)Left+2字節(jié)Top+2字節(jié)圖片寬+2字節(jié)圖片高+4字節(jié)圖片內(nèi)偏移量+2字節(jié)數(shù)據(jù)長(zhǎng)度+圖片數(shù)據(jù)標(biāo)識(shí)：bit7..1保留，填0；bit1等于1表示更新顯示區(qū)。對(duì)于雙色屏，XMPX圖片紅色和綠色是分開存放的，一般發(fā)送都是先發(fā)送紅色部分再發(fā)送綠色部分，這樣如果每發(fā)一個(gè)報(bào)文就更新顯示的話，很容易出現(xiàn)屏幕上紅色部分先更新，綠色部分后更新的情況。因此應(yīng)該先把所有數(shù)據(jù)發(fā)送