API 接口 设计文档 模板

Dream调试工具DLL接口文档

一、DLL初始化

1.描述

调用所有接口之前需要先调用初始化接口。

2.接口名（dll导出名）

Dream_Init()

4.返回参数说明

a.返回类型Int :0成功-1重复初始化

二、获取最新设备列表

1.描述

调用该接口获取所有当前在线列表。

2.接口名（dll导出名）

Dream_GetDeviceList()

3.请求参数说明

4.返回参数说明

a.返回类型Int : 返回数据长度。

b.返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。

[ID,Name\r\n]为一个设备，以后有跟多设备详细信息，往后接。

三、发送指令消息

1.描述

下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数)

2.接口名（dll导出名）

Dream_SendAction()

4.返回参数说明

a.返回类型Int : 返回数据长度。如果为0,表示超时或网络异常

b.返回的数据结构：如果是下发数据，返回的是成功和失

败；”ACK”,”NAK”,”NO_CMD”,”ERROR”,”TimeOut”,如果是读取数据，返回的是数据，

例如12.1，或数据组12.1,12.2,1,1.2.....

四、DLL初始化

1.描述

下发数据和读取数据指令都通过该接口实现。(非阻塞方式调用函数)

2.接口名（dll导出名）

Dream_SendAction()

3.请求参数说明

4.返回参数说明

a.返回类型Int :数据为消息编号(Seq)。

五、回调函数

1.描述

异步消息收到后的回调，10秒内没有收到，会返回“TimeOut”数据

2.回调函数类型

intAsync_CallBack(int·_device_id,int·_seq,int·_ChannelCode,int·_FunctionCode,int·_FunctionNumber,char*·data_msg)

4.返回参数说明

a.返回类型Int :0处理成功-1处理失败