OneNET EDP接入协议

简介

EDP (Enhanced Device Protocol增强设备协议）是OneNET平台根据物联网特点专门定制的完全公开的基于TCP的协议，可以广泛应用到家居、交通、物流、能源以及其他行业应用中。具有以下功能特点：1. 长连接协议；2. 数据加密传输；3. 终端数据点上报，支持的数据点类型为：浮点数(float)、整型（int）、字符串、JSON对象/二进制数据；4. 平台消息下发（支持离线消息）；5. 端到端数据转发。

重要定义及数据结构

消息类型

平台与设备之间的交互消息类型定义如下：

API列表

PacketConnect1

该函数用于打包由设备到设备云的EDP协议包，连接设备云的请求(登录认证方式1)，其函数原型如下:

EdpPacket *PacketConnect1(const char *devid, const char *auth_key);

说明：返回的EDP包发送给设备云后，需要客户程序删除该包。

PacketConnect2

该函数用于打包由设备到设备云的EDP协议包，连接设备云的请求(登录认证方式2)，其函数原型如下:

EdpPacket *PacketConnect2(const char *userid, const char *auth_info);

说明：返回的EDP包发送给设备云后，需要客户程序删除该包。

GetEdpPacket

该函数用于将接收到的二进制流，分解成一个一个的EDP包，函数原型如下：

EdpPacket *GetEdpPacket(RecvBuffer *buf);

说明：返回的EDP包使用后，需要客户程序删除该包。

EdpPacketType

该函数用于获取一个EDP包的消息类型，客户程序根据消息类型做不同的处理，函数原型如下：

uint8 EdpPacketType(EdpPacket *pkg);

PacketPushdata

该函数用于打包设备到设备云的EDP协议包，设备与设备之间转发数据，其函数原型如下：

EdpPacket *PacketPushdata(const char *dst_devid, const char *data, uint32 data_len);

说明：返回的EDP包使用后，需要客户程序删除该包。

UnpackPushdata

该函数用于解包由设备云到设备的EDP协议包，设备与设备之间转发数据，其函数原型如下：

int32 UnpackPushdata(EdpPacket *pkg, char **src_devid, char **data, uint32 *data_len);

说明：通过函数GetEdpPacket和EdpPacketType判断出是pushdata后，将整个响应EDP包作为参数，由该函数进行解析，返回的源设备ID(src_devid)和数据(data)都需要客户端释放。

PacketSavedataJson

该函数用于打包设备到设备云的EDP协议包，存储数据(json格式数据)，其函数原型如下：

EdpPacket *PacketSavedataJson(const char *dst_devid, 
                              cJSON      *json_obj, 
                              int         type, 
                              uint16      msg_id);

说明：返回的EDP包发送给设备云后，需要客户程序删除该包。

UnpackSavedataJson

该函数用于解包由设备云到设备的EDP协议包，存储数据(json格式数据)，其函数原型如下：

int32 UnpackSavedataJson(EdpPacket *pkg, cJSON **json_obj);

说明：返回的json数据(json_obj)需要客户端释放。

PacketPing

该函数用于打包由设备到设备云的EDP心跳包，该函数原型如下：

EdpPacket *PacketPing(void);

说明：返回的EDP包发送给设备云后，需要客户程序删除该包。

使用示例

完整示例较大，可参考components\cloud\onenet\edp\edp_sample.c的实现。