lpwifi  2.0.0.0
lpwifi.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 LPWIFI_H
29 #define LPWIFI_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define LPWIFI_CMD_ATZ "ATZ"
60 #define LPWIFI_CMD_ATE "ATE"
61 #define LPWIFI_CMD_ATF "ATF"
62 
67 #define LPWIFI_CMD_WFMODE "AT+WFMODE"
68 #define LPWIFI_CMD_WFJAPA "AT+WFJAPA"
69 
74 #define LPWIFI_CMD_TRTS "AT+TRTS"
75 #define LPWIFI_CMD_TRUSE "AT+TRUSE"
76 
77  // lpwifi_reg
79 
94 #define LPWIFI_MODE_STA 0
95 #define LPWIFI_MODE_SOFT_AP 1
96 
102 #define DRV_BUFFER_SIZE 400
103  // lpwifi_set
105 
120 #define LPWIFI_MAP_MIKROBUS( cfg, mikrobus ) \
121  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
122  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
123  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
124  cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
125  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
126  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
127  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT ); \
128  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK );
129  // lpwifi_map // lpwifi
132 
137 typedef struct
138 {
139  // Output pins
140 
141  digital_out_t pwr;
142  digital_out_t wkp;
143  digital_out_t cts;
144  digital_out_t cs;
145  digital_out_t sck;
147  // Input pins
148 
149  digital_in_t rts;
151  // Modules
152 
153  uart_t uart;
155  // Buffers
156 
157  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
158  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
160 } lpwifi_t;
161 
166 typedef struct
167 {
168  // Communication gpio pins
169 
170  pin_name_t rx_pin;
171  pin_name_t tx_pin;
173  // Additional gpio pins
174 
175  pin_name_t pwr;
176  pin_name_t wkp;
177  pin_name_t cts;
178  pin_name_t cs;
179  pin_name_t rts;
180  pin_name_t sck;
182  // Static variable
183 
184  uint32_t baud_rate;
186  uart_data_bits_t data_bit;
187  uart_parity_t parity_bit;
188  uart_stop_bits_t stop_bit;
190 } lpwifi_cfg_t;
191 
196 typedef enum
197 {
199  LPWIFI_ERROR = -1
200 
202 
219 
234 err_t lpwifi_init ( lpwifi_t *ctx, lpwifi_cfg_t *cfg );
235 
250 
264 err_t lpwifi_generic_write ( lpwifi_t *ctx, char *data_buf, uint16_t len );
265 
279 err_t lpwifi_generic_read ( lpwifi_t *ctx, char *data_buf, uint16_t max_len );
280 
290 
300 
310 void lpwifi_send_cmd ( lpwifi_t *ctx, char *cmd );
311 
322 void lpwifi_send_cmd_with_parameter ( lpwifi_t *ctx, char *at_cmd_buf, char *param_buf );
323 
333 void lpwifi_send_cmd_check ( lpwifi_t *ctx, char *at_cmd_buf );
334 
345 void lpwifi_connect_to_ap ( lpwifi_t *ctx, char *ssid, char *password );
346 
356 void lpwifi_set_wifi_mode ( lpwifi_t *ctx, uint8_t mode );
357 
367 void lpwifi_create_tcp_server ( lpwifi_t *ctx, uint16_t port );
368 
378 void lpwifi_create_udp_socket ( lpwifi_t *ctx, uint16_t port );
379 
380 #ifdef __cplusplus
381 }
382 #endif
383 #endif // LPWIFI_H
384  // lpwifi
386 
387 // ------------------------------------------------------------------------ END
lpwifi_connect_to_ap
void lpwifi_connect_to_ap(lpwifi_t *ctx, char *ssid, char *password)
Connect to AP function.
lpwifi_t::wkp
digital_out_t wkp
Definition: lpwifi.h:142
lpwifi_t::cts
digital_out_t cts
Definition: lpwifi.h:143
lpwifi_send_cmd_check
void lpwifi_send_cmd_check(lpwifi_t *ctx, char *at_cmd_buf)
Send command to check commands current value.
lpwifi_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lpwifi.h:188
lpwifi_generic_write
err_t lpwifi_generic_write(lpwifi_t *ctx, char *data_buf, uint16_t len)
LP WiFi data writing function.
lpwifi_t::rts
digital_in_t rts
Definition: lpwifi.h:149
lpwifi_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lpwifi.h:186
lpwifi_t::cs
digital_out_t cs
Definition: lpwifi.h:144
lpwifi_t::pwr
digital_out_t pwr
Definition: lpwifi.h:141
lpwifi_return_value_t
lpwifi_return_value_t
LP WiFi Click return value data.
Definition: lpwifi.h:197
lpwifi_cfg_t::sck
pin_name_t sck
Definition: lpwifi.h:180
lpwifi_t
LP WiFi Click context object.
Definition: lpwifi.h:138
lpwifi_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lpwifi.h:170
LPWIFI_ERROR
@ LPWIFI_ERROR
Definition: lpwifi.h:199
lpwifi_factory_reset_device
void lpwifi_factory_reset_device(lpwifi_t *ctx)
Device factory reset function.
lpwifi_cfg_t::rts
pin_name_t rts
Definition: lpwifi.h:179
lpwifi_default_cfg
err_t lpwifi_default_cfg(lpwifi_t *ctx)
LP WiFi default configuration function.
lpwifi_restart_device
void lpwifi_restart_device(lpwifi_t *ctx)
Device restart function.
lpwifi_t::sck
digital_out_t sck
Definition: lpwifi.h:145
lpwifi_cfg_t::cs
pin_name_t cs
Definition: lpwifi.h:178
lpwifi_cfg_t::wkp
pin_name_t wkp
Definition: lpwifi.h:176
lpwifi_cfg_t::uart_blocking
bool uart_blocking
Definition: lpwifi.h:185
lpwifi_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lpwifi.h:187
lpwifi_generic_read
err_t lpwifi_generic_read(lpwifi_t *ctx, char *data_buf, uint16_t max_len)
LP WiFi data reading function.
lpwifi_send_cmd
void lpwifi_send_cmd(lpwifi_t *ctx, char *cmd)
Send command function.
lpwifi_cfg_setup
void lpwifi_cfg_setup(lpwifi_cfg_t *cfg)
LP WiFi configuration object setup function.
lpwifi_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lpwifi.h:171
lpwifi_cfg_t::cts
pin_name_t cts
Definition: lpwifi.h:177
lpwifi_send_cmd_with_parameter
void lpwifi_send_cmd_with_parameter(lpwifi_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
lpwifi_cfg_t::pwr
pin_name_t pwr
Definition: lpwifi.h:175
lpwifi_cfg_t
LP WiFi Click configuration object.
Definition: lpwifi.h:167
lpwifi_t::uart
uart_t uart
Definition: lpwifi.h:153
lpwifi_create_tcp_server
void lpwifi_create_tcp_server(lpwifi_t *ctx, uint16_t port)
Create TCP server function.
lpwifi_cfg_t::baud_rate
uint32_t baud_rate
Definition: lpwifi.h:184
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
LP WiFi driver buffer size.
Definition: lpwifi.h:102
lpwifi_init
err_t lpwifi_init(lpwifi_t *ctx, lpwifi_cfg_t *cfg)
LP WiFi initialization function.
lpwifi_set_wifi_mode
void lpwifi_set_wifi_mode(lpwifi_t *ctx, uint8_t mode)
Set WiFi mode function.
lpwifi_create_udp_socket
void lpwifi_create_udp_socket(lpwifi_t *ctx, uint16_t port)
Create UDP socket function.
LPWIFI_OK
@ LPWIFI_OK
Definition: lpwifi.h:198