SDK开发指南

 产品使用指南

Windows SDK

Windows SDK 开发指南

1. 概述

SDK 使用C语言开发，可供C、C++、C#、JAVA等语言调用，兼容Windows 7、Windows8/8.1、Windows 10 主流Windows版本系统。接口一共4个API函数，集成简单，使用方便。

2. SDK下载

参数下载地址
C# Demo (源码)已包含DLL电信 联通
C# Demo (bin)运行环境 .NET Framework 4.0电信 联通
DLL电信 联通


3. API调用流程

3.1 准备工作

3.2 通讯


4. C# DEMO

DEMO 界面

Demo_CSharp

操作步骤

  • 在界面上方填入SDK账号，密码，点击OK。

  • 在Recv ID 输入接收数据的模块ID, 在Data内输入要发送的数据，点击send按钮即可发送。
    默认使用ASCII码发送，也可以更改位Hex发送。 Hex发送示例如下：

    Demo_CSharp

  • 在Recvive Data框内显示模块ID发送来的数据。


5. API Doc

Function: dkapi_set_userinfo - 设置SDK账号

函数原型

int dkapi_set_userinfo(char *user_id, char *user_pwd);

参数

参数描述
user_id传入SDK账号的ID 5开头的11位数字ID
user_pwd传入SDK账号的密码

返回值

返回值描述
-1失败
0成功
此处仅为设置，ID和密码在发送数据时才会去校验

代码示例

//回调函数
void _stdcall receive_data_callback(char *userid, char *data_buffer, int data_len)
{
	......
}

//设置回调函数
dkapi_set_recv_callback(receive_data_callback);



Function: dkapi_set_recv_callback - 设置接收数据的回调函数

函数原型

void dkapi_set_recv_callback(recv_data_callback callback);

参数

参数描述
recv_data_callback传入接收数据回调函数
函数类型 recv_data_callback

返回值

返回值描述
voidvoid

代码示例

//回调函数
void _stdcall receive_data_callback(char *userid, char *data_buffer, int data_len)
{
	......
}

//设置回调函数
dkapi_set_recv_callback(receive_data_callback);



Function: dkapi_send_data_t - 发送数据(有返回值)

函数原型

int dkapi_send_data_t(char *data, int data_len, char *dst_userid);

参数

参数描述
data[in]要发送的数据
data_len[in]数据的长度
dst_userid[in]模块ID指定要把数据发送给那个模块

返回值

返回值描述
0成功,数据已加入发送队列
10服务器连接中断
11被连接方不在线
12没有权限和对方通信，通信双方必须在一个组
13连接已过期
14发送数据超时，请重新发送数据
15和接收方连线超时，请重新发送数据
20发送的数据不正确
23接收方不在线 或 没有权限和对方通信
-1其它

代码示例

int ret = dkapi_send_data_t("Hello World!", 10, "9056840****");



Function: dkapi_send_data - 发送数据(无返回值)

函数原型

void dkapi_send_data(char *data, int data_len, char *str_dst_userid);

参数

参数描述
data[in]要发送的数据
data_len[in]数据的长度
dst_userid[in]模块ID指定要把数据发送给那个模块

返回值

返回值描述
voidvoid

代码示例

dkapi_send_data("Hello World!", 10, "9056840****");



Type: recv_data_callback - 回调函数的定义

函数原型

typedef void(_stdcall *recv_data_callback)(char *userid, char *data, int data_len);

参数

参数描述
userid[out]发送数据的ID模块ID、SDK账号ID
data[out]接收的数据
data_len[out]数据的长度`

返回值

返回值描述
voidvoid

代码示例

//回调函数
void _stdcall receive_data_callback(char *userid, char *data_buffer, int data_len)
{
	......
}

//设置回调函数
dkapi_set_recv_callback(receive_data_callback);