HEKR ESP8266 SDK 接口说明

v1.0.6 by zengxuefeng@hekr.me 2015/9/7 20:15:00

1-1 HekrConfig (Wi-Fi一键配置)

void hekr_config_start(hekr_config_event_cb_t event_cb, size_t timeout)

参数

返回值

头文件

参数类型定义

typedef enum
{
    EVENT_CONNECT_WIFI_FAIL = 0,    //配置失败,未能连接上Wi-Fi
    EVENT_HEKR_CONFIG_TIMEOUT,      //配置超时
    EVENT_HEKR_CONFIG_FINISH        //配置成功,将会自动去连接服务器
}config_event_t;

typedef void( *hekr_config_event_cb_t)(config_event_t event);

说明

1-2 取消Wi-Fi 一键配置

void hekr_config_stop(void)

参数

返回值

2-1 连接服务器

void connect_server(cloud_conn_event_cb_t cb)

参数

返回值

头文件

参数类型定义

typedef enum {
    WIFI_DISCONNED = 0,     //Wi-Fi未连接
    NO_ACCESSKEY,           //设备没有accesskey
    DNS_ERROR,              //无法获取服务器IP
    DEVICE_LOGIN_ERROR,     //设备登入服务器失败
    DEVICE_LOGIN_SUCCESS,   //设备登入服务器成功
    DISCONNED_FROM_CLOUD    //设备与服务器连接断开
}cloud_conn_event_t;

typedef void(*cloud_conn_event_cb_t)(cloud_conn_event_t event);

2-2 断开与服务器的连接

void disconnected_from_server(void)

参数

返回值

2-3 向服务器发送数据

uint8_t send_message_to_remote(char *tid, void *data, size_t size)

说明

参数

返回值

2-4 注册收到服务器数据的回调函数

void register_receive_server_data_callback(recicve_server_data_cb_t cb)

参数

返回值

头文件

参数类型定义

typedef void(*recicve_server_data_cb_t)(void *data, size_t size);

3-1 注册串口收到数据的回调函数

void register_uart_data_received_callback(uart_data_received_cb_t *cb)

参数

返回值

头文件

相关定义

typedef void(uart_data_received_cb_t)(uint8_t data);

4-1获取SDK版本号

char *get_hekr_sdk_version(void)

参数

返回值

头文件

4-2 系统日志

void system_log_set(log_port_t port)

参数

返回值

参数类型定义

typedef enum
{
    PORT_UART0 = 0, //通过uart0输出
    PORT_UART1,     //通过uart1输出
    PORT_NULL       //不输出
}log_port_t;

头文件

说明

5-1 用户函数执行入口

void hekr_main(void)

说明

示例

void hekr_main(void)
{
    /*通过串口GPIO2输出信息*/
    /*波特率9600 8位数据位 1位停止位*/ 
    uart_init(BIT_RATE_9600, BIT_RATE_9600);
    os_printf("\n\nsystem run !! \n\n");
    os_printf("hekr sdk ver:%s\n", get_hekr_sdk_version());
}

参数

返回值

头文件

备注

基于ESP8266 SDK 1.1.2开发, ESP8266 通用API请参考 ESP官方文档