Commit cd0d1a297634d7b280d5237eec314b9f8033a022

Authored by 刘琴
1 parent f3310fd7

修改BIC说明,增加基站自检功能

通讯协议-B200W-MQTT协议[内部].md
... ... @@ -105,7 +105,7 @@
105 105 |识别设置 - 出厂编码|<font color="red">设置基站出厂编码(内)|[setBsSN](#setbssn)|[fEvtBsSN](#fevtbssn)|
106 106 |识别设置 - 基站型号|读取基站型号|[getBsModel](#getbsmodel)|[fEvtBsModel](#fevtbsmodel)|
107 107 |识别设置 - 固件版本|获取基站固件版本|[getBsFWVersion](#getbsfwversion)|[fEvtBsFWVersion](#fevtbsfwversion)|
108   -|识别设置 - 品牌识别码|获取基站品牌识别码|[getBsBIC](#getbsbic)|[fEvtBsBIC](#fevtbsbic)|
  108 +|识别设置 - 品牌识别码|<font color="red">获取基站品牌识别码(内)</font>|[getBsBIC](#getbsbic)|[fEvtBsBIC](#fevtbsbic)|
109 109 ||<font color="red">设置基站品牌识别码(内)|[setBsBIC](#setbsbic)|[fEvtBsBIC](#fevtbsbic)|
110 110 |组网设置 - 组网模式|获取基站组网模式|[getBsNetworkMode](#getbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)|
111 111 ||<font color="blue">设置基站组网模式<br>(前期不开放,后期需要)|[setBsNetworkMode](#setbsnetworkmode)|[fEvtBsNetworkMode](#fevtbsnetworkmode)|
... ... @@ -148,6 +148,7 @@
148 148 ||<font color="red">清空基站日志(内)</font>|[clearBsLogInfo](#clearbsloginfo)|[sEvtStateCode](#sevtstatecode)|
149 149 ||基站软复位|[resetBsSystem](#resetbssystem)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)|
150 150 ||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)|
  151 +||基站自检|[startBsSelfCheck](#startbsselfcheck)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsSelfCheck](#fevtbsselfcheck)|
151 152 |基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)|
152 153 ||<font color="red">下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsFontLibState](#fevtbsfontlibstate)<br>[fEvtBsFontLibProgress](#fevtbsfontlibprogress)|
153 154 ### 键盘管理
... ... @@ -343,19 +344,23 @@
343 344 |---|---|---|---|---|
344 345 |fun|string|-|是|事件名称|
345 346 |dataTag|string|-|否|数据包标识|
346   -|data|object|-|是|传送参数的对象|
347   -|+keySn|string||是|键盘SN|
348   -|+keyValue|string||是|键盘提交的按键值|
  347 +|data|array|-|是|传送参数的对象数组|
  348 +|++keySn|string||是|键盘SN|
  349 +|++keyValue|string||是|键盘提交的按键值|
  350 +|++voltage|double||是|键盘电量|
  351 +|++retryCount|int||是|键盘提交数据的重发次数|
349 352  
350 353 - **示例代码**
351 354 ```json
352 355 {
353 356 "fun":"sEvtKpRtFeedback",
354 357 "dataTag":"1",
355   - "data":{
  358 + "data":[{
356 359 "keySn":"1234567890",
357   - "keyValue":"A"
358   - }
  360 + "keyValue":"A",
  361 + "voltage":2.6,
  362 + "retryCount":1
  363 + }]
359 364 }
360 365 ```
361 366 ### sEvtKpHandUp
... ... @@ -409,6 +414,7 @@
409 414 |20008|value参数错误|
410 415 |30001|基站在答题中|
411 416 |30002|基站忙(内存不足)|
  417 +|30003|基站执行失败|
412 418 |40001|升级功能只能支持一个基站|
413 419 |50001|此功能必须指定基站|
414 420 |60001|此功能必须指定键盘SN|
... ... @@ -583,7 +589,7 @@
583 589 }
584 590 ```
585 591 ##### getBsBIC
586   -- **主题**:/client/\${baseSN}/send
  592 +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span>
587 593 - **功能描述**:获取基站品牌识别码
588 594 - **参数说明**
589 595  
... ... @@ -619,7 +625,7 @@
619 625 "fun":"setBsBIC",
620 626 "dataTag":"1",
621 627 "data":{
622   - "value":"sunvote"
  628 + "value":"EA10"
623 629 }
624 630 }
625 631 ```
... ... @@ -691,7 +697,7 @@
691 697 }
692 698 ```
693 699 ##### fEvtBsBIC
694   -- **主题**: /basestation/\${baseSN}/receive
  700 +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
695 701 - **功能描述**:返回基站的品牌码
696 702 - **参数说明**
697 703  
... ... @@ -700,7 +706,7 @@
700 706 |fun|string|-|是|事件名称|
701 707 |dataTag|string|-|否|数据包标识|
702 708 |data|object|-|是|传送参数的对象|
703   -|+value|string||是|基站的品牌码|
  709 +|+value|string||是|基站的品牌码<br>EA10: 中天电子<br>B001: 科大讯飞<br>B002: 台湾网奕<br>B003: 德国Infowhyse<br>B004: 印度K12 Techno<br>B005: 印度UOLO |
704 710  
705 711 - **示例代码**
706 712 ```json
... ... @@ -708,7 +714,7 @@
708 714 "fun":"fEvtBsBIC",
709 715 "dataTag":"1",
710 716 "data":{
711   - "value":"sunvote"
  717 + "value":"EA10"
712 718 }
713 719 }
714 720 ```
... ... @@ -1800,7 +1806,7 @@
1800 1806 |+port|int||是|端口,默认1883|
1801 1807 |+userName|string||否|连接服务器的用户名,可不设置|
1802 1808 |+password|string||否|连接服务器的密码,可不设置|
1803   -|+interval|int|>=10|否|基站连接服务器失败后重连的间隔时长,单位秒|
  1809 +|+interval|int|>=60|否|基站连接服务器失败后重连的间隔时长,单位秒|
1804 1810  
1805 1811 - **示例代码**
1806 1812 ```json
... ... @@ -1812,7 +1818,7 @@
1812 1818 "port":1883,
1813 1819 "userName":"",
1814 1820 "password":"",
1815   - "interval":30
  1821 + "interval":60
1816 1822 }
1817 1823 }
1818 1824 ```
... ... @@ -2015,6 +2021,24 @@
2015 2021 }
2016 2022 ```
2017 2023  
  2024 +##### startBsSelfCheck
  2025 +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span>
  2026 +- **功能描述**:开始基站自检,基站自检状态中不接收其他指令,空闲状态中才进入自检
  2027 +- **参数说明**
  2028 +
  2029 +|参数名|类型|限制|是否必填|说明|
  2030 +|---|---|---|---|---|
  2031 +|fun|string|-|是|指令名称|
  2032 +|dataTag|string|-|否|数据包标识,可为空字符串|
  2033 +
  2034 +- **示例代码**
  2035 +```json
  2036 +{
  2037 + "fun":"startBsSelfCheck",
  2038 + "dataTag":"1"
  2039 +}
  2040 +```
  2041 +
2018 2042 #### 事件
2019 2043 ##### [sEvtStateCode](#sevtstatecode)
2020 2044 返回指令的接收状态
... ... @@ -2047,6 +2071,46 @@
2047 2071 }
2048 2072 }
2049 2073 ```
  2074 +
  2075 +##### fEvtBsSelfCheck
  2076 +- **主题**: <sapn class="yellowFill">/manage/\${baseSN}/receive</span>
  2077 +- **功能描述**:返回基站自检的结果
  2078 +- **参数说明**
  2079 +
  2080 +|参数名|类型|限制|非空|说明|
  2081 +|---|---|---|---|---|
  2082 +|fun|string|-|是|指令名称|
  2083 +|dataTag|string|-|否|数据包标识,可为空字符串|
  2084 +|data|array|-|是|传送参数的对象数组|
  2085 +|++name|string||是|检测项名称:MCU、RF、FLASH、EEPROM|
  2086 +|++state|int||是|检测结果<br>0-功能异常<br>1-功能正常|
  2087 +
  2088 +- **示例代码**
  2089 +```json
  2090 +{
  2091 + "fun":"fEvtBsSelfCheck",
  2092 + "dataTag":"1",
  2093 + "data":[
  2094 + {
  2095 + "name":"MCU",
  2096 + "state":1
  2097 + },
  2098 + {
  2099 + "name":"RF",
  2100 + "state":1
  2101 + },
  2102 + {
  2103 + "name":"FLASH",
  2104 + "state":1
  2105 + },
  2106 + {
  2107 + "name":"EEPROM",
  2108 + "state":1
  2109 + }
  2110 + ]
  2111 +}
  2112 +```
  2113 +
2050 2114 ### 基站升级
2051 2115 #### 方法
2052 2116 ##### startBsUpdate
... ... @@ -3289,7 +3353,7 @@
3289 3353 |++keySn|string||是|键盘SN|
3290 3354 |++keyValue|string||是|键盘提交的按键值|
3291 3355 |++keyTime|double||是|答题时间,从启动开始计算,单位秒|
3292   -|++voltage|double||是|键盘电量</font>|
  3356 +|++voltage|double||是|键盘电量|
3293 3357 |++retryCount|int||是|键盘提交数据的重发次数|
3294 3358  
3295 3359 - **示例代码**
... ... @@ -3469,11 +3533,12 @@
3469 3533 |fun|string|-|是|指令名称|
3470 3534 |dataTag|string|-|否|数据包标识,可为空字符串|
3471 3535 |data|array|-|是|传送参数的对象数组|
3472   -|+state|int||是|启用待机实时反馈<br>0-启用<br>1-启用|
  3536 +|+state|int||是|启用待机实时反馈<br>0-启用<br>1-启用|
3473 3537 |+mode|int||是|当前启动待机反馈类型,state=1时返回<br>0-举手<br>1-指定按键反馈|
3474 3538  
3475 3539 - **示例代码**
3476 3540 ```json
  3541 +//当前启用待机实时反馈,模式为指定按键反馈
3477 3542 {
3478 3543 "fun":"fEvtKpStbResponse",
3479 3544 "dataTag":"1",
... ... @@ -3482,6 +3547,15 @@
3482 3547 "mode": 1
3483 3548 }
3484 3549 }
  3550 +
  3551 +//当前未启用待机反馈
  3552 +{
  3553 + "fun":"fEvtKpStbResponse",
  3554 + "dataTag":"1",
  3555 + "data": {
  3556 + "state": 0
  3557 + }
  3558 +}
3485 3559 ```
3486 3560  
3487 3561 ##### [sEvtKpRtFeedback](#sevtkprtfeedback)
... ... @@ -3489,6 +3563,7 @@
3489 3563  
3490 3564 ##### [sEvtKpHandup](#sevtkphandup)
3491 3565 启动待机按键反馈类型为举手提问时返回此事件
  3566 +
3492 3567 ## 在线测验
3493 3568 ### 标准测验
3494 3569 #### 方法
... ...