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
32extern "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 WIFINORA_CMD_AT "AT"
70#define WIFINORA_CMD_AT_USYFR "AT+USYFR"
71#define WIFINORA_CMD_AT_GMM "AT+GMM"
72#define WIFINORA_CMD_AT_SW_RESET "AT+CPWROFF"
73#define WIFINORA_CMD_AT_UWAPC "AT+UWAPC"
74#define WIFINORA_CMD_AT_UWSCP "AT+UWSCP"
75#define WIFINORA_CMD_AT_UWSIPD "AT+UWSIPD"
76#define WIFINORA_CMD_AT_UWSSW "AT+UWSSW"
77#define WIFINORA_CMD_AT_UWSC "AT+UWSC"
78#define WIFINORA_CMD_AT_USOCR "AT+USOCR"
79#define WIFINORA_CMD_AT_USOC "AT+USOC"
80#define WIFINORA_CMD_AT_USOWS "AT+USOWS"
81#define WIFINORA_CMD_AT_USORS "AT+USORS"
82#define WIFINORA_CMD_AT_USOCL "AT+USOCL"
83
88#define WIFINORA_RSP_OK "OK"
89#define WIFINORA_RSP_ERROR "ERROR"
90#define WIFINORA_RSP_READY "+STARTUP"
91
96#define WIFINORA_PIN_STATE_HIGH 0x01
97#define WIFINORA_PIN_STATE_LOW 0x00
98
104#define WIFINORA_TX_DRV_BUFFER_SIZE 100
105#define WIFINORA_RX_DRV_BUFFER_SIZE 300
106 // wifinora_cmd
108
123#define WIFINORA_MAP_MIKROBUS( cfg, mikrobus ) \
124 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
125 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
126 cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
127 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
128 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
129 cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
130 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
131 // wifinora_map // wifinora
134
139typedef struct
140{
141 // Output pins
142 digital_out_t dsr;
143 digital_out_t rst;
144 digital_out_t cts;
146 // Input pins
147 digital_in_t dtr;
148 digital_in_t rts;
150 // Modules
151 uart_t uart;
153 // Buffers
154 uint8_t uart_rx_buffer[ WIFINORA_RX_DRV_BUFFER_SIZE ];
155 uint8_t uart_tx_buffer[ WIFINORA_TX_DRV_BUFFER_SIZE ];
157} wifinora_t;
158
163typedef struct
164{
165 // Communication gpio pins
166 pin_name_t rx_pin;
167 pin_name_t tx_pin;
169 // Additional gpio pins
170 pin_name_t dsr;
171 pin_name_t rst;
172 pin_name_t cts;
173 pin_name_t dtr;
174 pin_name_t rts;
176 // Static variable
177 uint32_t baud_rate;
179 uart_data_bits_t data_bit;
180 uart_parity_t parity_bit;
181 uart_stop_bits_t stop_bit;
184
189typedef enum
190{
196
198
215
230
243err_t wifinora_generic_write ( wifinora_t *ctx, uint8_t *data_in, uint16_t len );
244
257err_t wifinora_generic_read ( wifinora_t *ctx, uint8_t *data_out, uint16_t len );
258
268void wifinora_set_rst_pin ( wifinora_t *ctx, uint8_t pin_state );
269
279void wifinora_set_dsr_pin ( wifinora_t *ctx, uint8_t pin_state );
280
290void wifinora_set_cts_pin ( wifinora_t *ctx, uint8_t pin_state );
291
301
311
321
331void wifinora_send_cmd ( wifinora_t *ctx, uint8_t *at_cmd_buf );
332
343void wifinora_send_cmd_with_par ( wifinora_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
344
354void wifinora_send_cmd_check ( wifinora_t *ctx, uint8_t *at_cmd_buf );
355
356#ifdef __cplusplus
357}
358#endif
359#endif // WIFINORA_H
360 // wifinora
362
363// ------------------------------------------------------------------------ END
#define WIFINORA_RX_DRV_BUFFER_SIZE
Definition: wifinora.h:105
#define WIFINORA_TX_DRV_BUFFER_SIZE
WiFi NORA driver buffer size.
Definition: wifinora.h:104
err_t wifinora_init(wifinora_t *ctx, wifinora_cfg_t *cfg)
WiFi NORA initialization function.
void wifinora_send_cmd(wifinora_t *ctx, uint8_t *at_cmd_buf)
WiFi NORA send command function.
uint8_t wifinora_get_rts_pin(wifinora_t *ctx)
WiFi NORA get RTS pin state function.
void wifinora_hw_reset(wifinora_t *ctx)
WiFi NORA HW reset function.
void wifinora_set_rst_pin(wifinora_t *ctx, uint8_t pin_state)
WiFi NORA set RST pin function.
err_t wifinora_generic_read(wifinora_t *ctx, uint8_t *data_out, uint16_t len)
WiFi NORA data reading function.
void wifinora_cfg_setup(wifinora_cfg_t *cfg)
WiFi NORA configuration object setup function.
void wifinora_send_cmd_check(wifinora_t *ctx, uint8_t *at_cmd_buf)
WiFi NORA send command check function.
uint8_t wifinora_get_dtr_pin(wifinora_t *ctx)
WiFi NORA get DTR pin state function.
err_t wifinora_generic_write(wifinora_t *ctx, uint8_t *data_in, uint16_t len)
WiFi NORA data writing function.
void wifinora_set_dsr_pin(wifinora_t *ctx, uint8_t pin_state)
WiFi NORA set DSR pin function.
void wifinora_set_cts_pin(wifinora_t *ctx, uint8_t pin_state)
WiFi NORA set CTS pin function.
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.
WiFi NORA Click configuration object.
Definition: wifinora.h:164
pin_name_t dtr
Definition: wifinora.h:173
pin_name_t rts
Definition: wifinora.h:174
uint32_t baud_rate
Definition: wifinora.h:177
pin_name_t cts
Definition: wifinora.h:172
bool uart_blocking
Definition: wifinora.h:178
uart_data_bits_t data_bit
Definition: wifinora.h:179
pin_name_t tx_pin
Definition: wifinora.h:167
pin_name_t rx_pin
Definition: wifinora.h:166
uart_stop_bits_t stop_bit
Definition: wifinora.h:181
pin_name_t dsr
Definition: wifinora.h:170
uart_parity_t parity_bit
Definition: wifinora.h:180
pin_name_t rst
Definition: wifinora.h:171
WiFi NORA Click context object.
Definition: wifinora.h:140
digital_out_t dsr
Definition: wifinora.h:142
uart_t uart
Definition: wifinora.h:151
digital_in_t rts
Definition: wifinora.h:148
digital_out_t rst
Definition: wifinora.h:143
digital_out_t cts
Definition: wifinora.h:144
digital_in_t dtr
Definition: wifinora.h:147
wifinora_return_value_t
WiFi NORA Click return value data.
Definition: wifinora.h:190
@ WIFINORA_ERROR_TIMEOUT
Definition: wifinora.h:193
@ WIFINORA_ERROR_UNKNOWN
Definition: wifinora.h:195
@ WIFINORA_ERROR_CMD
Definition: wifinora.h:194
@ WIFINORA_ERROR
Definition: wifinora.h:192
@ WIFINORA_OK
Definition: wifinora.h:191