mesh.h

浏览该文件的文档.

/*
 * ESPRSSIF MIT License
 *
 * Copyright (c) 2015 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
 *
 * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
 * it is free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished
 * to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
#ifndef __LWIP_API_MESH_H__
#define __LWIP_API_MESH_H__

#include "ip_addr.h"
#include "user_interface.h"
#include "espconn.h"
#ifdef __cplusplus
extern "C" {
#endif

#define ESP_MESH_GROUP_ID_LEN (6)

typedef void (* espconn_mesh_callback)();
typedef void (* espconn_mesh_scan_callback)(void *arg, int8_t status);

enum mesh_type {
    MESH_CLOSE = 0,
    MESH_LOCAL,
    MESH_ONLINE,
    MESH_NONE = 0xFF
};
enum mesh_status {
    MESH_DISABLE = 0,
    MESH_WIFI_CONN,
    MESH_NET_CONN,
    MESH_LOCAL_AVAIL,
    MESH_ONLINE_AVAIL
};

enum mesh_node_type {
    MESH_NODE_PARENT = 0,
    MESH_NODE_CHILD,
    MESH_NODE_ALL
};

struct mesh_scan_para_type {
    espconn_mesh_scan_callback usr_scan_cb; // scan done callback
    uint8_t grp_id[ESP_MESH_GROUP_ID_LEN];  // group id
    bool grp_set;                           // group set
};


bool espconn_mesh_local_addr(struct ip_addr *ip);

bool espconn_mesh_get_router(struct station_config *router);

bool espconn_mesh_set_router(struct station_config *router);

bool espconn_mesh_server_init(struct ip_addr *ip, uint16_t port);

bool espconn_mesh_get_node_info(enum mesh_node_type type,
                                uint8_t **info, uint8_t *count);

bool espconn_mesh_encrypt_init(AUTH_MODE mode, uint8_t *passwd, uint8_t passwd_len);
bool espconn_mesh_set_ssid_prefix(uint8_t *prefix, uint8_t prefix_len);

bool espconn_mesh_set_max_hops(uint8_t max_hops);

bool espconn_mesh_group_id_init(uint8_t *grp_id, uint16_t gid_len);

bool espconn_mesh_set_dev_type(uint8_t dev_type);
uint8_t espconn_mesh_get_dev_type();

int8_t espconn_mesh_connect(struct espconn *usr_esp);

int8_t espconn_mesh_disconnect(struct espconn *usr_esp);

int8_t espconn_mesh_get_status();

int8_t espconn_mesh_sent(struct espconn *usr_esp, uint8 *pdata, uint16 len);

uint8_t espconn_mesh_get_max_hops();

void espconn_mesh_enable(espconn_mesh_callback enable_cb, enum mesh_type type);

void espconn_mesh_disable(espconn_mesh_callback disable_cb);

void espconn_mesh_print_ver();

void espconn_mesh_scan(struct mesh_scan_para_type *para);
#ifdef __cplusplus
}
#endif

#endif