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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define ANYNET3GAA_CMD_AT "AT"
60 #define ANYNET3GAA_CMD_QCCID "AT+QCCID"
61 #define ANYNET3GAA_CMD_GSN "AT+GSN"
62 #define ANYNET3GAA_CMD_AWSVER "AT+AWSVER"
63 #define ANYNET3GAA_CMD_AWSRESET "AT+AWSRESET"
64 #define ANYNET3GAA_CMD_AWSSTATE "AT+AWSSTATE"
65 #define ANYNET3GAA_CMD_AWSBUTTON "AT+AWSBUTTON"
66 #define ANYNET3GAA_CMD_AWSPUBOPEN "AT+AWSPUBOPEN"
67 #define ANYNET3GAA_CMD_AWSPUBLISH "AT+AWSPUBLISH"
68 #define ANYNET3GAA_CMD_AWSSUBOPEN "AT+AWSSUBOPEN"
69 #define ANYNET3GAA_CMD_AWSPUBCLOSE "AT+AWSPUBCLOSE"
70 
75 #define ANYNET3GAA_RSP_OK "OK"
76 #define ANYNET3GAA_RSP_ERROR "ERROR"
77 #define ANYNET3GAA_RSP_READY_FOR_SEND ">"
78 #define ANYNET3GAA_RSP_SEND_OK "SEND OK"
79 #define ANYNET3GAA_RSP_SEND_FAIL "SEND FAIL"
80 
86 #define ANYNET3GAA_RX_DRV_BUFFER_SIZE 256
87 #define ANYNET3GAA_TX_DRV_BUFFER_SIZE 256
88  // anynet3gaa_set
90 
105 #define ANYNET3GAA_MAP_MIKROBUS( cfg, mikrobus ) \
106  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
107  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
108  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
109  cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_CS ); \
110  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
111  cfg.iot = MIKROBUS( mikrobus, MIKROBUS_INT )
112  // anynet3gaa_map // anynet3gaa
115 
120 typedef struct
121 {
122  // Output pins
123  digital_out_t slp;
124  digital_out_t dtr;
125  digital_out_t iot;
127  // Input pins
128  digital_in_t dsr;
130  // Modules
131  uart_t uart;
133  // Buffers
134  uint8_t uart_rx_buffer[ ANYNET3GAA_RX_DRV_BUFFER_SIZE ];
135  uint8_t uart_tx_buffer[ ANYNET3GAA_TX_DRV_BUFFER_SIZE ];
137 } anynet3gaa_t;
138 
143 typedef struct
144 {
145  // Communication gpio pins
146  pin_name_t rx_pin;
147  pin_name_t tx_pin;
149  // Additional gpio pins
150  pin_name_t slp;
151  pin_name_t dtr;
152  pin_name_t iot;
153  pin_name_t dsr;
155  // Static variable
156  uint32_t baud_rate;
158  uart_data_bits_t data_bit;
159  uart_parity_t parity_bit;
160  uart_stop_bits_t stop_bit;
163 
168 typedef enum
169 {
176 
178 
195 
210 
223 err_t anynet3gaa_generic_write ( anynet3gaa_t *ctx, uint8_t *data_in, uint16_t len );
224 
237 err_t anynet3gaa_generic_read ( anynet3gaa_t *ctx, uint8_t *data_out, uint16_t len );
238 
248 void anynet3gaa_set_slp_pin ( anynet3gaa_t *ctx, uint8_t state );
249 
259 void anynet3gaa_set_dtr_pin ( anynet3gaa_t *ctx, uint8_t state );
260 
270 void anynet3gaa_set_iot_pin ( anynet3gaa_t *ctx, uint8_t state );
271 
281 
291 void anynet3gaa_send_cmd ( anynet3gaa_t *ctx, uint8_t *cmd );
292 
303 void anynet3gaa_send_cmd_with_par ( anynet3gaa_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
304 
314 void anynet3gaa_send_cmd_check ( anynet3gaa_t *ctx, uint8_t *at_cmd_buf );
315 
325 void anynet3gaa_send_cmd_par_check ( anynet3gaa_t *ctx, uint8_t *at_cmd_buf );
326 
327 #ifdef __cplusplus
328 }
329 #endif
330 #endif // ANYNET3GAA_H
331  // anynet3gaa
333 
334 // ------------------------------------------------------------------------ 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:86
anynet3gaa_cfg_t::uart_blocking
bool uart_blocking
Definition: anynet3gaa.h:157
anynet3gaa_t::dtr
digital_out_t dtr
Definition: anynet3gaa.h:124
anynet3gaa_cfg_t::dsr
pin_name_t dsr
Definition: anynet3gaa.h:153
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:173
anynet3gaa_cfg_t::dtr
pin_name_t dtr
Definition: anynet3gaa.h:151
anynet3gaa_cfg_t::tx_pin
pin_name_t tx_pin
Definition: anynet3gaa.h:147
anynet3gaa_t::slp
digital_out_t slp
Definition: anynet3gaa.h:123
anynet3gaa_t::dsr
digital_in_t dsr
Definition: anynet3gaa.h:128
anynet3gaa_cfg_t::rx_pin
pin_name_t rx_pin
Definition: anynet3gaa.h:146
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:174
anynet3gaa_cfg_t::slp
pin_name_t slp
Definition: anynet3gaa.h:150
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:158
anynet3gaa_return_value_t
anynet3gaa_return_value_t
AnyNet 3G-AA Click return value data.
Definition: anynet3gaa.h:169
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:125
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:172
ANYNET3GAA_OK
@ ANYNET3GAA_OK
Definition: anynet3gaa.h:170
ANYNET3GAA_ERROR
@ ANYNET3GAA_ERROR
Definition: anynet3gaa.h:171
ANYNET3GAA_TX_DRV_BUFFER_SIZE
#define ANYNET3GAA_TX_DRV_BUFFER_SIZE
Definition: anynet3gaa.h:87
anynet3gaa_cfg_t
AnyNet 3G-AA Click configuration object.
Definition: anynet3gaa.h:144
anynet3gaa_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: anynet3gaa.h:160
anynet3gaa_t::uart
uart_t uart
Definition: anynet3gaa.h:131
anynet3gaa_cfg_t::iot
pin_name_t iot
Definition: anynet3gaa.h:152
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:156
anynet3gaa_t
AnyNet 3G-AA Click context object.
Definition: anynet3gaa.h:121
ANYNET3GAA_ERROR_UNKNOWN
@ ANYNET3GAA_ERROR_UNKNOWN
Definition: anynet3gaa.h:175
anynet3gaa_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: anynet3gaa.h:159