diff --git a/通讯协议-SDK_DLL部分[内部].md b/通讯协议-SDK_DLL部分[内部].md index 29f1d4f..19e7350 100644 --- a/通讯协议-SDK_DLL部分[内部].md +++ b/通讯协议-SDK_DLL部分[内部].md @@ -24,7 +24,7 @@ Ver5.1.1
-二〇二三年十月 +二〇二三年十一月

@@ -43,7 +43,7 @@ Ver5.1.1
| 文档版本 | 日期 | 作者 | 版本说明 | |---|---|---|---| -|5.1.1| 2023年10月09日|陈定敏|1. 初始版| +|5.1.1| 2023年11月30日|陈定敏|1. 初始版|
@@ -4111,6 +4111,33 @@ extern"C" __declspec(dllexport) bool SetWhiteList( const char* keylist); ``` +#### 样例: +样例目的:设置键盘名单 + +```C++ +SetWhiteList(1,"1837454011,1837454012"); // +``` + +B200 2.4G + S6 或 B100 2.4G + S6 + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|48|| +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| + +B200 5.8G + T2 + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|56|| +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| + ### 获取键盘名单 函数名称:GetWhiteList 参数说明: @@ -4124,6 +4151,21 @@ extern"C" __declspec(dllexport) bool SetWhiteList( extern"C" __declspec(dllexport) bool GetWhiteList(UCHAR iBaseID); ``` +#### 样例: +样例目的:获取键盘名单 + +```C++ +GetWhiteList(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|47|| +|const char* sInfo|参数字符串|"1837454011;1837454012"|"键盘SN1;键盘SN2"| + ### 删除键盘指定名单SN 函数名称:DelWhiteList 参数说明: @@ -4140,6 +4182,21 @@ extern"C" __declspec(dllexport) bool DelWhiteList( const char* keylist); ``` +#### 样例: +样例目的:删除键盘指定名单SN + +```C++ +DelWhiteList(1,"1837454011,1837454012"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|31|| +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| + ### 增加键盘指定名单SN 函数名称:AddWhiteList 参数说明: @@ -4156,6 +4213,33 @@ extern"C" __declspec(dllexport) bool AddWhiteList( const char* keylist); ``` +#### 样例: +样例目的:增加键盘指定名单SN + +```C++ +AddWhiteList(1,"1837454011,1837454012"); // +``` + +B200 2.4G + S6 或 B100 2.4G + S6 + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|48|| +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| + +B200 5.8G + T2 + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|56|| +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| + ### 清空键盘名单 函数名称:CleWhiteList 参数说明: @@ -4169,9 +4253,24 @@ extern"C" __declspec(dllexport) bool AddWhiteList( extern"C" __declspec(dllexport) bool CleWhiteList(UCHAR iBaseID); ``` +#### 样例: +样例目的:清空键盘名单 + +```C++ +CleWhiteList(1"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|32|| +|const char* sInfo|参数字符串|"1"|"状态"| + ## 基站Tcp参数 ### Tcp IP -设置基站Tcp IP地址 +#### 设置基站Tcp IP地址 函数名称:SetDevBase_Tcp_IP 参数说明: @@ -4188,7 +4287,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_IP( char* buf); ``` -获取基站Tcp IP地址 +样例: +样例目的:设置基站Tcp IP地址 + +```C++ +SetDevBase_Tcp_IP(1,"192.168.0.100"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"1;192.168.0.100"|"模式;参数"| + +#### 获取基站Tcp IP地址 函数名称:GetDevBase_Tcp_IP 参数说明: @@ -4202,7 +4316,7 @@ extern"C" __declspec(dllexport) bool GetDevBase_Tcp_IP(UCHAR iBaseID); ``` ### Tcp MAC -设置基站Tcp MAC地址 +#### 设置基站Tcp MAC地址 函数名称:SetDevBase_Tcp_mac 参数说明: @@ -4219,7 +4333,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mac( char* buf); ``` -获取基站Tcp MAC地址 +样例: +样例目的:设置基站Tcp MAC地址 + +```C++ +SetDevBase_Tcp_mac(1,"FF:FF:FF:FF:FF:FF"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"2;FF:FF:FF:FF:FF:FF"|"模式;参数"| + +#### 获取基站Tcp MAC地址 函数名称:GetDevBase_Tcp_mac 参数说明: @@ -4232,8 +4361,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mac( extern"C" __declspec(dllexport) bool GetDevBase_Tcp_mac(UCHAR iBaseID); ``` +样例: +样例目的:获取基站Tcp MAC地址 + +```C++ +GetDevBase_Tcp_mac(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"2;FF:FF:FF:FF:FF:FF"|"模式;参数"| + ### Tcp 子网掩码 -设置基站Tcp 子网掩码 +#### 设置基站Tcp 子网掩码 函数名称:SetDevBase_Tcp_mask 参数说明: @@ -4250,7 +4394,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mask( char* buf); ``` -获取基站Tcp 子网掩码 +样例: +样例目的:设置基站Tcp 子网掩码 + +```C++ +SetDevBase_Tcp_mask(1,"255.255.255.0"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"3;255.255.255.0"|"模式;参数"| + +#### 获取基站Tcp 子网掩码 函数名称:GetDevBase_Tcp_mask 参数说明: @@ -4263,8 +4422,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mask( extern"C" __declspec(dllexport) bool GetDevBase_Tcp_mask(UCHAR iBaseID); ``` +样例: +样例目的:获取基站Tcp 子网掩码 + +```C++ +GetDevBase_Tcp_mask(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"3;255.255.255.0"|"模式;参数"| + ### Tcp 网关 -设置基站Tcp 网关 +#### 设置基站Tcp 网关 函数名称:SetDevBase_Tcp_gateway 参数说明: @@ -4281,7 +4455,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_gateway( char* buf); ``` -获取基站Tcp 网关 +样例: +样例目的:设置基站Tcp 网关 + +```C++ +SetDevBase_Tcp_gateway(1,"192.168.10.1"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"4;192.168.10.1"|"模式;参数"| + + +#### 获取基站Tcp 网关 函数名称:GetDevBase_Tcp_gateway 参数说明: @@ -4294,8 +4484,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_gateway( extern"C" __declspec(dllexport) bool GetDevBase_Tcp_gateway(UCHAR iBaseID); ``` +样例: +样例目的:设置基站Tcp 网关 + +```C++ +GetDevBase_Tcp_gateway(1"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"4;192.168.10.1"|"模式;参数"| + ### Tcp DNS -设置基站Tcp DNS +#### 设置基站Tcp DNS 函数名称:SetDevBase_Tcp_dns 参数说明: @@ -4312,7 +4517,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_dns( char* buf); ``` -获取基站Tcp DNS +样例: +样例目的:设置基站Tcp DNS + +```C++ +SetDevBase_Tcp_dns(1,"114.114.114.114"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"5;114.114.114.114"|"模式;参数"| + +#### 获取基站Tcp DNS 函数名称:GetDevBase_Tcp_dns 参数说明: @@ -4325,8 +4545,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_dns( extern"C" __declspec(dllexport) bool GetDevBase_Tcp_dns(UCHAR iBaseID); ``` +样例: +样例目的:获取基站Tcp DNS + +```C++ +GetDevBase_Tcp_dns(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"5;114.114.114.114"|"模式;参数"| + ### 服务器 IP -设置服务器 IP +#### 设置服务器 IP 函数名称:SetServer_Tcp_IP 参数说明: @@ -4343,7 +4578,23 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_IP( char* buf); ``` -获取服务器 IP +样例: +样例目的:设置服务器 IP + +```C++ +SetServer_Tcp_IP(1,"210.98.10.124"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"6;210.98.10.124"|"模式;参数"| + + +#### 获取服务器 IP 函数名称:GetServer_Tcp_IP 参数说明: @@ -4356,8 +4607,23 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_IP( extern"C" __declspec(dllexport) bool GetServer_Tcp_IP(UCHAR iBaseID); ``` +样例: +样例目的:设置服务器 IP + +```C++ +GetServer_Tcp_IP(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"6;210.98.10.124"|"模式;参数"| + ### 服务器 DHCP和端口 -设置DHCP和端口 +#### 设置DHCP和端口 函数名称:SetServer_Tcp_Prot 参数说明: @@ -4376,7 +4642,22 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_Prot( ULONG Server_Port); ``` -获取DHCP和端口 +样例: +样例目的:设置DHCP和端口 + +```C++ +SetServer_Tcp_Prot(1,0,12000); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"7;0;12000"|"模式;DHCP模式;端口"| + +#### 获取DHCP和端口 函数名称:GetServer_Tcp_IP 参数说明: @@ -4389,8 +4670,23 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_Prot( extern"C" __declspec(dllexport) bool GetServer_Tcp_Prot(UCHAR iBaseID); ``` +样例: +样例目的:获取DHCP和端口 + +```C++ +GetServer_Tcp_Prot(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"7;0;12000"|"模式;DHCP模式;端口"| + ### 服务器 用户名 -设置服务器 用户名 +#### 设置服务器 用户名 函数名称:SetServer_UserName 参数说明: @@ -4407,7 +4703,22 @@ extern"C" __declspec(dllexport) bool SetServer_UserName( char* buf); ``` -获取服务器 用户名 +样例: +样例目的:获取服务器 用户名 + +```C++ +SetServer_UserName(1,"admin"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"8;admin"|"模式;参数"| + +#### 获取服务器 用户名 函数名称:GetServer_UserName 参数说明: @@ -4420,8 +4731,23 @@ extern"C" __declspec(dllexport) bool SetServer_UserName( extern"C" __declspec(dllexport) bool GetServer_UserName(UCHAR iBaseID); ``` +样例: +样例目的:获取服务器 用户名 + +```C++ +GetServer_UserName(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"8;admin"|"模式;参数"| + ### 服务器 密码 -设置服务器 密码 +#### 设置服务器 密码 函数名称:SetServer_UserPW 参数说明: @@ -4438,7 +4764,23 @@ extern"C" __declspec(dllexport) bool SetServer_UserPW( char* buf); ``` -获取服务器 密码 +样例: +样例目的:获取服务器 用户名 + +```C++ +SetServer_UserPW(1,"123456"); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"9;123456"|"模式;参数"| + + +#### 获取服务器 密码 函数名称:GetServer_UserPW 参数说明: @@ -4451,9 +4793,24 @@ extern"C" __declspec(dllexport) bool SetServer_UserPW( extern"C" __declspec(dllexport) bool GetServer_UserPW(UCHAR iBaseID); ``` +样例: +样例目的:获取服务器 用户名 + +```C++ +GetServer_UserPW(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|54|| +|const char* sInfo|参数字符串|"9;123456"|"模式;参数"| + ## AES参数 ### AES开关设置 -设置AES开关 +#### 设置AES开关 函数名称:SetAESPar 参数说明: @@ -4470,6 +4827,22 @@ extern"C" __declspec(dllexport) bool SetAESPar( UCHAR par); ``` +样例: +样例目的:设置AES开关 + +```C++ +SetAESPar(1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|55|| +|const char* sInfo|参数字符串|"1"|| + + 获取AES开关 函数名称:GetAESPar 参数说明: @@ -4483,6 +4856,21 @@ extern"C" __declspec(dllexport) bool SetAESPar( extern"C" __declspec(dllexport) bool GetAESPar(UCHAR iBaseID); ``` +样例: +样例目的:设置AES开关 + +```C++ +GetAESPar(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|55|| +|const char* sInfo|参数字符串|"1"|| + ### AES秘钥数据 设置秘钥数据 函数名称:SetAESData @@ -4533,8 +4921,8 @@ extern"C" __declspec(dllexport) bool CopyBaseAES( ``` ## 基站基础配置参数 -设置基础配置参数 -函数名称:SetAESData +### 设置基础配置参数 +函数名称:SetBasicSet 参数说明: | **参数名称** | **参数说明** | **范围** | **备注** | @@ -4554,8 +4942,23 @@ extern"C" __declspec(dllexport) bool SetBasicSet( char Led); ``` -获取基础配置参数 -函数名称:GetAESData +样例: +样例目的:设置基础配置参数 + +```C++ +SetBasicSet(1,1,1,1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|57|| +|const char* sInfo|参数字符串|"1;1;1"|"启动震动;答题开始震动;指示灯开关"| + +### 获取基础配置参数 +函数名称:GetBasicSet 参数说明: | **参数名称** | **参数说明** | **范围** | **备注** | @@ -4567,6 +4970,21 @@ extern"C" __declspec(dllexport) bool SetBasicSet( extern"C" __declspec(dllexport) bool GetBasicSet(UCHAR iBaseID); ``` +样例: +样例目的:设置基础配置参数 + +```C++ +GetBasicSet(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|57|| +|const char* sInfo|参数字符串|"1;1;1"|"启动震动;答题开始震动;指示灯开关"| + # 固件升级 ## 基站固件升级 基站固件升级 @@ -4585,7 +5003,39 @@ extern"C" __declspec(dllexport) bool DevBaseFirmwareUpdate( char *Path); ``` +样例: +样例目的:基站固件升级 + +```C++ +DevBaseFirmwareUpdate(1,"C:\123.bin"); // +``` + +开启状态反馈 +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|28|| +|const char* sInfo|参数字符串|"1,OK"|"开启升级;状态"| + +进度状态反馈 +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|28|| +|const char* sInfo|参数字符串|"2,100,50,OK"|"正在升级,总进度,当前进度;状态"| + +结束状态反馈 +HDParamCallBack 回调接口反馈数据解析: +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|28|| +|const char* sInfo|参数字符串|"3,OK"|"完成升级;状态"| ## 键盘固件升级 键盘固件升级 @@ -4604,6 +5054,40 @@ extern"C" __declspec(dllexport) bool KeyFirmwareUpdateStart( char* Path); ``` +样例: +样例目的:键盘固件升级 + +```C++ +KeyFirmwareUpdateStart(1,"C:\234.bin"); // +``` + +开启状态反馈 +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|30|| +|const char* sInfo|参数字符串|"11,OK"|"开启升级;状态"| + +进度状态反馈 +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|30|| +|const char* sInfo|参数字符串|"12,100,50,OK"|"正在升级,总进度,当前进度;状态"| + +结束状态反馈 +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|30|| +|const char* sInfo|参数字符串|"13,OK"|"完成升级;状态"| + 停止键盘固件升级 函数名称:KeyFirmwareUpdateStop 参数说明: @@ -4617,6 +5101,21 @@ extern"C" __declspec(dllexport) bool KeyFirmwareUpdateStart( extern"C" __declspec(dllexport) bool KeyFirmwareUpdateStop(UCHAR iBaseID); ``` +样例: +样例目的:停止键盘固件升级 + +```C++ +KeyFirmwareUpdateStop(1); // +``` + +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|30|| +|const char* sInfo|参数字符串|"13,OK"|"停止升级;状态"| + ## 异常处理 ### WSCmdApp收到数据异常