API-接口-设计文档-模板.docVIP

PAGE / NUMPAGES Dream调试工具DLL接口文档 文件状态： [√] 草 稿 [ ] 正式发布 [ ] 正在修改 当前版本： 1.0 作 者： ChunFeng Li 文件密级： [ ]普通 [√]秘密 [ ]绝密 文档版本 版本/状态 作者 参与者 日期 说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备,指令只能下发单条修改 DLL初始化 描述 调用所有接口之前需要先调用初始化接口。 接口名（dll导出名） Dream_Init() 请求参数说明 参数字段 必选 类型 限制 说明 _net_point True int 65535 Udp广播端口号 _com_rate True int 38400 连接串口的默认波特率 _call_back True Void* ... 异步消息回调（详细见第五条：回调函数） 返回参数说明 返回类型Int :0成功 -1重复初始化 获取最新设备列表 描述 调用该接口获取所有当前在线列表。 接口名（dll导出名） Dream_GetDeviceList() 请求参数说明 参数字段 必选 类型 限制 说明 char_buf True char* 1024 存放返回数据的内存指针,空间大小有调用方分配 buf_len True int 1024 分配的空间大小 返回参数说明 返回类型Int : 返回数据长度。 返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。[ID,Name\r\n]为一个设备,以后有跟多设备详细信息,往后接。 发送指令消息 描述 下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 接口名（dll导出名） Dream_SendAction() 请求参数说明 参数字段 必选 类型 限制 说明 device_id True int 1000 发送消息的设备ID例如1000 _ChannelCode True int 0-0xFF 通道编码：例如0x10 _FunctionCode True int 0-0xFF 效用编码,不同的编码对应不同的效用 _FunctionNumber True int 0-0xFF 效用编号,标记当前编码对应不同的效用 data_msg True char* 发送指令的data,没有数据为NULL,如果是单个数据：12.1,如果是整组数据：12.1,1,0, 按顺序逗号隔开的连续字符 time_out True int 20*N 接口调用超时时间,单位毫秒 out_buf True char* 存放返回数据的内存指针,空间大小有调用方分配 buf_max_len True int 分配的空间大小 返回参数说明 返回类型Int : 返回数据长度。如果为0,表示超时或网络异常 返回的数据结构：如果是下发数据,返回的是成功和失败；”ACK”,”NAK”,”NO_CMD”,”ERROR”,”TimeOut”,如果是读取数据,返回的是数据,例如12.1,或数据组12.1,12.2,1,1.2 DLL初始化 描述 下发数据和读取数据指令都通过该接口实现。(非阻塞方式调用函数) 接口名（dll导出名） Dream_SendAction() 请求参数说明 参数字段 必选 类型 限制 说明 device_id True int 1000 发送消息的设备ID例如1000 _ChannelCode True int 0-0xFF 通道编码：例如0x10 _FunctionCode True int 0-0xFF 效用编码,不同的编码对应不同的效用 _FunctionNumber True int 0-0xFF 效用编号,标记当前编码对应不同的效用 data_msg True char* 发送指令的data,没有数据为NULL,如果是单个数据：12.1,如果是整组数据：12.1,1,0, 按顺序逗号隔开的连续字符 返回参数说明 返回类型Int :数据为消息编号(Seq)。 回调函数 描述 异步消息收到后的回调,10秒内没有收到,会返回“TimeOut”数据 回调函数类型 intAsync_CallBack(int·_device_id,int·_seq,int·_ChannelCode,int·_FunctionCode,int·_FunctionNumber,char*·data_msg) 请求参数说明 参数字段 必选 类型 限制 说明 _device_id True int 1000 发送消息的设备ID例如1000 _seq True int 100 消息编号,与异步调用的返回值对应