client-c  0.7.4
Classes | Macros | Typedefs | Enumerations | Functions
esp8266.h File Reference
#include "esp8266_serial.h"
+ Include dependency graph for esp8266.h:

Go to the source code of this file.

Classes

struct  esp8266_wifi_ap_t
 

Macros

#define TCP_SEND_MAX_BUFFER   2048
 
#define ESP8266_RETURN_IF_ERR(E)   { if (E) return E; }
 
#define ESP8266_RETURN_IF_NIL(p, E)   { if (!(p)) return E; }
 
#define ESP8266_RETURN_IF_NIL2(p1, p2, E)   { if (!(p1) || !(p2)) return E; }
 
#define ESP8266_RETURN_IF_NIL3(p1, p2, p3, E)   { if (!(p1) || !(p2) || !(p3)) return E; }
 
#define ESP8266_RETURN_IF_NIL4(p1, p2, p3, p4, E)   { if (!(p1) || !(p2) || !(p3) || !(p4)) return E; }
 
#define ESP8266_RETURN_IF_NIL5(p1, p2, p3, p4, p5, E)   { if (!(p1) || !(p2) || !(p3) || !(p4) || !(p5)) return E; }
 

Typedefs

typedef struct esp8266_t esp8266_t
 
typedef void(* on_esp8266_comand_complete_fn )(void *context, const bool result, const bool timeout_expired, const char *command, int index, time_t comand_complete_milis)
 
typedef void(* on_esp8266_tcp_receive_fn )(void *context, int id, const uint8 *buffer, const int receive_size)
 

Enumerations

enum  esp8266_error_t {
  ESP8266_ERR_NONE = 0, ESP8266_ERR_NOMEM = -1, ESP8266_ERR_BAD_PARAM = -2, ESP8266_ERR_COMMAND_BUSY = -3,
  ESP8266_ERR_INIT_FAILED = -4, ESP8266_ERR_COMMAND_ERROR = -5, ESP8266_ERR_COMMAND_TIMEOUT = -6, ESP8266_ERR_NOT_CONNECTED = -7,
  ESP8266_ERR_TCP_CONN_LIMIT = -8, ESP8266_ERR_TCP_CONN_DNS = -9, ESP8266_ERR_TCP_CONN_UNCONNECTED = -10, ESP8266_ERR_TCP_SEND_TIMEOUT = -11,
  ESP8266_ERR_TCP_SEND_FAILED = -12, ESP8266_ERR_TCP_SEND_BUFFER_TO_BIG = -13, ESP8266_ERR_IPD_PROTO = -14
}
 
enum  esp8266_wifi_ap_type_t {
  ESP8266_WIFI_AP_OPEN = 0, ESP8266_WIFI_AP_WEP = 1, ESP8266_WIFI_AP_WPA_PSK = 2, ESP8266_WIFI_AP_WPA2_PSK = 3,
  ESP8266_WIFI_AP_WPA_WPA2_PSK = 4, ESP8266_WIFI_AP_UNKNOWN = 5
}
 

Functions

esp8266_error_t esp8266_create (esp8266_t **controler, esp8266_serial_t *hw_serial, size_t rx_buffer_size)
 
void esp8266_destroy (esp8266_t *controler)
 
esp8266_error_t esp8266_send_command (esp8266_t *controler, on_esp8266_comand_complete_fn command_callback, void *callback_context, const char *command, const char *success, size_t success_size, const char *error, size_t error_size, time_t timeout_milis)
 
esp8266_error_t esp8266_init (esp8266_t *controler)
 
esp8266_error_t esp8266_echo (esp8266_t *controler, bool echo_enabled)
 
esp8266_error_t esp8266_scan (esp8266_t *controler, esp8266_wifi_ap_t **ap_array, size_t *ap_array_size)
 
esp8266_error_t esp8266_process (esp8266_t *controler, time_t limit_timeout_milis)
 
esp8266_error_t esp8266_connect_wifi (esp8266_t *controler, const char *SSID, const char *pwd)
 
esp8266_error_t esp8266_mux_mod (esp8266_t *controler, bool mux_mod_enabled)
 
esp8266_error_t esp8266_disconnect_wifi (esp8266_t *controler)
 
esp8266_error_t esp8266_connect_tcp (esp8266_t *controler, const char *hostname, const size_t hostname_size, const uint16_t port, int *id)
 
esp8266_error_t esp8266_send_tcp (esp8266_t *controler, int id, const uint8 *buffer, const size_t size)
 
esp8266_error_t esp8266_tcp_register_receive_callback (esp8266_t *controler, on_esp8266_tcp_receive_fn receive_callback, void *receive_context)
 
esp8266_error_t esp8266_disconnect_tcp (esp8266_t *controler, int id)
 
esp8266_error_t esp8266_check_status (esp8266_t *controler)
 

Macro Definition Documentation

#define ESP8266_RETURN_IF_ERR (   E)    { if (E) return E; }

Definition at line 126 of file esp8266.h.

#define ESP8266_RETURN_IF_NIL (   p,
  E 
)    { if (!(p)) return E; }

Definition at line 129 of file esp8266.h.

#define ESP8266_RETURN_IF_NIL2 (   p1,
  p2,
  E 
)    { if (!(p1) || !(p2)) return E; }

Definition at line 132 of file esp8266.h.

#define ESP8266_RETURN_IF_NIL3 (   p1,
  p2,
  p3,
  E 
)    { if (!(p1) || !(p2) || !(p3)) return E; }

Definition at line 135 of file esp8266.h.

#define ESP8266_RETURN_IF_NIL4 (   p1,
  p2,
  p3,
  p4,
  E 
)    { if (!(p1) || !(p2) || !(p3) || !(p4)) return E; }

Definition at line 138 of file esp8266.h.

#define ESP8266_RETURN_IF_NIL5 (   p1,
  p2,
  p3,
  p4,
  p5,
  E 
)    { if (!(p1) || !(p2) || !(p3) || !(p4) || !(p5)) return E; }

Definition at line 141 of file esp8266.h.

#define TCP_SEND_MAX_BUFFER   2048

Maximum size of bytes which can be send by one call

Definition at line 34 of file esp8266.h.

Typedef Documentation

typedef struct esp8266_t esp8266_t

Definition at line 37 of file esp8266.h.

typedef void(* on_esp8266_comand_complete_fn)(void *context, const bool result, const bool timeout_expired, const char *command, int index, time_t comand_complete_milis)

Definition at line 74 of file esp8266.h.

typedef void(* on_esp8266_tcp_receive_fn)(void *context, int id, const uint8 *buffer, const int receive_size)

Definition at line 81 of file esp8266.h.

Enumeration Type Documentation

enum esp8266_error_t
Enumerator
ESP8266_ERR_NONE 
ESP8266_ERR_NOMEM 
ESP8266_ERR_BAD_PARAM 
ESP8266_ERR_COMMAND_BUSY 
ESP8266_ERR_INIT_FAILED 
ESP8266_ERR_COMMAND_ERROR 
ESP8266_ERR_COMMAND_TIMEOUT 
ESP8266_ERR_NOT_CONNECTED 
ESP8266_ERR_TCP_CONN_LIMIT 
ESP8266_ERR_TCP_CONN_DNS 
ESP8266_ERR_TCP_CONN_UNCONNECTED 
ESP8266_ERR_TCP_SEND_TIMEOUT 
ESP8266_ERR_TCP_SEND_FAILED 
ESP8266_ERR_TCP_SEND_BUFFER_TO_BIG 
ESP8266_ERR_IPD_PROTO 

Definition at line 39 of file esp8266.h.

enum esp8266_wifi_ap_type_t
Enumerator
ESP8266_WIFI_AP_OPEN 
ESP8266_WIFI_AP_WEP 
ESP8266_WIFI_AP_WPA_PSK 
ESP8266_WIFI_AP_WPA2_PSK 
ESP8266_WIFI_AP_WPA_WPA2_PSK 
ESP8266_WIFI_AP_UNKNOWN 

Definition at line 57 of file esp8266.h.

Function Documentation

esp8266_error_t esp8266_check_status ( esp8266_t *  controler)
esp8266_error_t esp8266_connect_tcp ( esp8266_t *  controler,
const char *  hostname,
const size_t  hostname_size,
const uint16_t  port,
int *  id 
)
esp8266_error_t esp8266_connect_wifi ( esp8266_t *  controler,
const char *  SSID,
const char *  pwd 
)
esp8266_error_t esp8266_create ( esp8266_t **  controler,
esp8266_serial_t *  hw_serial,
size_t  rx_buffer_size 
)
void esp8266_destroy ( esp8266_t *  controler)
esp8266_error_t esp8266_disconnect_tcp ( esp8266_t *  controler,
int  id 
)
esp8266_error_t esp8266_disconnect_wifi ( esp8266_t *  controler)
esp8266_error_t esp8266_echo ( esp8266_t *  controler,
bool  echo_enabled 
)
esp8266_error_t esp8266_init ( esp8266_t *  controler)
esp8266_error_t esp8266_mux_mod ( esp8266_t *  controler,
bool  mux_mod_enabled 
)
esp8266_error_t esp8266_process ( esp8266_t *  controler,
time_t  limit_timeout_milis 
)
esp8266_error_t esp8266_scan ( esp8266_t *  controler,
esp8266_wifi_ap_t **  ap_array,
size_t *  ap_array_size 
)
esp8266_error_t esp8266_send_command ( esp8266_t *  controler,
on_esp8266_comand_complete_fn  command_callback,
void *  callback_context,
const char *  command,
const char *  success,
size_t  success_size,
const char *  error,
size_t  error_size,
time_t  timeout_milis 
)
esp8266_error_t esp8266_send_tcp ( esp8266_t *  controler,
int  id,
const uint8 *  buffer,
const size_t  size 
)
esp8266_error_t esp8266_tcp_register_receive_callback ( esp8266_t *  controler,
on_esp8266_tcp_receive_fn  receive_callback,
void *  receive_context 
)