diff --git a/通讯协议-SDK_DLL部分[内部].md b/通讯协议-SDK_DLL部分[内部].md index e63182d..29f1d4f 100644 --- a/通讯协议-SDK_DLL部分[内部].md +++ b/通讯协议-SDK_DLL部分[内部].md @@ -1552,6 +1552,34 @@ extern"C" __declspec(dllexport) bool Custom_Questions_Event( extern"C" __declspec(dllexport) bool QuickMatch(UCHAR iBaseID); ``` +#### 样例: +样例目的:启动快速配对 +##### 启动功能部分: +```C++ +QuickMatch(1); //开启快速配对 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|40|快速配对| +|const char* sInfo|参数字符串|"OK"|成功| + + + +##### 退出功能部分: +```C++ +ExitEvent(40); //快速配对模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"40,OK"|40:快速配对模式切换到空闲模式成功| + ### 开启快速配对功能[内部接口] 函数名称:QuickMatch_Pro 功能:开启快速配对功能[广播] @@ -1574,11 +1602,39 @@ extern"C" __declspec(dllexport) bool QuickMatch_Pro( USHORT Id); //开启快速配对生产模式 ``` +#### 样例: +样例目的:启动快速配对 +##### 启动功能部分: +```C++ +QuickMatch_Pro(1,4, 10, 1); //开启快速配对 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|40|快速配对| +|const char* sInfo|参数字符串|"OK"|成功| + + + +##### 退出功能部分: +```C++ +ExitEvent(40); //快速配对模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"40,OK"|40:快速配对模式切换到空闲模式成功| + # 键盘设置 ## 键盘自定义姓名 ### 设置键盘自定义姓名 -函数名称:SetKeyNameTxt_C100B_S6 -功能:设置键盘自定义姓名,C100B+S6键盘自定义姓名 +函数名称:SetKeyNameTxt +功能:设置键盘自定义姓名,B200 5.8G+T2、B200 2.4G+S6或B100+S6键盘自定义姓名 参数说明: | **参数名称** | **参数说明** | **范围** | **备注** | @@ -1599,6 +1655,36 @@ extern"C" __declspec(dllexport) bool SetKeyNameTxt( const char *Name); ``` +#### 样例: +样例目的:设置键盘自定义姓名 +##### 启动功能部分: +```C++ +SetKeyNameTxt(1,1837454011, 2, "张三"); //设置键盘自定义姓名 +``` +keyEventCallBack 回调接口反馈数据解析: + +###### B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,1,1,0"|"状态,预留,键盘自定义姓名模式,预留"| + +###### B200 5.8G + T2 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|300
304|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,2,0"
"2,0,5,0"|"状态,预留,键盘自定义姓名模式,预留"| + ## 键盘自定义姓名[C100B+S6] ### 设置C100B+S6键盘自定义姓名 函数名称:SetKeyNameTxt_C100B_S6 @@ -1620,6 +1706,24 @@ extern"C" __declspec(dllexport) bool SetKeyNameTxt_C100B_S6( UCHAR Name_Len, const char* Name); ``` +#### 样例: +样例目的:设置C100B+S6键盘自定义姓名 +##### 启动功能部分: +```C++ +SetKeyNameTxt_C100B_S6(1,1837454011, 2, "张三"); //设置键盘自定义姓名 +``` +##### keyEventCallBack 回调接口反馈数据解析: + +###### C100B 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|306|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"张三,OK,0,0"|"姓名,状态,预留,预留"| ### 获取C100B+S6键盘自定义姓名 函数名称:GetKeyNameTxt_C100B_S6 @@ -1637,6 +1741,25 @@ extern"C" __declspec(dllexport) bool GetKeyNameTxt_C100B_S6( UCHAR iBaseID, ULONG KeySN); ``` +#### 样例: +样例目的:获取C100B+S6键盘自定义姓名 +#### 启动功能部分: +```C++ +GetKeyNameTxt_C100B_S6(1,1837454011); //获取键盘自定义姓名 +``` +keyEventCallBack 回调接口反馈数据解析: + +###### C100B 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|306|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"张三,OK,0,0"|"姓名,状态,预留,预留"| + ## 设置键盘评分[积分] 函数名称:SetKeyScore @@ -1661,6 +1784,36 @@ extern"C" __declspec(dllexport) bool SetKeyScore( char* Score); ``` +### 样例: +样例目的:设置键盘评分[积分] +#### 启动功能部分: +```C++ +SetKeyScore(1,1837454011, 2, 2, "99"); //设置键盘评分[积分] +``` +#### keyEventCallBack 回调接口反馈数据解析: + +##### B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,1,3,0"|"状态,预留,键盘评分[积分]模式,预留"| + +##### B200 5.8G + T2 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|300
304|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,9,0"
"2,0,13,0"|"状态,预留,键盘评分[积分]模式,预留"| + ## 键盘自定义标题字符串[第二行] 函数名称:SetKeyTitleTxt2 功能:设置键盘自定义标题字符串[第二行] @@ -1686,6 +1839,36 @@ extern"C" __declspec(dllexport) bool SetKeyTitleTxt2( const char* Txt); ``` +### 样例: +样例目的:设置键盘自定义标题字符串[第二行] +#### 启动功能部分: +```C++ +SetKeyTitleTxt2(1,1837454011, 2, 1, 2, "第二行文本"); //设置键盘自定义标题字符串[第二行] +``` +keyEventCallBack 回调接口反馈数据解析: + +##### B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,1,11,0"|"状态,预留,第二行文本模式,预留"| + +##### B200 5.8G + T2 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|300
304|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,16,0"
"2,0,17,0"|"状态,预留,第二行文本模式,预留"| + ## 键盘自定义标题字符串[第三行] 函数名称:SetKeyTitleTxt3 功能:设置键盘自定义标题字符串[第三行] @@ -1757,6 +1940,25 @@ extern"C" __declspec(dllexport) bool SetKeyMessage( const char* Txt); ``` +### 样例: +样例目的:设置键盘自定义短信 +#### 启动功能部分: +```C++ +SetKeyMessage(1,1837454011, "短信文本"); //设置键盘自定义短信 +``` +keyEventCallBack 回调接口反馈数据解析: + +##### B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,1,60,0"|"状态,预留,短信文,预留"| + ## 键盘功能提示预设 设置功能提示预设 函数名称:SetKeyFunPromptPresetTxt @@ -1782,6 +1984,24 @@ extern"C" __declspec(dllexport) bool SetKeyFunPromptPresetTxt( const char* Txt); ``` +### 样例: +样例目的:设置功能提示预设 +```C++ +SetKeyFunPromptPresetTxt(1,1837454011, 0, 1, 4, "提交成功"); //设置功能提示预设 +``` +keyEventCallBack 回调接口反馈数据解析: + +B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,1,52,0"|"状态,预留,功能提示预设模式,预留"| + ## 键盘暂停休眠时间 设置键盘暂停休眠时间 @@ -1798,9 +2018,23 @@ extern"C" __declspec(dllexport) bool SetKeyFunPromptPresetTxt( extern"C" __declspec(dllexport) bool Key_Pause_Sleep(UCHAR iBaseID, UCHAR Time);// ``` -## 键盘关机设置 +### 样例: +样例目的:设置键盘暂停休眠时间 10秒 +```C++ +Key_Pause_Sleep(0, 0); //设置键盘暂停休眠时间 10秒 + +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|53|键盘暂停休眠时间| +|const char* sInfo|参数字符串|"0"|键盘暂停休眠时间 10秒| + +## 键盘关机时间等级设置 -获取键盘关机时间等级 +### 获取键盘关机时间等级 函数名称:GetKeyboardAutoPowerOffLevel 参数说明: @@ -1813,7 +2047,20 @@ extern"C" __declspec(dllexport) bool Key_Pause_Sleep(UCHAR iBaseID, UCHAR Time); extern"C" __declspec(dllexport) bool GetKeyboardAutoPowerOffLevel(UCHAR iBaseID); ``` -设置键盘关机时间等级 +样例: +样例目的:获取键盘关机时间等级 +```C++ +GetKeyboardAutoPowerOffLevel(1); //获取键盘关机时间等级 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|202|基站特征参数| +|const char* sInfo|参数字符串|"A,B,C,D,E,F,G,H,I"|A:预留
B:预留
C:键盘关机时间等级
D:心跳开关
E:键盘登录菜单
F:预留
G:键盘考勤发送次数
H:预留
I:键盘考勤发送功率| + +### 设置键盘关机时间等级 函数名称:SetKeyboardAutoPowerOffLevel 参数说明: @@ -1827,6 +2074,19 @@ extern"C" __declspec(dllexport) bool GetKeyboardAutoPowerOffLevel(UCHAR iBaseID) extern"C" __declspec(dllexport) bool SetKeyboardAutoPowerOffLevel(UCHAR iBaseID, UCHAR Level); ``` +样例: +样例目的:获取键盘关机时间等级 +```C++ +SetKeyboardAutoPowerOffLevel(1,255); //设置键盘关机时间等级 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|202|基站特征参数| +|const char* sInfo|参数字符串|"A,B,C,D,E,F,G,H,I"|A:预留
B:预留
C:键盘关机时间等级
D:心跳开关
E:键盘登录菜单
F:预留
G:键盘考勤发送次数
H:预留
I:键盘考勤发送功率| + ## 键盘外设操作[仅T2有效] 设置键盘外设操作[仅T2有效] @@ -1835,20 +2095,23 @@ extern"C" __declspec(dllexport) bool SetKeyboardAutoPowerOffLevel(UCHAR iBaseID, | **参数名称** | **参数说明** | **范围** | **备注** | | --- | --- | --- | --- | -|UCHAR iBaseID|基站ID|0~32|| -| keySn | 键盘SN |空字符串,为所有在线键盘| -| ledTimes | Led灯闪烁次数 | 0~255 (0是马上灭,255是长亮)| -| ledOnTime | Led灯每次开时间 |0~255 (单位0.1s)| -| ledOffTime | Led灯每次关时间 |0~255 (单位0.1s,为0就是连续亮)| -| ledColorR | Led灯灯颜色,红值 |0~255(现只支持0灭和1亮,,>1也认为是1)| -| ledColorG | Led灯灯颜色,绿值 |0~255(现只支持0灭和1亮,,>1也认为是1)| -| ledColorB | Led灯灯颜色,蓝值 |0~255(现只支持0灭和1亮,,>1也认为是1)| -| beepTimes | 蜂鸣器响次数 | 0~255 (0是马上响,255是长响) | -| beepOnTime | 蜂鸣器每次开时间 |0~255 (单位0.1s)| +| UCHAR iBaseID|基站ID|0~32|| +| ULONG keySn | 键盘SN |空字符串,为所有在线键盘| +| UCHAR LED_CTRL | Led功能使能 | 0:关闭 1:开启| +| UCHAR ledTimes | Led灯闪烁次数 | 0~255 (0是马上灭,255是长亮)| +| UCHAR ledOnTime | Led灯每次开时间 |0~255 (单位0.1s)| +| UCHAR ledOffTime | Led灯每次关时间 |0~255 (单位0.1s,为0就是连续亮)| +| UCHAR ledColorR | Led灯灯颜色,红值 |0~255(现只支持0灭和1亮,,>1也认为是1)| +| UCHAR ledColorG | Led灯灯颜色,绿值 |0~255(现只支持0灭和1亮,,>1也认为是1)| +| UCHAR edColorB | Led灯灯颜色,蓝值 |0~255(现只支持0灭和1亮,,>1也认为是1)| +| UCHAR BEEP_CTRL | 蜂鸣器功能使能 | 0:关闭 1:开启| +| UCHAR beepTimes | 蜂鸣器响次数 | 0~255 (0是马上响,255是长响) | +| UCHAR beepOnTime | 蜂鸣器每次开时间 |0~255 (单位0.1s)| | beepOffTime | 蜂鸣器每次关时间 |0~255 (单位0.1s,为0就是连续响)| -| motorTimes |马达震动次数|0~255| -| motorOnTime | 马达每次开时间 |0~255 (单位0.1s)| -| motorOffTime | 马达每次关时间 |0~255 (单位0.1s,为0就是连续振动)| +| UCHAR MOTO_CTRL | 马达震动功能使能 | 0:关闭 1:开启| +| UCHAR motorTimes |马达震动次数|0~255| +| UCHAR motorOnTime | 马达每次开时间 |0~255 (单位0.1s)| +| UCHAR motorOffTime | 马达每次关时间 |0~255 (单位0.1s,为0就是连续振动)| 接口代码: ```C++ @@ -1872,6 +2135,24 @@ extern"C" __declspec(dllexport) bool SetKeyPeripheral( UCHAR MOTO_TOFF); ``` +### 样例: +样例目的:设置键盘外设操作[仅T2有效] led 红灯闪烁3次,震动3次。 + +```C++ +//设置键盘外设操作[仅T2有效] +SetKeyPeripheral(1,1837454011, 1, 3, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 3, 1, 1); +``` +keyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|600|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,3"|"状态,外设控制模式"| + ## 键盘遥控关机 遥控关机 @@ -1891,6 +2172,37 @@ extern"C" __declspec(dllexport) bool SetKeyRemoteShutdown( ULONG KeySN); ``` +### 样例: +样例目的:设置键盘外设操作[仅T2有效] led 红灯闪烁3次,震动3次。 + +```C++ +//键盘遥控关机 +SetKeyRemoteShutdown(1,1837454011); +``` +keyEventCallBack 回调接口反馈数据解析: + +B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,40,0"|"状态,预留,遥控关机模式,预留"| + +B200 5.8G + T2 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|304|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,4,0"|"状态,预留,遥控关机模式,预留"| + ## 键盘ID遥控关机生产模式 键盘ID遥控关机生产模式 @@ -1914,6 +2226,26 @@ extern"C" __declspec(dllexport) bool SetKeyRemoteShutdown_Pro( USHORT KeyIdMax); ``` +### 样例: +样例目的:键盘ID遥控关机生产模式 正常关机,编号1~100。 + +```C++ +//键盘遥控关机 +SetKeyRemoteShutdown_Pro(1, 1, 100); +``` +keyEventCallBack 回调接口反馈数据解析: + +B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,40,0"|"状态,预留,遥控关机模式,预留"| + ## 键盘恢复出厂设置 设置键盘恢复出厂设置 @@ -1922,7 +2254,7 @@ extern"C" __declspec(dllexport) bool SetKeyRemoteShutdown_Pro( | **参数名称** | **参数说明** | **范围** | **备注** | | --- | --- | --- | --- | -|UCHAR iBaseID|基站ID|0~32|| +| UCHAR iBaseID|基站ID|0~32|| | ULONG KeySN | 键盘SN |空字符串,为所有在线键盘| @@ -1933,6 +2265,14 @@ extern"C" __declspec(dllexport) bool SetKeyFactory( ULONG KeySN); ``` +### 样例: +样例目的:所有在线键盘恢复出厂设置 + +```C++ +//所有在线键盘恢复出厂设置 +SetKeyFactory(0, 0); +``` + ## 显著显示表决器信息 设置显著显示表决器信息 @@ -1952,6 +2292,14 @@ extern"C" __declspec(dllexport) bool SetKey_SignificantlyDisplay( UCHAR Mode); ``` +### 样例: +样例目的:所有在线键盘 大字体显示表决器编号 + +```C++ +//所有在线键盘 大字体显示表决器编号 +SetKey_SignificantlyDisplay(0, 1); +``` + ## 无线修改键盘配对码(解绑) 无线修改键盘配对码(解绑) @@ -1973,6 +2321,27 @@ extern"C" __declspec(dllexport) bool SetKeyUnbind( const char* MatchCode); ``` +### 样例: +样例目的:所有在线键盘 解绑 + +```C++ +//所有在线键盘 解绑 +SetKeyUnbind(0, 0,"FFFFFFFF"); +``` + +keyEventCallBack 回调接口反馈数据解析: + +B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,41,0"|"状态,预留,遥改配对码模式,预留"| + ## 设置OEM型号显示名称 设置OEM型号显示名称 @@ -1996,6 +2365,14 @@ extern"C" __declspec(dllexport) bool SetKeyOEMModel( const char* Model);//设置键盘OEM型号名称 ``` +### 样例: +样例目的:所有在线键盘 解绑 + +```C++ +//所有在线键盘 设置OEM型号显示名称 +SetKeyOEMModel(0, 0, 2, "T3"); +``` + ## 锁定键盘,解锁键盘 锁定键盘,解锁键盘 @@ -2019,17 +2396,49 @@ extern"C" __declspec(dllexport) bool KeySN_Manage( ULONG KeySN[250]); ``` -## 键盘的FSN - -设置键盘的FSN -函数名称:SetKeyFSN -参数说明: +### 样例1: +样例目的:所有在线键盘 锁定 -| **参数名称** | **参数说明** | **范围** | **备注** | -| --- | --- | --- | --- | -|UCHAR iBaseID|基站ID|0~32| -|ULONG KeySN_Old| 旧键盘SN || -|ULONG KeySN_New| 新键盘SN || +```C++ +//所有在线键盘 锁定 +KeySN_Manage(0, 5, 0, NULL); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|33|锁定键盘| +|const char* sInfo|参数字符串|"-99,0"|"状态,预留"| + +### 样例2: +样例目的:解锁所有键盘 + +```C++ +//所有在线键盘 锁定 +KeySN_Manage(0, 7, 0, NULL); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|34|解锁键盘| +|const char* sInfo|参数字符串|"-99,0"|"状态,预留"| + +## 键盘的FSN + +设置键盘的FSN +函数名称:SetKeyFSN +参数说明: + +| **参数名称** | **参数说明** | **范围** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|0~32| +|ULONG KeySN_Old| 旧键盘SN || +|ULONG KeySN_New| 新键盘SN || 接口代码: @@ -2040,6 +2449,26 @@ extern"C" __declspec(dllexport) bool SetKeyFSN( ULONG KeySN_New); ``` +### 样例: +样例目的:设置在线键盘的FSN为“1837454011” + +```C++ +//键设置在线键盘的FSN +SetKeyFSN(1,0,1837454011); +``` +keyEventCallBack 回调接口反馈数据解析: + +B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,43,0"|"状态,预留,设置键盘SN模式,预留"| + ## 键盘的出厂日期 设置键盘的出厂日期 @@ -2082,10 +2511,30 @@ extern"C" __declspec(dllexport) bool SetKeyID( USHORT ID);//设置键盘的ID ``` +### 样例: +样例目的:设置键盘的ID + +```C++ +//设置键盘的ID +SetKeyID(1,1837454011,100); +``` +keyEventCallBack 回调接口反馈数据解析: + +B200 2.4G + S6 或 B100 2.4G + S6 + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|303|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"2,0,42,0"|"状态,预留,设置键盘ID模式,预留"| + # 基站参数设置 ## 基站的设备ID -设置基站的设备ID +### 设置基站的设备ID 函数名称:SetDevBaseId 参数说明: @@ -2101,7 +2550,22 @@ extern"C" __declspec(dllexport) bool SetDevBaseId( UCHAR iBaseID); //设置基站的设备ID ``` -获取基站的设备ID +样例: +样例目的:设置基站的设备ID + +```C++ +SetDevBaseId(0xFFFF, 1); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|201|基站读取ID 、信道、RF功率等级| +|const char* sInfo|参数字符串|"1,10,1"|"基站ID,信道,RF功率"| + +### 获取基站的设备ID 函数名称:GetDevBaseId 参数说明: @@ -2114,6 +2578,21 @@ extern"C" __declspec(dllexport) bool SetDevBaseId( extern"C" __declspec(dllexport) bool GetDevBaseId(UCHAR iBaseID); //获取基站的设备ID ``` +样例: +样例目的:设置基站的设备ID + +```C++ +GetDevBaseId(0); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|201|基站读取ID 、信道、RF功率等级| +|const char* sInfo|参数字符串|"1,10,1"|"基站ID,信道,RF功率"| + ## 基站黑名单 设置基站到基站黑名单 函数名称:SetDevBaseBlacklist @@ -2125,7 +2604,15 @@ extern"C" __declspec(dllexport) bool GetDevBaseId(UCHAR iBaseID); //获取基 接口代码: ```C++ -extern"C" __declspec(dllexport) bool SetDevBaseBlacklist(int pathAdd); //设置基站到基站黑名单 +//设置基站到基站黑名单 +extern"C" __declspec(dllexport) bool SetDevBaseBlacklist(int pathAdd); +``` + +样例: +样例目的:将参数对应的基站设置到本地的基站黑名单列表 + +```C++ +SetDevBaseBlacklist(XXXXX); ``` 获取基站黑名单列表 @@ -2137,8 +2624,15 @@ extern"C" __declspec(dllexport) bool SetDevBaseBlacklist(int pathAdd); //设置 extern"C" __declspec(dllexport) bool GetDevBaseBlacklist(); //获取基站黑名单列表 ``` +样例: +样例目的:将本地的基站黑名单列表载入内存 + +```C++ +GetDevBaseBlacklist(); +``` + ## 基站的设备RF功率 -设置基站的设备RF功率 +### 设置基站的设备RF功率 函数名称:SetDevRFPWR 参数说明: @@ -2154,7 +2648,22 @@ extern"C" __declspec(dllexport) bool SetDevRFPWR( UCHAR RFPWR); //设置基站的设备RF功率 ``` -获取基站的设备RF功率 +样例: +样例目的:设置基站的设备ID + +```C++ +SetDevRFPWR(0, 1); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|201|基站读取ID 、信道、RF功率等级| +|const char* sInfo|参数字符串|"1,10,1"|"基站ID,信道,RF功率"| + +### 获取基站的设备RF功率 函数名称:GetDevRFPWR 参数说明: @@ -2167,8 +2676,23 @@ extern"C" __declspec(dllexport) bool SetDevRFPWR( extern"C" __declspec(dllexport) bool GetDevRFPWR(UCHAR iBaseID); //获取基站的设备RF功率 ``` +样例: +样例目的:获取基站的设备ID + +```C++ +GetDevRFPWR(0); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|201|基站读取ID 、信道、RF功率等级| +|const char* sInfo|参数字符串|"1,10,1"|"基站ID,信道,RF功率"| + ## 基站信道 -设置基站的设备信道 +### 设置基站的设备信道 函数名称:SetDevCHAN 参数说明: @@ -2186,7 +2710,22 @@ extern"C" __declspec(dllexport) bool SetDevCHAN( UCHAR * chan); //设置基站的设备信道 ``` -获取基站的设备信道 +样例: +样例目的:设置1号基站的设备信道,信道1:0,信道2::8 + +```C++ +SetDevCHAN(1,2,10,18); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|206|基站频点| +|const char* sInfo|参数字符串|"2,10,18,0,0"|"信道有效数,信道1,信道2,信道3,信道4"| + +### 获取基站的设备信道 函数名称:GetDevCHAN 参数说明: @@ -2199,8 +2738,23 @@ extern"C" __declspec(dllexport) bool SetDevCHAN( extern"C" __declspec(dllexport) bool GetDevCHAN(UCHAR iBaseID); ``` +样例: +样例目的:获取基站的设备信道 + +```C++ +GetDevCHAN(1); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|206|基站频点| +|const char* sInfo|参数字符串|"2,10,18,0,0"|"信道有效数,信道1,信道2,信道3,信道4"| + ## 基站配对码 -设置基站配对码 +### 设置基站配对码 函数名称:SetDevSYSCODE 参数说明: @@ -2215,8 +2769,22 @@ extern"C" __declspec(dllexport) bool SetDevSYSCODE( UCHAR iBaseID, UCHAR code[4]); //设置基站配对码 ``` +样例: +样例目的:获取基站的设备信道 + +```C++ +SetDevSYSCODE(1,0xFF010203); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|5|基站配对码| +|const char* sInfo|参数字符串|"FF010203"|基站配对码| -获取基站配对码 +### 获取基站配对码 函数名称:GetDevSYSCODE 参数说明: @@ -2229,8 +2797,23 @@ extern"C" __declspec(dllexport) bool SetDevSYSCODE( extern"C" __declspec(dllexport) bool GetDevSYSCODE(UCHAR iBaseID); //获取基站配对码 ``` +样例: +样例目的:获取基站配对码 + +```C++ +GetDevSYSCODE(1); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|5|基站配对码| +|const char* sInfo|参数字符串|"FF010203"|基站配对码| + ## 基站配对模式 -设置基站配对模式 +### 设置基站配对模式 函数名称:SetDevPairMode 参数说明: @@ -2246,7 +2829,23 @@ extern"C" __declspec(dllexport) bool SetDevPairMode( UCHAR mode); //设置基站配对模式 ``` -获取基站配对模式 +样例: +样例目的:设置基站配对模式 4:配对SN号模式 + +```C++ +SetDevPairMode(1,4); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|204|基站配对模式、基站名称(自定义)| +|const char* sInfo|参数字符串|"4,设备1"|"基站配对模式,基站名称"| + + +### 获取基站配对模式 函数名称:GetDevPairMode 参数说明: @@ -2259,8 +2858,23 @@ extern"C" __declspec(dllexport) bool SetDevPairMode( extern"C" __declspec(dllexport) bool GetDevPairMode(UCHAR iBaseID); //获取基站配对模式 ``` +样例: +样例目的:设置基站配对模式 4:配对SN号模式 + +```C++ +GetDevPairMode(1); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|204|基站配对模式、基站名称(自定义)| +|const char* sInfo|参数字符串|"4,设备1"|"基站配对模式,基站名称"| + ## 基站名称 -设置基站名称 +### 设置基站名称 函数名称:SetDevNmae 参数说明: @@ -2278,7 +2892,22 @@ extern"C" __declspec(dllexport) bool SetDevNmae( const char *Name); //设置基站名称 ``` -获取基站名称 +样例: +样例目的:设置基站名称 + +```C++ +SetDevNmae(1,3,"设备1"); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|204|基站配对模式、基站名称(自定义)| +|const char* sInfo|参数字符串|"4,设备1"|"基站配对模式,基站名称"| + +### 获取基站名称 函数名称:GetDevNmae 参数说明: @@ -2291,8 +2920,23 @@ extern"C" __declspec(dllexport) bool SetDevNmae( extern"C" __declspec(dllexport) bool GetDevNmae(UCHAR iBaseID); //获取基站名称 ``` +样例: +样例目的:设置基站名称 + +```C++ +GetDevNmae(1); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|204|基站配对模式、基站名称(自定义)| +|const char* sInfo|参数字符串|"4,设备1"|"基站配对模式,基站名称"| + ## 基站键盘容量 -设置基站键盘容量 +### 设置基站键盘容量 函数名称:SetDevKPNUMS 参数说明: @@ -2310,7 +2954,22 @@ extern"C" __declspec(dllexport) bool SetDevKPNUMS( UCHAR Lock=0); //设置基站键盘容量 ``` -获取基站键盘容量 +样例: +样例目的:设置基站键盘容量 + +```C++ +SetDevKPNUMS(1,60,0); +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|10|基站键盘容量| +|const char* sInfo|参数字符串|"60,0"|"基站键盘容量,预留"| + +### 获取基站键盘容量 函数名称:GetDevKPNUMS 参数说明: @@ -2323,39 +2982,24 @@ extern"C" __declspec(dllexport) bool SetDevKPNUMS( extern"C" __declspec(dllexport) bool GetDevKPNUMS(UCHAR iBaseID); //获取基站键盘容量 ``` -## 键盘关机时间等级 -设置键盘关机时间等级 -函数名称:SetKeyboardAutoPowerOffLevel -参数说明: - -| **参数名称** | **参数说明** | **范围** | **备注** | -| --- | --- | --- | --- | -|UCHAR iBaseID|基站ID|0~32| -|UCHAR Level| 等级 |0:30秒
1:2分钟
2:15分钟
3:45分钟
255:不自动关机| - +样例: +样例目的:获取基站键盘容量 -接口代码: ```C++ -extern"C" __declspec(dllexport) bool SetKeyboardAutoPowerOffLevel( - UCHAR iBaseID, - UCHAR Level); +GetDevKPNUMS(1); ``` -获取键盘关机时间等级 -函数名称:GetKeyboardAutoPowerOffLevel -参数说明: +HDParamCallBack 回调接口反馈数据解析: -| **参数名称** | **参数说明** | **范围** | **备注** | +| **参数名称** | **参数说明** | **解析** | **备注** | | --- | --- | --- | --- | -|UCHAR iBaseID|基站ID|0~32| +|int iBaseID|基站ID|1|| +|int mode|模式|10|基站键盘容量| +|const char* sInfo|参数字符串|"60,0"|"基站键盘容量,预留"| -接口代码: -```C++ -extern"C" __declspec(dllexport) bool GetKeyboardAutoPowerOffLevel(UCHAR iBaseID); -``` ## 键盘登录菜单显示允许[S6适用] -设置键盘登录菜单显示允许[S6适用] +### 设置键盘登录菜单显示允许[S6适用] 函数名称:SetKeyboardLoginMenu 参数说明: @@ -2372,7 +3016,22 @@ extern"C" __declspec(dllexport) bool SetKeyboardLoginMenu( UCHAR OnOff); ``` -获取键盘登录菜单显示允许[S6适用] +样例: +样例目的:设置键盘登录菜单显示允许 + +```C++ +SetKeyboardLoginMenu(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|202|基站特征参数| +|const char* sInfo|参数字符串|"A,B,C,D,E,F,G,H,I"|A:预留
B:预留
C:键盘关机时间等级
D:心跳开关
E:键盘登录菜单
F:预留
G:键盘考勤发送次数
H:预留
I:键盘考勤发送功率| + +### 获取键盘登录菜单显示允许[S6适用] 函数名称:GetKeyboardLoginMenu 参数说明: @@ -2385,8 +3044,23 @@ extern"C" __declspec(dllexport) bool SetKeyboardLoginMenu( extern"C" __declspec(dllexport) bool GetKeyboardLoginMenu(UCHAR iBaseID); ``` +样例: +样例目的:获取键盘登录菜单显示允许 + +```C++ +GetKeyboardLoginMenu(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|202|基站特征参数| +|const char* sInfo|参数字符串|"A,B,C,D,E,F,G,H,I"|A:预留
B:预留
C:键盘关机时间等级
D:心跳开关
E:键盘登录菜单
F:预留
G:键盘考勤发送次数
H:预留
I:键盘考勤发送功率| + ## 键盘和基站之间开启或关闭心跳 -设置键盘和基站之间开启或关闭心跳 +### 设置键盘和基站之间开启或关闭心跳 函数名称:SetKeyboardHeartbeat 参数说明: @@ -2403,7 +3077,22 @@ extern"C" __declspec(dllexport) bool SetKeyboardHeartbeat( UCHAR OnOff); ``` -获取键盘和基站之间开启或关闭心跳 +样例: +样例目的:设置键盘和基站之间开启或关闭心跳 + +```C++ +SetKeyboardHeartbeat(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|202|基站特征参数| +|const char* sInfo|参数字符串|"A,B,C,D,E,F,G,H,I"|A:预留
B:预留
C:键盘关机时间等级
D:心跳开关
E:键盘登录菜单
F:预留
G:键盘考勤发送次数
H:预留
I:键盘考勤发送功率| + +### 获取键盘和基站之间开启或关闭心跳 函数名称:GetKeyboardHeartbeat 参数说明: @@ -2416,8 +3105,24 @@ extern"C" __declspec(dllexport) bool SetKeyboardHeartbeat( extern"C" __declspec(dllexport) bool GetKeyboardHeartbeat(UCHAR iBaseID); ``` +样例: +样例目的:获取键盘和基站之间开启或关闭心跳 + +```C++ +GetKeyboardHeartbeat(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|202|基站特征参数| +|const char* sInfo|参数字符串|"A,B,C,D,E,F,G,H,I"|A:预留
B:预留
C:键盘关机时间等级
D:心跳开关
E:键盘登录菜单
F:预留
G:键盘考勤发送次数
H:预留
I:键盘考勤发送功率| + + ## 键盘登录密码[S6适用] -设置键盘登录密码[S6适用] +### 设置键盘登录密码[S6适用] 函数名称:SetKeyboardLoginPW 参数说明: @@ -2434,21 +3139,51 @@ extern"C" __declspec(dllexport) bool SetKeyboardLoginPW( USHORT PW); ``` -获取键盘登录密码[S6适用] -函数名称:GetKeyboardLoginPW -参数说明: - -| **参数名称** | **参数说明** | **范围** | **备注** | -| --- | --- | --- | --- | -|UCHAR iBaseID|基站ID|0~32| +样例: +样例目的:设置键盘登录密码[S6适用] -接口代码: +```C++ +SetKeyboardLoginPW(1,1234); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|18|键盘登录密码| +|const char* sInfo|参数字符串|"1234"|键盘登录密码| + +### 获取键盘登录密码[S6适用] +函数名称:GetKeyboardLoginPW +参数说明: + +| **参数名称** | **参数说明** | **范围** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|0~32| + +接口代码: ```C++ extern"C" __declspec(dllexport) bool GetKeyboardLoginPW(UCHAR iBaseID); ``` +样例: +样例目的:设置键盘登录密码[S6适用] + +```C++ +GetKeyboardLoginPW(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|18|键盘登录密码| +|const char* sInfo|参数字符串|"1234"|键盘登录密码| + ## 基站手动登录开关 -设置基站手动登录开关 +### 设置基站手动登录开关 函数名称:SetDevBaseManualLogin 参数说明: @@ -2465,7 +3200,22 @@ extern"C" __declspec(dllexport) bool SetDevBaseManualLogin( UCHAR OnOff); ``` -获取基站手动登录开关 +样例: +样例目的:设置基站手动登录开关 + +```C++ +SetDevBaseManualLogin(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|19|基站手动登录开关| +|const char* sInfo|参数字符串|"1"|基站手动登录开关| + +### 获取基站手动登录开关 函数名称:GetDevBaseManualLogin 参数说明: @@ -2478,8 +3228,23 @@ extern"C" __declspec(dllexport) bool SetDevBaseManualLogin( extern"C" __declspec(dllexport) bool GetDevBaseManualLogin(UCHAR iBaseID); ``` +样例: +样例目的:获取基站手动登录开关 + +```C++ +GetDevBaseManualLogin(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|19|基站手动登录开关| +|const char* sInfo|参数字符串|"1"|基站手动登录开关| + ## 基站配套的语言 -设置基站配套的语言 +### 设置基站配套的语言 函数名称:SetDevLanguage 参数说明: @@ -2496,7 +3261,22 @@ extern"C" __declspec(dllexport) bool SetDevLanguage( UCHAR Language); ``` -获取基站配套的语言 +样例: +样例目的:设置基站配套的语言 + +```C++ +SetDevLanguage(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|21|基站配套的语言| +|const char* sInfo|参数字符串|"1"|中文| + +### 获取基站配套的语言 函数名称:GetDevLanguage 参数说明: @@ -2509,8 +3289,23 @@ extern"C" __declspec(dllexport) bool SetDevLanguage( extern"C" __declspec(dllexport) bool GetDevLanguage(UCHAR iBaseID); ``` +样例: +样例目的:获取基站配套的语言 + +```C++ +GetDevLanguage(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|21|基站配套的语言| +|const char* sInfo|参数字符串|"1"|中文| + ## 基站和键盘之间开启CRC -设置基站和键盘之间开启CRC +### 设置基站和键盘之间开启CRC 函数名称:SetDevCRC 参数说明: @@ -2527,7 +3322,22 @@ extern"C" __declspec(dllexport) bool SetDevCRC( UCHAR CRC); ``` -获取基站和键盘之间开启CRC +样例: +样例目的:设置基站和键盘之间开启CRC + +```C++ +SetDevCRC(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|22|基站和键盘之间开启CRC| +|const char* sInfo|参数字符串|"1"|开启| + +### 获取基站和键盘之间开启CRC 函数名称:GetDevCRC 参数说明: @@ -2540,8 +3350,23 @@ extern"C" __declspec(dllexport) bool SetDevCRC( extern"C" __declspec(dllexport) bool GetDevCRC(UCHAR iBaseID); ``` +样例: +样例目的:设置基站和键盘之间开启CRC + +```C++ +GetDevCRC(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|22|基站和键盘之间开启CRC| +|const char* sInfo|参数字符串|"1"|开启| + ## 基站软件狗功能 -设置基站软件狗密码[内部使用] +### 设置基站软件狗密码[内部使用] 函数名称:SetDevCRC 参数说明: @@ -2560,7 +3385,22 @@ extern"C" __declspec(dllexport) bool SetDevVotePW( char* buf); ``` -获取基站软件狗密码[内部使用] +样例: +样例目的:设置基站软件狗密码[内部使用] + +```C++ +SetDevVotePW(1,6,"123456"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|24|基站软件狗密码| +|const char* sInfo|参数字符串|"123456"|| + +### 获取基站软件狗密码[内部使用] 函数名称:GetDevVotePW 参数说明: @@ -2572,7 +3412,23 @@ extern"C" __declspec(dllexport) bool SetDevVotePW( ```C++ extern"C" __declspec(dllexport) bool GetDevVotePW(UCHAR iBaseID); ``` -校验基站软件狗密码 + +样例: +样例目的:获取基站软件狗密码[内部使用] + +```C++ +GetDevVotePW(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|24|基站软件狗密码| +|const char* sInfo|参数字符串|"123456"|| + +### 校验基站软件狗密码 函数名称:CheckDevVotePW 参数说明: @@ -2587,9 +3443,25 @@ extern"C" __declspec(dllexport) bool GetDevVotePW(UCHAR iBaseID); extern"C" __declspec(dllexport) bool CheckDevVotePW(UCHAR iBaseID, UCHAR Len, char* buf); ``` +样例: +样例目的:校验基站软件狗密码 + +```C++ +CheckDevVotePW(1,6,"123456"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|23|校验基站软件狗密码| +|const char* sInfo|参数字符串|"1"|核对通过| + + ## 基站用户自定字符串 -设置基站用户自定字符串 +### 设置基站用户自定字符串 函数名称:SetDevUserTxt 参数说明: @@ -2609,7 +3481,23 @@ extern"C" __declspec(dllexport) bool SetDevUserTxt( UCHAR Len, char* buf); ``` -获取基站用户自定字符串 + +样例: +样例目的:设置基站用户自定字符串 + +```C++ +SetDevUserTxt(1,1,6,"333444"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|25|基站用户自定字符串| +|const char* sInfo|参数字符串|"1,333444"|"序号,基站用户自定字符串"| + +### 获取基站用户自定字符串 函数名称:GetDevVotePW 参数说明: @@ -2623,8 +3511,23 @@ extern"C" __declspec(dllexport) bool SetDevUserTxt( extern"C" __declspec(dllexport) bool GetDevUserTxt(UCHAR iBaseID, UCHAR id); ``` +样例: +样例目的:获取基站用户自定字符串 + +```C++ +GetDevUserTxt(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|25|基站用户自定字符串| +|const char* sInfo|参数字符串|"1,333444"|"序号,基站用户自定字符串"| + ## 基站唯一硬件编号UID -获取基站唯一硬件编号UID +### 获取基站唯一硬件编号UID 函数名称:GetDevUID 参数说明: @@ -2636,9 +3539,24 @@ extern"C" __declspec(dllexport) bool GetDevUserTxt(UCHAR iBaseID, UCHAR id); ```C++ extern"C" __declspec(dllexport) bool GetDevUID(UCHAR iBaseID); ``` -## 基站反馈参数设置 -设置空闲模式-反馈参数设置 +样例: +样例目的:获取基站唯一硬件编号UID + +```C++ +GetDevUID(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|26|获取基站唯一硬件编号UID| +|const char* sInfo|参数字符串|"12345678"|| + +## 基站反馈参数设置 +### 设置空闲模式-反馈参数 函数名称:SetFeedbackMode 参数说明: @@ -2656,7 +3574,23 @@ extern"C" __declspec(dllexport) bool SetFeedbackMode( UCHAR Mode, UCHAR KeyValue); ``` -获取空闲模式-反馈参数设置 + +样例: +样例目的:设置空闲模式-反馈参数 + +```C++ +SetFeedbackMode(1,0,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|27|空闲模式-反馈参数| +|const char* sInfo|参数字符串|"0,1"|"模式,键值"| + +### 获取空闲模式-反馈参数 函数名称:GetFeedbackMode 参数说明: @@ -2670,9 +3604,23 @@ extern"C" __declspec(dllexport) bool SetFeedbackMode( extern"C" __declspec(dllexport) bool GetFeedbackMode(UCHAR iBaseID); ``` -## 基站SN +样例: +样例目的:获取空闲模式-反馈参数 + +```C++ +GetFeedbackMode(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|27|空闲模式-反馈参数| +|const char* sInfo|参数字符串|"0,1"|"模式,键值"| -设置基站SN +## 基站SN +### 设置基站SN 函数名称:SetDevBaseSn 参数说明: @@ -2681,14 +3629,29 @@ extern"C" __declspec(dllexport) bool GetFeedbackMode(UCHAR iBaseID); |UCHAR iBaseID|基站ID|0~32| |UCHAR SN[5]| 基站SN || - 接口代码: ```C++ extern"C" __declspec(dllexport) bool SetDevBaseSn( UCHAR iBaseID, UCHAR SN[5]); ``` -获取基站SN + +样例: +样例目的:设置基站SN + +```C++ +SetDevBaseSn(1,"1122334455"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|203|基站的型号、硬件版本、软件版本、设备SN号| +|const char* sInfo|参数字符串|"218;1;1.0.1;1112334455"|"基站的型号;硬件版本;软件版本;设备SN号"| + +### 获取基站SN 函数名称:GetDevBaseSn 参数说明: @@ -2701,8 +3664,23 @@ extern"C" __declspec(dllexport) bool SetDevBaseSn( extern"C" __declspec(dllexport) bool GetDevBaseSn(UCHAR iBaseID); ``` +样例: +样例目的:获取基站SN + +```C++ +GetDevBaseSn(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|203|基站的型号、硬件版本、软件版本、设备SN号| +|const char* sInfo|参数字符串|"218;1;1.0.1;1112334455"|"基站的型号;硬件版本;软件版本;设备SN号"| + ## 基站软件版本 -获取基站软件版本 +### 获取基站软件版本 函数名称:GetDevBaseVer 参数说明: @@ -2715,8 +3693,23 @@ extern"C" __declspec(dllexport) bool GetDevBaseSn(UCHAR iBaseID); extern"C" __declspec(dllexport) bool GetDevBaseVer(UCHAR iBaseID); ``` +样例: +样例目的:获取基站SN + +```C++ +GetDevBaseVer(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|203|基站的型号、硬件版本、软件版本、设备SN号| +|const char* sInfo|参数字符串|"218;1;1.0.1;1112334455"|"基站的型号;硬件版本;软件版本;设备SN号"| + ## 基站型号 -获取基站型号 +### 获取基站型号 函数名称:GetDevBaseModel 参数说明: @@ -2729,11 +3722,25 @@ extern"C" __declspec(dllexport) bool GetDevBaseVer(UCHAR iBaseID); extern"C" __declspec(dllexport) bool GetDevBaseModel(UCHAR iBaseID); ``` +样例: +样例目的:获取基站SN + +```C++ +GetDevBaseModel(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|203|基站的型号、硬件版本、软件版本、设备SN号| +|const char* sInfo|参数字符串|"218;1;1.0.1;1112334455"|"基站的型号;硬件版本;软件版本;设备SN号"| + ## 基站列表数量 -获取基站列表数量 +### 获取基站列表数量 函数名称:GetHidList_len -参数说明: - +返回参数: 当前SDK接入的在线设备数量 接口代码: ```C++ @@ -2741,39 +3748,71 @@ extern"C" __declspec(dllexport) int GetHidList_len(); ``` ## 快速配对模式时是否开启低功率模式 -获取基站快速配对模式时是否开启低功率模式 -函数名称:Get_QuickMatchPower +### 设置基站快速配对模式时是否开启低功率模式 +函数名称:Set_QuickMatchPower 参数说明: | **参数名称** | **参数说明** | **范围** | **备注** | | --- | --- | --- | --- | |UCHAR iBaseID|基站ID|0~32| +|UCHAR LoPower|低功率模式|0:不使用低功率模式
1:使用低功率模式| 接口代码: ```C++ -extern"C" __declspec(dllexport) bool Get_QuickMatchPower(UCHAR iBaseID); +extern"C" __declspec(dllexport) bool Set_QuickMatchPower( + UCHAR iBaseID, + UCHAR LoPower); ``` -设置基站快速配对模式时是否开启低功率模式 -函数名称:Set_QuickMatchPower +样例: +样例目的:设置基站快速配对模式时是否开启低功率模式 + +```C++ +Set_QuickMatchPower(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|16|| +|const char* sInfo|参数字符串|"1"|1:使用低功率模式| + +### 获取基站快速配对模式时是否开启低功率模式 +函数名称:Get_QuickMatchPower 参数说明: | **参数名称** | **参数说明** | **范围** | **备注** | | --- | --- | --- | --- | |UCHAR iBaseID|基站ID|0~32| -|UCHAR LoPower|低功率模式|0:不使用低功率模式
1:使用低功率模式| 接口代码: ```C++ -extern"C" __declspec(dllexport) bool Set_QuickMatchPower( - UCHAR iBaseID, - UCHAR LoPower); +extern"C" __declspec(dllexport) bool Get_QuickMatchPower(UCHAR iBaseID); ``` +样例: +样例目的:获取基站快速配对模式时是否开启低功率模式 + +```C++ +Get_QuickMatchPower(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|16|| +|const char* sInfo|参数字符串|"1"|1:使用低功率模式| + + + ## 基站刷卡 ### 设置NFC信息 姓名 设置设置NFC信息 姓名 -函数名称:Set_QuickMatchPower +函数名称:SetNFCinf 参数说明: | **参数名称** | **参数说明** | **范围** | **备注** | @@ -2790,6 +3829,21 @@ extern"C" __declspec(dllexport) bool SetNFCinf( char* Name); ``` +样例: +样例目的:设置NFC信息 姓名 + +```C++ +SetNFCinf(1,2,"张三"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|43|| +|const char* sInfo|参数字符串|"OK"|| + ### 设置NFC配对码 设置设置NFC配对码 函数名称:SetNFCmatchCode @@ -2821,9 +3875,40 @@ extern"C" __declspec(dllexport) bool SetNFCmatchCode( extern"C" __declspec(dllexport) bool SetNFC_Empty(UCHAR iBaseID); ``` +样例: +样例目的:设置设置NFC清除指令 + +```C++ +SetNFC_Empty(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|45|| +|const char* sInfo|参数字符串|"OK"|| + +### 键盘刷卡反馈数据[主动上报] + +样例: +样例目的:键盘刷卡反馈数据[主动上报] + +keyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0|无效| +|int mode|回调反馈数据模式|305|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"1,1"|"状态,键盘列表数量"| + ## 考勤基站参数 ### 考勤基站时钟 -设置考勤基站时钟 +#### 设置考勤基站时钟 函数名称:SetDevBaseDTime 参数说明: @@ -2843,7 +3928,22 @@ extern"C" __declspec(dllexport) bool SetDevBaseDTime( UCHAR SEC); ``` -获取考勤基站时钟 +样例: +样例目的:设置考勤基站时钟 1:1:1 + +```C++ +SetDevBaseDTime(1,01,01,01); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|36|| +|const char* sInfo|参数字符串|"1,1,1"|"1:1:1"| + +#### 获取考勤基站时钟 函数名称:GetDevBaseDTime 参数说明: @@ -2856,8 +3956,23 @@ extern"C" __declspec(dllexport) bool SetDevBaseDTime( extern"C" __declspec(dllexport) bool GetDevBaseDTime(UCHAR iBaseID); ``` +样例: +样例目的:获取考勤基站时钟 + +```C++ +GetDevBaseDTime(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|36|| +|const char* sInfo|参数字符串|"1,1,1"|"1:1:1"| + ### 键盘考勤发送次数 -设置键盘考勤发送次数 +#### 设置键盘考勤发送次数 函数名称:SetKeyboardAttendanceTimes 参数说明: @@ -2874,7 +3989,22 @@ extern"C" __declspec(dllexport) bool SetKeyboardAttendanceTimes( UCHAR Number); ``` -获取键盘考勤发送次数 +样例: +样例目的:设置键盘考勤发送次数 + +```C++ +SetKeyboardAttendanceTimes(1,3); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|37|| +|const char* sInfo|参数字符串|"3"|| + +#### 获取键盘考勤发送次数 函数名称:GetKeyboardAttendanceTimes 参数说明: @@ -2887,8 +4017,23 @@ extern"C" __declspec(dllexport) bool SetKeyboardAttendanceTimes( extern"C" __declspec(dllexport) bool GetKeyboardAttendanceTimes(UCHAR iBaseID); ``` +样例: +样例目的:获取键盘考勤发送次数 + +```C++ +GetKeyboardAttendanceTimes(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|37|| +|const char* sInfo|参数字符串|"3"|| + ### 键盘考勤发送功率 -设置键盘考勤发送功率 +#### 设置键盘考勤发送功率 函数名称:SetKeyboardAttendanceTimes 参数说明: @@ -2905,7 +4050,23 @@ extern"C" __declspec(dllexport) bool SetKeyboardAttendancePower( UCHAR Power); ``` -获取键盘考勤发送功率 +样例: +样例目的:设置键盘考勤发送功率 + +```C++ +SetKeyboardAttendancePower(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|38|| +|const char* sInfo|参数字符串|"1"|| + + +#### 获取键盘考勤发送功率 函数名称:GetKeyboardAttendancePower 参数说明: @@ -2918,6 +4079,21 @@ extern"C" __declspec(dllexport) bool SetKeyboardAttendancePower( extern"C" __declspec(dllexport) bool GetKeyboardAttendancePower(UCHAR iBaseID); ``` +样例: +样例目的:设置键盘考勤发送功率 + +```C++ +GetKeyboardAttendancePower(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|38|| +|const char* sInfo|参数字符串|"1"|| + ## 基站键盘名单 ### 设置键盘名单 函数名称:SetWhiteList