ninaw152  2.1.0.0
ninaw152.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 NINAW152_H
29 #define NINAW152_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 #include "drv_spi_master.h"
49 #include "spi_specifics.h"
50 
71 #define NINAW152_CMD_AT "AT"
72 #define NINAW152_CMD_GET_MODEL_ID "AT+GMM"
73 #define NINAW152_CMD_GET_SW_VERSION "AT+GMR"
74 #define NINAW152_CMD_GET_SERIAL_NUM "AT+GSN"
75 #define NINAW152_CMD_FACTORY_RESET "AT+UFACTORY"
76 #define NINAW152_CMD_REBOOT_DEVICE "AT+CPWROFF"
77 #define NINAW152_CMD_NETWORK_HOST_NAME "AT+UNHN"
78 #define NINAW152_CMD_BT_LOCAL_NAME "AT+UBTLN"
79 #define NINAW152_CMD_WIFI_STATION_CONFIG "AT+UWSC"
80 #define NINAW152_CMD_WIFI_STATION_CONFIG_ACTION "AT+UWSCA"
81 #define NINAW152_CMD_WIFI_STATION_STATUS "AT+UWSSTAT"
82 #define NINAW152_CMD_CONNECT_PEER "AT+UDCP"
83 #define NINAW152_CMD_WRITE_DATA "AT+UDATW"
84 #define NINAW152_CMD_READ_DATA "AT+UDATR"
85 #define NINAW152_CMD_CLOSE_PEER "AT+UDCPC"
86 #define NINAW152_CMD_ENTER_DATA_MODE "ATO1"
87 #define NINAW152_CMD_ENTER_CMD_MODE "+++"
88 
93 #define NINAW152_RSP_OK "OK"
94 #define NINAW152_RSP_ERROR "ERROR"
95 
100 #define NINAW152_URC_GREETING "+STARTUP"
101 #define NINAW152_URC_WIFI_LINK_CONNECTED "+UUWLE:"
102 #define NINAW152_URC_NETWORK_UP "+UUNU:"
103 #define NINAW152_URC_PEER_CONNECTED "+UUDPC:"
104 #define NINAW152_URC_PEER_DISCONNECTED "+UUDPD:"
105 #define NINAW152_URC_READ_SOCKET_DATA "+UUDATA:"
106 
112 #define NINAW152_TX_DRV_BUFFER_SIZE 200
113 #define NINAW152_RX_DRV_BUFFER_SIZE 600
114 
119 #define NINAW152_SPI_HEADER_0 0xBA
120 #define NINAW152_SPI_HEADER_1 0x15
121 #define NINAW152_SPI_NORX 0x80
122 
131 #define NINAW152_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
132 #define NINAW152_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
133  // ninaw152_cmd
135 
150 #define NINAW152_MAP_MIKROBUS( cfg, mikrobus ) \
151  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
152  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
153  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
154  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
155  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
156  cfg.sry = MIKROBUS( mikrobus, MIKROBUS_AN ); \
157  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
158  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
159  cfg.esc = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
160  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
161  // ninaw152_map // ninaw152
164 
169 typedef enum
170 {
175 
180 typedef struct
181 {
182  // Output pins
183  digital_out_t rst;
184  digital_out_t cts;
185  digital_out_t esc;
187  // Input pins
188  digital_in_t sry;
189  digital_in_t rts;
191  // Modules
192  uart_t uart;
193  spi_master_t spi;
195  uint8_t uart_rx_buffer[ NINAW152_RX_DRV_BUFFER_SIZE ];
196  uint8_t uart_tx_buffer[ NINAW152_TX_DRV_BUFFER_SIZE ];
198  uint8_t slave_address;
199  pin_name_t chip_select;
202 } ninaw152_t;
203 
208 typedef struct
209 {
210  // Communication gpio pins
211  pin_name_t miso;
212  pin_name_t mosi;
213  pin_name_t sck;
214  pin_name_t rx_pin;
215  pin_name_t tx_pin;
217  // Additional gpio pins
218  pin_name_t sry;
219  pin_name_t rst;
220  pin_name_t cts;
221  pin_name_t esc;
222  pin_name_t rts;
224  // Static variable
225  uint32_t baud_rate;
227  uart_data_bits_t data_bit;
228  uart_parity_t parity_bit;
229  uart_stop_bits_t stop_bit;
231  uint32_t spi_speed;
232  spi_master_mode_t spi_mode;
233  spi_master_chip_select_polarity_t cs_polarity;
238 
243 typedef enum
244 {
250 
252 
269 
284 
300 
313 err_t ninaw152_generic_write ( ninaw152_t *ctx, uint8_t *data_in, uint16_t len );
314 
327 err_t ninaw152_generic_read ( ninaw152_t *ctx, uint8_t *data_out, uint16_t len );
328 
338 void ninaw152_set_rst_pin ( ninaw152_t *ctx, uint8_t state );
339 
349 
359 void ninaw152_set_cts_pin ( ninaw152_t *ctx, uint8_t state );
360 
370 void ninaw152_set_esc_pin ( ninaw152_t *ctx, uint8_t state );
371 
381 
391 
401 void ninaw152_send_cmd ( ninaw152_t *ctx, uint8_t *cmd );
402 
413 void ninaw152_send_cmd_with_par ( ninaw152_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
414 
424 void ninaw152_send_cmd_check ( ninaw152_t *ctx, uint8_t *at_cmd_buf );
425 
426 #ifdef __cplusplus
427 }
428 #endif
429 #endif // NINAW152_H
430  // ninaw152
432 
433 // ------------------------------------------------------------------------ END
ninaw152_cfg_t::baud_rate
uint32_t baud_rate
Definition: ninaw152.h:225
ninaw152_drv_interface_sel
void ninaw152_drv_interface_sel(ninaw152_cfg_t *cfg, ninaw152_drv_t drv_sel)
NINA-W152 driver interface setup function.
ninaw152_cfg_t::spi_speed
uint32_t spi_speed
Definition: ninaw152.h:231
ninaw152_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ninaw152.h:227
NINAW152_OK
@ NINAW152_OK
Definition: ninaw152.h:245
ninaw152_t::slave_address
uint8_t slave_address
Definition: ninaw152.h:198
ninaw152_set_rst_pin
void ninaw152_set_rst_pin(ninaw152_t *ctx, uint8_t state)
NINA-W152 set rst pin function.
ninaw152_t::rst
digital_out_t rst
Definition: ninaw152.h:183
ninaw152_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ninaw152.h:228
ninaw152_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ninaw152.h:214
ninaw152_cfg_t::esc
pin_name_t esc
Definition: ninaw152.h:221
spi_specifics.h
This file contains SPI specific macros, functions, etc.
ninaw152_t::uart
uart_t uart
Definition: ninaw152.h:192
ninaw152_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ninaw152.h:233
ninaw152_return_value_t
ninaw152_return_value_t
NINA-W152 Click return value data.
Definition: ninaw152.h:244
ninaw152_t::sry
digital_in_t sry
Definition: ninaw152.h:188
ninaw152_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: ninaw152.h:232
ninaw152_init
err_t ninaw152_init(ninaw152_t *ctx, ninaw152_cfg_t *cfg)
NINA-W152 initialization function.
ninaw152_generic_read
err_t ninaw152_generic_read(ninaw152_t *ctx, uint8_t *data_out, uint16_t len)
NINA-W152 data reading function.
ninaw152_cfg_t::cts
pin_name_t cts
Definition: ninaw152.h:220
ninaw152_t::chip_select
pin_name_t chip_select
Definition: ninaw152.h:199
NINAW152_ERROR
@ NINAW152_ERROR
Definition: ninaw152.h:246
ninaw152_cfg_t
NINA-W152 Click configuration object.
Definition: ninaw152.h:209
ninaw152_send_cmd_check
void ninaw152_send_cmd_check(ninaw152_t *ctx, uint8_t *at_cmd_buf)
NINA-W152 send command check function.
ninaw152_t
NINA-W152 Click context object.
Definition: ninaw152.h:181
ninaw152_generic_write
err_t ninaw152_generic_write(ninaw152_t *ctx, uint8_t *data_in, uint16_t len)
NINA-W152 data writing function.
ninaw152_set_esc_pin
void ninaw152_set_esc_pin(ninaw152_t *ctx, uint8_t state)
NINA-W152 set esc pin function.
ninaw152_get_sry_pin
uint8_t ninaw152_get_sry_pin(ninaw152_t *ctx)
NINA-W152 get sry pin function.
ninaw152_send_cmd
void ninaw152_send_cmd(ninaw152_t *ctx, uint8_t *cmd)
NINA-W152 send command function.
ninaw152_t::cts
digital_out_t cts
Definition: ninaw152.h:184
ninaw152_set_cts_pin
void ninaw152_set_cts_pin(ninaw152_t *ctx, uint8_t state)
NINA-W152 set cts pin function.
ninaw152_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ninaw152.h:229
ninaw152_t::rts
digital_in_t rts
Definition: ninaw152.h:189
ninaw152_t::spi
spi_master_t spi
Definition: ninaw152.h:193
NINAW152_RX_DRV_BUFFER_SIZE
#define NINAW152_RX_DRV_BUFFER_SIZE
Definition: ninaw152.h:113
NINAW152_DRV_SEL_UART
@ NINAW152_DRV_SEL_UART
Definition: ninaw152.h:171
ninaw152_send_cmd_with_par
void ninaw152_send_cmd_with_par(ninaw152_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
NINA-W152 send command with parameter function.
ninaw152_cfg_t::rst
pin_name_t rst
Definition: ninaw152.h:219
NINAW152_ERROR_CMD
@ NINAW152_ERROR_CMD
Definition: ninaw152.h:248
ninaw152_reset_device
void ninaw152_reset_device(ninaw152_t *ctx)
NINA-W152 reset device function.
NINAW152_TX_DRV_BUFFER_SIZE
#define NINAW152_TX_DRV_BUFFER_SIZE
NINA-W152 driver buffer size.
Definition: ninaw152.h:112
NINAW152_ERROR_TIMEOUT
@ NINAW152_ERROR_TIMEOUT
Definition: ninaw152.h:247
ninaw152_cfg_t::miso
pin_name_t miso
Definition: ninaw152.h:211
ninaw152_t::drv_sel
ninaw152_drv_t drv_sel
Definition: ninaw152.h:200
ninaw152_get_rts_pin
uint8_t ninaw152_get_rts_pin(ninaw152_t *ctx)
NINA-W152 get rts pin function.
NINAW152_DRV_SEL_SPI
@ NINAW152_DRV_SEL_SPI
Definition: ninaw152.h:172
ninaw152_cfg_t::sry
pin_name_t sry
Definition: ninaw152.h:218
ninaw152_cfg_t::drv_sel
ninaw152_drv_t drv_sel
Definition: ninaw152.h:235
ninaw152_cfg_t::sck
pin_name_t sck
Definition: ninaw152.h:213
ninaw152_t::esc
digital_out_t esc
Definition: ninaw152.h:185
NINAW152_ERROR_UNKNOWN
@ NINAW152_ERROR_UNKNOWN
Definition: ninaw152.h:249
ninaw152_drv_t
ninaw152_drv_t
NINA-W152 Click driver selector.
Definition: ninaw152.h:170
ninaw152_cfg_t::mosi
pin_name_t mosi
Definition: ninaw152.h:212
ninaw152_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ninaw152.h:215
ninaw152_cfg_t::uart_blocking
bool uart_blocking
Definition: ninaw152.h:226
ninaw152_cfg_setup
void ninaw152_cfg_setup(ninaw152_cfg_t *cfg)
NINA-W152 configuration object setup function.
ninaw152_cfg_t::rts
pin_name_t rts
Definition: ninaw152.h:222