Commit caf68b47acd3a245fc933db6f96f5f026fad19f7
1 parent
7fa6c735
1.SDK_DLL部分[内部] 初版完成
Showing
1 changed file
with
524 additions
and
25 deletions
通讯协议-SDK_DLL部分[内部].md
... | ... | @@ -24,7 +24,7 @@ Ver5.1.1 |
24 | 24 | <br> |
25 | 25 | |
26 | 26 | <div style="text-align: center;font-size: 30px;"> |
27 | -二〇二三年十月 | |
27 | +二〇二三年十一月 | |
28 | 28 | </div> |
29 | 29 | |
30 | 30 | <br> |
... | ... | @@ -43,7 +43,7 @@ Ver5.1.1 |
43 | 43 | <br> |
44 | 44 | | 文档版本 | 日期 | 作者 | 版本说明 | |
45 | 45 | |---|---|---|---| |
46 | -|5.1.1| 2023年10月09日|陈定敏|1. 初始版| | |
46 | +|5.1.1| 2023年11月30日|陈定敏|1. 初始版| | |
47 | 47 | |
48 | 48 | <br> |
49 | 49 | |
... | ... | @@ -4111,6 +4111,33 @@ extern"C" __declspec(dllexport) bool SetWhiteList( |
4111 | 4111 | const char* keylist); |
4112 | 4112 | ``` |
4113 | 4113 | |
4114 | +#### 样例: | |
4115 | +样例目的:设置键盘名单 | |
4116 | + | |
4117 | +```C++ | |
4118 | +SetWhiteList(1,"1837454011,1837454012"); // | |
4119 | +``` | |
4120 | + | |
4121 | +B200 2.4G + S6 或 B100 2.4G + S6 | |
4122 | + | |
4123 | +HDParamCallBack 回调接口反馈数据解析: | |
4124 | + | |
4125 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4126 | +| --- | --- | --- | --- | | |
4127 | +|int iBaseID|基站ID|1|| | |
4128 | +|int mode|模式|48|| | |
4129 | +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| | |
4130 | + | |
4131 | +B200 5.8G + T2 | |
4132 | + | |
4133 | +HDParamCallBack 回调接口反馈数据解析: | |
4134 | + | |
4135 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4136 | +| --- | --- | --- | --- | | |
4137 | +|int iBaseID|基站ID|1|| | |
4138 | +|int mode|模式|56|| | |
4139 | +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| | |
4140 | + | |
4114 | 4141 | ### 获取键盘名单 |
4115 | 4142 | 函数名称:GetWhiteList |
4116 | 4143 | 参数说明: |
... | ... | @@ -4124,6 +4151,21 @@ extern"C" __declspec(dllexport) bool SetWhiteList( |
4124 | 4151 | extern"C" __declspec(dllexport) bool GetWhiteList(UCHAR iBaseID); |
4125 | 4152 | ``` |
4126 | 4153 | |
4154 | +#### 样例: | |
4155 | +样例目的:获取键盘名单 | |
4156 | + | |
4157 | +```C++ | |
4158 | +GetWhiteList(1); // | |
4159 | +``` | |
4160 | + | |
4161 | +HDParamCallBack 回调接口反馈数据解析: | |
4162 | + | |
4163 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4164 | +| --- | --- | --- | --- | | |
4165 | +|int iBaseID|基站ID|1|| | |
4166 | +|int mode|模式|47|| | |
4167 | +|const char* sInfo|参数字符串|"1837454011;1837454012"|"键盘SN1;键盘SN2"| | |
4168 | + | |
4127 | 4169 | ### 删除键盘指定名单SN |
4128 | 4170 | 函数名称:DelWhiteList |
4129 | 4171 | 参数说明: |
... | ... | @@ -4140,6 +4182,21 @@ extern"C" __declspec(dllexport) bool DelWhiteList( |
4140 | 4182 | const char* keylist); |
4141 | 4183 | ``` |
4142 | 4184 | |
4185 | +#### 样例: | |
4186 | +样例目的:删除键盘指定名单SN | |
4187 | + | |
4188 | +```C++ | |
4189 | +DelWhiteList(1,"1837454011,1837454012"); // | |
4190 | +``` | |
4191 | + | |
4192 | +HDParamCallBack 回调接口反馈数据解析: | |
4193 | + | |
4194 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4195 | +| --- | --- | --- | --- | | |
4196 | +|int iBaseID|基站ID|1|| | |
4197 | +|int mode|模式|31|| | |
4198 | +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| | |
4199 | + | |
4143 | 4200 | ### 增加键盘指定名单SN |
4144 | 4201 | 函数名称:AddWhiteList |
4145 | 4202 | 参数说明: |
... | ... | @@ -4156,6 +4213,33 @@ extern"C" __declspec(dllexport) bool AddWhiteList( |
4156 | 4213 | const char* keylist); |
4157 | 4214 | ``` |
4158 | 4215 | |
4216 | +#### 样例: | |
4217 | +样例目的:增加键盘指定名单SN | |
4218 | + | |
4219 | +```C++ | |
4220 | +AddWhiteList(1,"1837454011,1837454012"); // | |
4221 | +``` | |
4222 | + | |
4223 | +B200 2.4G + S6 或 B100 2.4G + S6 | |
4224 | + | |
4225 | +HDParamCallBack 回调接口反馈数据解析: | |
4226 | + | |
4227 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4228 | +| --- | --- | --- | --- | | |
4229 | +|int iBaseID|基站ID|1|| | |
4230 | +|int mode|模式|48|| | |
4231 | +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| | |
4232 | + | |
4233 | +B200 5.8G + T2 | |
4234 | + | |
4235 | +HDParamCallBack 回调接口反馈数据解析: | |
4236 | + | |
4237 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4238 | +| --- | --- | --- | --- | | |
4239 | +|int iBaseID|基站ID|1|| | |
4240 | +|int mode|模式|56|| | |
4241 | +|const char* sInfo|参数字符串|"1837454011,1"|"键盘SN,状态"| | |
4242 | + | |
4159 | 4243 | ### 清空键盘名单 |
4160 | 4244 | 函数名称:CleWhiteList |
4161 | 4245 | 参数说明: |
... | ... | @@ -4169,9 +4253,24 @@ extern"C" __declspec(dllexport) bool AddWhiteList( |
4169 | 4253 | extern"C" __declspec(dllexport) bool CleWhiteList(UCHAR iBaseID); |
4170 | 4254 | ``` |
4171 | 4255 | |
4256 | +#### 样例: | |
4257 | +样例目的:清空键盘名单 | |
4258 | + | |
4259 | +```C++ | |
4260 | +CleWhiteList(1"); // | |
4261 | +``` | |
4262 | + | |
4263 | +HDParamCallBack 回调接口反馈数据解析: | |
4264 | + | |
4265 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4266 | +| --- | --- | --- | --- | | |
4267 | +|int iBaseID|基站ID|1|| | |
4268 | +|int mode|模式|32|| | |
4269 | +|const char* sInfo|参数字符串|"1"|"状态"| | |
4270 | + | |
4172 | 4271 | ## 基站Tcp参数 |
4173 | 4272 | ### Tcp IP |
4174 | -设置基站Tcp IP地址 | |
4273 | +#### 设置基站Tcp IP地址 | |
4175 | 4274 | 函数名称:SetDevBase_Tcp_IP |
4176 | 4275 | 参数说明: |
4177 | 4276 | |
... | ... | @@ -4188,7 +4287,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_IP( |
4188 | 4287 | char* buf); |
4189 | 4288 | ``` |
4190 | 4289 | |
4191 | -获取基站Tcp IP地址 | |
4290 | +样例: | |
4291 | +样例目的:设置基站Tcp IP地址 | |
4292 | + | |
4293 | +```C++ | |
4294 | +SetDevBase_Tcp_IP(1,"192.168.0.100"); // | |
4295 | +``` | |
4296 | + | |
4297 | +HDParamCallBack 回调接口反馈数据解析: | |
4298 | + | |
4299 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4300 | +| --- | --- | --- | --- | | |
4301 | +|int iBaseID|基站ID|1|| | |
4302 | +|int mode|模式|54|| | |
4303 | +|const char* sInfo|参数字符串|"1;192.168.0.100"|"模式;参数"| | |
4304 | + | |
4305 | +#### 获取基站Tcp IP地址 | |
4192 | 4306 | 函数名称:GetDevBase_Tcp_IP |
4193 | 4307 | 参数说明: |
4194 | 4308 | |
... | ... | @@ -4202,7 +4316,7 @@ extern"C" __declspec(dllexport) bool GetDevBase_Tcp_IP(UCHAR iBaseID); |
4202 | 4316 | ``` |
4203 | 4317 | |
4204 | 4318 | ### Tcp MAC |
4205 | -设置基站Tcp MAC地址 | |
4319 | +#### 设置基站Tcp MAC地址 | |
4206 | 4320 | 函数名称:SetDevBase_Tcp_mac |
4207 | 4321 | 参数说明: |
4208 | 4322 | |
... | ... | @@ -4219,7 +4333,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mac( |
4219 | 4333 | char* buf); |
4220 | 4334 | ``` |
4221 | 4335 | |
4222 | -获取基站Tcp MAC地址 | |
4336 | +样例: | |
4337 | +样例目的:设置基站Tcp MAC地址 | |
4338 | + | |
4339 | +```C++ | |
4340 | +SetDevBase_Tcp_mac(1,"FF:FF:FF:FF:FF:FF"); // | |
4341 | +``` | |
4342 | + | |
4343 | +HDParamCallBack 回调接口反馈数据解析: | |
4344 | + | |
4345 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4346 | +| --- | --- | --- | --- | | |
4347 | +|int iBaseID|基站ID|1|| | |
4348 | +|int mode|模式|54|| | |
4349 | +|const char* sInfo|参数字符串|"2;FF:FF:FF:FF:FF:FF"|"模式;参数"| | |
4350 | + | |
4351 | +#### 获取基站Tcp MAC地址 | |
4223 | 4352 | 函数名称:GetDevBase_Tcp_mac |
4224 | 4353 | 参数说明: |
4225 | 4354 | |
... | ... | @@ -4232,8 +4361,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mac( |
4232 | 4361 | extern"C" __declspec(dllexport) bool GetDevBase_Tcp_mac(UCHAR iBaseID); |
4233 | 4362 | ``` |
4234 | 4363 | |
4364 | +样例: | |
4365 | +样例目的:获取基站Tcp MAC地址 | |
4366 | + | |
4367 | +```C++ | |
4368 | +GetDevBase_Tcp_mac(1); // | |
4369 | +``` | |
4370 | + | |
4371 | +HDParamCallBack 回调接口反馈数据解析: | |
4372 | + | |
4373 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4374 | +| --- | --- | --- | --- | | |
4375 | +|int iBaseID|基站ID|1|| | |
4376 | +|int mode|模式|54|| | |
4377 | +|const char* sInfo|参数字符串|"2;FF:FF:FF:FF:FF:FF"|"模式;参数"| | |
4378 | + | |
4235 | 4379 | ### Tcp 子网掩码 |
4236 | -设置基站Tcp 子网掩码 | |
4380 | +#### 设置基站Tcp 子网掩码 | |
4237 | 4381 | 函数名称:SetDevBase_Tcp_mask |
4238 | 4382 | 参数说明: |
4239 | 4383 | |
... | ... | @@ -4250,7 +4394,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mask( |
4250 | 4394 | char* buf); |
4251 | 4395 | ``` |
4252 | 4396 | |
4253 | -获取基站Tcp 子网掩码 | |
4397 | +样例: | |
4398 | +样例目的:设置基站Tcp 子网掩码 | |
4399 | + | |
4400 | +```C++ | |
4401 | +SetDevBase_Tcp_mask(1,"255.255.255.0"); // | |
4402 | +``` | |
4403 | + | |
4404 | +HDParamCallBack 回调接口反馈数据解析: | |
4405 | + | |
4406 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4407 | +| --- | --- | --- | --- | | |
4408 | +|int iBaseID|基站ID|1|| | |
4409 | +|int mode|模式|54|| | |
4410 | +|const char* sInfo|参数字符串|"3;255.255.255.0"|"模式;参数"| | |
4411 | + | |
4412 | +#### 获取基站Tcp 子网掩码 | |
4254 | 4413 | 函数名称:GetDevBase_Tcp_mask |
4255 | 4414 | 参数说明: |
4256 | 4415 | |
... | ... | @@ -4263,8 +4422,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_mask( |
4263 | 4422 | extern"C" __declspec(dllexport) bool GetDevBase_Tcp_mask(UCHAR iBaseID); |
4264 | 4423 | ``` |
4265 | 4424 | |
4425 | +样例: | |
4426 | +样例目的:获取基站Tcp 子网掩码 | |
4427 | + | |
4428 | +```C++ | |
4429 | +GetDevBase_Tcp_mask(1); // | |
4430 | +``` | |
4431 | + | |
4432 | +HDParamCallBack 回调接口反馈数据解析: | |
4433 | + | |
4434 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4435 | +| --- | --- | --- | --- | | |
4436 | +|int iBaseID|基站ID|1|| | |
4437 | +|int mode|模式|54|| | |
4438 | +|const char* sInfo|参数字符串|"3;255.255.255.0"|"模式;参数"| | |
4439 | + | |
4266 | 4440 | ### Tcp 网关 |
4267 | -设置基站Tcp 网关 | |
4441 | +#### 设置基站Tcp 网关 | |
4268 | 4442 | 函数名称:SetDevBase_Tcp_gateway |
4269 | 4443 | 参数说明: |
4270 | 4444 | |
... | ... | @@ -4281,7 +4455,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_gateway( |
4281 | 4455 | char* buf); |
4282 | 4456 | ``` |
4283 | 4457 | |
4284 | -获取基站Tcp 网关 | |
4458 | +样例: | |
4459 | +样例目的:设置基站Tcp 网关 | |
4460 | + | |
4461 | +```C++ | |
4462 | +SetDevBase_Tcp_gateway(1,"192.168.10.1"); // | |
4463 | +``` | |
4464 | + | |
4465 | +HDParamCallBack 回调接口反馈数据解析: | |
4466 | + | |
4467 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4468 | +| --- | --- | --- | --- | | |
4469 | +|int iBaseID|基站ID|1|| | |
4470 | +|int mode|模式|54|| | |
4471 | +|const char* sInfo|参数字符串|"4;192.168.10.1"|"模式;参数"| | |
4472 | + | |
4473 | + | |
4474 | +#### 获取基站Tcp 网关 | |
4285 | 4475 | 函数名称:GetDevBase_Tcp_gateway |
4286 | 4476 | 参数说明: |
4287 | 4477 | |
... | ... | @@ -4294,8 +4484,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_gateway( |
4294 | 4484 | extern"C" __declspec(dllexport) bool GetDevBase_Tcp_gateway(UCHAR iBaseID); |
4295 | 4485 | ``` |
4296 | 4486 | |
4487 | +样例: | |
4488 | +样例目的:设置基站Tcp 网关 | |
4489 | + | |
4490 | +```C++ | |
4491 | +GetDevBase_Tcp_gateway(1"); // | |
4492 | +``` | |
4493 | + | |
4494 | +HDParamCallBack 回调接口反馈数据解析: | |
4495 | + | |
4496 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4497 | +| --- | --- | --- | --- | | |
4498 | +|int iBaseID|基站ID|1|| | |
4499 | +|int mode|模式|54|| | |
4500 | +|const char* sInfo|参数字符串|"4;192.168.10.1"|"模式;参数"| | |
4501 | + | |
4297 | 4502 | ### Tcp DNS |
4298 | -设置基站Tcp DNS | |
4503 | +#### 设置基站Tcp DNS | |
4299 | 4504 | 函数名称:SetDevBase_Tcp_dns |
4300 | 4505 | 参数说明: |
4301 | 4506 | |
... | ... | @@ -4312,7 +4517,22 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_dns( |
4312 | 4517 | char* buf); |
4313 | 4518 | ``` |
4314 | 4519 | |
4315 | -获取基站Tcp DNS | |
4520 | +样例: | |
4521 | +样例目的:设置基站Tcp DNS | |
4522 | + | |
4523 | +```C++ | |
4524 | +SetDevBase_Tcp_dns(1,"114.114.114.114"); // | |
4525 | +``` | |
4526 | + | |
4527 | +HDParamCallBack 回调接口反馈数据解析: | |
4528 | + | |
4529 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4530 | +| --- | --- | --- | --- | | |
4531 | +|int iBaseID|基站ID|1|| | |
4532 | +|int mode|模式|54|| | |
4533 | +|const char* sInfo|参数字符串|"5;114.114.114.114"|"模式;参数"| | |
4534 | + | |
4535 | +#### 获取基站Tcp DNS | |
4316 | 4536 | 函数名称:GetDevBase_Tcp_dns |
4317 | 4537 | 参数说明: |
4318 | 4538 | |
... | ... | @@ -4325,8 +4545,23 @@ extern"C" __declspec(dllexport) bool SetDevBase_Tcp_dns( |
4325 | 4545 | extern"C" __declspec(dllexport) bool GetDevBase_Tcp_dns(UCHAR iBaseID); |
4326 | 4546 | ``` |
4327 | 4547 | |
4548 | +样例: | |
4549 | +样例目的:获取基站Tcp DNS | |
4550 | + | |
4551 | +```C++ | |
4552 | +GetDevBase_Tcp_dns(1); // | |
4553 | +``` | |
4554 | + | |
4555 | +HDParamCallBack 回调接口反馈数据解析: | |
4556 | + | |
4557 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4558 | +| --- | --- | --- | --- | | |
4559 | +|int iBaseID|基站ID|1|| | |
4560 | +|int mode|模式|54|| | |
4561 | +|const char* sInfo|参数字符串|"5;114.114.114.114"|"模式;参数"| | |
4562 | + | |
4328 | 4563 | ### 服务器 IP |
4329 | -设置服务器 IP | |
4564 | +#### 设置服务器 IP | |
4330 | 4565 | 函数名称:SetServer_Tcp_IP |
4331 | 4566 | 参数说明: |
4332 | 4567 | |
... | ... | @@ -4343,7 +4578,23 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_IP( |
4343 | 4578 | char* buf); |
4344 | 4579 | ``` |
4345 | 4580 | |
4346 | -获取服务器 IP | |
4581 | +样例: | |
4582 | +样例目的:设置服务器 IP | |
4583 | + | |
4584 | +```C++ | |
4585 | +SetServer_Tcp_IP(1,"210.98.10.124"); // | |
4586 | +``` | |
4587 | + | |
4588 | +HDParamCallBack 回调接口反馈数据解析: | |
4589 | + | |
4590 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4591 | +| --- | --- | --- | --- | | |
4592 | +|int iBaseID|基站ID|1|| | |
4593 | +|int mode|模式|54|| | |
4594 | +|const char* sInfo|参数字符串|"6;210.98.10.124"|"模式;参数"| | |
4595 | + | |
4596 | + | |
4597 | +#### 获取服务器 IP | |
4347 | 4598 | 函数名称:GetServer_Tcp_IP |
4348 | 4599 | 参数说明: |
4349 | 4600 | |
... | ... | @@ -4356,8 +4607,23 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_IP( |
4356 | 4607 | extern"C" __declspec(dllexport) bool GetServer_Tcp_IP(UCHAR iBaseID); |
4357 | 4608 | ``` |
4358 | 4609 | |
4610 | +样例: | |
4611 | +样例目的:设置服务器 IP | |
4612 | + | |
4613 | +```C++ | |
4614 | +GetServer_Tcp_IP(1); // | |
4615 | +``` | |
4616 | + | |
4617 | +HDParamCallBack 回调接口反馈数据解析: | |
4618 | + | |
4619 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4620 | +| --- | --- | --- | --- | | |
4621 | +|int iBaseID|基站ID|1|| | |
4622 | +|int mode|模式|54|| | |
4623 | +|const char* sInfo|参数字符串|"6;210.98.10.124"|"模式;参数"| | |
4624 | + | |
4359 | 4625 | ### 服务器 DHCP和端口 |
4360 | -设置DHCP和端口 | |
4626 | +#### 设置DHCP和端口 | |
4361 | 4627 | 函数名称:SetServer_Tcp_Prot |
4362 | 4628 | 参数说明: |
4363 | 4629 | |
... | ... | @@ -4376,7 +4642,22 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_Prot( |
4376 | 4642 | ULONG Server_Port); |
4377 | 4643 | ``` |
4378 | 4644 | |
4379 | -获取DHCP和端口 | |
4645 | +样例: | |
4646 | +样例目的:设置DHCP和端口 | |
4647 | + | |
4648 | +```C++ | |
4649 | +SetServer_Tcp_Prot(1,0,12000); // | |
4650 | +``` | |
4651 | + | |
4652 | +HDParamCallBack 回调接口反馈数据解析: | |
4653 | + | |
4654 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4655 | +| --- | --- | --- | --- | | |
4656 | +|int iBaseID|基站ID|1|| | |
4657 | +|int mode|模式|54|| | |
4658 | +|const char* sInfo|参数字符串|"7;0;12000"|"模式;DHCP模式;端口"| | |
4659 | + | |
4660 | +#### 获取DHCP和端口 | |
4380 | 4661 | 函数名称:GetServer_Tcp_IP |
4381 | 4662 | 参数说明: |
4382 | 4663 | |
... | ... | @@ -4389,8 +4670,23 @@ extern"C" __declspec(dllexport) bool SetServer_Tcp_Prot( |
4389 | 4670 | extern"C" __declspec(dllexport) bool GetServer_Tcp_Prot(UCHAR iBaseID); |
4390 | 4671 | ``` |
4391 | 4672 | |
4673 | +样例: | |
4674 | +样例目的:获取DHCP和端口 | |
4675 | + | |
4676 | +```C++ | |
4677 | +GetServer_Tcp_Prot(1); // | |
4678 | +``` | |
4679 | + | |
4680 | +HDParamCallBack 回调接口反馈数据解析: | |
4681 | + | |
4682 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4683 | +| --- | --- | --- | --- | | |
4684 | +|int iBaseID|基站ID|1|| | |
4685 | +|int mode|模式|54|| | |
4686 | +|const char* sInfo|参数字符串|"7;0;12000"|"模式;DHCP模式;端口"| | |
4687 | + | |
4392 | 4688 | ### 服务器 用户名 |
4393 | -设置服务器 用户名 | |
4689 | +#### 设置服务器 用户名 | |
4394 | 4690 | 函数名称:SetServer_UserName |
4395 | 4691 | 参数说明: |
4396 | 4692 | |
... | ... | @@ -4407,7 +4703,22 @@ extern"C" __declspec(dllexport) bool SetServer_UserName( |
4407 | 4703 | char* buf); |
4408 | 4704 | ``` |
4409 | 4705 | |
4410 | -获取服务器 用户名 | |
4706 | +样例: | |
4707 | +样例目的:获取服务器 用户名 | |
4708 | + | |
4709 | +```C++ | |
4710 | +SetServer_UserName(1,"admin"); // | |
4711 | +``` | |
4712 | + | |
4713 | +HDParamCallBack 回调接口反馈数据解析: | |
4714 | + | |
4715 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4716 | +| --- | --- | --- | --- | | |
4717 | +|int iBaseID|基站ID|1|| | |
4718 | +|int mode|模式|54|| | |
4719 | +|const char* sInfo|参数字符串|"8;admin"|"模式;参数"| | |
4720 | + | |
4721 | +#### 获取服务器 用户名 | |
4411 | 4722 | 函数名称:GetServer_UserName |
4412 | 4723 | 参数说明: |
4413 | 4724 | |
... | ... | @@ -4420,8 +4731,23 @@ extern"C" __declspec(dllexport) bool SetServer_UserName( |
4420 | 4731 | extern"C" __declspec(dllexport) bool GetServer_UserName(UCHAR iBaseID); |
4421 | 4732 | ``` |
4422 | 4733 | |
4734 | +样例: | |
4735 | +样例目的:获取服务器 用户名 | |
4736 | + | |
4737 | +```C++ | |
4738 | +GetServer_UserName(1); // | |
4739 | +``` | |
4740 | + | |
4741 | +HDParamCallBack 回调接口反馈数据解析: | |
4742 | + | |
4743 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4744 | +| --- | --- | --- | --- | | |
4745 | +|int iBaseID|基站ID|1|| | |
4746 | +|int mode|模式|54|| | |
4747 | +|const char* sInfo|参数字符串|"8;admin"|"模式;参数"| | |
4748 | + | |
4423 | 4749 | ### 服务器 密码 |
4424 | -设置服务器 密码 | |
4750 | +#### 设置服务器 密码 | |
4425 | 4751 | 函数名称:SetServer_UserPW |
4426 | 4752 | 参数说明: |
4427 | 4753 | |
... | ... | @@ -4438,7 +4764,23 @@ extern"C" __declspec(dllexport) bool SetServer_UserPW( |
4438 | 4764 | char* buf); |
4439 | 4765 | ``` |
4440 | 4766 | |
4441 | -获取服务器 密码 | |
4767 | +样例: | |
4768 | +样例目的:获取服务器 用户名 | |
4769 | + | |
4770 | +```C++ | |
4771 | +SetServer_UserPW(1,"123456"); // | |
4772 | +``` | |
4773 | + | |
4774 | +HDParamCallBack 回调接口反馈数据解析: | |
4775 | + | |
4776 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4777 | +| --- | --- | --- | --- | | |
4778 | +|int iBaseID|基站ID|1|| | |
4779 | +|int mode|模式|54|| | |
4780 | +|const char* sInfo|参数字符串|"9;123456"|"模式;参数"| | |
4781 | + | |
4782 | + | |
4783 | +#### 获取服务器 密码 | |
4442 | 4784 | 函数名称:GetServer_UserPW |
4443 | 4785 | 参数说明: |
4444 | 4786 | |
... | ... | @@ -4451,9 +4793,24 @@ extern"C" __declspec(dllexport) bool SetServer_UserPW( |
4451 | 4793 | extern"C" __declspec(dllexport) bool GetServer_UserPW(UCHAR iBaseID); |
4452 | 4794 | ``` |
4453 | 4795 | |
4796 | +样例: | |
4797 | +样例目的:获取服务器 用户名 | |
4798 | + | |
4799 | +```C++ | |
4800 | +GetServer_UserPW(1); // | |
4801 | +``` | |
4802 | + | |
4803 | +HDParamCallBack 回调接口反馈数据解析: | |
4804 | + | |
4805 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4806 | +| --- | --- | --- | --- | | |
4807 | +|int iBaseID|基站ID|1|| | |
4808 | +|int mode|模式|54|| | |
4809 | +|const char* sInfo|参数字符串|"9;123456"|"模式;参数"| | |
4810 | + | |
4454 | 4811 | ## AES参数 |
4455 | 4812 | ### AES开关设置 |
4456 | -设置AES开关 | |
4813 | +#### 设置AES开关 | |
4457 | 4814 | 函数名称:SetAESPar |
4458 | 4815 | 参数说明: |
4459 | 4816 | |
... | ... | @@ -4470,6 +4827,22 @@ extern"C" __declspec(dllexport) bool SetAESPar( |
4470 | 4827 | UCHAR par); |
4471 | 4828 | ``` |
4472 | 4829 | |
4830 | +样例: | |
4831 | +样例目的:设置AES开关 | |
4832 | + | |
4833 | +```C++ | |
4834 | +SetAESPar(1,1); // | |
4835 | +``` | |
4836 | + | |
4837 | +HDParamCallBack 回调接口反馈数据解析: | |
4838 | + | |
4839 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4840 | +| --- | --- | --- | --- | | |
4841 | +|int iBaseID|基站ID|1|| | |
4842 | +|int mode|模式|55|| | |
4843 | +|const char* sInfo|参数字符串|"1"|| | |
4844 | + | |
4845 | + | |
4473 | 4846 | 获取AES开关 |
4474 | 4847 | 函数名称:GetAESPar |
4475 | 4848 | 参数说明: |
... | ... | @@ -4483,6 +4856,21 @@ extern"C" __declspec(dllexport) bool SetAESPar( |
4483 | 4856 | extern"C" __declspec(dllexport) bool GetAESPar(UCHAR iBaseID); |
4484 | 4857 | ``` |
4485 | 4858 | |
4859 | +样例: | |
4860 | +样例目的:设置AES开关 | |
4861 | + | |
4862 | +```C++ | |
4863 | +GetAESPar(1); // | |
4864 | +``` | |
4865 | + | |
4866 | +HDParamCallBack 回调接口反馈数据解析: | |
4867 | + | |
4868 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4869 | +| --- | --- | --- | --- | | |
4870 | +|int iBaseID|基站ID|1|| | |
4871 | +|int mode|模式|55|| | |
4872 | +|const char* sInfo|参数字符串|"1"|| | |
4873 | + | |
4486 | 4874 | ### AES秘钥数据 |
4487 | 4875 | 设置秘钥数据 |
4488 | 4876 | 函数名称:SetAESData |
... | ... | @@ -4533,8 +4921,8 @@ extern"C" __declspec(dllexport) bool CopyBaseAES( |
4533 | 4921 | ``` |
4534 | 4922 | |
4535 | 4923 | ## 基站基础配置参数 |
4536 | -设置基础配置参数 | |
4537 | -函数名称:SetAESData | |
4924 | +### 设置基础配置参数 | |
4925 | +函数名称:SetBasicSet | |
4538 | 4926 | 参数说明: |
4539 | 4927 | |
4540 | 4928 | | **参数名称** | **参数说明** | **范围** | **备注** | |
... | ... | @@ -4554,8 +4942,23 @@ extern"C" __declspec(dllexport) bool SetBasicSet( |
4554 | 4942 | char Led); |
4555 | 4943 | ``` |
4556 | 4944 | |
4557 | -获取基础配置参数 | |
4558 | -函数名称:GetAESData | |
4945 | +样例: | |
4946 | +样例目的:设置基础配置参数 | |
4947 | + | |
4948 | +```C++ | |
4949 | +SetBasicSet(1,1,1,1); // | |
4950 | +``` | |
4951 | + | |
4952 | +HDParamCallBack 回调接口反馈数据解析: | |
4953 | + | |
4954 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4955 | +| --- | --- | --- | --- | | |
4956 | +|int iBaseID|基站ID|1|| | |
4957 | +|int mode|模式|57|| | |
4958 | +|const char* sInfo|参数字符串|"1;1;1"|"启动震动;答题开始震动;指示灯开关"| | |
4959 | + | |
4960 | +### 获取基础配置参数 | |
4961 | +函数名称:GetBasicSet | |
4559 | 4962 | 参数说明: |
4560 | 4963 | |
4561 | 4964 | | **参数名称** | **参数说明** | **范围** | **备注** | |
... | ... | @@ -4567,6 +4970,21 @@ extern"C" __declspec(dllexport) bool SetBasicSet( |
4567 | 4970 | extern"C" __declspec(dllexport) bool GetBasicSet(UCHAR iBaseID); |
4568 | 4971 | ``` |
4569 | 4972 | |
4973 | +样例: | |
4974 | +样例目的:设置基础配置参数 | |
4975 | + | |
4976 | +```C++ | |
4977 | +GetBasicSet(1); // | |
4978 | +``` | |
4979 | + | |
4980 | +HDParamCallBack 回调接口反馈数据解析: | |
4981 | + | |
4982 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
4983 | +| --- | --- | --- | --- | | |
4984 | +|int iBaseID|基站ID|1|| | |
4985 | +|int mode|模式|57|| | |
4986 | +|const char* sInfo|参数字符串|"1;1;1"|"启动震动;答题开始震动;指示灯开关"| | |
4987 | + | |
4570 | 4988 | # 固件升级 |
4571 | 4989 | ## 基站固件升级 |
4572 | 4990 | 基站固件升级 |
... | ... | @@ -4585,7 +5003,39 @@ extern"C" __declspec(dllexport) bool DevBaseFirmwareUpdate( |
4585 | 5003 | char *Path); |
4586 | 5004 | ``` |
4587 | 5005 | |
5006 | +样例: | |
5007 | +样例目的:基站固件升级 | |
5008 | + | |
5009 | +```C++ | |
5010 | +DevBaseFirmwareUpdate(1,"C:\123.bin"); // | |
5011 | +``` | |
5012 | + | |
5013 | +开启状态反馈 | |
5014 | +HDParamCallBack 回调接口反馈数据解析: | |
5015 | + | |
5016 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
5017 | +| --- | --- | --- | --- | | |
5018 | +|int iBaseID|基站ID|1|| | |
5019 | +|int mode|模式|28|| | |
5020 | +|const char* sInfo|参数字符串|"1,OK"|"开启升级;状态"| | |
5021 | + | |
5022 | +进度状态反馈 | |
5023 | +HDParamCallBack 回调接口反馈数据解析: | |
5024 | + | |
5025 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
5026 | +| --- | --- | --- | --- | | |
5027 | +|int iBaseID|基站ID|1|| | |
5028 | +|int mode|模式|28|| | |
5029 | +|const char* sInfo|参数字符串|"2,100,50,OK"|"正在升级,总进度,当前进度;状态"| | |
5030 | + | |
5031 | +结束状态反馈 | |
5032 | +HDParamCallBack 回调接口反馈数据解析: | |
4588 | 5033 | |
5034 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
5035 | +| --- | --- | --- | --- | | |
5036 | +|int iBaseID|基站ID|1|| | |
5037 | +|int mode|模式|28|| | |
5038 | +|const char* sInfo|参数字符串|"3,OK"|"完成升级;状态"| | |
4589 | 5039 | |
4590 | 5040 | ## 键盘固件升级 |
4591 | 5041 | 键盘固件升级 |
... | ... | @@ -4604,6 +5054,40 @@ extern"C" __declspec(dllexport) bool KeyFirmwareUpdateStart( |
4604 | 5054 | char* Path); |
4605 | 5055 | ``` |
4606 | 5056 | |
5057 | +样例: | |
5058 | +样例目的:键盘固件升级 | |
5059 | + | |
5060 | +```C++ | |
5061 | +KeyFirmwareUpdateStart(1,"C:\234.bin"); // | |
5062 | +``` | |
5063 | + | |
5064 | +开启状态反馈 | |
5065 | +HDParamCallBack 回调接口反馈数据解析: | |
5066 | + | |
5067 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
5068 | +| --- | --- | --- | --- | | |
5069 | +|int iBaseID|基站ID|1|| | |
5070 | +|int mode|模式|30|| | |
5071 | +|const char* sInfo|参数字符串|"11,OK"|"开启升级;状态"| | |
5072 | + | |
5073 | +进度状态反馈 | |
5074 | +HDParamCallBack 回调接口反馈数据解析: | |
5075 | + | |
5076 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
5077 | +| --- | --- | --- | --- | | |
5078 | +|int iBaseID|基站ID|1|| | |
5079 | +|int mode|模式|30|| | |
5080 | +|const char* sInfo|参数字符串|"12,100,50,OK"|"正在升级,总进度,当前进度;状态"| | |
5081 | + | |
5082 | +结束状态反馈 | |
5083 | +HDParamCallBack 回调接口反馈数据解析: | |
5084 | + | |
5085 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
5086 | +| --- | --- | --- | --- | | |
5087 | +|int iBaseID|基站ID|1|| | |
5088 | +|int mode|模式|30|| | |
5089 | +|const char* sInfo|参数字符串|"13,OK"|"完成升级;状态"| | |
5090 | + | |
4607 | 5091 | 停止键盘固件升级 |
4608 | 5092 | 函数名称:KeyFirmwareUpdateStop |
4609 | 5093 | 参数说明: |
... | ... | @@ -4617,6 +5101,21 @@ extern"C" __declspec(dllexport) bool KeyFirmwareUpdateStart( |
4617 | 5101 | extern"C" __declspec(dllexport) bool KeyFirmwareUpdateStop(UCHAR iBaseID); |
4618 | 5102 | ``` |
4619 | 5103 | |
5104 | +样例: | |
5105 | +样例目的:停止键盘固件升级 | |
5106 | + | |
5107 | +```C++ | |
5108 | +KeyFirmwareUpdateStop(1); // | |
5109 | +``` | |
5110 | + | |
5111 | +HDParamCallBack 回调接口反馈数据解析: | |
5112 | + | |
5113 | +| **参数名称** | **参数说明** | **解析** | **备注** | | |
5114 | +| --- | --- | --- | --- | | |
5115 | +|int iBaseID|基站ID|1|| | |
5116 | +|int mode|模式|30|| | |
5117 | +|const char* sInfo|参数字符串|"13,OK"|"停止升级;状态"| | |
5118 | + | |
4620 | 5119 | ## 异常处理 |
4621 | 5120 | |
4622 | 5121 | ### WSCmdApp收到数据异常 | ... | ... |