aiwb212f 2.1.0.0
aiwb212f.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 AIWB212F_H
29#define AIWB212F_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 AIWB212F_CMD_AT "AT"
70#define AIWB212F_CMD_AT_HELP "AT+HELP"
71#define AIWB212F_CMD_AT_SW_RESET "AT+RST"
72#define AIWB212F_CMD_AT_GMR "AT+GMR"
73#define AIWB212F_CMD_AT_SLEEP "AT+SLEEP"
74#define AIWB212F_CMD_AT_SYSIOMAP "AT+SYSIOMAP"
75#define AIWB212F_CMD_AT_SYSGPIOWRITE "AT+SYSGPIOWRITE"
76#define AIWB212F_CMD_AT_SYSGPIOREAD "AT+SYSGPIOREAD"
77#define AIWB212F_CMD_AT_PWMCFG "AT+PWMCFG"
78#define AIWB212F_CMD_AT_PWMCFGS "AT+PWMCFGS"
79#define AIWB212F_CMD_AT_PWMSTOP "AT+PWMSTOP"
80#define AIWB212F_CMD_AT_PWMDUTYSET "AT+PWMDUTYSET"
81#define AIWB212F_CMD_AT_PWMDUTYSETS "AT+PWMDUTYSETS"
82#define AIWB212F_CMD_AT_WMODE "AT+WMODE"
83#define AIWB212F_CMD_AT_WSCAN "AT+WSCAN"
84#define AIWB212F_CMD_AT_WSDHCP "AT+WSDHCP"
85#define AIWB212F_CMD_AT_WJAP "AT+WJAP"
86#define AIWB212F_CMD_AT_WAUTOCONN "AT+WAUTOCONN"
87#define AIWB212F_CMD_AT_WAPDHCP "AT+WAPDHCP"
88#define AIWB212F_CMD_AT_WAP "AT+WAP"
89#define AIWB212F_CMD_AT_PING "AT+PING"
90#define AIWB212F_CMD_AT_CIPSTAMAC_DEF "AT+CIPSTAMAC_DEF"
91#define AIWB212F_CMD_AT_WCOUNTRY "AT+WCOUNTRY"
92#define AIWB212F_CMD_AT_WCONFIG "AT+WCONFIG"
93#define AIWB212F_CMD_AT_SOCKET "AT+SOCKET"
94#define AIWB212F_CMD_AT_SOCKETSEND "AT+SOCKETSEND"
95#define AIWB212F_CMD_AT_SOCKETSENDLINE "AT+SOCKETSENDLINE"
96#define AIWB212F_CMD_AT_SOCKETREAD "AT+SOCKETREAD"
97#define AIWB212F_CMD_AT_SOCKETDEL "AT+SOCKETDEL"
98#define AIWB212F_CMD_AT_SOCKETRECVCFG "AT+SOCKETRECVCFG"
99#define AIWB212F_CMD_AT_SOCKETTT "AT+SOCKETTT"
100#define AIWB212F_CMD_AT_MQTT "AT+MQTT"
101#define AIWB212F_CMD_AT_MQTTPUB "AT+MQTTPUB"
102#define AIWB212F_CMD_AT_MQTTPUBRAW "AT+MQTTPUBRAW"
103#define AIWB212F_CMD_AT_MQTTSUB "AT+MQTTSUB"
104#define AIWB212F_CMD_AT_BLEMAC "AT+BLEMAC"
105#define AIWB212F_CMD_AT_BLEMODE "AT+BLEMODE"
106#define AIWB212F_CMD_AT_BLERFPWR "AT+BLERFPWR"
107#define AIWB212F_CMD_AT_BLENAME "AT+BLENAME"
108
113#define AIWB212F_RSP_OK "OK"
114#define AIWB212F_RSP_ERROR "ERROR"
115#define AIWB212F_RSP_READY "ready"
116
122#define AIWB212F_TX_DRV_BUFFER_SIZE 100
123#define AIWB212F_RX_DRV_BUFFER_SIZE 300
124 // aiwb212f_cmd
126
141#define AIWB212F_MAP_MIKROBUS( cfg, mikrobus ) \
142 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
143 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
144 cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
145 // aiwb212f_map // aiwb212f
148
153typedef struct
154{
155 // Output pins
156 digital_out_t en;
158 // Modules
159 uart_t uart;
161 // Buffers
162 uint8_t uart_rx_buffer[ AIWB212F_RX_DRV_BUFFER_SIZE ];
163 uint8_t uart_tx_buffer[ AIWB212F_TX_DRV_BUFFER_SIZE ];
165} aiwb212f_t;
166
171typedef struct
172{
173 // Communication gpio pins
174 pin_name_t rx_pin;
175 pin_name_t tx_pin;
177 // Additional gpio pins
178 pin_name_t en;
180 // Static variable
181 uint32_t baud_rate;
183 uart_data_bits_t data_bit;
184 uart_parity_t parity_bit;
185 uart_stop_bits_t stop_bit;
188
193typedef enum
194{
200
202
219
234
248
261err_t aiwb212f_generic_write ( aiwb212f_t *ctx, uint8_t *data_in, uint16_t len );
262
275err_t aiwb212f_generic_read ( aiwb212f_t *ctx, uint8_t *data_out, uint16_t len );
276
286
296void aiwb212f_send_cmd ( aiwb212f_t *ctx, uint8_t *at_cmd_buf );
297
308void aiwb212f_send_cmd_with_par ( aiwb212f_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
309
319void aiwb212f_send_cmd_check ( aiwb212f_t *ctx, uint8_t *at_cmd_buf );
320
331void aiwb212f_set_gpio ( aiwb212f_t *ctx, uint8_t *pin, uint8_t *state );
332
333#ifdef __cplusplus
334}
335#endif
336#endif // AIWB212F_H
337 // aiwb212f
339
340// ------------------------------------------------------------------------ END
aiwb212f_return_value_t
Ai-WB2-12F Click return value data.
Definition: aiwb212f.h:194
@ AIWB212F_ERROR_CMD
Definition: aiwb212f.h:198
@ AIWB212F_ERROR_TIMEOUT
Definition: aiwb212f.h:197
@ AIWB212F_ERROR_UNKNOWN
Definition: aiwb212f.h:199
@ AIWB212F_OK
Definition: aiwb212f.h:195
@ AIWB212F_ERROR
Definition: aiwb212f.h:196
#define AIWB212F_RX_DRV_BUFFER_SIZE
Definition: aiwb212f.h:123
#define AIWB212F_TX_DRV_BUFFER_SIZE
Ai-WB2-12F driver buffer size.
Definition: aiwb212f.h:122
void aiwb212f_send_cmd(aiwb212f_t *ctx, uint8_t *at_cmd_buf)
Ai-WB2-12F send command function.
void aiwb212f_send_cmd_with_par(aiwb212f_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Ai-WB2-12F send command with parameter function.
void aiwb212f_hw_reset(aiwb212f_t *ctx)
Ai-WB2-12F hardware reset function.
void aiwb212f_cfg_setup(aiwb212f_cfg_t *cfg)
Ai-WB2-12F configuration object setup function.
err_t aiwb212f_generic_write(aiwb212f_t *ctx, uint8_t *data_in, uint16_t len)
Ai-WB2-12F data writing function.
err_t aiwb212f_generic_read(aiwb212f_t *ctx, uint8_t *data_out, uint16_t len)
Ai-WB2-12F data reading function.
void aiwb212f_send_cmd_check(aiwb212f_t *ctx, uint8_t *at_cmd_buf)
Ai-WB2-12F send command check function.
void aiwb212f_set_gpio(aiwb212f_t *ctx, uint8_t *pin, uint8_t *state)
Ai-WB2-12F set gpio pin state function.
err_t aiwb212f_default_cfg(aiwb212f_t *ctx)
Ai-WB2-12F default configuration function.
err_t aiwb212f_init(aiwb212f_t *ctx, aiwb212f_cfg_t *cfg)
Ai-WB2-12F initialization function.
Ai-WB2-12F Click configuration object.
Definition: aiwb212f.h:172
uint32_t baud_rate
Definition: aiwb212f.h:181
bool uart_blocking
Definition: aiwb212f.h:182
uart_data_bits_t data_bit
Definition: aiwb212f.h:183
pin_name_t tx_pin
Definition: aiwb212f.h:175
pin_name_t rx_pin
Definition: aiwb212f.h:174
uart_stop_bits_t stop_bit
Definition: aiwb212f.h:185
pin_name_t en
Definition: aiwb212f.h:178
uart_parity_t parity_bit
Definition: aiwb212f.h:184
Ai-WB2-12F Click context object.
Definition: aiwb212f.h:154
uart_t uart
Definition: aiwb212f.h:159
digital_out_t en
Definition: aiwb212f.h:156