diff --git a/通讯协议-平台化-应用部分[内部].md b/通讯协议-平台化-应用部分[内部].md index 96ef0b5..3af5b22 100644 --- a/通讯协议-平台化-应用部分[内部].md +++ b/通讯协议-平台化-应用部分[内部].md @@ -215,8 +215,6 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ||设置键盘长距考勤状态(内)|[setBsKpRFIDState](#setbskprfidstate)|[fEvtBsKpRFIDState](#fevtbskprfidstate)| |键盘统一设置 - 键盘休眠|设置键盘休眠等级(内)|[setBsKpSleepLevel](#setbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| ||获取键盘休眠等级(内)|[getBsKpSleepLevel](#getbskpsleeplevel)|[fEvtBsKpSleepLevel](#fevtbskpsleeplevel)| -|键盘统一设置 - 键盘离线关机|设置键盘离线关机等级(内)|[setBsKpPowerOffLevel](#setbskppowerofflevel)|[fEvtBsKpPowerOffLevel](#fevtbskppowerofflevel)| -||获取键盘离线关机等级(内)|[getBsKpPowerOffLevel](#getbskppowerofflevel)|[fEvtBsKpPowerOffLevel](#fevtbskppowerofflevel)| ||设置键盘暂停休眠状态(内)|[setBsKpPauseSleep](#setbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| ||获取键盘暂停休眠状态(内)|[getBsKpPauseSleep](#getbskppausesleep)|[fEvtBsKpPauseSleep](#fevtbskppausesleep)| |配对模式 - 快速配对|启动基站快速配对|[startBsFastPair](#startbsfastpair)|[sEvtStateCode](#sevtstatecode)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| @@ -258,6 +256,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 ||停止扫描在线键盘|[stopGetKpOnline](#stopgetkponline)|[sEvtStateCode](#sevtstatecode)| ||实时获取在线键盘列表|[rtGetKpOnlineList](#rtgetkponlinelist)|[sEvtBsKpOnlineList](#sevtbskponlinelist)| |维护功能 - 遥控功能|遥控键盘休眠|[remoteKpSleep](#remotekpsleep)|[sEvtStateCode](#sevtstatecode)| +|维护功能 - 离线关机|设置键盘离线关机等级(内)|[setKpPowerOffLevel](#setkppowerofflevel)|[fEvtSetKpPowerOffLevel](#fevtsetkppowerofflevel)| |维护功能 - 键盘升级|启动键盘无线升级(内)|[startKpFWUpdate](#startkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)
[fEvtKpUpdateProgress](#fevtkpupdateprogress)
[sEvtBsKpOnlineMsg](#sevtbskponlinemsg)| ||停止键盘无线升级(内)|[stopKpFWUpdate](#stopkpfwupdate)|[sEvtStateCode](#sevtstatecode)
[fEvtKpFWUpdateState](#fevtkpfwupdatestate)| ||退出键盘静默升级(内)|[exitKpSilentUpdate](#exitkpsilentupdate)|[sEvtStateCode](#sevtstatecode)| @@ -2005,51 +2004,6 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` -##### getBsKpPowerOffLevel -- **主题**：/manage/{baseSN}/send -- **功能描述**：获取键盘离线后关机时间等级 -- **参数说明** - -|参数名|类型|限制|是否必填|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| - -- **示例代码** -```json -{ - "fun":"getBsKpPowerOffLevel", - "dataTag":"1", - "baseSn":"2024061101" -} -``` - -##### setBsKpPowerOffLevel -- **主题**：/manage/{baseSN}/send -- **功能描述**：设置键盘离线后关机时间等级 -- **参数说明** - -|参数名|类型|限制|是否必填|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| -|data|object|-|是|传送参数的对象| -|+value|string||是|设置键盘离线后关机时间等级
0-30秒
1-1分钟
2-5分钟| - -- **示例代码** -```json -{ - "fun":"setBsKpPowerOffLevel", - "dataTag":"1", - "baseSn":"2024061101", - "data":{ - "value":"1" - } -} -``` - ##### setBsKpPauseSleep - **主题**：/manage/{baseSN}/send - **功能描述**：设置键盘暂停休眠是否开启
注意：请谨慎使用本功能，务必在相关测试或功能完成后关闭，否则可能会导致键盘异常耗电
设置单次生效，基站拔插后复位成关闭状态 @@ -2221,31 +2175,6 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` -##### fEvtBsKpPowerOffLevel -- **主题**: /manage/{baseSN}/receive -- **功能描述**：返回键盘离线后关机时间等级 -- **参数说明** - -|参数名|类型|限制|非空|说明| -|---|---|---|---|---| -|fun|string|-|是|指令名称| -|dataTag|string|-|否|数据包标识,可为空字符串| -|baseSn|string||是|基站的出厂编码| -|data|object|-|是|传送参数的对象| -|+value|string||是|键盘休眠的时间等级
0-30秒
1-1分钟
2-5分钟| - -- **示例代码** -```json -{ - "fun":"fEvtBsKpPowerOffLevel", - "dataTag":"1", - "baseSn":"2024061101", - "data":{ - "value":"1" - } -} -``` - ##### fEvtBsKpPauseSleep - **主题**: /manage/{baseSN}/receive - **功能描述**：返回暂停键盘休眠开启状态 @@ -3767,6 +3696,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |++version|string||是|键盘固件版本| |++model|int||是|键盘型号| |++voltage|double||是|键盘电量（待键盘修改成百分比）| +|++offTime|int||是|键盘离线关机时间，单位秒| - **示例代码** ```json @@ -3778,12 +3708,14 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 "keySn":"1234567890", "version":"1.0.0", "model":67, - "voltage":2.8 + "voltage":2.8, + "offTime":30 },{ "keySn":"1234567891", "version":"1.0.0", "model":67, - "voltage":2.8 + "voltage":2.8, + "offTime":30 }] } ``` @@ -3815,6 +3747,33 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 } ``` +##### setKpPowerOffLevel +- **主题**：/manage/{baseSN}/send +- **功能描述**：设置键盘离线后关机时间等级 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| +|data|object|-|是|传送参数的对象| +|+keySns|array||否|需要执行指令的键盘SN数组，空数组表示所有键盘| +|+value|string||是|设置键盘离线后关机时间，10-65535秒| + +- **示例代码** +```json +{ + "fun":"setKpPowerOffLevel", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "keySns":[], + "value":"1" + } +} +``` + ##### startKpFWUpdate - **主题**：/manage/{baseSN}/send - **功能描述**:键盘升级 @@ -3913,6 +3872,44 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 注意：管理指令的接收状态需从**主题: /manage/{baseSN}/receive** 返回 +##### fEvtSetKpPowerOffLevel +- **主题**: /manage/{baseSN}/receive +- **功能描述**：返回设置键盘离线后关机时间是否成功 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| +|data|array|-|是|传送参数的对象数组| +|++keySn|string||是|设置的键盘SN| +|++state|string||是|设置的离线关机时间是否成功
0 - 成功
1 - 超时失败
2 - 参数错误| + +- **示例代码** + +```json +{ + "fun":"fEvtSetKpPowerOffLevel", + "dataTag":"1", + "baseSn":"2024061101", + "data": [ + { + "keySn": "1479824643", + "state": "0" + }, + { + "keySn": "1479824645", + "state": "0" + }, + { + "keySn": "1479824644", + "state": "1" + } + ] +} +``` + ##### fEvtKpFWUpdateState - **主题**: /manage/{baseSN}/receive - **功能描述**：返回键盘升级状态 @@ -5044,7 +5041,7 @@ WebSocket方式应用与SDK建立长连接后，通过WebSocket接口发送接 |+keySns|array||是|指定的键盘SN数组，空数组表示全部在线键盘| |+mode|int||是|录音模式
0-按键录音(默认值)
1-自动录音| |+submitTimes|int||是|允许提交次数,0-255， 0 - 不限次数| -|+timeLimit|int||否|限制的录音时长，0-255秒, 0-不限时长| +|+timeLimit|int||否|限制的录音时长，0-255秒, 0 - 不限时长| |+format|int||否|录音格式
0-录音文件
1-实时流| |+audioFormat|int||否|音频格式
0-pcm
1-mp3(默认值1)
2-wav
3-speex| |+tip|string||否|提示的标题，长度不超过16字符|