diff --git a/通讯协议-SDK_DLL部分[内部].md b/通讯协议-SDK_DLL部分[内部].md index 224e326..127546e 100644 --- a/通讯协议-SDK_DLL部分[内部].md +++ b/通讯协议-SDK_DLL部分[内部].md @@ -192,6 +192,8 @@ extern"C" __declspec(dllexport) void SetVoiceStreamEventCallBack(VoiceStreamEven extern"C" __declspec(dllexport) bool resetBase(UCHAR iBaseID); ``` +反馈效果:基站可以听到“滴”一声响,基站进入重启状态。 + ## 获取SDK Ver 函数名称:GetSDKVer 返回参数:字符串 @@ -201,7 +203,11 @@ extern"C" __declspec(dllexport) bool resetBase(UCHAR iBaseID); extern"C" __declspec(dllexport) char* GetSDKVer(); ``` +返回值:函数直接返回字符串。如“0.02.63.100”。 + ## 退出线程释放资源 +此函数在退出软件时用来是否DLL库开辟的内存资源,请谨慎使用。 + 函数名称:SetThread_Exit 接口代码: @@ -210,6 +216,8 @@ extern"C" __declspec(dllexport) void SetThread_Exit(void); //退出线程释放 ``` ## 获取基站列表 +此函数用来获取当前DLL连接了多少个基站设备。 + 函数名称:GetHidList_len 接口代码: @@ -217,8 +225,15 @@ extern"C" __declspec(dllexport) void SetThread_Exit(void); //退出线程释放 extern"C" __declspec(dllexport) int GetHidList_len(); ``` +返回值: +| **函数返回值** | **参数说明** | **备注** | +| --- | --- | --- | +|0|无连接基站|| +|大于0 |连接基站数量|| + # 投票业务部分 ## 设置广播投票是标题 + 函数名称:Set_Custom_Title 功能:设置广播投票是标题 说明:配合广播启动业务使用 @@ -237,6 +252,7 @@ extern"C" __declspec(dllexport) bool Set_Custom_Title( const char* Title); ``` + ## 设置空闲模式功能[广播] 函数名称:EndFreeEvent 功能:设置空闲模式功能[广播] @@ -247,6 +263,14 @@ extern"C" __declspec(dllexport) bool Set_Custom_Title( extern"C" __declspec(dllexport) bool EndFreeEvent(void); //空闲模式功能 ``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|0~32|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|0,OK|默认空闲模式切换成功| + ## 带参数进入空闲模式 函数名称:ExitEvent 功能:退出当前模式功能[广播] @@ -258,9 +282,18 @@ extern"C" __declspec(dllexport) bool EndFreeEvent(void); //空闲模式功能 接口代码: ```C++ -extern"C" __declspec(dllexport) bool ExitEvent(int mode_ID); //带参数进入空闲模式功能 +//带参数进入空闲模式功能 +extern"C" __declspec(dllexport) bool ExitEvent(int mode_ID); ``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|0~32|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|X,OK|X:mode_ID和对应
带参数空闲模式切换成功| + ## 签到 ### 签到功能[广播] 函数名称:Start_Sign_in_Event @@ -286,6 +319,45 @@ extern"C" __declspec(dllexport) bool Start_Sign_in_Event( int Moed5 = 0, int KeyValue=0); //开始签到功能 ``` +#### 启动样例: +目的:PIN签到模式,可以修改,可选项数6 +##### 启动功能部分: +```C++ +Set_Custom_Title(0, 3, "TXT"); //设置自定义标题 +Start_Sign_in_Event(2, 0, 0, 0, 6, 0); //开启pin模式签到 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|918|签到模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|1|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,1001,0,0"|"预留,按键值,预留,预留"| + +##### 退出功能部分: +```C++ +ExitEvent(1); //带签到模式退出签到 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"1,OK"|1:签到绑定带参数空闲模式切换成功| ### 签到功能[指定键盘SN] 函数名称:Start_Sign_in_Event_SN @@ -320,6 +392,48 @@ extern"C" __declspec(dllexport) bool Start_Sign_in_Event_SN( const char* Txt); //开始签到功能 ``` +#### 启动样例: +目的:PIN签到模式,可以修改,可选项数6 +##### 启动功能部分: +```C++ +//指定键盘开启pin模式签到,带自定义标题 +Start_Sign_in_Event_SN(0,1837454011,2, 0, 0, 0, 6, 0, 3, "TXT"); +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|918|签到模式| +|const char* sInfo|参数字符串|"OK"|成功| + +##### 接收按键数据部分: + +KeyEventCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **数据值** | **备注** | +| --- | --- | --- | --- | +|UCHAR iBaseID|基站ID|1|| +|unsigned long long keySn|键盘SN|1837454011|| +|float Time|反馈时间[秒]|0.5|| +|int mode|回调反馈数据模式|1|| +|int RxMode|预留|0|| +|const char* sInfo|回调反馈数据|"0,1001,0,0"|"预留,按键值,预留,预留"| + + +##### 退出功能部分: +```C++ +ExitEvent(1); //带签到模式切换到空闲模式 +``` +HDParamCallBack 回调接口反馈数据解析: + +| **参数名称** | **参数说明** | **解析** | **备注** | +| --- | --- | --- | --- | +|int iBaseID|基站ID|1|| +|int mode|模式|0|| +|const char* sInfo|参数字符串|"1,OK"|1:签到绑定带参数切换空闲模式成功| + + ## 数字题功能[广播] 函数名称:Start_Number_Event 功能:数字题功能[广播]