增加同步签到相关内容

刘琴
1 parent 2448f2b2
Showing 1 changed file with 108 additions and 37 deletions
通讯协议-B200W-MQTT协议[内部].md
@@ -141,6 +141,8 @@
 ### 签到
 |功能归类|功能|API指令|指令事件|
 |---|---|---|---|
+|同步签到|启动同步签到|[startKpSignIn](#startkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)|
+||停止同步签到|[stopKpSignIn](#stopkpsignin)|[sEvtStateCode](#sevtstatecode)|
 |随时签到|启动随时签到|[rtStartKpSignIn](#rtstartkpsignin)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpSignIn](#fevtkpsignin)|
 ||停止随时签到|[rtStopKpSignIn](#rtstopkpsignin)|[sEvtStateCode](#sevtstatecode)|
 ||实时PIN签到授权|[rtSetKpLoginAllowed](#rtsetkploginallowed)|[sEvtStateCode](#sevtstatecode)<br>[fEvtKpLoginAllowed](#fevtkploginallowed)|
@@ -1105,7 +1107,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "startBsFastPair",
+  "fun":"startBsFastPair",
   "dataTag":"1"
 }
 ```
@@ -1122,7 +1124,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "stopBsFastPair",
+  "fun":"stopBsFastPair",
   "dataTag":"1"
 }
 ```
@@ -1800,7 +1802,7 @@
 ```json
 //分别提示
 {
-  "fun": "rtSetKpUserPrompt",
+  "fun":"rtSetKpUserPrompt",
   "dataTag":"1",
   "data": [
     {
@@ -1815,7 +1817,7 @@
 }
 //统一提示
 {
-  "fun": "rtSetKpUserPrompt",
+  "fun":"rtSetKpUserPrompt",
   "dataTag":"1",
   "data": [
     {
@@ -1865,7 +1867,7 @@
 |++state|string||是|设置的提示语是否成功<br>0 - 成功<br>1 - 失败|
 ```json
 {
-  "fun": "fEvtSetKpUserPrompt",
+  "fun":"fEvtSetKpUserPrompt",
   "dataTag":"1",
   "data": [
     {
@@ -1898,7 +1900,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "startGetKpOnline",
+  "fun":"startGetKpOnline",
   "dataTag":"1"
 }
 ```
@@ -1916,7 +1918,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "stopGetKpOnline",
+  "fun":"stopGetKpOnline",
   "dataTag":"1"
 }
 ```
@@ -2120,7 +2122,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "rtSetKpBindingInfo",
+  "fun":"rtSetKpBindingInfo",
   "dataTag":"1",
   "data": [
     {
@@ -2150,7 +2152,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "clearKpBindingInfo",
+  "fun":"clearKpBindingInfo",
   "dataTag":"1",
   "data": {
     "keySns":["1479824643","1479824644","1479824645"]
@@ -2177,7 +2179,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtKpBindingInfo",
+  "fun":"fEvtKpBindingInfo",
   "dataTag":"1",
   "data": [
     {
@@ -2206,7 +2208,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtClearKpBindingInfo",
+  "fun":"fEvtClearKpBindingInfo",
   "dataTag":"1",
   "data": {
     "state": "0"
@@ -2214,6 +2216,75 @@
 }
 ```
 ## 签到
+### 同步签到
+#### 方法
+##### startKpSignIn
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：启动同步签到
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+|data|object|-|是|传递参数的对象|
+|+mode|int|-|是|签到模式<br>1-按键签到，可指定按键<br>2-PIN码签到，可指定PIN码长度<br>3-指纹签到(<font color="red">暂不支持</font>)|
+|+allowModify |int|-|是 | 修改模式 <br> 0-不可修改 <br>1-可以修改(默认值)|
+|+pinLen |int|-|是| 可输入pin码的最大长度 1≤N≤14 |
+|+keyValue |int|-|是 | 指定按键键值 <br> 0: 未指定(OK键签到) <br>1-9: 按键1-9 <br> 10: 按键0 <br> 11: 上键  <br> 12: 下键 <br> 13: OK键  <br> 14: ESC键  <br> 15: Menu键 |
+|+tipTitle |string|-|否| 提示标题,长度最多不超过16个字节|
+
+- **示例代码**
+```Json
+//按键签到
+{
+  "fun":"startKpSignIn",
+  "dataTag":"1",
+  "data":{
+    "mode":1,
+    "allowModify":1,
+    "keyValue":5,
+    "tip":"请按5键签到"
+  }
+}
+
+//pin签到
+{
+  "fun":"startKpSignIn",
+  "dataTag":"1",
+  "data":{
+    "mode":2,
+    "allowModify":1,
+    "pinLen":6,
+    "tip":"请输入PIN码签到"
+  }
+}
+```
+
+##### stopKpSignIn
+- **主题**：/client/\${baseSN}/send
+- **功能描述**：停止同步签到
+- **参数说明**
+
+|参数名|类型|限制|是否必填|说明|
+|---|---|---|---|---|
+|fun|string|-|是|指令名称|
+|dataTag|string|-|否|数据包标识,可为空字符串|
+
+- **示例代码**
+```Json
+{
+  "fun":"stopKpSignIn",
+  "dataTag":"1"
+}
+```
+#### 事件
+##### [sEvtStateCode](#sevtstatecode)
+发送指令后返回接收状态
+
+##### [fEvtKpSignIn](#fevtkpsignin)
+返回键盘提交的签到数据
+
 ### 随时签到
 #### 方法
 ##### rtStartKpSignIn
@@ -2231,7 +2302,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "rtStartKpSignIn",
+  "fun":"rtStartKpSignIn",
   "dataTag":"1",
   "data":{
     "mode":2
@@ -2240,7 +2311,7 @@
 ```
 ##### rtStopKpSignIn
 - **主题**：/client/\${baseSN}/send
-- **功能描述**：停止签到绑定
+- **功能描述**：停止随时签到绑定
 - **参数说明**
 |参数名|类型|限制|是否必填|说明|
@@ -2251,7 +2322,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "rtStopKpSignIn",
+  "fun":"rtStopKpSignIn",
   "dataTag":"1"
 }
 ```
@@ -2271,7 +2342,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "rtSetKpLoginAllowed",
+  "fun":"rtSetKpLoginAllowed",
   "dataTag":"1",
   "data":{
     "keySn":"1479824643",
@@ -2300,7 +2371,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtKpSignIn",
+  "fun":"fEvtKpSignIn",
   "dataTag":"1",
   "data": [{
       "keySn": "1234567890",
@@ -2331,7 +2402,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtKpLoginAllowed",
+  "fun":"fEvtKpLoginAllowed",
   "dataTag":"1",
   "data": {
       "keySn":"1479824643",
@@ -2363,7 +2434,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "startQATrueFalse",
+  "fun":"startQATrueFalse",
   "dataTag":"1",
   "data":{
     "keySns":[],
@@ -2390,7 +2461,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "stopQATrueFalse",
+  "fun":"stopQATrueFalse",
   "dataTag":"1"
 }
 ```
@@ -2415,7 +2486,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtQATrueFalse",
+  "fun":"fEvtQATrueFalse",
   "dataTag":"1",
   "data": [{
       "keySn": "1234567890",
@@ -2451,7 +2522,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "startQAChoice",
+  "fun":"startQAChoice",
   "dataTag":"1",
   "data":{
     "keySns":[],
@@ -2481,7 +2552,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "stopQAChoice",
+  "fun":"stopQAChoice",
   "dataTag":"1"
 }
 ```
@@ -2506,7 +2577,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtQAChoice",
+  "fun":"fEvtQAChoice",
   "dataTag":"1",
   "data": [{
       "keySn": "1234567890",
@@ -2540,7 +2611,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "startQANum",
+  "fun":"startQANum",
   "dataTag":"1",
   "data":{
     "keySns":[],
@@ -2569,7 +2640,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "stopQANum",
+  "fun":"stopQANum",
   "dataTag":"1"
 }
 ```
@@ -2594,7 +2665,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtQANum",
+  "fun":"fEvtQANum",
   "dataTag":"1",
   "data": [{
       "keySn": "1234567890",
@@ -2625,7 +2696,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "startQAQuicker",
+  "fun":"startQAQuicker",
   "dataTag":"1",
   "data":{
     "keySns":[],
@@ -2651,7 +2722,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "stopQAQuicker",
+  "fun":"stopQAQuicker",
   "dataTag":"1"
 }
 ```
@@ -2676,7 +2747,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtQAQuicker",
+  "fun":"fEvtQAQuicker",
   "dataTag":"1",
   "data": [{
       "keySn": "1234567890",
@@ -2713,7 +2784,7 @@
 ```json
 //自定义题号
 {
-  "fun": "startKpExam",
+  "fun":"startKpExam",
   "dataTag":"1",
   "data":{
     "mode": 0,
@@ -2752,7 +2823,7 @@
 //显示Q开头
 {
-  "fun": "startKpExam",
+  "fun":"startKpExam",
   "dataTag":"1",
   "data":{
     "mode": 1,
@@ -2772,7 +2843,7 @@
 //显示题开头
 {
-  "fun": "startKpExam",
+  "fun":"startKpExam",
   "dataTag":"1",
   "data":{
     "mode": 2,
@@ -2803,7 +2874,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "stopKpExam",
+  "fun":"stopKpExam",
   "dataTag":"1"
 }
 ```
@@ -2822,7 +2893,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "rtGetKpExamData",
+  "fun":"rtGetKpExamData",
   "dataTag":"1",
   "data":{
     "keySns":["1234567890","1234567891"]
@@ -2844,7 +2915,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "rtKpAllowEdited",
+  "fun":"rtKpAllowEdited",
   "dataTag":"1",
   "data":{
     "keySns":["1234567890","1234567891"]
@@ -2872,7 +2943,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtKpExam",
+  "fun":"fEvtKpExam",
   "dataTag":"1",
   "data": [{
       "keySn": "1234567890",
@@ -2904,7 +2975,7 @@
 - **示例代码**
 ```json
 {
-  "fun": "fEvtFinalSubmit",
+  "fun":"fEvtFinalSubmit",
   "dataTag":"1",
   "data": [{
       "keySn": "1234567890",