anynet3gaa  2.0.0.0
anynet3gaa.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 ANYNET3GAA_H
29 #define ANYNET3GAA_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define ANYNET3GAA_CMD_AT "AT"
74 #define ANYNET3GAA_CMD_QCCID "AT+QCCID"
75 #define ANYNET3GAA_CMD_GSN "AT+GSN"
76 #define ANYNET3GAA_CMD_AWSVER "AT+AWSVER"
77 #define ANYNET3GAA_CMD_AWSRESET "AT+AWSRESET"
78 #define ANYNET3GAA_CMD_AWSSTATE "AT+AWSSTATE"
79 #define ANYNET3GAA_CMD_AWSBUTTON "AT+AWSBUTTON"
80 #define ANYNET3GAA_CMD_AWSPUBOPEN "AT+AWSPUBOPEN"
81 #define ANYNET3GAA_CMD_AWSPUBLISH "AT+AWSPUBLISH"
82 #define ANYNET3GAA_CMD_AWSSUBOPEN "AT+AWSSUBOPEN"
83 #define ANYNET3GAA_CMD_AWSPUBCLOSE "AT+AWSPUBCLOSE"
84 
89 #define ANYNET3GAA_RSP_OK "OK"
90 #define ANYNET3GAA_RSP_ERROR "ERROR"
91 #define ANYNET3GAA_RSP_READY_FOR_SEND ">"
92 #define ANYNET3GAA_RSP_SEND_OK "SEND OK"
93 #define ANYNET3GAA_RSP_SEND_FAIL "SEND FAIL"
94 
100 #define ANYNET3GAA_RX_DRV_BUFFER_SIZE 256
101 #define ANYNET3GAA_TX_DRV_BUFFER_SIZE 256
102  // anynet3gaa_set
104 
119 #define ANYNET3GAA_MAP_MIKROBUS( cfg, mikrobus ) \
120  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
121  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
122  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
123  cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_CS ); \
124  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
125  cfg.iot = MIKROBUS( mikrobus, MIKROBUS_INT )
126  // anynet3gaa_map // anynet3gaa
129 
134 typedef struct
135 {
136  // Output pins
137  digital_out_t slp;
138  digital_out_t dtr;
139  digital_out_t iot;
141  // Input pins
142  digital_in_t dsr;
144  // Modules
145  uart_t uart;
147  // Buffers
148  uint8_t uart_rx_buffer[ ANYNET3GAA_RX_DRV_BUFFER_SIZE ];
149  uint8_t uart_tx_buffer[ ANYNET3GAA_TX_DRV_BUFFER_SIZE ];
151 } anynet3gaa_t;
152 
157 typedef struct
158 {
159  // Communication gpio pins
160  pin_name_t rx_pin;
161  pin_name_t tx_pin;
163  // Additional gpio pins
164  pin_name_t slp;
165  pin_name_t dtr;
166  pin_name_t iot;
167  pin_name_t dsr;
169  // Static variable
170  uint32_t baud_rate;
172  uart_data_bits_t data_bit;
173  uart_parity_t parity_bit;
174  uart_stop_bits_t stop_bit;
177 
182 typedef enum
183 {
190 
192 
209 
224 
237 err_t anynet3gaa_generic_write ( anynet3gaa_t *ctx, uint8_t *data_in, uint16_t len );
238 
251 err_t anynet3gaa_generic_read ( anynet3gaa_t *ctx, uint8_t *data_out, uint16_t len );
252 
262 void anynet3gaa_set_slp_pin ( anynet3gaa_t *ctx, uint8_t state );
263 
273 void anynet3gaa_set_dtr_pin ( anynet3gaa_t *ctx, uint8_t state );
274 
284 void anynet3gaa_set_iot_pin ( anynet3gaa_t *ctx, uint8_t state );
285 
295 
305 void anynet3gaa_send_cmd ( anynet3gaa_t *ctx, uint8_t *cmd );
306 
317 void anynet3gaa_send_cmd_with_par ( anynet3gaa_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
318 
328 void anynet3gaa_send_cmd_check ( anynet3gaa_t *ctx, uint8_t *at_cmd_buf );
329 
339 void anynet3gaa_send_cmd_par_check ( anynet3gaa_t *ctx, uint8_t *at_cmd_buf );
340 
341 #ifdef __cplusplus
342 }
343 #endif
344 #endif // ANYNET3GAA_H
345  // anynet3gaa
347 
348 // ------------------------------------------------------------------------ END
anynet3gaa_init
err_t anynet3gaa_init(anynet3gaa_t *ctx, anynet3gaa_cfg_t *cfg)
AnyNet 3G-AA initialization function.
ANYNET3GAA_RX_DRV_BUFFER_SIZE
#define ANYNET3GAA_RX_DRV_BUFFER_SIZE
AnyNet 3G-AA driver buffer size.
Definition: anynet3gaa.h:100
anynet3gaa_cfg_t::uart_blocking
bool uart_blocking
Definition: anynet3gaa.h:171
anynet3gaa_t::dtr
digital_out_t dtr
Definition: anynet3gaa.h:138
anynet3gaa_cfg_t::dsr
pin_name_t dsr
Definition: anynet3gaa.h:167
anynet3gaa_get_dsr_pin
uint8_t anynet3gaa_get_dsr_pin(anynet3gaa_t *ctx)
AnyNet 3G-AA get dsr pin function.
anynet3gaa_generic_read
err_t anynet3gaa_generic_read(anynet3gaa_t *ctx, uint8_t *data_out, uint16_t len)
AnyNet 3G-AA data reading function.
anynet3gaa_set_iot_pin
void anynet3gaa_set_iot_pin(anynet3gaa_t *ctx, uint8_t state)
AnyNet 3G-AA set iot pin function.
ANYNET3GAA_ERROR_CMD
@ ANYNET3GAA_ERROR_CMD
Definition: anynet3gaa.h:187
anynet3gaa_cfg_t::dtr
pin_name_t dtr
Definition: anynet3gaa.h:165
anynet3gaa_cfg_t::tx_pin
pin_name_t tx_pin
Definition: anynet3gaa.h:161
anynet3gaa_t::slp
digital_out_t slp
Definition: anynet3gaa.h:137
anynet3gaa_t::dsr
digital_in_t dsr
Definition: anynet3gaa.h:142
anynet3gaa_cfg_t::rx_pin
pin_name_t rx_pin
Definition: anynet3gaa.h:160
anynet3gaa_send_cmd_with_par
void anynet3gaa_send_cmd_with_par(anynet3gaa_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
anynet3gaa_generic_write
err_t anynet3gaa_generic_write(anynet3gaa_t *ctx, uint8_t *data_in, uint16_t len)
AnyNet 3G-AA data writing function.
anynet3gaa_set_dtr_pin
void anynet3gaa_set_dtr_pin(anynet3gaa_t *ctx, uint8_t state)
AnyNet 3G-AA set dtr pin function.
ANYNET3GAA_ERROR_SEND
@ ANYNET3GAA_ERROR_SEND
Definition: anynet3gaa.h:188
anynet3gaa_cfg_t::slp
pin_name_t slp
Definition: anynet3gaa.h:164
anynet3gaa_set_slp_pin
void anynet3gaa_set_slp_pin(anynet3gaa_t *ctx, uint8_t state)
AnyNet 3G-AA set slp pin function.
anynet3gaa_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: anynet3gaa.h:172
anynet3gaa_return_value_t
anynet3gaa_return_value_t
AnyNet 3G-AA Click return value data.
Definition: anynet3gaa.h:183
anynet3gaa_cfg_setup
void anynet3gaa_cfg_setup(anynet3gaa_cfg_t *cfg)
AnyNet 3G-AA configuration object setup function.
anynet3gaa_t::iot
digital_out_t iot
Definition: anynet3gaa.h:139
anynet3gaa_send_cmd
void anynet3gaa_send_cmd(anynet3gaa_t *ctx, uint8_t *cmd)
Send command function.
anynet3gaa_send_cmd_check
void anynet3gaa_send_cmd_check(anynet3gaa_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.
ANYNET3GAA_ERROR_TIMEOUT
@ ANYNET3GAA_ERROR_TIMEOUT
Definition: anynet3gaa.h:186
ANYNET3GAA_OK
@ ANYNET3GAA_OK
Definition: anynet3gaa.h:184
ANYNET3GAA_ERROR
@ ANYNET3GAA_ERROR
Definition: anynet3gaa.h:185
ANYNET3GAA_TX_DRV_BUFFER_SIZE
#define ANYNET3GAA_TX_DRV_BUFFER_SIZE
Definition: anynet3gaa.h:101
anynet3gaa_cfg_t
AnyNet 3G-AA Click configuration object.
Definition: anynet3gaa.h:158
anynet3gaa_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: anynet3gaa.h:174
anynet3gaa_t::uart
uart_t uart
Definition: anynet3gaa.h:145
anynet3gaa_cfg_t::iot
pin_name_t iot
Definition: anynet3gaa.h:166
anynet3gaa_send_cmd_par_check
void anynet3gaa_send_cmd_par_check(anynet3gaa_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
anynet3gaa_cfg_t::baud_rate
uint32_t baud_rate
Definition: anynet3gaa.h:170
anynet3gaa_t
AnyNet 3G-AA Click context object.
Definition: anynet3gaa.h:135
ANYNET3GAA_ERROR_UNKNOWN
@ ANYNET3GAA_ERROR_UNKNOWN
Definition: anynet3gaa.h:189
anynet3gaa_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: anynet3gaa.h:173