diff --git a/通讯协议-B200W-MQTT协议[内部].md b/通讯协议-B200W-MQTT协议[内部].md index 2dd99de..985111a 100644 --- a/通讯协议-B200W-MQTT协议[内部].md +++ b/通讯协议-B200W-MQTT协议[内部].md @@ -67,7 +67,7 @@ Ver 1.0.3 |---|---|---|---| |1.0.1| 2024年10月22日|刘琴|1. 初始版| |1.0.2| 2024年12月27日|刘琴|1. 增加测验题和多科测验中自判题题型
2. 多科测验的科目数量为从9增加至11
3. 增加测验自定义题型标题下发和清除
4. 可自定义最长128位的数据包标签
注：(基站固件版本需不低于0.0.9)| -|1.0.3| 2025年2月20日|刘琴|1. 增加英文题和短消息题型
2. 增加键盘在线列表读取
3. 增加遥控器事件上报
注：(基站固件版本需不低于0.0.10)| +|1.0.3| 2025年2月20日|刘琴|1. 增加文本题和短消息题型
2. 增加键盘在线列表读取
3. 增加遥控器事件上报
注：(基站固件版本需不低于0.0.10)|

@@ -257,8 +257,8 @@ Ver 1.0.3 ||停止数字题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| |抢答题|启动抢答题答题|[startQAQuicker](#startqaquicker)|[sEvtStateCode](#sevtstatecode)
[fEvtQAQuicker](#fevtqaquicker)| ||停止抢答题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| -|英文题|启动英文题答题|[startQAEText](#startqaetext)|[sEvtStateCode](#sevtstatecode)
[fEvtQAEText](#fevtqaetext)| -||停止英文题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| +|文本题|启动文本题答题|[startQAEText](#startqaetext)|[sEvtStateCode](#sevtstatecode)
[fEvtQAEText](#fevtqaetext)| +||停止文本题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| |短消息|发送短消息|[sendKpMsg](#sendkpmsg)|[sEvtStateCode](#sevtstatecode)
[fEvtKpMsg](#fevtkpmsg)| |待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)
[sEvtKpRtFeedback](#sevtkprtfeedback)
[sEvtKpHandUp](#sevtkphandup)| ||获取待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)| @@ -3459,9 +3459,9 @@ Ver 1.0.3 |+count|int||是|题目数量，1-16，>1多题快答| |+mode|int||是|1 - True/False 对/错
2 - Yes/No 是/否
3 - √/×| |+allowModify|int||是|0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值
1-对
2-错| +|++answer|string||是|预设提交的按键值
1-对
2-错| - **示例代码** @@ -3474,10 +3474,7 @@ Ver 1.0.3 "count":1, "mode":1, "allowModify":1, - "tip":"请判断对错", - "simParams":{ - "answer":"1" - } + "tip":"请判断对错" } } ``` @@ -3556,9 +3553,9 @@ Ver 1.0.3 |+options|int||是|选项数量，1≤M≤10(默认值4)| |+optionalN|int||是|可选项个数，1≤N≤M(默认值1)| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** @@ -3574,10 +3571,7 @@ Ver 1.0.3 "options": 4, "optionalN": 1, "allowModify":1, - "tip":"请选择", - "simParams":{ - "answer":"A" - } + "tip":"请选择" } } ``` @@ -3653,9 +3647,9 @@ Ver 1.0.3 |+numMin|int||是|可输入下限,mode=1有效，范围0-100| |+numMax|int||是|可输入上限,mode=1有效，范围0-100| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** @@ -3670,10 +3664,7 @@ Ver 1.0.3 "numMin": 0, "numMax": 100, "allowModify":1, - "tip":"请输入数字", - "simParams":{ - "answer":"10" - } + "tip":"请输入数字" } } ``` @@ -3746,9 +3737,9 @@ Ver 1.0.3 |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| |+mode|int||是|模式
0:普通抢答| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** ```json @@ -3759,10 +3750,7 @@ Ver 1.0.3 "keySns":[], "mode": 0, "allowModify":1, - "tip":"请按键抢答", - "simParams":{ - "answer":"1" - } + "tip":"请按键抢答" } } ``` @@ -3821,11 +3809,11 @@ Ver 1.0.3 }] } ``` -### 英文题 +### 文本题 #### 方法 ##### startQAEText - **主题**：/client/{baseSN}/send -- **功能描述**：启动英文题答题 +- **功能描述**：启动文本题答题 - **参数说明** |参数名|类型|限制|是否必填|说明| @@ -3834,11 +3822,10 @@ Ver 1.0.3 |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| -|+mode|int||是|模式
1:自由输入字母，最多不超过144字符| -|+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+mode|int||是|模式
1:自由输入，最多不超过144字符| +|+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** ```json @@ -3848,17 +3835,13 @@ Ver 1.0.3 "data":{ "keySns":[], "mode": 0, - "allowModify":1, - "tip":"请输入英文文本", - "simParams":{ - "answer":"AAAAAAA" - } + "allowModify":1 } } ``` ##### [stopKpVote](#stopkpvote) -停止英文题答题 +停止文本题答题 #### 事件 ##### [sEvtStateCode](#sevtstatecode) @@ -4124,9 +4107,9 @@ Ver 1.0.3 |++quesType | int||是| 题目类型
1:单选
2:多选（排序）
3:数字
4:判断
5:自判题| |++option |int||是 |选项数目
quesType = 1 有效。
quesType = 2 有效。
此项缺省时 默认4;
范围：1-10。| |++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，“1-1-1”，最多只能输入三级
mode=0 时有效，mode=1或2时键盘按顺序显示题号| -|++count | int||是| 相同参数的连续题目数量, >0
注意：总题数最多支持200题 | +|++count | int||是| 相同参数的连续题目数量, >0
注意：总题数最多支持200题 | |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| +|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| - **示例代码** @@ -4142,10 +4125,7 @@ Ver 1.0.3 "quesType": 1, //单选题 "startNo": "1", //题号从1开始 "count":10 //连续10题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4176,10 +4156,7 @@ Ver 1.0.3 "quesType": 4, //判断题 "startNo": "6", //题号从6开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4210,10 +4187,7 @@ Ver 1.0.3 "quesType": 4, //判断题 "startNo": "4-1", //题号从4-1开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4244,10 +4218,7 @@ Ver 1.0.3 "quesType": 4, //判断题 "startNo": "3-1-1", //题号从3-1-1开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4277,10 +4248,7 @@ Ver 1.0.3 "quesType": 4, //判断题 "startNo": "6", //题号从6开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4310,10 +4278,7 @@ Ver 1.0.3 "quesType": 4, //判断题 "startNo": "6", //题号从6开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4474,9 +4439,9 @@ Ver 1.0.3 |++quesType | int||是| 题目类型
1:单选
2:多选（排序）
3:数字
4:判断
5:自判题| |++option |int||是 |选项数目
quesType = 1 有效。
quesType = 2 有效。
此项缺省时 默认4;
范围：1-10。| |++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，最多支持两级题号
mode=0 时有效，mode=1或2时键盘按顺序显示题号| -|++count | int||是| 相同参数的连续题目数量, >0
注意：所有科目的总题数最多支持200题| +|++count | int||是| 相同参数的连续题目数量, >0
注意：所有科目的总题数最多支持200题| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| +|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| - **示例代码** ```json @@ -4512,10 +4477,7 @@ Ver 1.0.3 "quesType": 4, "startNo": "4", "count":2 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } @@ -4532,10 +4494,7 @@ Ver 1.0.3 "quesType": 1, "startNo": "1", "count":20 - }], - "simParams":{ - "answer":["A","","",""] - } + }] } } @@ -4552,10 +4511,7 @@ Ver 1.0.3 "quesType": 1, "startNo": "1", "count":20 - }], - "simParams":{ - "answer":["A","","",""] - } + }] } } ``` diff --git a/通讯协议-平台化-应用部分.md b/通讯协议-平台化-应用部分.md index e0a133c..77cf09f 100644 --- a/通讯协议-平台化-应用部分.md +++ b/通讯协议-平台化-应用部分.md @@ -285,8 +285,8 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ||停止数字题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| |抢答题|启动抢答题答题|[startQAQuicker](#startqaquicker)|[sEvtStateCode](#sevtstatecode)
[fEvtQAQuicker](#fevtqaquicker)| ||停止抢答题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| -|英文题|启动英文题答题|[startQAEText](#startqaetext)|[sEvtStateCode](#sevtstatecode)
[fEvtQAEText](#fevtqaetext)| -||停止英文题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| +|文本题|启动文本题答题|[startQAEText](#startqaetext)|[sEvtStateCode](#sevtstatecode)
[fEvtQAEText](#fevtqaetext)| +||停止文本题答题|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| |短消息|发送短消息|[sendKpMsg](#sendkpmsg)|[sEvtStateCode](#sevtstatecode)
[fEvtKpMsg](#fevtkpmsg)| |待机实时反馈|设置待机实时反馈状态|[setKpStbResponse](#setkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)
[sEvtKpRtFeedback](#sevtkprtfeedback)
[sEvtKpHandUp](#sevtkphandup)| ||获取待机实时反馈状态|[getKpStbResponse](#getkpstbresponse)|[fEvtKpStbResponse](#fevtkpstbresponse)| @@ -3876,9 +3876,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+count|int||是|题目数量，1-16，>1多题快答| |+mode|int||是|1 - True/False 对/错
2 - Yes/No 是/否
3 - √/×| |+allowModify|int||是|0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值
1-对
2-错| +|++answer|string||是|预设提交的按键值
1-对
2-错| - **示例代码** @@ -3892,10 +3892,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "count":1, "mode":1, "allowModify":1, - "tip":"请判断对错", - "simParams":{ - "answer":"1" - } + "tip":"请判断对错" } } ``` @@ -3977,9 +3974,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+options|int||是|选项数量，1≤M≤10(默认值4)| |+optionalN|int||是|可选项个数，1≤N≤M(默认值1)| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** @@ -3996,10 +3993,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "options": 4, "optionalN": 1, "allowModify":1, - "tip":"请选择", - "simParams":{ - "answer":"A" - } + "tip":"请选择" } } ``` @@ -4078,9 +4072,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+numMin|int||是|可输入下限,mode=1有效，范围0-100| |+numMax|int||是|可输入上限,mode=1有效，范围0-100| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** @@ -4096,10 +4090,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "numMin": 0, "numMax": 100, "allowModify":1, - "tip":"请输入数字", - "simParams":{ - "answer":"10" - } + "tip":"请输入数字" } } ``` @@ -4175,9 +4166,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| |+mode|int||是|模式
0:普通抢答| |+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+tip|string||否|提示的标题，长度不超过16字符| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** ```json @@ -4189,10 +4180,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "keySns":[], "mode": 0, "allowModify":1, - "tip":"请按键抢答", - "simParams":{ - "answer":"1" - } + "tip":"请按键抢答" } } ``` @@ -4253,11 +4241,11 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 }] } ``` -### 英文题 +### 文本题 #### 方法 ##### startQAEText - **主题**：/client/{baseSN}/send -- **功能描述**：启动英文题答题 +- **功能描述**：启动文本题答题 - **参数说明** |参数名|类型|限制|是否必填|说明| @@ -4267,11 +4255,10 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象| |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| -|+mode|int||是|模式
1:自由输入字母，最多不超过144字符| -|+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| -|+tip|string||否|提示的标题，长度不超过16字符| +|+mode|int||是|模式
1:自由输入，最多不超过144字符| +|+allowModify|int||是|修改模式
0 - 不允许修改
1 - 允许修改| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|string||是|预设提交的按键值| +|++answer|string||是|预设提交的按键值| - **示例代码** ```json @@ -4282,17 +4269,13 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "data":{ "keySns":[], "mode": 0, - "allowModify":1, - "tip":"请输入英文文本", - "simParams":{ - "answer":"AAAAAAA" - } + "allowModify":1 } } ``` ##### [stopKpVote](#stopkpvote) -停止英文题答题 +停止文本题答题 #### 事件 ##### [sEvtStateCode](#sevtstatecode) @@ -4575,9 +4558,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |++quesType | int||是| 题目类型
1:单选
2:多选（排序）
3:数字
4:判断
5:自判题| |++option |int||是 |选项数目
quesType = 1 有效。
quesType = 2 有效。
此项缺省时 默认4;
范围：1-10。| |++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，“1-1-1”，最多只能输入三级
mode=0 时有效，mode=1或2时键盘按顺序显示题号| -|++count | int||是| 相同参数的连续题目数量, >0
注意：总题数最多支持200题 | +|++count | int||是| 相同参数的连续题目数量, >0
注意：总题数最多支持200题 | |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| +|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| - **示例代码** @@ -4594,10 +4577,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 1, //单选题 "startNo": "1", //题号从1开始 "count":10 //连续10题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4629,10 +4609,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 4, //判断题 "startNo": "6", //题号从6开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4664,10 +4641,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 4, //判断题 "startNo": "4-1", //题号从4-1开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4699,10 +4673,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 4, //判断题 "startNo": "3-1-1", //题号从3-1-1开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4733,10 +4704,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 4, //判断题 "startNo": "6", //题号从6开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4767,10 +4735,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 4, //判断题 "startNo": "6", //题号从6开始 "count":1 //连续1题 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } ``` @@ -4940,9 +4905,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |++quesType | int||是| 题目类型
1:单选
2:多选（排序）
3:数字
4:判断
5:自判题| |++option |int||是 |选项数目
quesType = 1 有效。
quesType = 2 有效。
此项缺省时 默认4;
范围：1-10。| |++startNo | string||是| 起始题号,可以为数字+“-”，单级的题号数字范围1-255，如“1”，“1-1”，最多支持两级题号
mode=0 时有效，mode=1或2时键盘按顺序显示题号| -|++count | int||是| 相同参数的连续题目数量, >0
注意：所有科目的总题数最多支持200题| +|++count | int||是| 相同参数的连续题目数量, >0
注意：所有科目的总题数最多支持200题| |+simParams|object||否|内部模拟测试参数设置对象| -|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| +|++answer|array||是|预设提交的按键值
格式为"单选题答案,多选题答案;
数字题答案;判断题答案(1对2错)"
如["A","ABCD","10","1"]| - **示例代码** ```json @@ -4979,10 +4944,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 4, "startNo": "4", "count":2 - }], - "simParams":{ - "answer":["A","ABCD","10","1"] - } + }] } } @@ -5000,10 +4962,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 1, "startNo": "1", "count":20 - }], - "simParams":{ - "answer":["A","","",""] - } + }] } } @@ -5021,10 +4980,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "quesType": 1, "startNo": "1", "count":20 - }], - "simParams":{ - "answer":["A","","",""] - } + }] } } ```