Commit ca8e0b8e0a60c02329e67f7a3b8f8c00755a80cc
1 parent
3e0a46de
删除键盘识别模式接口,增加清空基站日志,修改几处示例代码错误
Showing
1 changed file
with
25 additions
and
70 deletions
通讯协议-B200W-MQTT协议[内部].md
@@ -13,10 +13,10 @@ | @@ -13,10 +13,10 @@ | ||
13 | background-color: yellow; | 13 | background-color: yellow; |
14 | } | 14 | } |
15 | </style> | 15 | </style> |
16 | -# SunVote B200W_MQTT 接口协议 | ||
17 | - | ||
18 | [TOC] | 16 | [TOC] |
19 | 17 | ||
18 | +# SunVote B200W_MQTT 接口协议 | ||
19 | + | ||
20 | # 功能说明 | 20 | # 功能说明 |
21 | 21 | ||
22 | ## 主题说明 | 22 | ## 主题说明 |
@@ -145,6 +145,7 @@ | @@ -145,6 +145,7 @@ | ||
145 | |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| | 145 | |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| |
146 | ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| | 146 | ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| |
147 | |基站维护|<font color="red">获取基站日志信息(内)</font>|[getBsLogInfo](#getbsloginfo)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsLogInfo](#fevtbsloginfo)| | 147 | |基站维护|<font color="red">获取基站日志信息(内)</font>|[getBsLogInfo](#getbsloginfo)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsLogInfo](#fevtbsloginfo)| |
148 | +||<font color="red">清空基站日志(内)</font>|[clearBsLog](#clearBsLog)|[sEvtStateCode](#sevtstatecode)| | ||
148 | ||基站软复位|[resetBsSystem](#resetbssystem)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)| | 149 | ||基站软复位|[resetBsSystem](#resetbssystem)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)| |
149 | ||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)| | 150 | ||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)<br>[sEvtBsConnectState](#sevtbsconnectstate)| |
150 | |基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)| | 151 | |基站升级|<font color="red">开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)<br>[fEvtBsUpateState](#fevtbsupatestate)<br>[fEvtBsUpdateProgress](#fevtbsupdateprogress)| |
@@ -154,8 +155,6 @@ | @@ -154,8 +155,6 @@ | ||
154 | |---|---|---|---| | 155 | |---|---|---|---| |
155 | |<font color="red">识别设置 - 出厂编码(内)|<font color="red">设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtSetKpSN](#fevtsetkpsn)<br>| | 156 | |<font color="red">识别设置 - 出厂编码(内)|<font color="red">设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtSetKpSN](#fevtsetkpsn)<br>| |
156 | |<font color="red">识别设置 - 键盘编号(内)|<font color="red">设置键盘编号(内)|[setKpID](#setkpid)|[fEvtSetKpID](#fevtsetkpid)| | 157 | |<font color="red">识别设置 - 键盘编号(内)|<font color="red">设置键盘编号(内)|[setKpID](#setkpid)|[fEvtSetKpID](#fevtsetkpid)| |
157 | -|<font color="red">识别设置 - 识别模式(内)|<font color="red">获取键盘识别模式(内)|[getKpIdentityMode](#getkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| | ||
158 | -||<font color="red">设置键盘识别模式(内)|[setKpIdentityMode](#setkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| | ||
159 | |<font color="red">识别设置 - 键盘信息(内)|<font color="red">开始获取键盘信息(内)|[startGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpInfo](#fevtkpinfo)| | 158 | |<font color="red">识别设置 - 键盘信息(内)|<font color="red">开始获取键盘信息(内)|[startGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpInfo](#fevtkpinfo)| |
160 | ||<font color="red">停止获取键盘信息(内)|[stopGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)| | 159 | ||<font color="red">停止获取键盘信息(内)|[stopGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)| |
161 | |交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| | 160 | |交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| |
@@ -1959,6 +1958,24 @@ | @@ -1959,6 +1958,24 @@ | ||
1959 | } | 1958 | } |
1960 | ``` | 1959 | ``` |
1961 | 1960 | ||
1961 | +##### clearBsLog | ||
1962 | +- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | ||
1963 | +- **功能描述**:清空基站内部日志记录 | ||
1964 | +- **参数说明** | ||
1965 | + | ||
1966 | +|参数名|类型|限制|是否必填|说明| | ||
1967 | +|---|---|---|---|---| | ||
1968 | +|fun|string|-|是|指令名称| | ||
1969 | +|dataTag|string|-|否|数据包标识,可为空字符串| | ||
1970 | + | ||
1971 | +- **示例代码** | ||
1972 | +```json | ||
1973 | +{ | ||
1974 | + "fun":"clearBsLog", | ||
1975 | + "dataTag":"1" | ||
1976 | +} | ||
1977 | +``` | ||
1978 | + | ||
1962 | ##### resetBsSystem | 1979 | ##### resetBsSystem |
1963 | - **主题**:/client/\${baseSN}/send | 1980 | - **主题**:/client/\${baseSN}/send |
1964 | - **功能描述**:软复位基站<sapn class="yellowFill">(公共主题可用,但不体现在外部版本协议中</span>) | 1981 | - **功能描述**:软复位基站<sapn class="yellowFill">(公共主题可用,但不体现在外部版本协议中</span>) |
@@ -2212,7 +2229,7 @@ | @@ -2212,7 +2229,7 @@ | ||
2212 | - **示例代码** | 2229 | - **示例代码** |
2213 | ```json | 2230 | ```json |
2214 | { | 2231 | { |
2215 | - "fun":"setKpIdentityMode", | 2232 | + "fun":"setKpSN", |
2216 | "dataTag":"1", | 2233 | "dataTag":"1", |
2217 | "data":{ | 2234 | "data":{ |
2218 | "oldKeySn":"1234567890", | 2235 | "oldKeySn":"1234567890", |
@@ -2283,74 +2300,10 @@ | @@ -2283,74 +2300,10 @@ | ||
2283 | } | 2300 | } |
2284 | ``` | 2301 | ``` |
2285 | 2302 | ||
2286 | - | ||
2287 | -##### getKpIdentityMode | ||
2288 | -- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | ||
2289 | -- **功能描述**:获取键盘识别模式 | ||
2290 | -- **参数说明** | ||
2291 | - | ||
2292 | -|参数名|类型|限制|是否必填|说明| | ||
2293 | -|---|---|---|---|---| | ||
2294 | -|fun|string|-|是|指令名称| | ||
2295 | -|dataTag|string|-|否|数据包标识,可为空字符串| | ||
2296 | - | ||
2297 | -- **示例代码** | ||
2298 | -```json | ||
2299 | -{ | ||
2300 | - "fun":"getKpIdentityMode", | ||
2301 | - "dataTag":"1" | ||
2302 | -} | ||
2303 | -``` | ||
2304 | -##### setKpIdentityMode | ||
2305 | -- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/send</span> | ||
2306 | -- **功能描述**:设置键盘识别模式 | ||
2307 | -- **参数说明** | ||
2308 | - | ||
2309 | -|参数名|类型|限制|是否必填|说明| | ||
2310 | -|---|---|---|---|---| | ||
2311 | -|fun|string|-|是|指令名称| | ||
2312 | -|dataTag|string|-|否|数据包标识,可为空字符串| | ||
2313 | -|data|object|-|是|传送参数的对象| | ||
2314 | -|+value|string||是|设置键盘识别模式<br>0 - SN模式<br>1 - ID+SN模式| | ||
2315 | -|+time|string|数字|是|时间,yyyyMMddHHmmss| | ||
2316 | -|+verCode|string||是|内部主题校验码,时间+固定key加密| | ||
2317 | - | ||
2318 | -- **示例代码** | ||
2319 | -```json | ||
2320 | -{ | ||
2321 | - "fun":"setKpIdentityMode", | ||
2322 | - "dataTag":"1", | ||
2323 | - "data":{ | ||
2324 | - "value":"0" | ||
2325 | - } | ||
2326 | -} | ||
2327 | -``` | ||
2328 | #### 事件 | 2303 | #### 事件 |
2329 | ##### [sEvtStateCode](#sevtstatecode) | 2304 | ##### [sEvtStateCode](#sevtstatecode) |
2330 | 发送指令后返回接收状态 | 2305 | 发送指令后返回接收状态 |
2331 | 2306 | ||
2332 | -##### fEvtKpIdentityMode | ||
2333 | -- **主题**:<sapn class="yellowFill">/manage/\${baseSN}/receive</span> | ||
2334 | -- **功能描述**:返回键盘识别模式 | ||
2335 | -- **参数说明** | ||
2336 | - | ||
2337 | -|参数名|类型|限制|非空|说明| | ||
2338 | -|---|---|---|---|---| | ||
2339 | -|fun|string|-|是|指令名称| | ||
2340 | -|dataTag|string|-|否|数据包标识,可为空字符串| | ||
2341 | -|data|object|-|是|传送参数的对象| | ||
2342 | -|+value|string||是|设置键盘识别模式<br>0 - SN模式<br>1 - ID+SN模式| | ||
2343 | - | ||
2344 | -- **示例代码** | ||
2345 | -```json | ||
2346 | -{ | ||
2347 | - "fun":"fEvtKpIdentityMode", | ||
2348 | - "dataTag":"1", | ||
2349 | - "data":{ | ||
2350 | - "value":"0" | ||
2351 | - } | ||
2352 | -} | ||
2353 | -``` | ||
2354 | ##### fEvtSetKpSN | 2307 | ##### fEvtSetKpSN |
2355 | - **主题**:<sapn class="yellowFill">/manage/\${baseSN}/receive</span> | 2308 | - **主题**:<sapn class="yellowFill">/manage/\${baseSN}/receive</span> |
2356 | - **功能描述**:返回写键盘SN状态 | 2309 | - **功能描述**:返回写键盘SN状态 |
@@ -2417,7 +2370,7 @@ | @@ -2417,7 +2370,7 @@ | ||
2417 | - **示例代码** | 2370 | - **示例代码** |
2418 | ```json | 2371 | ```json |
2419 | { | 2372 | { |
2420 | - "fun":"fEvtKpModel", | 2373 | + "fun":"fEvtKpInfo", |
2421 | "dataTag":"1", | 2374 | "dataTag":"1", |
2422 | "data":{ | 2375 | "data":{ |
2423 | "keySn":"2024021011", | 2376 | "keySn":"2024021011", |
@@ -4033,12 +3986,14 @@ | @@ -4033,12 +3986,14 @@ | ||
4033 | "examNo": 0, | 3986 | "examNo": 0, |
4034 | "questions": [{ | 3987 | "questions": [{ |
4035 | //题号1 到 2 共2题,单题满分10分 | 3988 | //题号1 到 2 共2题,单题满分10分 |
3989 | + "symbol":"", | ||
4036 | "max":10, | 3990 | "max":10, |
4037 | "digits":1, | 3991 | "digits":1, |
4038 | "startNo": 1, | 3992 | "startNo": 1, |
4039 | "count":2 | 3993 | "count":2 |
4040 | }, { | 3994 | }, { |
4041 | //题号3到6 共4道题,单题满分5 | 3995 | //题号3到6 共4道题,单题满分5 |
3996 | + "symbol":"", | ||
4042 | "max":5, | 3997 | "max":5, |
4043 | "digits":0, | 3998 | "digits":0, |
4044 | "startNo": 3, | 3999 | "startNo": 3, |