API接口设计文档模板

Dream调试工具DLL接口文档文件状态：当前版本： 1.0 [√] 草稿作者： ChunFeng Li [ ] 正式发布 [ ] 正在修改文件密级： [ ]普通[√]秘密 [ ]绝密文档版本版本/状态作者参与者日期说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备，指令只能下发单条修改

一、DLL初始化 1.描述调用所有接口之前需要先调用初始化接口。 2.接口名（dll导出名） Dream_Init()

3.请求参数说明参数字段必选类型限制说明True int _net_point <65535 Udp广播端口号True int _com_rate 38400 连接串口的默认波特率True Void* _call_back ... 异步消息回调（详细见第五条：回调函数）

4.返回参数说明 a. 返回类型Int :0成功 -1重复初始化二、获取最新设备列表 1.描述调用该接口获取所有当前在线列表。 2.接口名（dll导出名）Dream_GetDeviceList() 3.请求参数说明

参数字段必选类型限制说明True char* char_buf 1024 存放返回数据的内存指针，空间大小有调用方分配 True int buf_len 1024 分配的空间大小 4.返回参数说明a. 返回类型Int : 返回数据长度。b. 返回数据

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

三、发送指令消息1.描述下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 2.接口名（dll导出名）

Dream_SendAction() 3.请求参数说明参数字段必选类型限制说明True int device_id >1000 发送消息的设备ID例如1000 True int _ChannelCode 0-0xFF 通道编码：例如

0x10 True int

_FunctionCode 0-0xFF 功能编码，不同的编码对应不同的功能 int True 0-0xFF 功能编号，标记当前编码对应不同的功能 _FunctionNumber char* True 发送指令的data，没有数据为NULL，

结

构:”1000,COM3\\r\\n1001,COM5\\r\\n1002,192.168.0.118\\r\\n”。

如data_msg 果是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开的连续字符 True int time_out 20*N 接口调用超时时间，单位毫秒 True char* out_buf 存放返回数据的内存指针，空间大小有调用方分配 True int buf_max_len 分配的空间大小 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.请求参数说明

参数字段必选类型限制说明True int device_id >1000 发送消息的设备ID例如1000 True int _ChannelCode 0-0xFF 通道编码：例如0x10 True int _FunctionCode 0-0xFF 功能编码，不同的编码对应不同的功能True int _FunctionNumber 0-0xFF 功能编号，标记当前编码对应不同的功能 True char* data_msg 发送指令的data，没有数据为NULL，如果

是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开的连续字符 4.返回参数说明 a. 返回类型Int :数据为消息编号(Seq)。五、回调函数 1.描述异步消息收到后的回调，10秒内没有收到，会返回

“TimeOut”

数

据

2.

回

调

函

数

类

型

intAsync_CallBack(int·_device_id,int·_seq,int·_ChannelCode,int·_F unctionCode,int·_FunctionNumber,char*·data_msg) 3.请求参数说明参数字段必选类型限制说明True int _device_id >1000 发送消息的设备ID例如1000 True int _seq >100 消息编号，与异步调用的返回值对应 True int _ChannelCode 0-0xFF 通道编码：例如0x10 True int _FunctionCode 0-0xFF 功能编码，不同的编码对应不同的功能True int _FunctionNumber 0-0xFF 功能编号，标记当前编码对应不同的功能 True char* data_msg 发送指令的data，没有数据为NULL，如果是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开

的连续字符 4.返回参数说明 a. 返回类型Int :0处理成功 -1处理失败