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_AT "AT"
60 #define LPWIFI_CMD_ATZ "ATZ"
61 #define LPWIFI_CMD_ATE "ATE"
62 #define LPWIFI_CMD_ATF "ATF"
63 
68 #define LPWIFI_CMD_WFMODE "AT+WFMODE"
69 #define LPWIFI_CMD_WFJAPA "AT+WFJAPA"
70 
75 #define LPWIFI_CMD_TRTS "AT+TRTS"
76 #define LPWIFI_CMD_TRUSE "AT+TRUSE"
77 
82 #define LPWIFI_CMD_PWMINIT "AT+PWMINIT"
83 #define LPWIFI_CMD_PWMSTART "AT+PWMSTART"
84 #define LPWIFI_CMD_PWMSTOP "AT+PWMSTOP"
85 
90 #define LPWIFI_CMD_I2CINIT "AT+I2CINIT"
91 #define LPWIFI_CMD_I2CREAD "AT+I2CREAD"
92 #define LPWIFI_CMD_I2CWRITE "AT+I2CWRITE"
93  // lpwifi_reg
95 
110 #define LPWIFI_MODE_STA 0
111 #define LPWIFI_MODE_SOFT_AP 1
112 
118 #define DRV_BUFFER_SIZE 400
119  // lpwifi_set
121 
136 #define LPWIFI_MAP_MIKROBUS( cfg, mikrobus ) \
137  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
138  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
139  cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
140  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
141  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
142  // lpwifi_map // lpwifi
145 
150 typedef struct
151 {
152  // Output pins
153 
154  digital_out_t wkp;
155  digital_out_t cs;
157  // Input pins
158 
159  digital_in_t int_pin;
161  // Modules
162 
163  uart_t uart;
165  // Buffers
166 
167  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
168  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
170 } lpwifi_t;
171 
176 typedef struct
177 {
178  // Communication gpio pins
179 
180  pin_name_t rx_pin;
181  pin_name_t tx_pin;
183  // Additional gpio pins
184 
185  pin_name_t wkp;
186  pin_name_t int_pin;
187  pin_name_t cs;
189  // Static variable
190 
191  uint32_t baud_rate;
192  bool uart_blocking;
193  uart_data_bits_t data_bit;
194  uart_parity_t parity_bit;
195  uart_stop_bits_t stop_bit;
197 } lpwifi_cfg_t;
198 
203 typedef enum
204 {
206  LPWIFI_ERROR = -1
207 
209 
225 void lpwifi_cfg_setup ( lpwifi_cfg_t *cfg );
226 
241 err_t lpwifi_init ( lpwifi_t *ctx, lpwifi_cfg_t *cfg );
242 
253 void lpwifi_default_cfg ( lpwifi_t *ctx );
254 
268 err_t lpwifi_generic_write ( lpwifi_t *ctx, char *data_buf, uint16_t len );
269 
283 err_t lpwifi_generic_read ( lpwifi_t *ctx, char *data_buf, uint16_t max_len );
284 
294 
304 void lpwifi_send_cmd ( lpwifi_t *ctx, char *cmd );
305 
316 void lpwifi_send_cmd_with_parameter ( lpwifi_t *ctx, char *at_cmd_buf, char *param_buf );
317 
327 void lpwifi_send_cmd_check ( lpwifi_t *ctx, char *at_cmd_buf );
328 
339 void lpwifi_connect_to_ap ( lpwifi_t *ctx, char *ssid, char *password );
340 
350 void lpwifi_set_wifi_mode ( lpwifi_t *ctx, uint8_t mode );
351 
361 void lpwifi_create_tcp_server ( lpwifi_t *ctx, uint16_t port );
362 
372 void lpwifi_create_udp_socket ( lpwifi_t *ctx, uint16_t port );
373 
374 #ifdef __cplusplus
375 }
376 #endif
377 #endif // LPWIFI_H
378  // lpwifi
380 
381 // ------------------------------------------------------------------------ END
lpwifi_connect_to_ap
void lpwifi_connect_to_ap(lpwifi_t *ctx, char *ssid, char *password)
Connect to AP function.
lpwifi_send_cmd_check
void lpwifi_send_cmd_check(lpwifi_t *ctx, char *at_cmd_buf)
Send command to check commands current value.
lpwifi_generic_write
err_t lpwifi_generic_write(lpwifi_t *ctx, char *data_buf, uint16_t len)
LP WiFi data writing function.
lpwifi_return_value_t
lpwifi_return_value_t
LP WiFi Click return value data.
Definition: lpwifi.h:202
lpwifi_t
LP WiFi Click context object.
Definition: lpwifi.h:149
LPWIFI_ERROR
Definition: lpwifi.h:205
lpwifi_factory_reset_device
void lpwifi_factory_reset_device(lpwifi_t *ctx)
Device factory reset function.
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_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_default_cfg
void lpwifi_default_cfg(lpwifi_t *ctx)
LP WiFi default configuration function.
lpwifi_cfg_t
LP WiFi Click configuration object.
Definition: lpwifi.h:175
lpwifi_create_tcp_server
void lpwifi_create_tcp_server(lpwifi_t *ctx, uint16_t port)
Create TCP server function.
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
LP WiFi driver buffer size.
Definition: lpwifi.h:117
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
Definition: lpwifi.h:204