李外 / Protocol

Commit 62d2ef20cb71cecac206c588c5efd6cb138a38f0

Authored by DMchen
1 parent 3764da68

1.整理部分SDK_DLL部分[内部] 接口，临时备份。

Inline Side-by-side
Showing 1 changed file with 867 additions and 1 deletions
通讯协议-SDK_DLL部分[内部].md
  View file @62d2ef2
... ... @@ -68,8 +68,769 @@ Ver5.1.1
68 68  
69 69 # 编程流程说明
70 70  
  71 +# 回调函数部分
  72 +## 基站事件的回调
  73 +
  74 +| **参数名称** | **参数说明** | **范围** | **备注** |
  75 +| --- | --- | --- | --- |
  76 +|UCHAR iBaseID|基站ID|0~32||
  77 +|int mode|回调反馈数据模式|||
  78 +|const char* sInfo|回调反馈数据|根据模式解析数据||
  79 +
  80 +回调接口代码：
  81 +```C++
  82 +typedef void(*HDParamCallBack)(int iBaseID, int mode, const char* sInfo);// 基站事件回调
  83 +```
  84 +设置回调代码：
  85 +```C++
  86 +extern"C" __declspec(dllexport) void SetHDParamCallBack(HDParamCallBack cb); //设置基站事件回调
  87 +```
  88 +
  89 +## 投票事件回调
  90 +
  91 +| **参数名称** | **参数说明** | **范围** | **备注** |
  92 +| --- | --- | --- | --- |
  93 +|UCHAR iBaseID|基站ID|0~32||
  94 +|int mode|回调反馈数据模式|||
  95 +|const char* sInfo|回调反馈数据|根据模式解析数据||
  96 +
  97 +回调接口代码：
  98 +```C++
  99 +typedef void(*VoteEventCallBack)(int iBaseID, int mode, const char* sInfo);// 投票事件回调
  100 +```
  101 +设置回调代码：
  102 +```C++
  103 +extern"C" __declspec(dllexport) void SetVoteEventCallBack(VoteEventCallBack cb); //设置投票事件回调
  104 +```
  105 +
  106 +## 键盘事件回调
  107 +
  108 +| **参数名称** | **参数说明** | **范围** | **备注** |
  109 +| --- | --- | --- | --- |
  110 +|UCHAR iBaseID|基站ID|0~32||
  111 +|unsigned long long keySn|键盘SN|||
  112 +|float Time|反馈时间|||
  113 +|int mode|回调反馈数据模式|||
  114 +|int RxMode|预留|||
  115 +|const char* sInfo|回调反馈数据|根据模式解析数据||
  116 +
  117 +回调接口代码：
  118 +```C++
  119 +typedef void(*KeyEventCallBack)(int iBaseID, unsigned long long keySn, float Time, int mode, int RxMode, const char* sInfo);// 键盘事件回调
  120 +```
  121 +设置回调代码：
  122 +```C++
  123 +extern"C" __declspec(dllexport) void SetKeyEventCallBack(KeyEventCallBack cb); //设置键盘事件回调回调
  124 +```
  125 +
  126 +## 语音事件回调
  127 +
  128 +| **参数名称** | **参数说明** | **范围** | **备注** |
  129 +| --- | --- | --- | --- |
  130 +|UCHAR iBaseID|基站ID|0~32||
  131 +|unsigned long long keySn|键盘SN|||
  132 +|float Time|反馈时间|||
  133 +|int mode|回调反馈数据模式|||
  134 +|USHORT voiceId|语音按键ID|||
  135 +|USHORT dataIndex|语音数据包ID|||
  136 +|const char* data|回调反馈数据|根据模式解析数据||
  137 +|USHORT dataIndex|语音数据包ID|||
  138 +|int len|语音数据长度|||
  139 +|int sampleRate| |||
  140 +|int bitsPerSample| |||
  141 +|int channel| |||
  142 +|int recFlag| |||
  143 +
  144 +回调接口代码：
  145 +```C++
  146 +typedef void(*VoiceStreamEventCallBack)(int iBaseID, ULONG keySn, int mode, USHORT voiceId, USHORT dataIndex, const char* data, int len, int sampleRate, int bitsPerSample, int channel, int recFlag);//
  147 +```
  148 +设置回调代码：
  149 +```C++
  150 +extern"C" __declspec(dllexport) void SetVoiceStreamEventCallBack(VoiceStreamEventCallBack); //设置语音数据回调函数
  151 +```
  152 +
71 153 # 基站参数部分
72   -##键盘关机设置
  154 +## 复位基站
  155 +函数名称：resetBase
  156 +参数说明：
  157 +
  158 +| **参数名称** | **参数说明** | **范围** | **备注** |
  159 +| --- | --- | --- | --- |
  160 +|UCHAR iBaseID|基站ID|0~32||
  161 +
  162 +接口代码：
  163 +```C++
  164 +extern"C" __declspec(dllexport) bool resetBase(UCHAR iBaseID);
  165 +```
  166 +
  167 +## 获取SDK Ver
  168 +函数名称：GetSDKVer
  169 +返回参数：字符串
  170 +
  171 +接口代码：
  172 +```C++
  173 +extern"C" __declspec(dllexport) char* GetSDKVer();
  174 +```
  175 +
  176 +## 退出线程释放资源
  177 +函数名称：SetThread_Exit
  178 +
  179 +接口代码：
  180 +```C++
  181 +extern"C" __declspec(dllexport) void SetThread_Exit(void); //退出线程释放资源
  182 +```
  183 +# 投票业务部分
  184 +## 设置空闲模式功能[广播]
  185 +函数名称：EndFreeEvent
  186 +功能：设置空闲模式功能[广播]
  187 +说明：把SDK管理的所有基站的在线键盘设置为空闲模式
  188 +
  189 +接口代码：
  190 +```C++
  191 +extern"C" __declspec(dllexport) bool EndFreeEvent(void); //空闲模式功能
  192 +```
  193 +
  194 +## 带参数进入空闲模式
  195 +函数名称：ExitEvent
  196 +功能：退出当前模式功能[广播]
  197 +说明：把SDK管理的所有基站的在线键盘设置为空闲模式，并在回调 函数中说明是什么模式切换到空闲模式
  198 +
  199 +| **参数名称** | **参数说明** | **范围** | **备注** |
  200 +| --- | --- | --- | --- |
  201 +|int mode_ID|用户提供的当前需要的模式||websocket情况下使用|
  202 +
  203 +接口代码：
  204 +```C++
  205 +extern"C" __declspec(dllexport) bool ExitEvent(int mode_ID); //带参数进入空闲模式功能
  206 +```
  207 +## 签到功能[广播]
  208 +函数名称：Start_Sign_in_Event
  209 +功能：签到功能[广播]
  210 +说明：把SDK管理的所有基站的在线键盘设置为签到功能模式
  211 +
  212 +| **参数名称** | **参数说明** | **范围** | **备注** |
  213 +| --- | --- | --- | --- |
  214 +|int Moed1|签到模式| 1:指定键签到 <br> 2:PIN码签到(默认值)||
  215 +|int Moed2|修改模式|0:不可修改 <br>1:可以修改(默认值)||
  216 +|int Moed3|迫选模式|0:(默认值）||
  217 +|int Moed4|选项数目|10:(默认值）||
  218 +|int Moed5|可选项数|1≤N≤14 (指定位数才需要设置)||
  219 +|int KeyValue|指定按键键值|0:未指定[OK键签到] <br>1:1 <br>2:2 <br> 3:3 <br> 4:4 <br> 5:5 <br> 6:6 <br> 7:7 <br> 8:8 <br> 9:9 <br> 10:0 <br> 11:上键 <br> 12:下键 <br> 13:OK <br> 14:ESC <br> 15: Menu ||
  220 +
  221 +接口代码：
  222 +```C++
  223 +extern"C" __declspec(dllexport) bool Start_Sign_in_Event(
  224 + int Moed1 = 1,
  225 + int Moed2 = 0,
  226 + int Moed3 = 0,
  227 + int Moed4 = 0,
  228 + int Moed5 = 0,
  229 + int KeyValue=0); //开始签到功能
  230 +```
  231 +
  232 +## 签到功能[指定键盘SN]
  233 +函数名称：Start_Sign_in_Event_SN
  234 +功能：签到功能[指定键盘SN]
  235 +说明：把SDK管理的指定在线键盘设置为签到功能模式
  236 +
  237 +| **参数名称** | **参数说明** | **范围** | **备注** |
  238 +| --- | --- | --- | --- |
  239 +|UCHAR iBaseID|基站ID|0~32||
  240 +|ULONG KeySN|指定键盘SN|||
  241 +|int Moed1|签到模式| 1:指定键签到 <br> 2:PIN码签到(默认值)||
  242 +|int Moed2|修改模式|0:不可修改 <br>1:可以修改(默认值)||
  243 +|int Moed3|迫选模式|0:(默认值）||
  244 +|int Moed4|选项数目|10:(默认值）||
  245 +|int Moed5|可选项数|1≤N≤14 (指定位数才需要设置)||
  246 +|int KeyValue|指定按键键值|0:未指定[OK键签到] <br>1:1 <br>2:2 <br> 3:3 <br> 4:4 <br> 5:5 <br> 6:6 <br> 7:7 <br> 8:8 <br> 9:9 <br> 10:0 <br> 11:上键 <br> 12:下键 <br> 13:OK <br> 14:ESC <br> 15: Menu ||
  247 +|UCHAR Txt_Len|提示标题长度|1~16字节||
  248 +|const char* Txt|提示标题|字符串||
  249 +
  250 +接口代码：
  251 +```C++
  252 +extern"C" __declspec(dllexport) bool Start_Sign_in_Event_SN(
  253 + UCHAR iBaseID,
  254 + ULONG KeySN,
  255 + int Moed1,
  256 + int Moed2,
  257 + int Moed3,
  258 + int Moed4,
  259 + int Moed5,
  260 + int KeyValue,
  261 + UCHAR Txt_Len,
  262 + const char* Txt); //开始签到功能
  263 +```
  264 +
  265 +## 数字题功能[广播]
  266 +函数名称：Start_Number_Event
  267 +功能：数字题功能[广播]
  268 +说明：把SDK管理的所有基站的在线键盘设置为数字功能模式
  269 +
  270 +| **参数名称** | **参数说明** | **范围** | **备注** |
  271 +|---|---|---|---|
  272 +|secrecyMode|保密模式|0:不保密(默认值)<br>1:保密||
  273 +|modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
  274 +|aswOption|按键模式|0:无规则 （S6最多16位，T2最多14位）<br>1:预留<br>2:预留<br>3:带小数位上下限（T2不支持）|
  275 +|digits|小数位数|0:没有小数点<br>1:一位小数点<br>2:二位小数点|
  276 +|numMin|下限|aswOption=3<br>digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  277 +|numMax|上限|aswOption=3<br>digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  278 +
  279 +接口代码：
  280 +```C++
  281 +extern"C" __declspec(dllexport) bool Start_Number_Event(
  282 + int Moed1 = 1,
  283 + int Moed2 = 0,
  284 + int Moed3 = 0,
  285 + int digits = 0,
  286 + USHORT numMax = 0,
  287 + USHORT numMin = 0); //
  288 +```
  289 +
  290 +## 数字题功能[指定键盘SN]
  291 +函数名称：Start_Number_Event_SN
  292 +功能：数字题功能[指定键盘SN]
  293 +说明：把SDK管理的指定在线键盘设置为数字题功能模式
  294 +
  295 +| **参数名称** | **参数说明** | **范围** | **备注** |
  296 +| --- | --- | --- | --- |
  297 +|UCHAR iBaseID|基站ID|0~32||
  298 +|ULONG KeySN|指定键盘SN|||
  299 +|secrecyMode|保密模式|0:不保密(默认值)<br>1:保密||
  300 +|modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
  301 +|aswOption|按键模式|0:无规则 （S6最多16位，T2最多14位）<br>1:预留<br>2:预留<br>3:带小数位上下限（T2不支持）|
  302 +|digits|小数位数|0:没有小数点<br>1:一位小数点<br>2:二位小数点|
  303 +|numMin|下限|aswOption=3<br>digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  304 +|numMax|上限|aswOption=3<br>digits=0 范围：0~65535 <br> digits=1 范围：0~6553 <br> digits=2 范围：0~655|
  305 +|UCHAR Txt_Len|提示标题长度|1~16字节||
  306 +|Txt|提示标题|字符串，长度最多不超过16个字节|
  307 +
  308 +接口代码：
  309 +```C++
  310 +extern"C" __declspec(dllexport) bool Start_Number_Event_SN(
  311 + UCHAR iBaseID,
  312 + ULONG KeySN,
  313 + int Moed1,
  314 + int Moed2,
  315 + int Moed3,
  316 + int digits,
  317 + USHORT numMax,
  318 + USHORT numMin,
  319 + UCHAR Txt_Len,
  320 + const char* Txt); //
  321 +```
  322 +
  323 +## 判断题功能[广播]
  324 +函数名称：Start_TrueFalse_Event
  325 +功能：判断题功能[广播]
  326 +说明：把SDK管理的所有基站的在线键盘设置为判断题功能模式
  327 +
  328 +| **参数名称** | **参数说明** | **范围** | **备注** |
  329 +|---|---|---|---|
  330 +| optionsMode | 选项类别 | 1:True/False 对/错 </br>2:Yes/No 是/否</br> 3:√/×|
  331 +| secrecyMode | 保密模式 | 0:不保密(默认值) </br> 1:保密|
  332 +| modifyMode | 修改模式 | 0:不可修改</br>1:可以修改(默认值)|
  333 +
  334 +
  335 +接口代码：
  336 +```C++
  337 +extern"C" __declspec(dllexport) bool Start_TrueFalse_Event(
  338 + int Moed1 = 1,
  339 + int Moed2 = 0,
  340 + int Moed3 = 0);
  341 +```
  342 +
  343 +## 判断题功能[指定键盘SN]
  344 +函数名称：Start_TrueFalse_Event_SN
  345 +功能：判断题功能[指定键盘SN]
  346 +说明：把SDK管理的指定在线键盘设置为判断题功能模式
  347 +
  348 +| **参数名称** | **参数说明** | **范围** | **备注** |
  349 +| --- | --- | --- | --- |
  350 +|UCHAR iBaseID|基站ID|0~32||
  351 +|ULONG KeySN|指定键盘SN|||
  352 +| optionsMode | 选项类别 | 1:True/False 对/错 </br>2:Yes/No 是/否</br> 3:√/×|
  353 +| secrecyMode | 保密模式 | 0:不保密(默认值) </br> 1:保密|
  354 +| modifyMode | 修改模式 | 0:不可修改</br>1:可以修改(默认值)|
  355 +|UCHAR Txt_Len|提示标题长度|1~16字节||
  356 +|Txt|提示标题|字符串，长度最多不超过16个字节|
  357 +
  358 +接口代码：
  359 +```C++
  360 +extern"C" __declspec(dllexport) bool T2_Start_TrueFalse_Event(
  361 + UCHAR iBaseID,
  362 + ULONG KeySN,
  363 + int Moed1,
  364 + int Moed2,
  365 + int Moed3,
  366 + UCHAR Txt_Len,
  367 + const char* Txt); //
  368 +```
  369 +
  370 +## 选择题功能[广播]
  371 +函数名称：Start_TrueFalse_Event
  372 +功能：选择题功能[广播]
  373 +说明：把SDK管理的所有基站的在线键盘设置为选择题功能模式
  374 +
  375 +| **参数名称** | **参数说明** | **范围** | **备注** |
  376 +|---|---|---|---|
  377 +|optionsMode|选项类别|1:显示字母(默认值) </br>2:显示数字 |
  378 +|secrecyMode|保密模式|0:不保密(默认值)</br>1:保密 |
  379 +|modifyMode|修改模式|0:不可修改 </br>1:可以修改(默认值) |
  380 +|lessMode|迫选模式| 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
  381 +| options|选项数目|1≤M≤10(默认值4)|
  382 +| optionalN|可选项数|1≤N≤M(默认值1)|
  383 +
  384 +
  385 +接口代码：
  386 +```C++
  387 +extern"C" __declspec(dllexport) bool Start_Choice_Event(
  388 + int Moed1 = 1,
  389 + int Moed2 = 0,
  390 + int Moed3 = 0,
  391 + int Moed4 = 0,
  392 + int Moed5 = 0,
  393 + int Moed6 = 0);
  394 +```
  395 +
  396 +## 选择题功能[指定键盘SN]
  397 +函数名称：Start_Choice_Event_SN
  398 +功能：选择题功能[指定键盘SN]
  399 +说明：把SDK管理的指定在线键盘设置为选择题功能模式
  400 +
  401 +| **参数名称** | **参数说明** | **范围** | **备注** |
  402 +| --- | --- | --- | --- |
  403 +|UCHAR iBaseID|基站ID|0~32||
  404 +|ULONG KeySN|指定键盘SN|||
  405 +|optionsMode|选项类别|1:显示字母(默认值) </br>2:显示数字 |
  406 +|secrecyMode|保密模式|0:不保密(默认值)</br>1:保密 |
  407 +|modifyMode|修改模式|0:不可修改 </br>1:可以修改(默认值) |
  408 +|lessMode|迫选模式| 0:可缺选(默认值) </br>1:不可缺选</br>2:允许重复输入</br>3:允许重复输入且不可缺选 |
  409 +| options|选项数目|1≤M≤10(默认值4)|
  410 +| optionalN|可选项数|1≤N≤M(默认值1)|
  411 +|UCHAR Txt_Len|提示标题长度|1~16字节||
  412 +|Txt|提示标题|字符串，长度最多不超过16个字节|
  413 +
  414 +接口代码：
  415 +```C++
  416 +extern"C" __declspec(dllexport) bool Start_Choice_Event_SN(
  417 + UCHAR iBaseID,
  418 + ULONG KeySN,
  419 + int Moed1,
  420 + int Moed2,
  421 + int Moed3,
  422 + int Moed4,
  423 + int Moed5,
  424 + int Moed6,
  425 + UCHAR Txt_Len,
  426 + const char* Txt);
  427 +```
  428 +
  429 +## 语音题功能[广播]
  430 +函数名称：Start_Voice_Event
  431 +功能：语音题功能[广播]
  432 +说明：把SDK管理的所有基站的在线键盘设置为语音题功能模式
  433 +
  434 +| **参数名称** | **参数说明** | **范围** | **备注** |
  435 +|---|---|---|---|
  436 +|recordingMode|录音模式|0:按键录音(默认值)|
  437 +|submitTimes|提交次数|0 (0：不限制, 默认值0)|
  438 +|recordingTimeLimit|预留|0|
  439 +|recordingFormat|预留|0(默认值0)|
  440 +|recordAudioFormat|音频格式|0:mp3(默认值)<br>1:实时流|
  441 +
  442 +
  443 +接口代码：
  444 +```C++
  445 +extern"C" __declspec(dllexport) bool Start_Voice_Event(
  446 + int Moed1,
  447 + int Time,
  448 + int Num,
  449 + int Alert,
  450 + int OutMode);
  451 +```
  452 +
  453 +## 语音题功能[指定键盘SN]
  454 +函数名称：Start_Voice_Event_SN
  455 +功能：语音题功能[指定键盘SN]
  456 +说明：把SDK管理的指定在线键盘设置为语音题功能模式
  457 +
  458 +| **参数名称** | **参数说明** | **范围** | **备注** |
  459 +| --- | --- | --- | --- |
  460 +|UCHAR iBaseID|基站ID|0~32||
  461 +|ULONG KeySN|指定键盘SN|||
  462 +|recordingMode|录音模式|0:按键录音(默认值)|
  463 +|submitTimes|提交次数|0 (0：不限制, 默认值0)|
  464 +|recordingTimeLimit|预留|0|
  465 +|recordingFormat|预留|0(默认值0)|
  466 +|recordAudioFormat|音频格式|0:mp3(默认值)<br>1:实时流|
  467 +|UCHAR Txt_Len|提示标题长度|1~16字节||
  468 +|Txt|提示标题|字符串，长度最多不超过16个字节|
  469 +
  470 +接口代码：
  471 +```C++
  472 +extern"C" __declspec(dllexport) bool Start_Voice_Event_SN(
  473 + UCHAR iBaseID,
  474 + ULONG KeySN,
  475 + int Moed1,
  476 + int Time,
  477 + int Num,
  478 + int Alert,
  479 + int OutMode,
  480 + UCHAR Txt_Len,
  481 + const char* Txt);//
  482 +```
  483 +
  484 +## 自由题功能
  485 +函数名称：Start_Free_Question_Event
  486 +功能：自由题功能
  487 +说明：把SDK管理的所有基站的在线键盘设置为自由题功能模式
  488 +
  489 +| **参数名称** | **参数说明** | **范围** | **备注** |
  490 +|---|---|---|---|
  491 +|UCHAR iBaseID|基站ID|0~32||
  492 +|ULONG KeySN|指定键盘SN|||
  493 +
  494 +
  495 +接口代码：
  496 +```C++
  497 +extern"C" __declspec(dllexport) bool Start_Free_Question_Event(
  498 + UCHAR iBaseID,
  499 + ULONG KeySN);
  500 +```
  501 +
  502 +## 抢答题功能
  503 +
  504 +函数名称：Start_Rush_Answer_Event
  505 +功能：抢答题功能
  506 +说明：把SDK管理的所有基站的在线键盘设置为抢答题功能模式
  507 +
  508 +| **参数名称** | **参数说明** | **范围** | **备注** |
  509 +|---|---|---|---|
  510 +|rushAnswerMode| 抢答模式|0:普通抢答(默认值)|
  511 +|Moed2| 预留|0:(默认值)|
  512 +|modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
  513 +
  514 +
  515 +接口代码：
  516 +```C++
  517 +extern"C" __declspec(dllexport) bool Start_Rush_Answer_Event(
  518 + int Moed1 = 1,
  519 + int Moed2 = 0,
  520 + int Moed3 = 0); //抢答
  521 +```
  522 +
  523 +## 抢答题功能[指定键盘SN]
  524 +函数名称：Start_Rush_Answer_Event_SN
  525 +功能：抢答题功能[指定键盘SN]
  526 +说明：把SDK管理的指定在线键盘设置为抢答题功能模式
  527 +
  528 +| **参数名称** | **参数说明** | **范围** | **备注** |
  529 +| --- | --- | --- | --- |
  530 +|UCHAR iBaseID|基站ID|0~32||
  531 +|ULONG KeySN|指定键盘SN|||
  532 +|rushAnswerMode| 抢答模式|0:普通抢答(默认值)|
  533 +|Moed2| 预留|0:(默认值)|
  534 +|modifyMode|修改模式|0:不可修改<br>1:可以修改(默认值)|
  535 +|UCHAR Txt_Len|提示标题长度|1~16字节||
  536 +|Txt|提示标题|字符串，长度最多不超过16个字节|
  537 +
  538 +接口代码：
  539 +```C++
  540 +extern"C" __declspec(dllexport) bool Start_Rush_Answer_Event_SN(
  541 + UCHAR iBaseID,
  542 + ULONG KeySN,
  543 + int Moed1 = 1,
  544 + int Moed2 = 0,
  545 + int Moed3 = 0); //抢答模式
  546 +```
  547 +
  548 +## 填空题功能
  549 +
  550 +函数名称：Start_Rush_Answer_Event
  551 +功能：填空题功能
  552 +说明：把SDK管理的所有基站的在线键盘设置为填空题功能模式
  553 +
  554 +| **参数名称** | **参数说明** | **范围** | **备注** |
  555 +|---|---|---|---|
  556 +| optionsMode | 填空类型 | 1:任意输入(默认值) |
  557 +| modifyMode | 预留 | 1: (默认值) |
  558 +| secrecyMode | 预留 | 0: (默认值) |
  559 +
  560 +
  561 +接口代码：
  562 +```C++
  563 +extern"C" __declspec(dllexport) bool Start_TextAnswer_Event(
  564 + int Moed1 = 1,
  565 + int Moed2 = 0,
  566 + int Moed3 = 0);
  567 +```
  568 +
  569 +## 填空题功能[指定键盘SN]
  570 +函数名称：Start_Rush_Answer_Event_SN
  571 +功能：填空题功能[指定键盘SN]
  572 +说明：把SDK管理的指定在线键盘设置为填空题功能模式
  573 +
  574 +| **参数名称** | **参数说明** | **范围** | **备注** |
  575 +| --- | --- | --- | --- |
  576 +|UCHAR iBaseID|基站ID|0~32||
  577 +|ULONG KeySN|指定键盘SN|||
  578 +| optionsMode | 填空类型 | 1:任意输入(默认值) |
  579 +| modifyMode | 预留 | 1: (默认值) |
  580 +| secrecyMode | 预留 | 0: (默认值) |
  581 +
  582 +接口代码：
  583 +```C++
  584 +extern"C" __declspec(dllexport) bool Start_TextAnswer_Event_SN(
  585 + UCHAR iBaseID,
  586 + ULONG KeySN,
  587 + int Moed1 = 1,
  588 + int Moed2 = 0,
  589 + int Moed3 = 0); //抢答模式
  590 +```
  591 +
  592 +## 模拟测试功能[广播]
  593 +函数名称：MockTest_Event
  594 +功能：模拟测试功能[广播]
  595 +说明：把SDK管理的所有基站的在线键盘设置为自由题功能模式
  596 +
  597 +| **参数名称** | **参数说明** | **范围** | **备注** |
  598 +|---|---|---|---|
  599 +|UCHAR iBaseID|基站ID|0~32||
  600 +|int Moed1|模式|||
  601 +|UCHAR KeyTime|按键开启时间|||
  602 +|UCHAR GapTime|按键间隔时间|||
  603 +
  604 +
  605 +接口代码：
  606 +```C++
  607 +extern"C" __declspec(dllexport) bool MockTest_Event(
  608 + UCHAR iBaseID,
  609 + int Moed1 = 1,
  610 + UCHAR KeyTime = 1,
  611 + UCHAR GapTime = 1); //模拟测试[1 报告状态]
  612 +```
  613 +
  614 +## 异步测验功能[广播]
  615 +函数名称：TestMode_Event
  616 +功能：异步测验功能[广播]
  617 +说明：把SDK管理的所有基站的在线键盘设置为异步测验功能模式
  618 +
  619 +| **参数名称** | **参数说明** | **范围** | **备注** |
  620 +|---|---|---|---|
  621 +|UCHAR iBaseID|基站ID|0~32||
  622 +|int Moed|模式|||
  623 +|USHORT TestNum||||
  624 +
  625 +
  626 +接口代码：
  627 +```C++
  628 +extern"C" __declspec(dllexport) bool TestMode_Event(
  629 + UCHAR iBaseID,
  630 + int Moed,
  631 + USHORT TestNum);
  632 +```
  633 +
  634 +# 键盘设置
  635 +## 键盘自定义姓名
  636 +### 设置键盘自定义姓名
  637 +函数名称：SetKeyNameTxt_C100B_S6
  638 +功能：设置键盘自定义姓名，C100B+S6键盘自定义姓名
  639 +参数说明：
  640 +
  641 +| **参数名称** | **参数说明** | **范围** | **备注** |
  642 +| --- | --- | --- | --- |
  643 +|UCHAR iBaseID|基站ID|0~32||
  644 +|ULONG KeySN|键盘SN| ||
  645 +|UCHAR Cont|操作类型|0:不操作<br>1:清除<br>2:写入||
  646 +|UCHAR Name_Len|姓名字符串长度| ||
  647 +|const char* Name|姓名字符串| ||
  648 +
  649 +接口代码：
  650 +```C++
  651 +extern"C" __declspec(dllexport) bool SetKeyNameTxt(
  652 + UCHAR iBaseID,
  653 + ULONG KeySN,
  654 + UCHAR Cont,
  655 + UCHAR Name_Len,
  656 + const char *Name);
  657 +```
  658 +
  659 +## 键盘自定义姓名[C100B+S6]
  660 +### 设置C100B+S6键盘自定义姓名
  661 +函数名称：SetKeyNameTxt_C100B_S6
  662 +功能：设置键盘自定义姓名，C100B+S6键盘自定义姓名
  663 +参数说明：
  664 +
  665 +| **参数名称** | **参数说明** | **范围** | **备注** |
  666 +| --- | --- | --- | --- |
  667 +|UCHAR iBaseID|基站ID|0~32||
  668 +|ULONG KeySN|键盘SN| ||
  669 +|UCHAR Name_Len|姓名字符串长度| ||
  670 +|const char* Name|姓名字符串| ||
  671 +
  672 +接口代码：
  673 +```C++
  674 +extern"C" __declspec(dllexport) bool SetKeyNameTxt_C100B_S6(
  675 + UCHAR iBaseID,
  676 + ULONG KeySN,
  677 + UCHAR Name_Len,
  678 + const char* Name);
  679 +```
  680 +
  681 +### 获取C100B+S6键盘自定义姓名
  682 +函数名称：GetKeyNameTxt_C100B_S6
  683 +功能：获取键盘自定义姓名，C100B+S6键盘自定义姓名
  684 +参数说明：
  685 +
  686 +| **参数名称** | **参数说明** | **范围** | **备注** |
  687 +| --- | --- | --- | --- |
  688 +|UCHAR iBaseID|基站ID|0~32||
  689 +|ULONG KeySN|键盘SN| ||
  690 +
  691 +接口代码：
  692 +```C++
  693 +extern"C" __declspec(dllexport) bool GetKeyNameTxt_C100B_S6(
  694 + UCHAR iBaseID,
  695 + ULONG KeySN);
  696 +```
  697 +
  698 +### 设置键盘评分[积分]
  699 +函数名称：SetKeyScore
  700 +功能：设置键盘评分[积分]
  701 +参数说明：
  702 +
  703 +| **参数名称** | **参数说明** | **范围** | **备注** |
  704 +| --- | --- | --- | --- |
  705 +|UCHAR iBaseID|基站ID|0~32||
  706 +|ULONG KeySN|键盘SN| ||
  707 +|UCHAR Cont|操作类型|0:不操作<br>1:清除<br>2:字符串模式<br>3:五角星模式<br>4:爱心[S6有效]<br>5:写测验题分数[S6有效]||
  708 +|UCHAR Score_Len|积分字符串长度| ||
  709 +|char* Score|积分字符串| ||
  710 +
  711 +接口代码：
  712 +```C++
  713 +extern"C" __declspec(dllexport) bool SetKeyScore(
  714 + UCHAR iBaseID,
  715 + ULONG KeySN,
  716 + UCHAR Cont,
  717 + UCHAR Score_Len,
  718 + char* Score);
  719 +```
  720 +
  721 +### 键盘自定义标题字符串[第二行]
  722 +函数名称：SetKeyTitleTxt2
  723 +功能：设置键盘自定义标题字符串[第二行]
  724 +参数说明：
  725 +
  726 +| **参数名称** | **参数说明** | **范围** | **备注** |
  727 +| --- | --- | --- | --- |
  728 +|UCHAR iBaseID|基站ID|0~32||
  729 +|ULONG KeySN|键盘SN| ||
  730 +|UCHAR Cont|操作类型|0:不操作<br>1:清除<br>2:写入||
  731 +|UCHAR Mode|操作类型|0:空闲模式[仅T2有效]<br>1:工作模式||
  732 +|UCHAR Txt_Len|字符串长度| ||
  733 +|const char* Txt|字符串| ||
  734 +
  735 +接口代码：
  736 +```C++
  737 +extern"C" __declspec(dllexport) bool SetKeyTitleTxt2(
  738 + UCHAR iBaseID,
  739 + ULONG KeySN,
  740 + UCHAR Cont,
  741 + UCHAR Mode,
  742 + UCHAR Txt_Len,
  743 + const char* Txt);
  744 +```
  745 +
  746 +### 键盘自定义标题字符串[第三行]
  747 +函数名称：SetKeyTitleTxt3
  748 +功能：设置键盘自定义标题字符串[第三行]
  749 +参数说明：
  750 +
  751 +| **参数名称** | **参数说明** | **范围** | **备注** |
  752 +| --- | --- | --- | --- |
  753 +|UCHAR iBaseID|基站ID|0~32||
  754 +|ULONG KeySN|键盘SN| ||
  755 +|UCHAR Cont|操作类型|0:不操作<br>1:清除<br>2:写入||
  756 +|UCHAR Txt_Len|字符串长度| ||
  757 +|const char* Txt|字符串| ||
  758 +
  759 +接口代码：
  760 +```C++
  761 +extern"C" __declspec(dllexport) bool SetKeyTitleTxt3(
  762 + UCHAR iBaseID,
  763 + ULONG KeySN,
  764 + UCHAR Cont,
  765 + UCHAR Txt_Len,
  766 + const char* Txt);
  767 +```
  768 +
  769 +### 键盘自定义评分[积分]和标题字符串[第二行]
  770 +函数名称：SetKeyScreTxt2
  771 +功能：设置键盘自定义评分[积分]和标题字符串[第二行]
  772 +参数说明：
  773 +
  774 +| **参数名称** | **参数说明** | **范围** | **备注** |
  775 +| --- | --- | --- | --- |
  776 +|UCHAR iBaseID|基站ID|0~32||
  777 +|ULONG KeySN|键盘SN| ||
  778 +|UCHAR Score_Type|操作类型|0:不操作<br>1:清除<br>2:字符串模式<br>3:五角星模式<br>4:爱心[S6有效]<br>5:写测验题分数[S6有效]||
  779 +|UCHAR Score_Len|字符串长度| ||
  780 +|char* Score|字符串| ||
  781 +|UCHAR Txt_Cont|操作类型|0:不操作<br>1:清除<br>2:写入||
  782 +|UCHAR Txt_Len|字符串长度| ||
  783 +|const char* Txt|字符串| ||
  784 +
  785 +接口代码：
  786 +```C++
  787 +extern"C" __declspec(dllexport) bool SetKeyScreTxt2(
  788 + UCHAR iBaseID,
  789 + ULONG KeySN,
  790 + UCHAR Score_Type,
  791 + UCHAR Score_Len,
  792 + char* Score,
  793 + UCHAR Txt_Cont,
  794 + UCHAR Txt_Len,
  795 + const char* Txt);
  796 +```
  797 +
  798 +### 键盘自定义短信
  799 +函数名称：SetKeyMessage
  800 +功能：设置键盘自定义短信
  801 +参数说明：
  802 +
  803 +| **参数名称** | **参数说明** | **范围** | **备注** |
  804 +| --- | --- | --- | --- |
  805 +|UCHAR iBaseID|基站ID|0~32||
  806 +|ULONG KeySN|键盘SN| ||
  807 +|const char* Txt|字符串| ||
  808 +
  809 +接口代码：
  810 +```C++
  811 +extern"C" __declspec(dllexport) bool SetKeyMessage(
  812 + UCHAR iBaseID,
  813 + ULONG KeySN,
  814 + const char* Txt);
  815 +```
  816 +
  817 +## 键盘暂停休眠时间
  818 +
  819 +设置键盘暂停休眠时间
  820 +函数名称：Key_Pause_Sleep
  821 +参数说明：
  822 +
  823 +| **参数名称** | **参数说明** | **范围** | **备注** |
  824 +| --- | --- | --- | --- |
  825 +|UCHAR iBaseID|基站ID|0~32||
  826 +|UCHAR Time|休眠时间| 0：10秒[默认]||
  827 +
  828 +接口代码：
  829 +```C++
  830 +extern"C" __declspec(dllexport) bool Key_Pause_Sleep(UCHAR iBaseID, UCHAR Time);//
  831 +```
  832 +
  833 +## 键盘关机设置
73 834  
74 835 获取键盘关机时间等级
75 836 函数名称：GetKeyboardAutoPowerOffLevel
... ... @@ -98,6 +859,111 @@ extern&quot;C&quot; __declspec(dllexport) bool GetKeyboardAutoPowerOffLevel(UCHAR iBaseID)
98 859 extern"C" __declspec(dllexport) bool SetKeyboardAutoPowerOffLevel(UCHAR iBaseID, UCHAR Level);
99 860 ```
100 861  
  862 +## 键盘外设操作[仅T2有效]
  863 +
  864 +设置键盘外设操作[仅T2有效]
  865 +函数名称：SetKeyPeripheral
  866 +参数说明：写键盘外设,由led灯、蜂鸣器、马达组合
  867 +
  868 +| **参数名称** | **参数说明** | **范围** | **备注** |
  869 +| --- | --- | --- | --- |
  870 +|UCHAR iBaseID|基站ID|0~32||
  871 +| keySn | 键盘SN |空字符串，为所有在线键盘|
  872 +| ledTimes | Led灯闪烁次数 | 0~255 (0是马上灭，255是长亮)|
  873 +| ledOnTime | Led灯每次开时间 |0~255 (单位0.1s)|
  874 +| ledOffTime | Led灯每次关时间 |0~255 (单位0.1s，为0就是连续亮)|
  875 +| ledColorR | Led灯灯颜色,红值 |0~255(现只支持0灭和1亮,，>1也认为是1)|
  876 +| ledColorG | Led灯灯颜色,绿值 |0~255(现只支持0灭和1亮,，>1也认为是1)|
  877 +| ledColorB | Led灯灯颜色,蓝值 |0~255(现只支持0灭和1亮,，>1也认为是1)|
  878 +| beepTimes | 蜂鸣器响次数 | 0~255 (0是马上响，255是长响) |
  879 +| beepOnTime | 蜂鸣器每次开时间 |0~255 (单位0.1s)|
  880 +| beepOffTime | 蜂鸣器每次关时间 |0~255 (单位0.1s，为0就是连续响)|
  881 +| motorTimes |马达震动次数|0~255|
  882 +| motorOnTime | 马达每次开时间 |0~255 (单位0.1s)|
  883 +| motorOffTime | 马达每次关时间 |0~255 (单位0.1s，为0就是连续振动)|
  884 +
  885 +接口代码：
  886 +```C++
  887 +extern"C" __declspec(dllexport) bool SetKeyPeripheral(
  888 + UCHAR iBaseID,
  889 + ULONG KeySN,
  890 + UCHAR LED_CTRL,
  891 + UCHAR LED_TIMES,
  892 + UCHAR LED_TON,
  893 + UCHAR LED_TOFF,
  894 + UCHAR R,
  895 + UCHAR G,
  896 + UCHAR B,
  897 + UCHAR BEEP_CTRL,
  898 + UCHAR BEEP_TIMES,
  899 + UCHAR BEEP_TON,
  900 + UCHAR BEEP_TOFF,
  901 + UCHAR MOTO_CTRL,
  902 + UCHAR MOTO_TIMES,
  903 + UCHAR MOTO_TON,
  904 + UCHAR MOTO_TOFF);
  905 +```
  906 +
  907 +## 键盘遥控关机
  908 +
  909 +遥控关机
  910 +函数名称：SetKeyRemoteShutdown
  911 +参数说明：键盘遥控关机
  912 +
  913 +| **参数名称** | **参数说明** | **范围** | **备注** |
  914 +| --- | --- | --- | --- |
  915 +|UCHAR iBaseID|基站ID|0~32||
  916 +| keySn | 键盘SN |空字符串，为所有在线键盘|
  917 +
  918 +
  919 +接口代码：
  920 +```C++
  921 +extern"C" __declspec(dllexport) bool SetKeyRemoteShutdown(
  922 + UCHAR iBaseID,
  923 + ULONG KeySN);
  924 +```
  925 +
  926 +## 键盘ID遥控关机生产模式
  927 +
  928 +键盘ID遥控关机生产模式
  929 +函数名称：SetKeyRemoteShutdown_Pro
  930 +参数说明：键盘遥控关机
  931 +
  932 +| **参数名称** | **参数说明** | **范围** | **备注** |
  933 +| --- | --- | --- | --- |
  934 +|UCHAR iBaseID|基站ID|0~32||
  935 +|UCHAR Mode| 模式 |0~255;0:正常关机 255：一直遥控开机|
  936 +|USHORT KeyIdMin| 开始编号 |1~9999；指定键盘编号范围时候的开始值|
  937 +|USHORT KeyIdMax| 结束编号 |1~9999；指定键盘编号范围时候的结束值|
  938 +
  939 +
  940 +接口代码：
  941 +```C++
  942 +extern"C" __declspec(dllexport) bool SetKeyRemoteShutdown_Pro(
  943 + UCHAR iBaseID,
  944 + UCHAR Mode,
  945 + USHORT KeyIdMin,
  946 + USHORT KeyIdMax);
  947 +```
  948 +
  949 +## 键盘恢复出厂设置
  950 +
  951 +设置键盘恢复出厂设置
  952 +函数名称：SetKeyFactory
  953 +参数说明：
  954 +
  955 +| **参数名称** | **参数说明** | **范围** | **备注** |
  956 +| --- | --- | --- | --- |
  957 +|UCHAR iBaseID|基站ID|0~32||
  958 +| keySn | 键盘SN |空字符串，为所有在线键盘|
  959 +
  960 +
  961 +接口代码：
  962 +```C++
  963 +extern"C" __declspec(dllexport) bool SetKeyFactory(
  964 + UCHAR iBaseID,
  965 + ULONG KeySN);
  966 +```
101 967  
102 968 ## 异常处理
103 969  
... ...