From 0f1000bec0eada9fe9f46a0f09ffe08a0c573bff Mon Sep 17 00:00:00 2001 From: liuqin Date: Mon, 9 Sep 2024 14:15:28 +0800 Subject: [PATCH] 修改键盘管理-设别设置章节的方法和事件 --- 通讯协议-B200W-MQTT协议[内部].md | 118 ++++++++++++++++++++++++++++++++++++---------------------------------------------------------------------------------- 1 file changed, 36 insertions(+), 82 deletions(-) diff --git a/通讯协议-B200W-MQTT协议[内部].md b/通讯协议-B200W-MQTT协议[内部].md index b2383d2..611272a 100644 --- a/通讯协议-B200W-MQTT协议[内部].md +++ b/通讯协议-B200W-MQTT协议[内部].md @@ -151,13 +151,12 @@ ### 键盘管理 |功能归类|功能|API指令|指令事件| |---|---|---|---| -|识别设置 - 出厂编码(内)|设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtKpSN](#fevtkpsn)| -|识别设置 - 键盘编号|获取键盘编号|[getKpID](#getkpid)|[fEvtKpID](#fevtkpid)| -|识别设置 - 键盘编号(内)|设置键盘编号(内)|[setKpID](#setkpid)|[fEvtKpID](#fevtkpid)| -|识别设置 - 键盘型号|获取键盘型号|[getKpModel](#getkpmodel)|[fEvtKpModel](#fevtkpmodel)| -|识别设置 - 键盘固件版本|获取键盘固件版本|[getKpFWVersion](#getKpfwversion)|[fEvtKpFWVersion](#fevtkpfwversion)| +|识别设置 - 出厂编码(内)|设置键盘出厂编码(内)|[setKpSN](#setkpsn)|[fEvtSetKpSN](#fevtsetkpsn)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| +|识别设置 - 键盘编号(内)|设置键盘编号(内)|[setKpID](#setkpid)|[fEvtSetKpID](#fevtsetkpid)| |识别设置 - 识别模式(内)|获取键盘识别模式(内)|[getKpIdentityMode](#getkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| ||设置键盘识别模式(内)|[setKpIdentityMode](#setkpidentitymode)|[fEvtKpIdentityMode](#fevtkpidentitymode)| +|识别设置 - 键盘信息(内)|开始获取键盘信息(内)|[startGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)
[fEvtKpInfo](#fevtkpinfo)| +||停止获取键盘信息(内)|[stopGetKpInfo](#setkpid)|[sEvtStateCode](#sevtstatecode)| |交互设置 - 用户内置状态语|设置用户内置状态语|[setKpUserStbMsg](#setkpuserstbmsg)|[fEvtKpUserStbMsg](#fevtkpuserstbmsg)| |交互设置 - 用户实时提示反馈信息|实时设置提示反馈信息|[rtSetKpUserPrompt](#rtsetkpuserprompt)|[sEvtStateCode](#sevtstatecode)
[fEvtSetKpUserPrompt](#fevtsetkpuserprompt)| |在线状态获取|开启扫描在线键盘|[startGetKpOnline](#startgetkponline)|[sEvtStateCode](#sevtstatecode)
[fEvtKpOnlineMsg](#fevtkponlinemsg)| @@ -2196,30 +2195,9 @@ } } ``` -##### getKpID -- **主题**：/client/\${baseSN}/send -- **功能描述**：获取键盘编号 -- **参数说明** -|参数名|类型|限制|是否必填|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|data|object|-|是|传送参数的对象| -|+keySn|string||是|需读取编号的键盘SN| - -- **示例代码** -```json -{ - "fun":"getKpID", - "dataTag":"1", - "data":{ - "keySn":"2024021011" - } -} -``` ##### setKpID -- **主题**：/client/\${baseSN}/send +- **主题**：/manage/\${baseSN}/send - **功能描述**：设置键盘编号 - **参数说明** @@ -2241,9 +2219,10 @@ } } ``` -##### getKpModel -- **主题**：/client/\${baseSN}/send -- **功能描述**：获取键盘型号 + +##### startGetKpInfo +- **主题**：/manage/\${baseSN}/send +- **功能描述**：开始获取键盘信息 - **参数说明** |参数名|类型|限制|是否必填|说明| @@ -2251,22 +2230,18 @@ |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| -|+keySn|string||是|需读取型号的键盘SN| - **示例代码** ```json { - "fun":"getKpModel", - "dataTag":"1", - "data":{ - "keySn":"2024021011" - } + "fun":"startGetKpInfo", + "dataTag":"1" } ``` -##### getKpFWVersion -- **主题**：/client/\${baseSN}/send -- **功能描述**：获取键盘型号 +##### stopGetKpInfo +- **主题**：/manage/\${baseSN}/send +- **功能描述**：停止获取键盘信息 - **参数说明** |参数名|类型|限制|是否必填|说明| @@ -2274,21 +2249,18 @@ |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| -|+keySn|string||是|需读取版本的键盘SN| - **示例代码** ```json { - "fun":"getKpFWVersion", - "dataTag":"1", - "data":{ - "keySn":"2024021011" - } + "fun":"stopGetKpInfo", + "dataTag":"1" } ``` + ##### getKpIdentityMode -- **主题**：/client/\${baseSN}/send +- **主题**：/manage/\${baseSN}/send - **功能描述**：获取键盘识别模式 - **参数说明** @@ -2329,8 +2301,11 @@ } ``` #### 事件 +##### [sEvtStateCode](#sevtstatecode) +发送指令后返回接收状态 + ##### fEvtKpIdentityMode -- **主题**：/basestation/\${baseSN}/receive +- **主题**：/manage/\${baseSN}/receive - **功能描述**：返回键盘识别模式 - **参数说明** @@ -2351,7 +2326,7 @@ } } ``` -##### fEvtKpSN +##### fEvtSetKpSN - **主题**：/manage/\${baseSN}/receive - **功能描述**：返回写键盘SN状态 - **参数说明** @@ -2367,7 +2342,7 @@ - **示例代码** ```json { - "fun":"fEvtKpSN", + "fun":"fEvtSetKpSN", "dataTag":"1", "data":{ "keySn":"1234567890", @@ -2375,8 +2350,8 @@ } } ``` -##### fEvtKpID -- **主题**：/basestation/\${baseSN}/receive +##### fEvtSetKpID +- **主题**：/manage/\${baseSN}/receive - **功能描述**：返回键盘编号 - **参数说明** @@ -2385,13 +2360,13 @@ |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| -|+keySn|string||是|设置键盘SN的原SN| +|+keySn|string||是|设置键盘id的键盘SN| |+keyId|int||是|键盘编号| - **示例代码** ```json { - "fun":"fEvtKpID", + "fun":"fEvtSetKpID", "dataTag":"1", "data":{ "keySn":"2024021011", @@ -2399,9 +2374,9 @@ } } ``` -##### fEvtKpModel -- **主题**：/basestation/\${baseSN}/receive -- **功能描述**：返回键盘型号 +##### fEvtKpInfo +- **主题**：/manage/\${baseSN}/receive +- **功能描述**：返回键盘信息 - **参数说明** |参数名|类型|限制|非空|说明| @@ -2409,41 +2384,20 @@ |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| -|+keySn|string||是|设置键盘SN的原SN| +|+keySn|string||是|键盘SN| +|+keyId|int||是|键盘Id| |+model|int||是|键盘型号代码| - -- **示例代码** -```json -{ - "fun":"fEvtKpModel", - "dataTag":"1", - "data":{ - "keySn":"2024021011", - "model":67 - } -} -``` - -##### fEvtKpFWVersion -- **主题**：/basestation/\${baseSN}/receive -- **功能描述**：返回键盘型号 -- **参数说明** - -|参数名|类型|限制|非空|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|data|object|-|是|传送参数的对象| -|+keySn|string||是|设置键盘SN的原SN| |+version|string||是|键盘固件版本| - **示例代码** ```json { - "fun":"fEvtKpFWVersion", + "fun":"fEvtKpModel", "dataTag":"1", "data":{ "keySn":"2024021011", + "keyId":1, + "model":67, "version":"1.0.0" } } -- libgit2 0.21.4