华数机顶盒二维码技术规范v12

1、华数机顶盒二维码技术规范研究院密级一级华数机顶盒二维码技术规范(Version 1.2)华数数字电视传媒集团有限公司2012年11月07日主送： 抄送： 关键字：二维码 省网 技术规范基本信息文档名称主标题华数机顶盒二维码技术规范副标题文档编号当前版本1.2发布版本起草时间2012年07月03日定稿时间起草人姓名部门电话电子邮件包晓晓系统技术部baoxx李兵伟系统技术部libw备注方案论证参与人：研究院：周明峰、陈民审核人签发人修订记录序号修改时间修改人主要修改存档版本12012-07-03李兵伟新建文档0.122012-07-04包晓晓增加流程、调整数据格式0.232012-08-02包晓晓

2、修改了前端下发数据生成二维码流程；修改了二维码数据最大长度；增加了生产数据异常场景；增加了系统接口；增加了业务ID大类规划0.342012-08-10李兵伟修改章节6.1时序图增加章节7.2二维码数据下发接口增加章节7.5数据存储0.452012-8-14包晓晓调整文档格式；增加章节1.概述修改章节2.目标为目的增加章节3.适用范围；删除章节4.背景增加附录B 二维码操作指令格式；1.062012-9-26包晓晓调整附录B 二维码操作指令格表；明确8.4章节 数据存储方式；增加了8.5章节数据显示；调整了二维码操作接口；增加8.3章节中数据格式中数字电视号标签；修改8.2.1二维码下发保存接口

3、，去除保存到内存；修改8.2.3二维码显示接口，接口中携带立即显示字段。1.172012-10-26包晓晓增加读取指令通道下发指令实例代码8.5章节数据显示，增加二维码显示方式描述1.2版权申明本文档包含了来自华数集团的机密的技术和商业信息，提供给华数集团的客户或合作伙伴使用。接受本文档表示同意对其内容保密并且未经华数集团书面认可，不得复制、泄露或散布本文档的全部或部分内容。本文文件及其描述的产品受有关法律的版权保护，对本文档内容的任何形式的非法复制，泄露或散布，将导致相应的法律责任。华数集团保留在不另行通知的情况下修改本文档的权利，并保留对本文档内容的解释权。目 录1概述52目的53适用范围

4、54引用标准与规范性文件55术语与缩略语65.1名词解释65.2缩略语66业务场景76.1前端数据生成二维码76.2终端数据生成二维码77业务时序图87.1前端数据生成二维码时序图87.2终端数据生成二维码时序图98技术规范108.1编码算法108.2二维码操作接口108.2.1二维码下发保存接口108.2.2二维码读取接口118.2.3二维码显示接口118.3数据格式138.4数据存储148.5数据显示148.6异常处理15附录A 业务ID规则16附录B 二维码操作指令格式161 概述随着二维码技术的发展，现在人们生活中已经随处可以见到它的应用。比如，火车票上的二维码乘客信息识别，互联网上二

5、维码应用（下载地址或者社交中友人的信息）等等。二维码引入到数字电视中，更大的方便电视用户操作，不用面对各种繁杂的数据，通过二维码可以做到移动终端的验证，下载应用等功能。 常见二维码标准有PDF417二维条码， Datamatrix二维条码，Maxicode二维条码， QR Code，Code 49， Code 16K，Code one等10多种；应用最普遍的是QR，DM，PDF417。中国目前的国家标准是QR码和PDF417码。手机二维码普遍使用QR和DM标准。2 目的为了简化用户输入，增强了用户体验度，华数终端采用二维码技术。本规范对终端二维码技术相关规范进行了阐述与定义。3 适用范围本规范

6、适用于所有集成了云终端软件的终端，要求所有需要二维码功能的终端照此规范开发集成。国家实验室对需要进行二维码功能验证测试的终端严格按照此规范进行测试验证。4 引用标准与规范性文件下列标准文件所包含的条文，通过在本规范中引用而构成为本规范的条文。对于注明日期的引用标准，以为进行的补充和修改并不适用，然而，鼓励基于国际标准的协议各方对应用以下标准文件最新版本的可能性进行调研，无注明日期的引用标准适用于提交应用的最近的版本。ISO和IEC的成员仍然是当前有效标准的注册机构。 1 Information technology - Automatic identification and data cap

7、ture techniques - QR Code 2005 bar code symbology specification2 GBT 18284-2000 快速响应矩阵码5 术语与缩略语5.1 名词解释二维条码/二维码：是用某种特定的几何图形按一定规律在平面（二维方向上）分布的黑白相间的图形记录数据符号信息的；在代码编制上巧妙地利用构成计算机内部逻辑基础的“0”、“1”比特流的概念，使用若干个与二进制相对应的几何形体来表示文字数值信息，通过图象输入设备或光电扫描设备自动识读以实现信息自动处理。云终端软件：集成在机顶盒，提供云服务接入能力的客户端。前端：应用系统的后台服务。5.2 缩略语QR

8、 Quick Response 快速响应矩阵码STBID Set Top Box Identification终端编号CA Conditional Access条件访问CAIDConditional Access Identification智能卡号DTVID Digital Television Identification数字电视号6 业务场景6.1 前端数据生成二维码图6-1 前端数据生成二维码场景图 该场景主要描述了终端的二维码模块接收到前端下发的数据生成二维码图，并展示到电视机的过程。6.2 终端数据生成二维码图6-2 终端数据生成二维码场景图 该场景主要描述了终端的二维码模块使用存

9、储在本地的数据生成二维码图，并展示在电视机的过程。7 业务时序图7.1 前端数据生成二维码时序图图7-1 前端数据生成二维码时序图1） 前端服务器把业务中使用到的数据下发到终端上的云终端软件；2） 云终端软件解析数据标志位，把类型为二维码的数据转发给二维码模块；3） 二维码模块根据标识决定存储数据还是立即显示二维码图；4） 如果存储数据，则当二维码模块接收到终端应用发送的显示指令时，二维码模块根据业务ID获取存储在本地数据（Flash中）合并必须生成的数据（STBID、CAID、REGID、DTVID），生成二维码图；5） 如果立即显示二维码图，则二维码模块合并前端下发的数据（包括存储在本地的

10、数据）与必须生成的数据（STBID、CAID、REGID、DTVID），生成二维码图。7.2 终端数据生成二维码时序图图7-2 终端数据生成二维码时序图1） 终端应用通知二维码模块生成二维码；2） 二维码模块从终端获取指定数据生成二维码图，并展示到电视机上；8 技术规范8.1 编码算法结合标准的普适性、国家和行业现状，本规范使用QR标准做为华数机顶盒二维码技术规范。QR标准参见国际标准（ISO/IEC 18004-2006信息技术-自动识别和数据采集技术-QR代码2005条形码符号体系规范）、国家标准（GBT18284-2000快速响应矩阵码）。8.2 二维码操作接口前端通过云终端软件下发二维

11、码操作命令给终端，终端通过接口获取到TS指令后，根据指令格式执行下列接口（具体指令格式见附录B）。8.2.1 二维码下发保存接口static int stb_2dimensional_barcode_set_property(int property_id, void *property, int size)；描述: 前端指令系统通过TS下发二维码数据，保存二维码信息到flash。参数:property_id: 保存接口操作方式，事件枚举如下：typedef enum _2dimensional_barcode_ops_type_EE_EDIT_FIELD_FLASH, /编辑flash已经存

12、在的二维码字段，如果该字段不存在，则添加；当XML存储空间达到上限时，添加失败；E_DEL_FIELD_FLASH, /删除flash指定二维码数据ID对应数据内容；E_2dimensional_barcode_ops_type;Property：二维码数据参数，数据格式如下:typedef struct _2dimensional_barcode_data_STunsigned charm_chBsTypeId; /业务ID类型编号unsigned charm_chAId; /业务ID序号charm_chData100; /二维码数据，字符串ST_2dimensional_barcode_d

13、ata; int size：为property数据长度；返回值:0成功；其他值失败；8.2.2 二维码读取接口static int stb_2dimensional_barcode_get_property(int property_id, void *property, int size)；描述:本接口用来读取底层flash（或机器自带信息如STBID）中保存的二维码。参数:property_id: 业务ID类型编号；void *property：读取数据保存缓存,数据格式如下：typedef struct _2dimensional_barcode_read_STchar*m_pchDat

14、a;/当前xml内容，由二维码模块申请内存空间，应用释放；intm_iDataSize;/指针m_pchData实际空间长度；ST_2dimensional_barcode_ read;int size：为property数据长度；返回值:0成功；其他值失败；8.2.3 二维码显示接口static int stb_2dimensional_barcode_display (int property_id, void *property, int size)；描述:本接口用来在终端即时显示二维码。二维码显示格式说明：本接口提供二维码显示数据寻址，即可通过接口将二维码显示的数据和显示的位置确定；参

15、数:property_id:显示二维码数据来源，数据定义如下：typedef enum _2dimensional_barcode_display_eE_FLASH_INFO，/显示flash中二维码，根据property携带的数据ID读取二维码数据，然后编码显示E_CMD_INFO,/根据指令中property字符串编码（显示指令）显示二维码e_2dimensional_barcode_display;二维码显示位置和时长数据结构：typedef struct osd_display_2code_st unsigned short x; unsigned short y; unsigned

16、short width; unsigned short height; unsigned short second; /显示时长（秒）st_osd_display_2code;property数据格式为：typedef struct _display_flash_info_stst_osd_display_2code m_stSeat; /二维码显示位置与时长unsigned char m_chBsTypeId; /业务ID类型编号unsigned char m_chAId; /业务ID序号char m_chString80;/业务ID m_chID对应的值；st_display_flash_

17、info;当property_id 为 E_FLASH_INFO时：显示业务ID类型编号的XML；当property_id为E_CMD_INFO时,将m_chAId中转换成xml的a id,m_chString为当前a id的值，然后与m_chBsTypeId对应的flash中xml拼接，显示出来；拼接后的xml不保存更新到flash中。当调用显示内存中数据时，int size：为property数据长度；返回值:0成功；其他值失败;8.3 数据格式数据按XML标记语言格式封装，如下所示： <?xml version="1.0" encoding="utf-

18、8"?><wasu><stbid>1111000000000000300004C7E7</stbid><caid>8657110122223333</caid><regid>0x601</regid><dtvid>90001234567</ dtvid ><need1></need1><need2></need2><need3></need3><need4></need4>&l

19、t;a id=""></a></wasu>数据格式说明：xml数据格式分成两部分，一是每次生成时，必须存在的部分，标签包括wasu、stbid、caid、regid、dtvid、need14；二是业务数据，即a标签内容，此标签属性ID为业务ID序号，具体规则见附录A，标签值由业务自身决定，客户端（解析软件）根据相应规则解析。xml字段说明如表8-3：标签定义长度是否可选wasu华数标识，判断二维码是否合法-必选stbid终端识别号26字节必选caidCA卡号16字节必选regid区域号8字节必选（获取不到时为空）dtvid数字电视号11字节必须

20、（获取不到时为空）need1need4必须生成的标签，具体含义预留，默认值为空32字节必选a由前端下发的一段数据 110个字节可选表8-3 标签说明表8.4 数据存储前端下发的数据字符总长度不能超过110个字节，在终端存储空间为4KB，如表8-4所示，表中业务ID规则，详见附录A。存储空间索引二级索引值330字节（业务ID）类型编号（业务ID）序号key1：value1，key2：value2； 表8-4 数据存储格式说明：一个业务在使用二维码时，允许在终端存储330字节数据，二维码模块能根据业务ID类型编号，获取该业务下所有数据，并根据业务ID序号，获取具体的数值。8.5 数据显示在业务显示

21、二维码时，根据业务ID类型编号，获取该业务下所有数据，并合并必须生成的数据（STBID、CAID、REGID、DTVID），组成XML，该业务下如有多条数据，则有多个<a>标签，并且每个<a>标签的ID不同。当前端有二维码更新时，终端显示最新二维码图；当用户操作时，二维码图消失。二维码图显示在屏幕的最上层，当前端有二维码更新时，终端显示最新二维码图；当用户操作时，二维码图消失；二维码背景底色为白色，大小超出二维码图（具体超出部分由终端自身决定）。8.6 异常处理图8-6 二维码异常场景图二维码模块在获取不到数据或者获取到的数据长度过长时，终端将会提示“二维码生成异常”信

22、息。附录A 业务ID规则AA BB类型编号序号例如： 01 02 格式： AA BB AA值定义01云服务注：AA、BB都为16进制数据，类型编号由华数定义（见上表），业务序号由业务本身决定。附录B 二维码操作指令格式二维码操作TS指令格式如下：16B32B4B125B空置32字节终端ID操作方式具体数据1字节1字节1字节122字节函数接口类型（0：显示接口；1：保存接口）接口操作事件类型数据长度数据结构下面是对二维码中125字节数据格式定义和组装实例代码：unsigned char gchOpsType = 0;unsigned char gchBsTypeId = 0;unsigned c

23、har gchAid = 0; /xml 中的a id =""unsigned char gchData100 = "" /xml <a id="">字符串</a>unsigned char x4 = "" unsigned char y4 = "" unsigned char width4 = "" unsigned char height4 = "" unsigned char second4 = "" /显

24、示时长（秒）void SendMsg()char chData125 = ""char *pch = NULL;int iSenLen = 0;chData0 = gchOpsType;chData1 = '0'chData2 = 2+Str_Len(gchData);chData3 = gchAid;chData4 = gchBsTypeId;pch = chData+5;if(Str_Len(gchData) > 100)printf("send msg:string len >100 ,error!");return ;Str_N_Copy(pch,gchData,Str_Len(gchData);p