wifinora  2.1.0.0
wifinora.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 WIFINORA_H
29 #define WIFINORA_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 WIFINORA_CMD_AT "AT"
74 #define WIFINORA_CMD_AT_USYFR "AT+USYFR"
75 #define WIFINORA_CMD_AT_GMM "AT+GMM"
76 #define WIFINORA_CMD_AT_SW_RESET "AT+CPWROFF"
77 #define WIFINORA_CMD_AT_UWAPC "AT+UWAPC"
78 #define WIFINORA_CMD_AT_UWSCP "AT+UWSCP"
79 #define WIFINORA_CMD_AT_UWSIPD "AT+UWSIPD"
80 #define WIFINORA_CMD_AT_UWSSW "AT+UWSSW"
81 #define WIFINORA_CMD_AT_UWSC "AT+UWSC"
82 #define WIFINORA_CMD_AT_USOCR "AT+USOCR"
83 #define WIFINORA_CMD_AT_USOC "AT+USOC"
84 #define WIFINORA_CMD_AT_USOWS "AT+USOWS"
85 #define WIFINORA_CMD_AT_USORS "AT+USORS"
86 #define WIFINORA_CMD_AT_USOCL "AT+USOCL"
87 
92 #define WIFINORA_RSP_OK "OK"
93 #define WIFINORA_RSP_ERROR "ERROR"
94 #define WIFINORA_RSP_READY "+STARTUP"
95 
100 #define WIFINORA_PIN_STATE_HIGH 0x01
101 #define WIFINORA_PIN_STATE_LOW 0x00
102 
108 #define WIFINORA_TX_DRV_BUFFER_SIZE 100
109 #define WIFINORA_RX_DRV_BUFFER_SIZE 300
110  // wifinora_cmd
112 
127 #define WIFINORA_MAP_MIKROBUS( cfg, mikrobus ) \
128  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
129  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
130  cfg.whs = MIKROBUS( mikrobus, MIKROBUS_AN ); \
131  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
132  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
133  cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
134  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
135  // wifinora_map // wifinora
138 
143 typedef struct
144 {
145  // Output pins
146  digital_out_t wkp;
147  digital_out_t rst;
148  digital_out_t cts;
150  // Input pins
151  digital_in_t whs;
152  digital_in_t rts;
154  // Modules
155  uart_t uart;
157  // Buffers
158  uint8_t uart_rx_buffer[ WIFINORA_RX_DRV_BUFFER_SIZE ];
159  uint8_t uart_tx_buffer[ WIFINORA_TX_DRV_BUFFER_SIZE ];
161 } wifinora_t;
162 
167 typedef struct
168 {
169  // Communication gpio pins
170  pin_name_t rx_pin;
171  pin_name_t tx_pin;
173  // Additional gpio pins
174  pin_name_t wkp;
175  pin_name_t rst;
176  pin_name_t cts;
177  pin_name_t whs;
178  pin_name_t rts;
180  // Static variable
181  uint32_t baud_rate;
183  uart_data_bits_t data_bit;
184  uart_parity_t parity_bit;
185  uart_stop_bits_t stop_bit;
188 
193 typedef enum
194 {
200 
202 
219 
234 
247 err_t wifinora_generic_write ( wifinora_t *ctx, uint8_t *data_in, uint16_t len );
248 
261 err_t wifinora_generic_read ( wifinora_t *ctx, uint8_t *data_out, uint16_t len );
262 
272 void wifinora_set_rst_pin ( wifinora_t *ctx, uint8_t pin_state );
273 
283 void wifinora_set_wkp_pin ( wifinora_t *ctx, uint8_t pin_state );
284 
294 void wifinora_set_cts_pin ( wifinora_t *ctx, uint8_t pin_state );
295 
305 
315 
325 
335 void wifinora_send_cmd ( wifinora_t *ctx, uint8_t *at_cmd_buf );
336 
347 void wifinora_send_cmd_with_par ( wifinora_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
348 
358 void wifinora_send_cmd_check ( wifinora_t *ctx, uint8_t *at_cmd_buf );
359 
360 #ifdef __cplusplus
361 }
362 #endif
363 #endif // WIFINORA_H
364  // wifinora
366 
367 // ------------------------------------------------------------------------ END
wifinora_send_cmd_check
void wifinora_send_cmd_check(wifinora_t *ctx, uint8_t *at_cmd_buf)
WiFi NORA send command check function.
WIFINORA_ERROR_TIMEOUT
@ WIFINORA_ERROR_TIMEOUT
Definition: wifinora.h:197
wifinora_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: wifinora.h:185
wifinora_generic_write
err_t wifinora_generic_write(wifinora_t *ctx, uint8_t *data_in, uint16_t len)
WiFi NORA data writing function.
WIFINORA_OK
@ WIFINORA_OK
Definition: wifinora.h:195
wifinora_t::rst
digital_out_t rst
Definition: wifinora.h:147
wifinora_send_cmd
void wifinora_send_cmd(wifinora_t *ctx, uint8_t *at_cmd_buf)
WiFi NORA send command function.
WIFINORA_ERROR
@ WIFINORA_ERROR
Definition: wifinora.h:196
wifinora_cfg_t::wkp
pin_name_t wkp
Definition: wifinora.h:174
wifinora_init
err_t wifinora_init(wifinora_t *ctx, wifinora_cfg_t *cfg)
WiFi NORA initialization function.
wifinora_t::cts
digital_out_t cts
Definition: wifinora.h:148
wifinora_get_whs_pin
uint8_t wifinora_get_whs_pin(wifinora_t *ctx)
WiFi NORA get WHS pin state function.
wifinora_cfg_t::rts
pin_name_t rts
Definition: wifinora.h:178
wifinora_get_rts_pin
uint8_t wifinora_get_rts_pin(wifinora_t *ctx)
WiFi NORA get RTS pin state function.
wifinora_set_wkp_pin
void wifinora_set_wkp_pin(wifinora_t *ctx, uint8_t pin_state)
WiFi NORA set WKP pin function.
wifinora_cfg_setup
void wifinora_cfg_setup(wifinora_cfg_t *cfg)
WiFi NORA configuration object setup function.
wifinora_return_value_t
wifinora_return_value_t
WiFi NORA Click return value data.
Definition: wifinora.h:194
wifinora_cfg_t::uart_blocking
bool uart_blocking
Definition: wifinora.h:182
wifinora_cfg_t::baud_rate
uint32_t baud_rate
Definition: wifinora.h:181
wifinora_t::whs
digital_in_t whs
Definition: wifinora.h:151
wifinora_hw_reset
void wifinora_hw_reset(wifinora_t *ctx)
WiFi NORA HW reset function.
wifinora_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: wifinora.h:184
WIFINORA_TX_DRV_BUFFER_SIZE
#define WIFINORA_TX_DRV_BUFFER_SIZE
WiFi NORA driver buffer size.
Definition: wifinora.h:108
wifinora_set_cts_pin
void wifinora_set_cts_pin(wifinora_t *ctx, uint8_t pin_state)
WiFi NORA set CTS pin function.
wifinora_cfg_t
WiFi NORA Click configuration object.
Definition: wifinora.h:168
WIFINORA_RX_DRV_BUFFER_SIZE
#define WIFINORA_RX_DRV_BUFFER_SIZE
Definition: wifinora.h:109
wifinora_t
WiFi NORA Click context object.
Definition: wifinora.h:144
wifinora_cfg_t::tx_pin
pin_name_t tx_pin
Definition: wifinora.h:171
wifinora_generic_read
err_t wifinora_generic_read(wifinora_t *ctx, uint8_t *data_out, uint16_t len)
WiFi NORA data reading function.
wifinora_send_cmd_with_par
void wifinora_send_cmd_with_par(wifinora_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
WiFi NORA send command with parameter function.
wifinora_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: wifinora.h:183
WIFINORA_ERROR_UNKNOWN
@ WIFINORA_ERROR_UNKNOWN
Definition: wifinora.h:199
wifinora_cfg_t::whs
pin_name_t whs
Definition: wifinora.h:177
wifinora_set_rst_pin
void wifinora_set_rst_pin(wifinora_t *ctx, uint8_t pin_state)
WiFi NORA set RST pin function.
wifinora_cfg_t::cts
pin_name_t cts
Definition: wifinora.h:176
wifinora_cfg_t::rx_pin
pin_name_t rx_pin
Definition: wifinora.h:170
wifinora_t::uart
uart_t uart
Definition: wifinora.h:155
WIFINORA_ERROR_CMD
@ WIFINORA_ERROR_CMD
Definition: wifinora.h:198
wifinora_cfg_t::rst
pin_name_t rst
Definition: wifinora.h:175
wifinora_t::rts
digital_in_t rts
Definition: wifinora.h:152
wifinora_t::wkp
digital_out_t wkp
Definition: wifinora.h:146