aiot_at_api.h

浏览该文件的文档.

#ifndef _AIOT_AT_API_H_
#define _AIOT_AT_API_H_

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

#include <stdint.h>
#include "core_list.h"
#include "aiot_sysdep_api.h"


#define MODULE_NAME_AT                      "AT"

#define STATE_AT_BASE                       (-0x1000)
#define STATE_AT_ALREADY_INITED             (-0x1003)
#define STATE_AT_NOT_INITED                 (-0x1004)
#define STATE_AT_UART_TX_FUNC_MISSING       (-0x1005)
#define STATE_AT_GET_RSP_FAILED             (-0x1006)
#define STATE_AT_RINGBUF_OVERFLOW           (-0x1007)
#define STATE_AT_RX_TIMEOUT                 (-0x1008)
#define STATE_AT_NO_AVAILABLE_LINK          (-0x1009)
#define STATE_AT_TX_TIMEOUT                 (-0x100A)
#define STATE_AT_TX_ERROR                   (-0x100B)
#define STATE_AT_RINGBUF_NO_DATA            (-0x100C)
#define STATE_AT_UART_TX_FUNC_NULL          (-0x100D)
#define STATE_AT_NO_DATA_SLOT               (-0x100F)
#define STATE_AT_LINK_IS_DISCONN            (-0x1010)
#define STATE_AT_UART_TX_FAILED             (-0x1011)

#define AIOT_AT_CMD_LEN_MAXIMUM             (128)       /* AT命令最大长度 */
#define AIOT_AT_RSP_LEN_MAXIMUM             (64)        /* AT应答最大长度 */
#define AIOT_AT_TX_TIMEOUT_DEFAULT          (5000)      /* UART默认发送超时时间 */
#define AIOT_AT_RX_TIMEOUT_DEFAULT          (5000)      /* UART默认接受等待超时时间 */
#define AIOT_AT_DATA_RB_SIZE_DEFAULT        (5000)      /* 内部网络数据接收缓冲区大小 */
#define AIOT_AT_RSP_RB_SIZE_DEFAULT         (5000)      /* 内部应答报文接受缓冲区大小 */
#define AIOT_AT_CMD_RETRY_TIME              (3)         /* AT命令发送重试最大次数 */
#define AIOT_AT_RINGBUF_RETRY_INTERVAL      (100)       /* RINGBUF数据长度检查间隔时间 */
#define AIOT_AT_SOCKET_NUM                  (1)         /* 支持的数据链路数量 */


#define AIOT_UART_DISABLE_RX_IT()           do {;} while(0)
#define AIOT_UART_ENABLE_RX_IT()            do {;} while(0)

typedef enum {
    AIOT_ATOPT_UART_TX_FUNC,
    AIOT_ATOPT_USER_DATA,
    AIOT_ATOPT_MAX,
} aiot_at_option_t;

typedef int32_t (*aiot_at_uart_tx_func_t)(const uint8_t *p_data, uint16_t len, uint32_t timeout);

typedef int32_t (*at_rsp_handler_t)(char *rsp, void *user_data);

typedef struct {
    /* 要发送的AT命令 */
    char *cmd;
    /* AT命令的数据长度 */
    uint32_t cmd_len;
    /* 期望的应答数据 */
    char *rsp;
    /* 接受到应答数据后的用户处理回调函数 */
    at_rsp_handler_t handler;
} core_at_cmd_item_t;

typedef struct {
    uint8_t *buf;
    uint8_t *head;
    uint8_t *tail;
    uint8_t *end;
    uint32_t size;
    void *mutex;
} core_ringbuf_t;

typedef enum {
    CORE_AT_LINK_DISABLE    = 0,
    CORE_AT_LINK_DISCONN    = 1,
    CORE_AT_LINK_CONN       = 2,
    CORE_AT_LINK_RECV       = 3,
} core_at_link_status_t;

typedef struct {
    uint8_t link_status;
    core_ringbuf_t data_rb;
} link_descript_t;

typedef enum {
    CORE_AT_READ_RSP = 0,
    CORE_AT_PARSE_RECV_RSP,
    CORE_AT_READ_DATA,
} core_at_parser_state_t;

typedef struct {
    uint32_t curr_link_id;
    uint32_t data_len;
    core_at_parser_state_t state;
} core_at_parse_sm_t;

typedef struct {
    uint8_t is_init;
    link_descript_t fd[AIOT_AT_SOCKET_NUM];
    uint32_t tx_timeout;
    uint32_t rsp_timeout;

    core_at_parse_sm_t sm;
    core_ringbuf_t rsp_rb;
    char rsp_buf[AIOT_AT_RSP_LEN_MAXIMUM];
    uint32_t rsp_buf_offset;

    aiot_at_uart_tx_func_t uart_tx_func;
    void *tx_mutex;

    void *user_data;
} core_at_handle_t;

int32_t aiot_at_init(void);

int32_t aiot_at_setopt(aiot_at_option_t opt, void *data);

int32_t aiot_at_bootstrap(void);

int32_t aiot_at_nwk_open(uint8_t *socket_id);

int32_t aiot_at_nwk_connect(uint8_t socket_id, const char *host, uint16_t port, uint32_t timeout);

int32_t aiot_at_nwk_send(uint8_t socket_id, const uint8_t *buffer, uint32_t len, uint32_t timeout);

int32_t aiot_at_nwk_recv(uint8_t socket_id, uint8_t *buffer, uint32_t len, uint32_t timeout_ms);

int32_t aiot_at_nwk_close(uint8_t socket_id);

int32_t aiot_at_uart_reception(uint8_t data);

int32_t aiot_at_deinit(void);


#if defined(__cplusplus)
}
#endif

#endif