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 "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 LPWIFI_CMD_AT "AT"
70 #define LPWIFI_CMD_ATZ "ATZ"
71 #define LPWIFI_CMD_ATE "ATE"
72 #define LPWIFI_CMD_ATF "ATF"
73 
78 #define LPWIFI_CMD_WFMODE "AT+WFMODE"
79 #define LPWIFI_CMD_WFJAPA "AT+WFJAPA"
80 
85 #define LPWIFI_CMD_TRTS "AT+TRTS"
86 #define LPWIFI_CMD_TRUSE "AT+TRUSE"
87 
92 #define LPWIFI_CMD_PWMINIT "AT+PWMINIT"
93 #define LPWIFI_CMD_PWMSTART "AT+PWMSTART"
94 #define LPWIFI_CMD_PWMSTOP "AT+PWMSTOP"
95 
100 #define LPWIFI_CMD_I2CINIT "AT+I2CINIT"
101 #define LPWIFI_CMD_I2CREAD "AT+I2CREAD"
102 #define LPWIFI_CMD_I2CWRITE "AT+I2CWRITE"
103  // lpwifi_reg
105 
120 #define LPWIFI_MODE_STA 0
121 #define LPWIFI_MODE_SOFT_AP 1
122 
128 #define DRV_BUFFER_SIZE 400
129  // lpwifi_set
131 
146 #define LPWIFI_MAP_MIKROBUS( cfg, mikrobus ) \
147  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
148  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
149  cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
150  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
151  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
152  // lpwifi_map // lpwifi
155 
160 typedef struct
161 {
162  // Output pins
163 
164  digital_out_t wkp;
165  digital_out_t cs;
167  // Input pins
168 
169  digital_in_t int_pin;
171  // Modules
172 
173  uart_t uart;
175  // Buffers
176 
177  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
178  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
180 } lpwifi_t;
181 
186 typedef struct
187 {
188  // Communication gpio pins
189 
190  pin_name_t rx_pin;
191  pin_name_t tx_pin;
193  // Additional gpio pins
194 
195  pin_name_t wkp;
196  pin_name_t int_pin;
197  pin_name_t cs;
199  // Static variable
200 
201  uint32_t baud_rate;
203  uart_data_bits_t data_bit;
204  uart_parity_t parity_bit;
205  uart_stop_bits_t stop_bit;
207 } lpwifi_cfg_t;
208 
213 typedef enum
214 {
216  LPWIFI_ERROR = -1
217 
219 
236 
251 err_t lpwifi_init ( lpwifi_t *ctx, lpwifi_cfg_t *cfg );
252 
264 
278 err_t lpwifi_generic_write ( lpwifi_t *ctx, char *data_buf, uint16_t len );
279 
293 err_t lpwifi_generic_read ( lpwifi_t *ctx, char *data_buf, uint16_t max_len );
294 
304 
314 void lpwifi_send_cmd ( lpwifi_t *ctx, char *cmd );
315 
326 void lpwifi_send_cmd_with_parameter ( lpwifi_t *ctx, char *at_cmd_buf, char *param_buf );
327 
337 void lpwifi_send_cmd_check ( lpwifi_t *ctx, char *at_cmd_buf );
338 
349 void lpwifi_connect_to_ap ( lpwifi_t *ctx, char *ssid, char *password );
350 
360 void lpwifi_set_wifi_mode ( lpwifi_t *ctx, uint8_t mode );
361 
371 void lpwifi_create_tcp_server ( lpwifi_t *ctx, uint16_t port );
372 
382 void lpwifi_create_udp_socket ( lpwifi_t *ctx, uint16_t port );
383 
384 #ifdef __cplusplus
385 }
386 #endif
387 #endif // LPWIFI_H
388  // lpwifi
390 
391 // ------------------------------------------------------------------------ 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:164
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:205
lpwifi_generic_write
err_t lpwifi_generic_write(lpwifi_t *ctx, char *data_buf, uint16_t len)
LP WiFi data writing function.
lpwifi_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lpwifi.h:203
lpwifi_t::int_pin
digital_in_t int_pin
Definition: lpwifi.h:169
lpwifi_t::cs
digital_out_t cs
Definition: lpwifi.h:165
lpwifi_return_value_t
lpwifi_return_value_t
LP WiFi Click return value data.
Definition: lpwifi.h:214
lpwifi_t
LP WiFi Click context object.
Definition: lpwifi.h:161
lpwifi_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lpwifi.h:190
LPWIFI_ERROR
@ LPWIFI_ERROR
Definition: lpwifi.h:216
lpwifi_factory_reset_device
void lpwifi_factory_reset_device(lpwifi_t *ctx)
Device factory reset function.
lpwifi_cfg_t::cs
pin_name_t cs
Definition: lpwifi.h:197
lpwifi_cfg_t::wkp
pin_name_t wkp
Definition: lpwifi.h:195
lpwifi_cfg_t::uart_blocking
bool uart_blocking
Definition: lpwifi.h:202
lpwifi_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lpwifi.h:204
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:191
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:187
lpwifi_t::uart
uart_t uart
Definition: lpwifi.h:173
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:201
lpwifi_cfg_t::int_pin
pin_name_t int_pin
Definition: lpwifi.h:196
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
LP WiFi driver buffer size.
Definition: lpwifi.h:128
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:215