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 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define WIZFI360_CMD_AT "AT"
70 #define WIZFI360_CMD_RST "AT+RST"
71 #define WIZFI360_CMD_GMR "AT+GMR"
72 #define WIZFI360_CMD_GSLP "AT+GSLP"
73 #define WIZFI360_CMD_ATE "ATE"
74 #define WIZFI360_CMD_RESTORE "AT+RESTORE"
75 #define WIZFI360_CMD_UART_CUR "AT+UART_CUR"
76 #define WIZFI360_CMD_UART_DEF "AT+UART_DEF"
77 #define WIZFI360_CMD_SLEEP "AT+SLEEP"
78 #define WIZFI360_CMD_SYSIOSETCFG "AT+SYSIOSETCFG"
79 #define WIZFI360_CMD_SYSIOGETCFG "AT+SYSIOGETCFG"
80 #define WIZFI360_CMD_SYSGPIODIR "AT+SYSGPIODIR"
81 #define WIZFI360_CMD_SYSGPIOWRITE "AT+SYSGPIOWRITE"
82 #define WIZFI360_CMD_SYSGPIOREAD "AT+SYSGPIOREAD"
83 #define WIZFI360_CMD_EXECUTE_AT_CMD "+++"
84 
89 #define WIZFI360_CMD_CWMODE_CUR "AT+CWMODE_CUR"
90 #define WIZFI360_CMD_CWMODE_DEF "AT+CWMODE_DEF"
91 #define WIZFI360_CMD_CWJAP_CUR "AT+CWJAP_CUR"
92 #define WIZFI360_CMD_CWJAP_DEF "AT+CWJAP_DEF"
93 #define WIZFI360_CMD_CWLAPOPT "AT+CWLAPOPT"
94 #define WIZFI360_CMD_CWLAP "AT+CWLAP"
95 #define WIZFI360_CMD_CWQAP "AT+CWQAP"
96 #define WIZFI360_CMD_CWSAP_CUR "AT+CWSAP_CUR"
97 #define WIZFI360_CMD_CWSAP_DEF "AT+CWSAP_DEF"
98 #define WIZFI360_CMD_CWLIF "AT+CWLIF"
99 #define WIZFI360_CMD_CWDHCP_CUR "AT+CWDHCP_CUR"
100 #define WIZFI360_CMD_CWDHCP_DEF "AT+CWDHCP_DEF"
101 #define WIZFI360_CMD_CWDHCPS_CUR "AT+CWDHCPS_CUR"
102 #define WIZFI360_CMD_CWDHCPS_DEF "AT+CWDHCPS_DEF"
103 #define WIZFI360_CMD_CWAUTOCONN "AT+CWAUTOCONN"
104 #define WIZFI360_CMD_CIPSTAMAC_CUR "AT+CIPSTAMAC_CUR"
105 #define WIZFI360_CMD_CIPSTAMAC_DEF "AT+CIPSTAMAC_DEF"
106 #define WIZFI360_CMD_CIPAPMAC_CUR "AT+CIPAPMAC_CUR"
107 #define WIZFI360_CMD_CIPAPMAC_DEF "AT+CIPAPMAC_DEF"
108 #define WIZFI360_CMD_CIPSTA_CUR "AT+CIPSTA_CUR"
109 #define WIZFI360_CMD_CIPSTA_DEF "AT+CIPSTA_DEF"
110 #define WIZFI360_CMD_CIPAP_CUR "AT+CIPAP_CUR"
111 #define WIZFI360_CMD_CIPAP_DEF "AT+CIPAP_DEF"
112 #define WIZFI360_CMD_CWSTARTSMART "AT+CWSTARTSMART"
113 #define WIZFI360_CMD_CWSTOPSMART "AT+CWSTOPSMART"
114 #define WIZFI360_CMD_WPS "AT+WPS"
115 #define WIZFI360_CMD_CWHOSTNAME "AT+CWHOSTNAME"
116 #define WIZFI360_CMD_CWCOUNTRY_CUR "AT+CWCOUNTRY_CUR"
117 #define WIZFI360_CMD_CWCOUNTRY_DEF "AT+CWCOUNTRY_DEF"
118 #define WIZFI360_CMD_WIZ_NETCONFIG "AT+WIZ_NETCONFIG"
119 
124 #define WIZFI360_CMD_CIPSTATUS "AT+CIPSTATUS"
125 #define WIZFI360_CMD_CIPDOMAIN "AT+CIPDOMAIN"
126 #define WIZFI360_CMD_CIPSTART "AT+CIPSTART"
127 #define WIZFI360_CMD_CIPSSLSIZE "AT+CIPSSLSIZE"
128 #define WIZFI360_CMD_CIPSSLCCONF "AT+CIPSSLCCONF"
129 #define WIZFI360_CMD_CASEND "AT+CASEND"
130 #define WIZFI360_CMD_CIPSEND "AT+CIPSEND"
131 #define WIZFI360_CMD_CIPSENDEX "AT+CIPSENDEX"
132 #define WIZFI360_CMD_CIPSENDBUF "AT+CIPSENDBUF"
133 #define WIZFI360_CMD_CIPBUFRESET "AT+CIPBUFRESET"
134 #define WIZFI360_CMD_CIPBUFSTATUS "AT+CIPBUFSTATUS"
135 #define WIZFI360_CMD_CIPCHECKSEQ "AT+CIPCHECKSEQ"
136 #define WIZFI360_CMD_CIPCLOSE "AT+CIPCLOSE"
137 #define WIZFI360_CMD_CIFSR "AT+CIFSR"
138 #define WIZFI360_CMD_CIPMUX "AT+CIPMUX"
139 #define WIZFI360_CMD_CIPSERVER "AT+CIPSERVER"
140 #define WIZFI360_CMD_CIPSERVERMAXCONN "AT+CIPSERVERMAXCONN"
141 #define WIZFI360_CMD_CIPMODE "AT+CIPMODE"
142 #define WIZFI360_CMD_SAVETRANSLINK "AT+SAVETRANSLINK"
143 #define WIZFI360_CMD_CIPSTO "AT+CIPSTO"
144 #define WIZFI360_CMD_CIUPDATE "AT+CIUPDATE"
145 #define WIZFI360_CMD_PING "AT+PING"
146 #define WIZFI360_CMD_CIPDINFO "AT+CIPDINFO"
147 #define WIZFI360_CMD_CIPSNTPCFG "AT+CIPSNTPCFG"
148 #define WIZFI360_CMD_CIPSNTPTIME "AT+CIPSNTPTIME"
149 #define WIZFI360_CMD_CIPDNS_CUR "AT+CIPDNS_CUR"
150 #define WIZFI360_CMD_CIPDNS_DEF "AT+CIPDNS_DEF"
151 #define WIZFI360_CMD_MQTTSET "AT+MQTTSET"
152 #define WIZFI360_CMD_MQTTOPIC "AT+MQTTOPIC"
153 #define WIZFI360_CMD_MQTTQOS "AT+MQTTQOS"
154 #define WIZFI360_CMD_MQTTCON "AT+MQTTCON"
155 #define WIZFI360_CMD_MQTTPUB "AT+MQTTPUB"
156 #define WIZFI360_CMD_MQTTPUBSEND "AT+MQTTPUBSEND"
157 #define WIZFI360_CMD_MQTTDIS "AT+MQTTDIS"
158 #define WIZFI360_CMD_AZSET "AT+AZSET"
159 #define WIZFI360_CMD_AZCON "AT+AZCON"
160 #define WIZFI360_CMD_AWSPKSEND "AT+AWSPKSEND"
161 #define WIZFI360_CMD_CLICASEND "AT+CLICASEND"
162 #define WIZFI360_CMD_AWSCON "AT+AWSCON"
163 
168 #define WIZFI360_CWMODE_STATION "1"
169 #define WIZFI360_CWMODE_SOFTAP "2"
170 #define WIZFI360_CWMODE_STATION_SOFTAP "3"
171 
176 #define WIZFI360_CIPMUX_SINGLE_CONN "0"
177 #define WIZFI360_CIPMUX_MULTIPLE_CONN "1"
178 
183 #define WIZFI360_CWDHCP_SOFTAP "0,0"
184 #define WIZFI360_CWDHCP_SOFTAP_DHCP "0,1"
185 #define WIZFI360_CWDHCP_STATION "1,0"
186 #define WIZFI360_CWDHCP_STATION_DHCP "1,1"
187 #define WIZFI360_CWDHCP_SOFTAP_STATION "2,0"
188 #define WIZFI360_CWDHCP_SFT_ST_DHCP "2,1"
189 
194 #define WIZFI360_ENABLE_TIMEZONE_1 "1,1"
195 
200 #define WIZFI360_PREFIX_SYMB_END "\r\n"
201 #define WIZFI360_PREFIX_SYMB_QUOTE "\""
202 #define WIZFI360_PREFIX_SYMB_SEPARATOR ","
203 #define WIZFI360_PREFIX_SYMB_QUERY "?"
204 #define WIZFI360_PREFIX_SYMB_SET_VAL "="
205 #define WIZFI360_PREFIX_SYMB_PLUS "+"
206 #define WIZFI360_PREFIX_SYMB_SPACE " "
207 #define WIZFI360_PREFIX_SYMB_NULL ""
208 
213 #define WIZFI360_RSP_OK "OK"
214 #define WIZFI360_RSP_ERROR "ERROR"
215 #define WIZFI360_RSP_READY_FOR_SEND ">"
216 #define WIZFI360_RSP_SEND_OK "SEND OK"
217 #define WIZFI360_RECEIVE "+IPD"
218 #define WIZFI360_MESSAGE_END "\032"
219 
224 #define WIZFI360_PIN_STATE_LOW 0
225 #define WIZFI360_PIN_STATE_HIGH 1
226 
232 #define WIZFI360_TX_DRV_BUFFER_SIZE 100
233 #define WIZFI360_RX_DRV_BUFFER_SIZE 300
234  // wizfi360_cmd
236 
251 #define WIZFI360_MAP_MIKROBUS( cfg, mikrobus ) \
252  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
253  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
254  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
255  cfg.bt = MIKROBUS( mikrobus, MIKROBUS_AN ); \
256  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
257  cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
258  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
259  // wizfi360_map // wizfi360
262 
267 typedef struct
268 {
269  // Output pins
270  digital_out_t bt;
271  digital_out_t rst;
272  digital_out_t cts;
273  digital_out_t wkp;
275  // Input pins
276  digital_in_t rts;
278  // Modules
279  uart_t uart;
281  // Buffers
282  uint8_t uart_rx_buffer[ WIZFI360_RX_DRV_BUFFER_SIZE ];
283  uint8_t uart_tx_buffer[ WIZFI360_TX_DRV_BUFFER_SIZE ];
285 } wizfi360_t;
286 
291 typedef struct
292 {
293  // Communication gpio pins
294  pin_name_t rx_pin;
295  pin_name_t tx_pin;
297  // Additional gpio pins
298  pin_name_t bt;
299  pin_name_t rst;
300  pin_name_t cts;
301  pin_name_t wkp;
302  pin_name_t rts;
304  // Static variable
305  uint32_t baud_rate;
307  uart_data_bits_t data_bit;
308  uart_parity_t parity_bit;
309  uart_stop_bits_t stop_bit;
312 
317 typedef enum
318 {
320  WIZFI360_ERROR = -1
321 
323 
340 
355 
365 void wizfi360_set_rst_pin ( wizfi360_t *ctx, uint8_t state );
366 
376 void wizfi360_set_bt_pin ( wizfi360_t *ctx, uint8_t state );
377 
388 
398 
409 
419 void wizfi360_clear_to_send ( wizfi360_t *ctx, uint8_t state );
420 
434 err_t wizfi360_generic_write ( wizfi360_t *ctx, uint8_t *data_in, uint16_t len );
435 
449 err_t wizfi360_generic_read ( wizfi360_t *ctx, uint8_t *data_out, uint16_t len );
450 
462 err_t wizfi360_write_command ( wizfi360_t *ctx, uint8_t *command );
463 
478 err_t wizfi360_write_cmd_param ( wizfi360_t *ctx, uint8_t *command, uint8_t *prefix, uint8_t *param );
479 
492 err_t wizfi360_inquire_command ( wizfi360_t *ctx, uint8_t *command );
493 
506 err_t wizfi360_send_message ( wizfi360_t *ctx, uint8_t *message );
507 
508 #ifdef __cplusplus
509 }
510 #endif
511 #endif // WIZFI360_H
512  // wizfi360
514 
515 // ------------------------------------------------------------------------ END
wizfi360_t::bt
digital_out_t bt
Definition: wizfi360.h:270
wizfi360_cfg_t::tx_pin
pin_name_t tx_pin
Definition: wizfi360.h:295
wizfi360_cfg_setup
void wizfi360_cfg_setup(wizfi360_cfg_t *cfg)
WIZFI360 configuration object setup function.
WIZFI360_OK
@ WIZFI360_OK
Definition: wizfi360.h:319
WIZFI360_RX_DRV_BUFFER_SIZE
#define WIZFI360_RX_DRV_BUFFER_SIZE
Definition: wizfi360.h:233
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:268
wizfi360_cfg_t::wkp
pin_name_t wkp
Definition: wizfi360.h:301
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:305
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:273
WIZFI360_ERROR
@ WIZFI360_ERROR
Definition: wizfi360.h:320
wizfi360_t::uart
uart_t uart
Definition: wizfi360.h:279
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:309
wizfi360_t::rts
digital_in_t rts
Definition: wizfi360.h:276
wizfi360_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: wizfi360.h:308
wizfi360_cfg_t::rst
pin_name_t rst
Definition: wizfi360.h:299
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:302
wizfi360_return_value_t
wizfi360_return_value_t
WIZFI360 Click return value data.
Definition: wizfi360.h:318
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:298
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:306
wizfi360_standby
void wizfi360_standby(wizfi360_t *ctx)
WIZFI360 standby function.
wizfi360_t::rst
digital_out_t rst
Definition: wizfi360.h:271
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:272
wizfi360_cfg_t::rx_pin
pin_name_t rx_pin
Definition: wizfi360.h:294
wizfi360_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: wizfi360.h:307
WIZFI360_TX_DRV_BUFFER_SIZE
#define WIZFI360_TX_DRV_BUFFER_SIZE
WIZFI360 driver buffer size.
Definition: wizfi360.h:232
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:300
wizfi360_cfg_t
WIZFI360 Click configuration object.
Definition: wizfi360.h:292