esp8684 2.1.0.0
esp8684.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef ESP8684_H
29#define ESP8684_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_uart.h"
38
59#define ESP8684_CMD_AT "AT"
60#define ESP8684_CMD_RST "AT+RST"
61#define ESP8684_CMD_GMR "AT+GMR"
62#define ESP8684_CMD_CWINIT "AT+CWINIT"
63#define ESP8684_CMD_CWMODE "AT+CWMODE"
64#define ESP8684_CMD_CWJAP "AT+CWJAP"
65#define ESP8684_CMD_CWLAP "AT+CWLAP"
66#define ESP8684_CMD_CWAP "AT+CWQAP"
67#define ESP8684_CMD_CWSAP "AT+CWSAP"
68#define ESP8684_CMD_CWLIF "AT+CWLIF"
69#define ESP8684_CMD_CIPSTATE "AT+CIPSTATE"
70#define ESP8684_CMD_CIPSTART "AT+CIPSTART"
71#define ESP8684_CMD_CIPMODE "AT+CIPMODE"
72#define ESP8684_CMD_CIPSEND "AT+CIPSEND"
73#define ESP8684_CMD_CIPCLOSE "AT+CIPCLOSE"
74#define ESP8684_CMD_CIFSR "AT+CIFSR"
75#define ESP8684_CMD_CIPMUX "AT+CIPMUX"
76#define ESP8684_CMD_CIPSERVER "AT+CIPSERVER"
77#define ESP8684_CMD_CIPSTO "AT+CIPSTO"
78#define ESP8684_CMD_CIPRECVMODE "AT+CIPRECVMODE"
79
84#define ESP8684_RSP_RECEIVE "+IPD"
85#define ESP8684_READY_FOR_SEND ">"
86#define ESP8684_RSP_OK "OK"
87#define ESP8684_RSP_SEND_OK "SEND OK"
88#define ESP8684_RSP_ERROR "ERROR"
89#define ESP8684_RSP_READY "ready"
90
95#define ESP8684_PIN_STATE_HIGH 0x01
96#define ESP8684_PIN_STATE_LOW 0x00
97
98
104#define ESP8684_TX_DRV_BUFFER_SIZE 100
105#define ESP8684_RX_DRV_BUFFER_SIZE 300
106 // esp8684_cmd
108
123#define ESP8684_MAP_MIKROBUS( cfg, mikrobus ) \
124 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
125 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
126 cfg.bt = MIKROBUS( mikrobus, MIKROBUS_AN ); \
127 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
128 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
129 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
130 // esp8684_map // esp8684
133
138typedef struct
139{
140 // Output pins
141 digital_out_t bt;
142 digital_out_t rst;
143 digital_out_t rts;
145 // Input pins
146 digital_in_t cts;
148 // Modules
149 uart_t uart;
151 // Buffers
152 uint8_t uart_rx_buffer[ ESP8684_RX_DRV_BUFFER_SIZE ];
153 uint8_t uart_tx_buffer[ ESP8684_TX_DRV_BUFFER_SIZE ];
155} esp8684_t;
156
161typedef struct
162{
163 // Communication gpio pins
164 pin_name_t rx_pin;
165 pin_name_t tx_pin;
167 // Additional gpio pins
168 pin_name_t bt;
169 pin_name_t rst;
170 pin_name_t rts;
171 pin_name_t cts;
173 // Static variable
174 uint32_t baud_rate;
176 uart_data_bits_t data_bit;
177 uart_parity_t parity_bit;
178 uart_stop_bits_t stop_bit;
181
186typedef enum
187{
191 ESP8684_TIMEOUT = -3
192
194
211
226
238
251err_t esp8684_generic_write ( esp8684_t *ctx, uint8_t *data_in, uint16_t len );
252
265err_t esp8684_generic_read ( esp8684_t *ctx, uint8_t *data_out, uint16_t len );
266
276void esp8684_set_rst_pin ( esp8684_t *ctx, uint8_t pin_state );
277
287void esp8684_set_bt_pin ( esp8684_t *ctx, uint8_t pin_state );
288
298void esp8684_set_rts_pin ( esp8684_t *ctx, uint8_t pin_state );
299
310
321void esp8684_send_cmd ( esp8684_t *ctx, uint8_t *cmd, uint8_t *args );
322
332void esp8684_send_query_cmd ( esp8684_t *ctx, uint8_t *cmd );
333
343void esp8684_send_test_cmd ( esp8684_t *ctx, uint8_t *cmd );
344
356void esp8684_connect_to_network ( esp8684_t* ctx, uint8_t *ssid, uint8_t *password );
357
370void esp8684_connect_for_trans ( esp8684_t* ctx, uint8_t *type, uint8_t *link_id, uint8_t *remote_host, uint8_t *remote_port );
371
372#ifdef __cplusplus
373}
374#endif
375#endif // ESP8684_H
376 // esp8684
378
379// ------------------------------------------------------------------------ END
esp8684_return_value_t
ESP8684 Click return value data.
Definition: esp8684.h:187
@ ESP8684_OK
Definition: esp8684.h:188
@ ESP8684_TIMEOUT
Definition: esp8684.h:191
@ ESP8684_ERROR
Definition: esp8684.h:189
@ ESP8684_OVERFLOW
Definition: esp8684.h:190
#define ESP8684_TX_DRV_BUFFER_SIZE
ESP8684 driver buffer size.
Definition: esp8684.h:104
#define ESP8684_RX_DRV_BUFFER_SIZE
Definition: esp8684.h:105
err_t esp8684_init(esp8684_t *ctx, esp8684_cfg_t *cfg)
ESP8684 initialization function.
uint8_t esp8684_get_cts_pin(esp8684_t *ctx)
ESP8684 get cts pin state function.
void esp8684_send_cmd(esp8684_t *ctx, uint8_t *cmd, uint8_t *args)
ESP8684 send command with arguments function.
void esp8684_set_rts_pin(esp8684_t *ctx, uint8_t pin_state)
ESP8684 set rts pin state function.
void esp8684_cfg_setup(esp8684_cfg_t *cfg)
ESP8684 configuration object setup function.
void esp8684_default_cfg(esp8684_t *ctx)
ESP8684 default configuration function.
err_t esp8684_generic_write(esp8684_t *ctx, uint8_t *data_in, uint16_t len)
ESP8684 data writing function.
void esp8684_set_rst_pin(esp8684_t *ctx, uint8_t pin_state)
ESP8684 set rst pin state function.
err_t esp8684_generic_read(esp8684_t *ctx, uint8_t *data_out, uint16_t len)
ESP8684 data reading function.
void esp8684_connect_for_trans(esp8684_t *ctx, uint8_t *type, uint8_t *link_id, uint8_t *remote_host, uint8_t *remote_port)
ESP8684 connect to remote host function.
void esp8684_send_test_cmd(esp8684_t *ctx, uint8_t *cmd)
ESP8684 test query command function.
void esp8684_connect_to_network(esp8684_t *ctx, uint8_t *ssid, uint8_t *password)
ESP8684 connect to network function.
void esp8684_send_query_cmd(esp8684_t *ctx, uint8_t *cmd)
ESP8684 send query command function.
void esp8684_set_bt_pin(esp8684_t *ctx, uint8_t pin_state)
ESP8684 set bt pin state function.
ESP8684 Click configuration object.
Definition: esp8684.h:162
pin_name_t rts
Definition: esp8684.h:170
uint32_t baud_rate
Definition: esp8684.h:174
pin_name_t cts
Definition: esp8684.h:171
pin_name_t bt
Definition: esp8684.h:168
bool uart_blocking
Definition: esp8684.h:175
uart_data_bits_t data_bit
Definition: esp8684.h:176
pin_name_t tx_pin
Definition: esp8684.h:165
pin_name_t rx_pin
Definition: esp8684.h:164
uart_stop_bits_t stop_bit
Definition: esp8684.h:178
uart_parity_t parity_bit
Definition: esp8684.h:177
pin_name_t rst
Definition: esp8684.h:169
ESP8684 Click context object.
Definition: esp8684.h:139
digital_out_t rts
Definition: esp8684.h:143
uart_t uart
Definition: esp8684.h:149
digital_in_t cts
Definition: esp8684.h:146
digital_out_t rst
Definition: esp8684.h:142
digital_out_t bt
Definition: esp8684.h:141