wizfi360  2.1.0.0
wizfi360.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 WIZFI360_H
29 #define WIZFI360_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define WIZFI360_CMD_AT "AT"
74 #define WIZFI360_CMD_RST "AT+RST"
75 #define WIZFI360_CMD_GMR "AT+GMR"
76 #define WIZFI360_CMD_GSLP "AT+GSLP"
77 #define WIZFI360_CMD_ATE "ATE"
78 #define WIZFI360_CMD_RESTORE "AT+RESTORE"
79 #define WIZFI360_CMD_UART_CUR "AT+UART_CUR"
80 #define WIZFI360_CMD_UART_DEF "AT+UART_DEF"
81 #define WIZFI360_CMD_SLEEP "AT+SLEEP"
82 #define WIZFI360_CMD_SYSIOSETCFG "AT+SYSIOSETCFG"
83 #define WIZFI360_CMD_SYSIOGETCFG "AT+SYSIOGETCFG"
84 #define WIZFI360_CMD_SYSGPIODIR "AT+SYSGPIODIR"
85 #define WIZFI360_CMD_SYSGPIOWRITE "AT+SYSGPIOWRITE"
86 #define WIZFI360_CMD_SYSGPIOREAD "AT+SYSGPIOREAD"
87 #define WIZFI360_CMD_EXECUTE_AT_CMD "+++"
88 
93 #define WIZFI360_CMD_CWMODE_CUR "AT+CWMODE_CUR"
94 #define WIZFI360_CMD_CWMODE_DEF "AT+CWMODE_DEF"
95 #define WIZFI360_CMD_CWJAP_CUR "AT+CWJAP_CUR"
96 #define WIZFI360_CMD_CWJAP_DEF "AT+CWJAP_DEF"
97 #define WIZFI360_CMD_CWLAPOPT "AT+CWLAPOPT"
98 #define WIZFI360_CMD_CWLAP "AT+CWLAP"
99 #define WIZFI360_CMD_CWQAP "AT+CWQAP"
100 #define WIZFI360_CMD_CWSAP_CUR "AT+CWSAP_CUR"
101 #define WIZFI360_CMD_CWSAP_DEF "AT+CWSAP_DEF"
102 #define WIZFI360_CMD_CWLIF "AT+CWLIF"
103 #define WIZFI360_CMD_CWDHCP_CUR "AT+CWDHCP_CUR"
104 #define WIZFI360_CMD_CWDHCP_DEF "AT+CWDHCP_DEF"
105 #define WIZFI360_CMD_CWDHCPS_CUR "AT+CWDHCPS_CUR"
106 #define WIZFI360_CMD_CWDHCPS_DEF "AT+CWDHCPS_DEF"
107 #define WIZFI360_CMD_CWAUTOCONN "AT+CWAUTOCONN"
108 #define WIZFI360_CMD_CIPSTAMAC_CUR "AT+CIPSTAMAC_CUR"
109 #define WIZFI360_CMD_CIPSTAMAC_DEF "AT+CIPSTAMAC_DEF"
110 #define WIZFI360_CMD_CIPAPMAC_CUR "AT+CIPAPMAC_CUR"
111 #define WIZFI360_CMD_CIPAPMAC_DEF "AT+CIPAPMAC_DEF"
112 #define WIZFI360_CMD_CIPSTA_CUR "AT+CIPSTA_CUR"
113 #define WIZFI360_CMD_CIPSTA_DEF "AT+CIPSTA_DEF"
114 #define WIZFI360_CMD_CIPAP_CUR "AT+CIPAP_CUR"
115 #define WIZFI360_CMD_CIPAP_DEF "AT+CIPAP_DEF"
116 #define WIZFI360_CMD_CWSTARTSMART "AT+CWSTARTSMART"
117 #define WIZFI360_CMD_CWSTOPSMART "AT+CWSTOPSMART"
118 #define WIZFI360_CMD_WPS "AT+WPS"
119 #define WIZFI360_CMD_CWHOSTNAME "AT+CWHOSTNAME"
120 #define WIZFI360_CMD_CWCOUNTRY_CUR "AT+CWCOUNTRY_CUR"
121 #define WIZFI360_CMD_CWCOUNTRY_DEF "AT+CWCOUNTRY_DEF"
122 #define WIZFI360_CMD_WIZ_NETCONFIG "AT+WIZ_NETCONFIG"
123 
128 #define WIZFI360_CMD_CIPSTATUS "AT+CIPSTATUS"
129 #define WIZFI360_CMD_CIPDOMAIN "AT+CIPDOMAIN"
130 #define WIZFI360_CMD_CIPSTART "AT+CIPSTART"
131 #define WIZFI360_CMD_CIPSSLSIZE "AT+CIPSSLSIZE"
132 #define WIZFI360_CMD_CIPSSLCCONF "AT+CIPSSLCCONF"
133 #define WIZFI360_CMD_CASEND "AT+CASEND"
134 #define WIZFI360_CMD_CIPSEND "AT+CIPSEND"
135 #define WIZFI360_CMD_CIPSENDEX "AT+CIPSENDEX"
136 #define WIZFI360_CMD_CIPSENDBUF "AT+CIPSENDBUF"
137 #define WIZFI360_CMD_CIPBUFRESET "AT+CIPBUFRESET"
138 #define WIZFI360_CMD_CIPBUFSTATUS "AT+CIPBUFSTATUS"
139 #define WIZFI360_CMD_CIPCHECKSEQ "AT+CIPCHECKSEQ"
140 #define WIZFI360_CMD_CIPCLOSE "AT+CIPCLOSE"
141 #define WIZFI360_CMD_CIFSR "AT+CIFSR"
142 #define WIZFI360_CMD_CIPMUX "AT+CIPMUX"
143 #define WIZFI360_CMD_CIPSERVER "AT+CIPSERVER"
144 #define WIZFI360_CMD_CIPSERVERMAXCONN "AT+CIPSERVERMAXCONN"
145 #define WIZFI360_CMD_CIPMODE "AT+CIPMODE"
146 #define WIZFI360_CMD_SAVETRANSLINK "AT+SAVETRANSLINK"
147 #define WIZFI360_CMD_CIPSTO "AT+CIPSTO"
148 #define WIZFI360_CMD_CIUPDATE "AT+CIUPDATE"
149 #define WIZFI360_CMD_PING "AT+PING"
150 #define WIZFI360_CMD_CIPDINFO "AT+CIPDINFO"
151 #define WIZFI360_CMD_CIPSNTPCFG "AT+CIPSNTPCFG"
152 #define WIZFI360_CMD_CIPSNTPTIME "AT+CIPSNTPTIME"
153 #define WIZFI360_CMD_CIPDNS_CUR "AT+CIPDNS_CUR"
154 #define WIZFI360_CMD_CIPDNS_DEF "AT+CIPDNS_DEF"
155 #define WIZFI360_CMD_MQTTSET "AT+MQTTSET"
156 #define WIZFI360_CMD_MQTTOPIC "AT+MQTTOPIC"
157 #define WIZFI360_CMD_MQTTQOS "AT+MQTTQOS"
158 #define WIZFI360_CMD_MQTTCON "AT+MQTTCON"
159 #define WIZFI360_CMD_MQTTPUB "AT+MQTTPUB"
160 #define WIZFI360_CMD_MQTTPUBSEND "AT+MQTTPUBSEND"
161 #define WIZFI360_CMD_MQTTDIS "AT+MQTTDIS"
162 #define WIZFI360_CMD_AZSET "AT+AZSET"
163 #define WIZFI360_CMD_AZCON "AT+AZCON"
164 #define WIZFI360_CMD_AWSPKSEND "AT+AWSPKSEND"
165 #define WIZFI360_CMD_CLICASEND "AT+CLICASEND"
166 #define WIZFI360_CMD_AWSCON "AT+AWSCON"
167 
172 #define WIZFI360_CWMODE_STATION "1"
173 #define WIZFI360_CWMODE_SOFTAP "2"
174 #define WIZFI360_CWMODE_STATION_SOFTAP "3"
175 
180 #define WIZFI360_CIPMUX_SINGLE_CONN "0"
181 #define WIZFI360_CIPMUX_MULTIPLE_CONN "1"
182 
187 #define WIZFI360_CWDHCP_SOFTAP "0,0"
188 #define WIZFI360_CWDHCP_SOFTAP_DHCP "0,1"
189 #define WIZFI360_CWDHCP_STATION "1,0"
190 #define WIZFI360_CWDHCP_STATION_DHCP "1,1"
191 #define WIZFI360_CWDHCP_SOFTAP_STATION "2,0"
192 #define WIZFI360_CWDHCP_SFT_ST_DHCP "2,1"
193 
198 #define WIZFI360_ENABLE_TIMEZONE_1 "1,1"
199 
204 #define WIZFI360_PREFIX_SYMB_END "\r\n"
205 #define WIZFI360_PREFIX_SYMB_QUOTE "\""
206 #define WIZFI360_PREFIX_SYMB_SEPARATOR ","
207 #define WIZFI360_PREFIX_SYMB_QUERY "?"
208 #define WIZFI360_PREFIX_SYMB_SET_VAL "="
209 #define WIZFI360_PREFIX_SYMB_PLUS "+"
210 #define WIZFI360_PREFIX_SYMB_SPACE " "
211 #define WIZFI360_PREFIX_SYMB_NULL ""
212 
217 #define WIZFI360_RSP_OK "OK"
218 #define WIZFI360_RSP_ERROR "ERROR"
219 #define WIZFI360_RSP_READY_FOR_SEND ">"
220 #define WIZFI360_RSP_SEND_OK "SEND OK"
221 #define WIZFI360_RECEIVE "+IPD"
222 #define WIZFI360_MESSAGE_END "\032"
223 
228 #define WIZFI360_PIN_STATE_LOW 0
229 #define WIZFI360_PIN_STATE_HIGH 1
230 
236 #define WIZFI360_TX_DRV_BUFFER_SIZE 100
237 #define WIZFI360_RX_DRV_BUFFER_SIZE 300
238  // wizfi360_cmd
240 
255 #define WIZFI360_MAP_MIKROBUS( cfg, mikrobus ) \
256  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
257  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
258  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
259  cfg.bt = MIKROBUS( mikrobus, MIKROBUS_AN ); \
260  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
261  cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
262  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
263  // wizfi360_map // wizfi360
266 
271 typedef struct
272 {
273  // Output pins
274  digital_out_t bt;
275  digital_out_t rst;
276  digital_out_t cts;
277  digital_out_t wkp;
279  // Input pins
280  digital_in_t rts;
282  // Modules
283  uart_t uart;
285  // Buffers
286  uint8_t uart_rx_buffer[ WIZFI360_RX_DRV_BUFFER_SIZE ];
287  uint8_t uart_tx_buffer[ WIZFI360_TX_DRV_BUFFER_SIZE ];
289 } wizfi360_t;
290 
295 typedef struct
296 {
297  // Communication gpio pins
298  pin_name_t rx_pin;
299  pin_name_t tx_pin;
301  // Additional gpio pins
302  pin_name_t bt;
303  pin_name_t rst;
304  pin_name_t cts;
305  pin_name_t wkp;
306  pin_name_t rts;
308  // Static variable
309  uint32_t baud_rate;
311  uart_data_bits_t data_bit;
312  uart_parity_t parity_bit;
313  uart_stop_bits_t stop_bit;
316 
321 typedef enum
322 {
324  WIZFI360_ERROR = -1
325 
327 
344 
359 
369 void wizfi360_set_rst_pin ( wizfi360_t *ctx, uint8_t state );
370 
380 void wizfi360_set_bt_pin ( wizfi360_t *ctx, uint8_t state );
381 
392 
402 
413 
423 void wizfi360_clear_to_send ( wizfi360_t *ctx, uint8_t state );
424 
438 err_t wizfi360_generic_write ( wizfi360_t *ctx, uint8_t *data_in, uint16_t len );
439 
453 err_t wizfi360_generic_read ( wizfi360_t *ctx, uint8_t *data_out, uint16_t len );
454 
466 err_t wizfi360_write_command ( wizfi360_t *ctx, uint8_t *command );
467 
482 err_t wizfi360_write_cmd_param ( wizfi360_t *ctx, uint8_t *command, uint8_t *prefix, uint8_t *param );
483 
496 err_t wizfi360_inquire_command ( wizfi360_t *ctx, uint8_t *command );
497 
510 err_t wizfi360_send_message ( wizfi360_t *ctx, uint8_t *message );
511 
512 #ifdef __cplusplus
513 }
514 #endif
515 #endif // WIZFI360_H
516  // wizfi360
518 
519 // ------------------------------------------------------------------------ END
wizfi360_t::bt
digital_out_t bt
Definition: wizfi360.h:274
wizfi360_cfg_t::tx_pin
pin_name_t tx_pin
Definition: wizfi360.h:299
wizfi360_cfg_setup
void wizfi360_cfg_setup(wizfi360_cfg_t *cfg)
WIZFI360 configuration object setup function.
WIZFI360_OK
@ WIZFI360_OK
Definition: wizfi360.h:323
WIZFI360_RX_DRV_BUFFER_SIZE
#define WIZFI360_RX_DRV_BUFFER_SIZE
Definition: wizfi360.h:237
wizfi360_clear_to_send
void wizfi360_clear_to_send(wizfi360_t *ctx, uint8_t state)
WIZFI360 set clear to send pin state function.
wizfi360_t
WIZFI360 Click context object.
Definition: wizfi360.h:272
wizfi360_cfg_t::wkp
pin_name_t wkp
Definition: wizfi360.h:305
wizfi360_request_to_send
uint8_t wizfi360_request_to_send(wizfi360_t *ctx)
WIZFI360 get request to send pin state function.
wizfi360_cfg_t::baud_rate
uint32_t baud_rate
Definition: wizfi360.h:309
wizfi360_write_cmd_param
err_t wizfi360_write_cmd_param(wizfi360_t *ctx, uint8_t *command, uint8_t *prefix, uint8_t *param)
WIZFI360 command - prefix - parameter writing function.
wizfi360_t::wkp
digital_out_t wkp
Definition: wizfi360.h:277
WIZFI360_ERROR
@ WIZFI360_ERROR
Definition: wizfi360.h:324
wizfi360_t::uart
uart_t uart
Definition: wizfi360.h:283
wizfi360_wake_up
void wizfi360_wake_up(wizfi360_t *ctx)
WIZFI360 wake up function.
wizfi360_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: wizfi360.h:313
wizfi360_t::rts
digital_in_t rts
Definition: wizfi360.h:280
wizfi360_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: wizfi360.h:312
wizfi360_cfg_t::rst
pin_name_t rst
Definition: wizfi360.h:303
wizfi360_init
err_t wizfi360_init(wizfi360_t *ctx, wizfi360_cfg_t *cfg)
WIZFI360 initialization function.
wizfi360_inquire_command
err_t wizfi360_inquire_command(wizfi360_t *ctx, uint8_t *command)
WIZFI360 inquire command function.
wizfi360_cfg_t::rts
pin_name_t rts
Definition: wizfi360.h:306
wizfi360_return_value_t
wizfi360_return_value_t
WIZFI360 Click return value data.
Definition: wizfi360.h:322
wizfi360_set_rst_pin
void wizfi360_set_rst_pin(wizfi360_t *ctx, uint8_t state)
WIZFI360 set RST pin state function.
wizfi360_cfg_t::bt
pin_name_t bt
Definition: wizfi360.h:302
wizfi360_set_bt_pin
void wizfi360_set_bt_pin(wizfi360_t *ctx, uint8_t state)
WIZFI360 set BT pin state function.
wizfi360_write_command
err_t wizfi360_write_command(wizfi360_t *ctx, uint8_t *command)
WIZFI360 command writing function.
wizfi360_cfg_t::uart_blocking
bool uart_blocking
Definition: wizfi360.h:310
wizfi360_standby
void wizfi360_standby(wizfi360_t *ctx)
WIZFI360 standby function.
wizfi360_t::rst
digital_out_t rst
Definition: wizfi360.h:275
wizfi360_send_message
err_t wizfi360_send_message(wizfi360_t *ctx, uint8_t *message)
WIZFI360 send message function.
wizfi360_generic_write
err_t wizfi360_generic_write(wizfi360_t *ctx, uint8_t *data_in, uint16_t len)
WIZFI360 data writing function.
wizfi360_t::cts
digital_out_t cts
Definition: wizfi360.h:276
wizfi360_cfg_t::rx_pin
pin_name_t rx_pin
Definition: wizfi360.h:298
wizfi360_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: wizfi360.h:311
WIZFI360_TX_DRV_BUFFER_SIZE
#define WIZFI360_TX_DRV_BUFFER_SIZE
WIZFI360 driver buffer size.
Definition: wizfi360.h:236
wizfi360_generic_read
err_t wizfi360_generic_read(wizfi360_t *ctx, uint8_t *data_out, uint16_t len)
WIZFI360 data reading function.
wizfi360_cfg_t::cts
pin_name_t cts
Definition: wizfi360.h:304
wizfi360_cfg_t
WIZFI360 Click configuration object.
Definition: wizfi360.h:296