diff --git a/通讯协议-B200W-MQTT协议[内部].md b/通讯协议-B200W-MQTT协议[内部].md index 930bc83..73a09e5 100644 --- a/通讯协议-B200W-MQTT协议[内部].md +++ b/通讯协议-B200W-MQTT协议[内部].md @@ -100,7 +100,9 @@ ||设置基站登录名称|[setBsSSID](#setbsssid)|[fEvtBsSSID](#fevtbsssid)|| |键盘统一设置 - 键盘语言|获取键盘语言|[getBsKpLanguage](#getbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)| ||设置键盘语言|[setBsKpLanguage](#setbskplanguage)|[fEvtBsKpLanguage](#fevtbskplanguage)|| -|键盘统一设置 - 暂停休眠|设置键盘暂停休眠状态|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| +|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[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)| @@ -949,8 +951,49 @@ } ``` -##### setBsKpPauseSleep +##### getBsKpSleepLevel - **主题**：/client/\${baseSN}/send +- **功能描述**：获取键盘休眠时间等级 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| + +- **示例代码** +```Json +{ + "fun":"getBsKpSleepLevel", + "dataTag":"1" +} +``` + +##### setBsKpSleepLevel +- **主题**：/client/\${baseSN}/send +- **功能描述**：设置键盘休眠时间等级 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| +|+value|string||是|设置键盘休眠的时间等级
0-30秒
1-2分钟
2-10分钟
3-45分钟| + +- **示例代码** +```Json +{ + "fun":"setBsKpSleepLevel", + "dataTag":"1", + "data":{ + "value":"1" + } +} +``` + +##### setBsKpPauseSleep +- **主题**：/manage/\${baseSN}/send - **功能描述**：设置键盘暂停休眠是否开启
注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电 - **参数说明** @@ -983,7 +1026,7 @@ |fun|string|-|是|指令名称| |dataTag|string|-|否|数据包标识,可为空字符串| |data|object|-|是|传送参数的对象| -|+value|string||是|设置键盘显示的语言
1-简体中文
2-英文| +|+value|string||是|键盘显示的语言
1-简体中文
2-英文| - **示例代码** ```Json @@ -996,8 +1039,31 @@ } ``` -##### fEvtBsKpPauseSleep +##### fEvtBsKpSleepLevel - **主题**: /basestation/\${baseSN}/receive +- **功能描述**：返回键盘休眠时间等级 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| +|+value|string||是|键盘休眠的时间等级
0-30秒
1-2分钟
2-10分钟
3-45分钟| + +- **示例代码** +```Json +{ + "fun":"fEvtBsKpSleepLevel", + "dataTag":"1", + "data":{ + "value":"1" + } +} +``` + +##### fEvtBsKpPauseSleep +- **主题**: /manage/\${baseSN}/receive - **功能描述**：返回暂停键盘休眠开启状态 - **参数说明** diff --git a/通讯协议-平台化-应用部分.md b/通讯协议-平台化-应用部分.md index 557d0ad..a6a2f02 100644 --- a/通讯协议-平台化-应用部分.md +++ b/通讯协议-平台化-应用部分.md @@ -153,7 +153,9 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 ||设置Beep工作状态|[setBsKpBeepMode](#setbskpbeepmode)|[fEvtBsKpBeepMode](#fevtbskpbeepmode)| |键盘统一设置 - 长距考勤|获取键盘长距考勤状态|[getBsKpRFIDState](#getbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| ||设置键盘长距考勤状态|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| -|键盘统一设置 - 暂停休眠|设置键盘暂停休眠状态|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| +|键盘统一设置 - 键盘休眠|设置键盘休眠等级|[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)| @@ -1575,6 +1577,49 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + + +##### getBsKpSleepLevel +- **主题**：/client/\${baseSN}/send +- **功能描述**：获取键盘休眠时间等级 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| + +- **示例代码** +```Json +{ + "fun":"getBsKpSleepLevel", + "dataTag":"1" +} +``` + +##### setBsKpSleepLevel +- **主题**：/client/\${baseSN}/send +- **功能描述**：设置键盘休眠时间等级 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| +|+value|string||是|设置键盘休眠的时间等级
0-30秒
1-2分钟
2-10分钟
3-45分钟| + +- **示例代码** +```Json +{ + "fun":"setBsKpSleepLevel", + "dataTag":"1", + "data":{ + "value":"1" + } +} +``` + ##### setBsKpPauseSleep - **主题**：/client/\${baseSN}/send - **功能描述**：设置键盘暂停休眠是否开启
注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电 @@ -1690,6 +1735,30 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 } } ``` + +##### fEvtBsKpSleepLevel +- **主题**: /basestation/\${baseSN}/receive +- **功能描述**：返回键盘休眠时间等级 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|data|object|-|是|传送参数的对象| +|+value|string||是|键盘休眠的时间等级
0-30秒
1-2分钟
2-10分钟
3-45分钟| + +- **示例代码** +```Json +{ + "fun":"fEvtBsKpSleepLevel", + "dataTag":"1", + "data":{ + "value":"1" + } +} +``` + ##### fEvtBsKpPauseSleep - **主题**: /basestation/\${baseSN}/receive - **功能描述**：返回暂停键盘休眠开启状态 @@ -2917,7 +2986,6 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 |+version|string||是|键盘固件版本| |+model|int||是|键盘型号| |+voltage|double||是|键盘电量（待键盘修改成百分比）| -|+isWeak|int||是|是否弱电， 0-正常，1-弱电（待键盘修改上报弱电状态）| - **示例代码** ```Json @@ -2928,8 +2996,7 @@ WebSocket方式应用与SDK或基站建立长连接后，通过WebSocket接口 "keySn":"1234567890", "version":"1.0.0", "model":67, - "voltage":2.8, - "isWeak":0 + "voltage":2.8 } } ```