C SDK 接口说明文档

设备信息结构体

保存设备端登陆JIoT平台需要的参数

struct DeviceInfo
{
char szProductKey[32]; //产品标示
char szDeviceName[32]; //设备名称
char szDeviceSecret[32]; //设备密钥
};

SDK初始化接口

jiotInit

创建JIOT客户端

接口定义

JHandle jiotInit();

参数说明

无

返回值

创建成功返回客户端的句柄，失败返回NULL

jiotRegister

注册JIOT客户端的回调函数

接口定义

void jiotRegister(JHandle handle,void* pContext, JClientMessageCallback *cb,JClientHandleCallback *handleCb);

参数说明

• handle :JIOT客户端的句柄
• pContext:设备的上下文信息
• cb: 客户端处理下行报文的回调函数结构体
• handleCb: 客户端处理接收状态回调函数

返回值

无

jiotConn

通过SIS获取MQTT的地址和端口，并连接MQTT服务端

接口定义

int jiotConn(JHandle handle，const DeviceInfo *pDev);

参数说明

• handle :JIOT客户端的句柄
• pDev :设备三元组

返回值

成功返回JIOT_SUCCESS，失败返回对应错误码

SDK释放接口

jiotDisConn

断开连接MQTT服务端。

接口定义

void jiotDisConn(JHandle handle);

参数说明

handle :JIOT客户端的句柄

返回值

成功返回true，失败返回false

jiotUnRegister

注销JIOT客户端的回调函数

接口定义

void jiotUnRegister(JHandle handle);

参数说明

handle :JIOT客户端的句柄

返回值

无

jiotRelease

销毁JIOT客户端

接口定义

void jiotRelease(JHandle handle);

参数说明

handle :JIOT客户端的句柄

返回值

无

SDK状态查询接口

jiotGetConnStatus

JIoT客户端状态查询。

接口定义

JClientStatus jiotGetConnStatus(JHandle * handle);

参数说明

handle :JIOT客户端的句柄

返回值

JClientStatus jClient的状态

SDK发送上行消息接口

jiotPropertyReportReq

JIOT客户端上报设备属性请求

接口定义

JiotResult jiotPropertyReportReq(JHandle handle,PropertyReportReq *pReq);

参数说明

• handle :JIOT客户端的句柄
• pReq :上报消息的结构体指针

返回值

返回值结构体，内容为错误码和seqNO

jiotEventReportReq

JIOT客户端上报设备事件请求。

接口定义

JiotResult jiotEventReportReq(JHandle handle,EventReportReq *pReq);

参数说明

• handle :JIOT客户端的句柄
• pReq :上报消息的结构体指针

返回值

返回值结构体，内容为错误码和seqNO

jiotVersionReportReq

JIOT客户端上报设备版本请求。

接口定义

JiotResult jiotVersionReportReq(JHandle handle, const VersionReportReq * pReq);

参数说明

• handle :JIOT客户端的句柄
• pReq :上报消息的结构体指针

返回值

返回值结构体，内容为错误码和seqNO

jiotOtaStatusReportReq

JIOT客户端上报设备OTA升级状态请求。

接口定义

JiotResult jiotOtaStatusReportReq(JHandle handle,const OtaStatusReportReq * pReq);

参数说明

• handle :JIOT客户端的句柄
• pReq :上报消息的结构体指针

返回值

返回值结构体，内容为错误码和seqNO

SDK接收下行消息回调函数接口

jiotPropertyReportRsp

处理服务端返回JIOT客户端上报设备属性请求回复

接口定义

typedef int jiotPropertyReportRsp(void* pContext, JHandle handle, const PropertyReportRsp * Rsp,int errcode);

参数说明

• pContext:用户注册的上下文信息
• handle:JIOT客户端句柄
• Rsp:结构体指针
• errcode:错误码

返回值

jiotEventReportRsp

处理服务端返回JIOT客户端上报设备事件请求回复

接口定义

typedef int jiotEventReportRsp(void* pContext, JHandle handle, const EventReportRsp * Rsp,int errcode);

参数说明

• pContext:用户注册的上下文信息
• handle:JIOT客户端句柄
• Rsp:接收回复消息的结构体指针
• errcode:错误码

返回值

jiotVersionReportRsp

处理服务端返回JIOT客户端上报设备版本请求回复

接口定义

typedef int jiotVersionReportRsp(void* pContext, JHandle handle, const VersionReportRsp * Rsp,int errcode);

参数说明

• pContext:用户注册的上下文信息
• handle:JIOT客户端句柄
• Rsp:接收回复消息的结构体指针
• errcode:错误码

返回值

jiotPropertySetReq

服务端下发给JIOT客户端设备属性设置请求。

接口定义

typedef int jiotPropertySetReq(void* pContext,JHandle handle,,PropertySetReq *Req,int errcode);

参数说明

• pContext:用户注册的上下文信息
• handle :JIOT客户端句柄
• Req :接收属性设置消息的结构体指针
• errcode:错误码

返回值

jiotMsgDeliverReq

服务端下发给JIOT客户端消息下发请求。

接口定义

typedef int jiotMsgDeliverReq(void* pContext, JHandle handle, MsgDeliverReq *Req,int errcode);

参数说明

• pContext:用户注册的上下文信息
• handle :JIOT客户端的句柄
• Req :接收属性设置消息的结构体指
• errcode:错误码

返回值

无

jiotOtaUpgradeInformReq

服务端下发给JIOT客户下发OTA升级请求。

接口定义

typedef int jiotOtaUpgradeInformReq(void* pContext,JHandle handle,OtaUpgradeInformReq *Req,int errcode);

参数说明

• pContext:用户注册的上下文信息
• handle :JIOT客户端的句柄
• Req :OTA升级信息的结构体指针
• errcode:错误码

返回值

无

jiotOtaStatusReportRsp

JIOT客户端上报OTA升级状态回复。

接口定义

typedef int jiotOtaStatusReportRsp(void* pContext,JHandle handle,const OtaStatusReportRsp * Rsp,int errcode);

参数说明

• pContext:用户注册的上下文信息
• handle :JIOT客户端的句柄
• Rsp :接收回复消息的结构体指针
• errcode:错误码

返回值

无

SDK消息回调函数指针结构体

struct JClientMessageCallback
{
    jiotPropertyReportRsp *_cbPropertyReportRsp; 
    jiotEventReportRsp *_cbEventReportRsp; 
    jiotVersionReportRsp *_cbVersionReportRsp;
    jiotPropertySetReq *_cbPropertySetReq; 
    jiotMsgDeliverReq *_cbMsgDeliverReq;
    jiotOtaUpgradeInformReq *_cbOtaUpgradeInformReq;
    jiotOtaStatusReportRsp  *_cbOtaStatusReportRsp;
} ;

SDK事件回调函数接口

jiotConnectedHandle

客户端mqtt连接成功。

接口定义

typedef int jiotConnectedHandle(void* pContext);

参数说明

• pContext:用户注册的上下文信息

返回值

无

jiotConnectFailHandle

客户端mqtt连接失败

接口定义

typedef int jiotConnectFailHandle(void* pContext,int errCode);

参数说明

• pContext:用户注册的上下文信息
• errCode JIOT客户端异常错误码

返回值

jiotDisconnectHandle

客户端mqtt连接断开。

接口定义

typedef int jiotDisconnectHandle(void* pContext);

参数说明

• pContext:用户注册的上下文信息

返回值

jiotSubscribeFailHandle

客户端subscirbe失败。

接口定义

typedef int jiotSubscribeFailHandle(void* pContext,char * TopicFilter);

参数说明

• pContext: 用户注册的上下文信息
• TopicFilter: JIOT订阅的topic

返回值

无

jiotPublishFailHandle

客户端publish失败。（需要mqtt-V5.0支持该功能）

接口定义

typedef int jiotPublishFailHandle(void* pContext,long long seqNo);

参数说明

• pContext:用户注册的上下文信息
• seqNo : 消息序号

返回值

无

jiotMessageTimeoutHandle

客户端消息发送超时。

接口定义

typedef int jiotMessageTimeoutHandle(void* pContext,long long seqNo);

参数说明

• pContext:用户注册的上下文信息
• seqNo : 消息序号

返回值

无

SDK的事件回调函数指针结构体

typedef struct JClientHandleCallback
{
    jiotConnectedHandle       *_cbConnectedHandle;        
    jiotConnectFailHandle     *_cbConnectFailHandle;      
    jiotDisconnectHandle      *_cbDisconnectHandle;       
    jiotSubscribeFailHandle   *_cbSubscribeFailHandle;    
    jiotPublishFailHandle     *_cbPublishFailHandle;      
    jiotMessageTimeoutHandle  *_cbMessageTimeoutHandle;   
} JClientHandleCallback;

错误码

SDK底层返回的错误码

服务器端返回的业务层错误码