API 接口 设计文档 模板

整理文档很辛苦,赏杯茶钱您下走!

免费阅读已结束,点击下载阅读编辑剩下 ...

阅读已结束,您可以下载文档离线阅读编辑

资源描述

Dream调试工具DLL接口文档文件状态:[√]草稿[]正式发布[]正在修改当前版本:1.0作者:ChunFengLi文件密级:[]普通[√]秘密[]绝密文档版本版本/状态作者参与者日期说明1.0ChunFengLiChunFengLi2016-04-13设备只能发现串口连接的设备,指令只能下发单条修改一、DLL初始化1.描述调用所有接口之前需要先调用初始化接口。2.接口名(dll导出名)Dream_Init()3.请求参数说明参数字段必选类型限制说明_net_pointTrueint65535Udp广播端口号_com_rateTrueint38400连接串口的默认波特率_call_backTrueVoid*...异步消息回调(详细见第五条:回调函数)4.返回参数说明a.返回类型Int:0成功-1重复初始化二、获取最新设备列表1.描述调用该接口获取所有当前在线列表。2.接口名(dll导出名)Dream_GetDeviceList()3.请求参数说明参数字段必选类型限制说明char_bufTruechar*1024存放返回数据的内存指针,空间大小有调用方分配buf_lenTrueint1024分配的空间大小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()3.请求参数说明参数字段必选类型限制说明device_idTrueint1000发送消息的设备ID例如1000_ChannelCodeTrueint0-0xFF通道编码:例如0x10_FunctionCodeTrueint0-0xFF功能编码,不同的编码对应不同的功能_FunctionNumberTrueint0-0xFF功能编号,标记当前编码对应不同的功能data_msgTruechar*发送指令的data,没有数据为NULL,如果是单个数据:12.1,如果是整组数据:12.1,1,0,......按顺序逗号隔开的连续字符time_outTrueint20*N接口调用超时时间,单位毫秒out_bufTruechar*存放返回数据的内存指针,空间大小有调用方分配buf_max_lenTrueint分配的空间大小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.请求参数说明参数字段必选类型限制说明device_idTrueint1000发送消息的设备ID例如1000_ChannelCodeTrueint0-0xFF通道编码:例如0x10_FunctionCodeTrueint0-0xFF功能编码,不同的编码对应不同的功能_FunctionNumberTrueint0-0xFF功能编号,标记当前编码对应不同的功能data_msgTruechar*发送指令的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·_FunctionCode,int·_FunctionNumber,char*·data_msg)3.请求参数说明参数字段必选类型限制说明_device_idTrueint1000发送消息的设备ID例如1000_seqTrueint100消息编号,与异步调用的返回值对应_ChannelCodeTrueint0-0xFF通道编码:例如0x10_FunctionCodeTrueint0-0xFF功能编码,不同的编码对应不同的功能_FunctionNumberTrueint0-0xFF功能编号,标记当前编码对应不同的功能data_msgTruechar*发送指令的data,没有数据为NULL,如果是单个数据:12.1,如果是整组数据:12.1,1,0,......按顺序逗号隔开的连续字符4.返回参数说明a.返回类型Int:0处理成功-1处理失败

1 / 3
下载文档,编辑使用

©2015-2020 m.777doc.com 三七文档.

备案号:鲁ICP备2024069028号-1 客服联系 QQ:2149211541

×
保存成功