aiot_subdev_api.h

浏览该文件的文档.

#ifndef __AIOT_SUBDEV_API_H__
#define __AIOT_SUBDEV_API_H__

#if defined(__cplusplus)
extern "C" {
#endif

#include <stdint.h>

#define STATE_SUBDEV_BASE                                             (-0x0C00)

typedef enum {
    AIOT_SUBDEVRECV_TOPO_ADD_REPLY,
    AIOT_SUBDEVRECV_TOPO_DELETE_REPLY,
    AIOT_SUBDEVRECV_TOPO_GET_REPLY,
    AIOT_SUBDEVRECV_BATCH_LOGIN_REPLY,
    AIOT_SUBDEVRECV_BATCH_LOGOUT_REPLY,
    AIOT_SUBDEVRECV_SUB_REGISTER_REPLY,
    AIOT_SUBDEVRECV_PRODUCT_REGISTER_REPLY,
    AIOT_SUBDEVRECV_TOPO_CHANGE_NOTIFY
} aiot_subdev_recv_type_t;

typedef struct {
    uint32_t     msg_id;
    uint32_t     code;
    char*        data;
    char*        message;
    char*        product_key;
    char*        device_name;
} aiot_subdev_generic_reply_t;

typedef struct {
    uint32_t     msg_id;
    char*        params;
    char*        product_key;
    char*        device_name;
} aiot_subdev_generic_notify_t;

typedef struct {
    aiot_subdev_recv_type_t  type;
    union {
        aiot_subdev_generic_reply_t  generic_reply;

        aiot_subdev_generic_notify_t generic_notify;
    } data;
} aiot_subdev_recv_t;

typedef void (* aiot_subdev_recv_handler_t)(void *handle,
        const aiot_subdev_recv_t *packet, void *user_data);


/* TODO: 列举 SUBDEV 可能发生的所有内部状态变更(可选), 如MQTT重连, OTA收到通知, CoAP的token过期, 与上一段之间有2个空行 */
/* TODO: 填上 doxygen 的注释说明 */
/* TODO: 由于面向用户, 模块名字符串长度 > 6个字符的时候, 改成缩写, 例如: DYNREG_HTTP_EVT -> DRHTTPEVT */

typedef enum {
    AIOT_SUBDEVEVT_INVALID_RESPONSE,
    AIOT_SUBDEVEVT_INVALID_ID,
    AIOT_SUBDEVEVT_INVALID_CODE
} aiot_subdev_event_type_t;

typedef struct {
    aiot_subdev_event_type_t  type;
} aiot_subdev_event_t;

typedef void (*aiot_subdev_event_handler_t)(void *handle,
        const aiot_subdev_event_t *event, void *userdata);

typedef struct {
    char *product_key;
    char *device_name;
    char *device_secret;
    char *product_secret;
} aiot_subdev_dev_t;

typedef enum {
    AIOT_SUBDEVOPT_MQTT_HANDLE,

    AIOT_SUBDEVOPT_RECV_HANDLER,

    AIOT_SUBDEVOPT_EVENT_HANDLER,

    AIOT_SUBDEVOPT_USERDATA,
    AIOT_SUBDEVOPT_MAX
} aiot_subdev_option_t;

void *aiot_subdev_init(void);

int32_t aiot_subdev_setopt(void *handle, aiot_subdev_option_t option, void *data);

int32_t aiot_subdev_deinit(void **handle);

int32_t aiot_subdev_send_topo_add(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);

int32_t aiot_subdev_send_topo_delete(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);

int32_t aiot_subdev_send_topo_get(void *handle);

int32_t aiot_subdev_send_batch_login(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);

int32_t aiot_subdev_send_batch_logout(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);

int32_t aiot_subdev_send_sub_register(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);

int32_t aiot_subdev_send_product_register(void *handle, aiot_subdev_dev_t dev[], uint32_t dev_num);

#if defined(__cplusplus)
}
#endif

#endif  /* __AIOT_SUBDEV_API_H__ */