diff --git a/通讯协议-B200W-MQTT协议[内部].md b/通讯协议-B200W-MQTT协议[内部].md index 73a09e5..bb1e283 100644 --- a/通讯协议-B200W-MQTT协议[内部].md +++ b/通讯协议-B200W-MQTT协议[内部].md @@ -74,6 +74,9 @@ |dataTag| 数据标签，用于对应收发数据|长度不超过4，可为0-9a-zA-Z的组合| |data| 数据内容|对象或者数组，可为空| +注意：基站接收指令数据单次不超过2K长度，在指定键盘发送指令时，如果指令长度超出限制，建议将指令进行拆分，分次发送，如果是所有键盘执行的指令，可将keySns设为空数组不使用指定键盘的模式 + + ## 功能速查一览表 ### 基站管理 |功能归类|功能|API指令|指令/系统事件| @@ -100,13 +103,13 @@ ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)|| |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)| ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|| -|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| -||获取键盘休眠等级|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| +|键盘统一设置 - 键盘休眠|设置键盘休眠等级(内)|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| +||获取键盘休眠等级(内)|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| ||设置键盘暂停休眠状态(内)|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| ||停止基站快速配对|[stopBsFastPair](#stopbsfastpair)|[sEvtStateCode](#sevtstatecode)| |白名单模式 - 白名单管理|获取白名单|[getBsWhitelist](#getbswhitelist)|[fEvtBsWhitelist](#fevtbswhitelist)| -||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtBsWhitelist](#fevtbswhitelist)| +||设置白名单|[setBsWhitelist](#setbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtSetBsWhitelist](#fevtsetbswhitelist)| ||清空白名单|[clearBsWhitelist](#clearbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtBsWhitelist](#fevtbswhitelist)| ||增加白名单|[addBsWhitelist](#addbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtAddBsWhitelist](#fevtaddbswhitelist)
[fEvtBsWhitelist](#fevtbswhitelist)| ||删除白名单|[delBsWhitelist](#delbswhitelist)|[sEvtStateCode](#sevtstatecode)
[fEvtDelBsWhitelist](#fevtdelbswhitelist)
[fEvtBsWhitelist](#fevtbswhitelist)| @@ -115,6 +118,8 @@ |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| |基站维护|获取基站日志信息|[getBsLogInfo](#getbsloginfo)|[sEvtStateCode](#sevtstatecode)
[fEvtBsLogInfo](#fevtbsloginfo)(内)| +||基站软复位|[resetBsSystem](#resetbssystem)|[sEvtStateCode](#sevtstatecode)
[sEvtBsConnectState](#sevtbsconnectstate)| +||基站断电复位|[resetBsPower](#resetbspower)|[sEvtStateCode](#sevtstatecode)
[sEvtBsConnectState](#sevtbsconnectstate)| |基站升级|开启基站升级(内)|[startBsUpdate](#startbsupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtBsUpateState](#fevtbsupatestate)
[fEvtBsUpdateProgress](#fevtbsupdateprogress)| ||下载字库(内)|[downloadFontLib](#downloadfontlib)|[sEvtStateCode](#sevtstatecode)
[fEvtBsFontLibState](#fevtbsfontlibstate)
[fEvtBsFontLibProgress](#fevtbsfontlibprogress)| ### 键盘管理 @@ -417,8 +422,8 @@ |dataTag|string|-|否|数据包标识| |data|object|-|是|传送参数的对象| |+value|string|数字|是|设置的基站SN，长度为10位数字| -|+time|string|数字|是|时间，yyyyMMddHHmmss| -|+verCode|string||是|内部主题校验码，时间+固定key加密| + - **示例代码** ```Json @@ -492,8 +497,8 @@ |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| |+value|string||是|设置的基站品牌码| -|+time|string|数字|是|时间，yyyyMMddHHmmss| -|+verCode|string||是|内部主题校验码，时间+固定key加密| + - **示例代码** ```Json @@ -663,8 +668,8 @@ |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|否|传送参数的对象| |+value|string|-|否|设置的基站配对码，8位数字| -|+time|string|数字|是|时间，yyyyMMddHHmmss| -|+verCode|string||是|内部主题校验码，时间+固定key加密| + - **示例代码** ```Json @@ -952,7 +957,7 @@ ``` ##### getBsKpSleepLevel -- **主题**：/client/\${baseSN}/send +- **主题**：/manage/\${baseSN}/send - **功能描述**：获取键盘休眠时间等级 - **参数说明** @@ -970,7 +975,7 @@ ``` ##### setBsKpSleepLevel -- **主题**：/client/\${baseSN}/send +- **主题**：/manage/\${baseSN}/send - **功能描述**：设置键盘休眠时间等级 - **参数说明** @@ -994,7 +999,7 @@ ##### setBsKpPauseSleep - **主题**：/manage/\${baseSN}/send -- **功能描述**：设置键盘暂停休眠是否开启
注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电 +- **功能描述**：设置键盘暂停休眠是否开启
注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电
设置单次生效，基站拔插后复位成关闭状态 - **参数说明** |参数名|类型|限制|是否必填|说明| @@ -1040,7 +1045,7 @@ ``` ##### fEvtBsKpSleepLevel -- **主题**: /basestation/\${baseSN}/receive +- **主题**: /manage/\${baseSN}/receive - **功能描述**：返回键盘休眠时间等级 - **参数说明** @@ -1143,7 +1148,7 @@ - **示例代码** ```json { - "fun": "getBsWhitelist", + "fun":"getBsWhitelist", "dataTag":"1" } ``` @@ -1162,7 +1167,7 @@ - **示例代码** ```json { - "fun": "setBsWhitelist", + "fun":"setBsWhitelist", "dataTag":"1", "data":{ "keySns":["2024021001","2024021002","2024021003","2024021004"] @@ -1182,7 +1187,7 @@ - **示例代码** ```json { - "fun": "clearBsWhitelist", + "fun":"clearBsWhitelist", "dataTag":"1" } ``` @@ -1201,7 +1206,7 @@ - **示例代码** ```json { - "fun": "addBsWhitelist", + "fun":"addBsWhitelist", "dataTag":"1", "data":{ "keySns":["2024021001"] @@ -1223,7 +1228,7 @@ - **示例代码** ```json { - "fun": "delBsWhitelist", + "fun":"delBsWhitelist", "dataTag":"1", "data":{ "keySns":["2024021001"] @@ -1257,6 +1262,31 @@ } ``` +##### fEvtSetBsWhitelist +- **主题**：/basestation/\${baseSN}/receive +- **功能描述**：返回设置白名单状态 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|array|-|是|传送参数的对象数组| +|++keySn|string||是|键盘SN| +|++state|int||是|键盘SN的写入状态
0-写入成功
1-写入失败| + +- **示例代码** +```Json +{ + "fun":"fEvtSetBsWhitelist", + "dataTag":"1", + "data":[{ + "keySn":"2024021001", + "state":0 + }] +} +``` + ##### fEvtAddBsWhitelist - **主题**：/basestation/\${baseSN}/receive - **功能描述**：返回增加键盘状态 @@ -1481,10 +1511,49 @@ } ``` +##### resetBsSystem +- **主题**：/client/\${baseSN}/send +- **功能描述**：软复位基站（公共主题可用，但不体现在外部版本协议中） +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| + +- **示例代码** +```Json +{ + "fun":"resetBsSystem", + "dataTag":"1" +} +``` + +##### resetBsPower +- **主题**：/client/\${baseSN}/send +- **功能描述**：断电复位基站（公共主题可用，但不体现在外部版本协议中） +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| + +- **示例代码** +```Json +{ + "fun":"resetBsPower", + "dataTag":"1" +} +``` + #### 事件 ##### [sEvtStateCode](#sevtstatecode) 返回指令的接收状态 +##### [sEvtBsConnectState](#sevtbsconnectstate) +复位基站后，基站重新连接成功后上报 + ##### fEvtBsLogInfo - **主题**: /manage/\${baseSN}/receive - **功能描述**：返回基站存储的日志内容 @@ -1525,8 +1594,8 @@ |+url|string||是|待升级的固件地址，可访问的网络url| |+version|string||是|待升级的基站固件版本| |+crc|uint||是|固件CRC校验码，10进制数字| -|+time|string||是|时间，yyyyMMddHHmmss| -|+verCode|string||是|内部主题校验码，时间+固定key加密| + - **示例代码** ```Json @@ -1555,8 +1624,8 @@ |+url|string||是|待下载的字库地址，可访问的网络url| |+version|string||是|待升级的字库版本| |+crc|int||是|字库CRC校验码，10进制数字| -|+time|string||是|时间，yyyyMMddHHmmss| -|+verCode|string||是|内部主题校验码，时间+固定key加密| + - **示例代码** ```Json @@ -1934,8 +2003,8 @@ |+url|string||是|待升级的固件地址，可访问的网络url| |+version|string||是|待升级的固件版本号| |+crc|uint||是|固件CRC校验码,10进制数字| -|+time|string|数字|是|时间，yyyyMMddHHmmss| -|+verCode|string||是|内部主题校验码，时间+固定key加密| + - **示例代码** ```Json @@ -1960,18 +2029,14 @@ |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| -|+time|string|数字|是|时间，yyyyMMddHHmmss| -|+verCode|string||是|内部主题校验码，时间+固定key加密| + - **示例代码** ```Json { "fun":"stopKpFWUpdate", - "dataTag":"1", - "data":{ - "time":"", - "verCode":"" - } + "dataTag":"1" } ```