diff --git a/通讯协议-SDK应用部分.md b/通讯协议-SDK应用部分.md index 4d53fb9..a2dbdc4 100644 --- a/通讯协议-SDK应用部分.md +++ b/通讯协议-SDK应用部分.md @@ -166,37 +166,23 @@ params:参数,可以为对象或者数组,用于伴随命令下发的数 packerTag: 数据标签字符串,用于区别当前指令与其他指令。应用程序发送给SunVoteWSTrayapp的,用户可以自定义数据(如果用户无自定义数据,可以为包序号,这样可以区分回复的数据回复的是哪个数据包)。SunVoteWSTrayapp回复应用程序时,直接回填应用程序收到的标签数据。 -反馈:SunVoteWSTrayapp -\> 应用程序 +反馈:SunVoteWSTrayapp -> 应用程序 { - -fun:\"\" //功能定义 - +fun:"" //功能定义 baseId:1 //基站id,数字类型 - infos: {}//信息对象/数组 - -packetTag:\"\"// -数据包标签字符串,用于区别当前指令与其他指令。SunVoteWSTrayapp发送给应用程序的用自增数字标记。SunVoteWSTrayapp回复应用程序的,直接回填SunVoteWSTrayapp收到的标签。 - +packetTag:""//数据包标签字符串,用于区别当前指令与其他指令。SunVoteWSTrayapp发送给应用程序的用自增数字标记。SunVoteWSTrayapp回复应用程序的,直接回填SunVoteWSTrayapp收到的标签。 } fun:同下发描述. - baseId:同下发描述. - -infos: -SunVoteWSTrayapp反馈给应用程序层的数据。具体详见具体功能定义。 - -packetTag: -数据标签字符串,反馈功能函数的状态为应用程序附带的数据包,如果SunVoteWSTrayapp主动发送数据,是一组自增数据。 +infos:SunVoteWSTrayapp反馈给应用程序层的数据。具体详见具体功能定义。 +packetTag:数据标签字符串,反馈功能函数的状态为应用程序附带的数据包,如果SunVoteWSTrayapp主动发送数据,是一组自增数据。 字段值说明: - 反馈infos中的状态字段state,OK表示成功,FAIL表示失败。 - 反馈infos中的硬件参数字段的值,FAIL表示失败,其他值为成功。 - X\~Y:范围内的值特指整数。 ## 心跳 @@ -205,37 +191,34 @@ X\~Y:范围内的值特指整数。 发送: -fun: \"heartBeat\" //心跳 - +fun: "heartBeat" //心跳 baseId: //无该值 - params:{}//无该值 - -packetTag:\"1\"//收到的packetTag,可用于分析通信状态 +packetTag:"1"//收到的packetTag,可用于分析通信状态 指令样例: - -{\ -    \"fun\":\"heartBeat\",\ -    \"packetTag\":\"1\"\ +```json +{ + "fun": "heartBeat", + "packetTag": "1" } +``` 接收: -fun: \"heartBeat\" //心跳 - +fun: "heartBeat" //心跳 baseId: //无该值 - infos:{}//无该值 - -packetTag:\"1\"//数据包标签 +packetTag:"1"//数据包标签 指令样例: -{\ -    \"fun\":\"heartBeat\",\ -    \"packetTag\":\"1\"\ +```json +{ + "fun": "heartBeat", + "packetTag": "1" } +``` ## 基站的连接、断开和复位 @@ -243,28 +226,61 @@ packetTag:\"1\"//数据包标签 ### 连接基站 -SunVoteWSTrayapp上报信息。 +读取在线基站状态 +发送: +fun: "readConnectBase" //连接基站 +baseId:0 //基站ID +params:{} //为空 +packetTag:"1" // -接收: +指令样例: +```json +{ + "fun": "readConnectBase", + "baseId": 0, + "packetTag": "1" +} +``` -fun: \"connectBase\" //连接基站 +接收: +fun: "connectBase" //连接基站 baseId:1 //基站ID +infos: {"state":"OK"} //OK连接成功 +packetTag:"1" //收到的packetTag -infos: {\"state\":\"OK\"} //OK连接成功 +指令样例: +```json +{ + "fun": "connectBase", + "baseId": 1, + "infos": { + "state": "OK" + }, + "packetTag": "1" +} +``` -packetTag:\"1\" //收到的packetTag +基站连接后主动上报,WSTrayapp上报信息。 -指令样例: +接收: -{\ -    \"fun\":\"connectBase\",\ -    \"baseId\":1,\ -    \"infos\":{\ -        \"state\":\"OK\"\ -    },\ -    \"packetTag\":\"1\"\ +fun: "connectBase" //连接基站 +baseId:1 //基站ID +infos: {"state":"OK"} //OK连接成功 +packetTag:"1" //收到的packetTag + +指令样例: +```json +{ + "fun": "connectBase", + "baseId": 1, + "infos": { + "state": "OK" + }, + "packetTag": "1" } +``` ### 断开基站 @@ -1903,7 +1919,7 @@ params:{} | **Json字段** | **字段含义** | **赋值及含义** | | --- | --- | --- | | questionLevel1Symbol | 一级题号 | 1-99 | -| toplimit | 数字上限 | 0-100 | +| toplimit | 数字上限 | 1-100 | | questionType | 题目类型 | 3:数字 | | decimal | 小数位数 | 0:无效小数
1:一位小数
2:二位小数 [默认是2]
此项缺省时默认是0。| @@ -2250,8 +2266,7 @@ infos:{"state":"OK"}//返回状态,成功为OK 发送: -fun: \"continueKeyPadMultipleQuestions\" //继续多题题型 - +fun: "continueKeyPadMultipleQuestions" //继续多题题型 params:{} 其中 displayMode 题号显示模式 有7中模式,分别对应7中显示题型的方式,用户可以根据需要自行选择 @@ -2427,7 +2442,7 @@ params:{} | **Json字段** | **字段含义** | **赋值及含义** | | --- | --- | --- | | questionLevel1Symbol | 一级题号 | 1-99 | -| toplimit | 数字上限 | 0-100 | +| toplimit | 数字上限 | 1-100 | | questionType | 题目类型 | 3:数字 | | decimal | 小数位数 | 0:无效小数
1:一位小数
2:二位小数 [默认是2]
此项缺省时默认是0。| @@ -2480,7 +2495,7 @@ params:{} | **Json字段** | **字段含义** | **赋值及含义** | | --- | --- | --- | | questionLevel1Symbol | 一级题号 | 1-99 | -| course | 科目 | 1:语文
2:数学
3:英语
4:政治
5:历史
6:地理
7:生物
8:物理
9化学 | +| course | 科目 | 1:语文
2:数学
3:英语
4:政治
5:历史
6:地理
7:生物
8:物理
9:化学 | | questionType | 题目类型 | 1:单选
2:多选(排序)
3:数字
4:判断 | | option | 选项数目 | 默认是0
当questionType = 2 有效。
此项缺省时 optional 项值代替。| @@ -2534,7 +2549,7 @@ params:{} | **Json字段** | **字段含义** | **赋值及含义** | | --- | --- | --- | | questionLevel1Symbol | 一级题号 | 1-99 | -| course | 科目 | 1:语文
2:数学
3:英语
4:政治
5:历史
6:地理
7:生物
8:物理
9化学 | +| course | 科目 | 1:语文
2:数学
3:英语
4:政治
5:历史
6:地理
7:生物
8:物理
9:化学 | | questionType | 题目类型 | 1:单选
2:多选(排序)
3:数字
4:判断 | | option | 选项数目 | 默认是0
当questionType = 2 有效。
此项缺省时 optional 项值代替。| @@ -2589,7 +2604,7 @@ params:{} | --- | --- | --- | | questionLevel1Symbol | 一级题号 | 1-99 | | questionLevel2Symbol | 二级题号 | 1-99 | -| course | 科目 | 1:语文
2:数学
3:英语
4:政治
5:历史
6:地理
7:生物
8:物理
9化学 | +| course | 科目 | 1:语文
2:数学
3:英语
4:政治
5:历史
6:地理
7:生物
8:物理
9:化学 | | questionType | 题目类型 | 1:单选
2:多选(排序)
3:数字
4:判断 | | option | 选项数目 | 默认是0
当questionType = 2 有效。
此项缺省时 optional 项值代替。|