anynet3gea  2.0.0.0
anynet3gea.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 ANYNET3GEA_H
29 #define ANYNET3GEA_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 ANYNET3GEA_CMD_AT "AT"
70 #define ANYNET3GEA_CMD_QCCID "AT+QCCID"
71 #define ANYNET3GEA_CMD_GSN "AT+GSN"
72 #define ANYNET3GEA_CMD_AWSVER "AT+AWSVER"
73 #define ANYNET3GEA_CMD_AWSRESET "AT+AWSRESET"
74 #define ANYNET3GEA_CMD_AWSSTATE "AT+AWSSTATE"
75 #define ANYNET3GEA_CMD_AWSBUTTON "AT+AWSBUTTON"
76 #define ANYNET3GEA_CMD_AWSPUBOPEN "AT+AWSPUBOPEN"
77 #define ANYNET3GEA_CMD_AWSPUBLISH "AT+AWSPUBLISH"
78 #define ANYNET3GEA_CMD_AWSSUBOPEN "AT+AWSSUBOPEN"
79 #define ANYNET3GEA_CMD_AWSPUBCLOSE "AT+AWSPUBCLOSE"
80 
85 #define ANYNET3GEA_RSP_OK "OK"
86 #define ANYNET3GEA_RSP_ERROR "ERROR"
87 #define ANYNET3GEA_RSP_READY_FOR_SEND ">"
88 #define ANYNET3GEA_RSP_SEND_OK "SEND OK"
89 #define ANYNET3GEA_RSP_SEND_FAIL "SEND FAIL"
90 
96 #define ANYNET3GEA_RX_DRV_BUFFER_SIZE 256
97 #define ANYNET3GEA_TX_DRV_BUFFER_SIZE 256
98  // anynet3gea_set
100 
115 #define ANYNET3GEA_MAP_MIKROBUS( cfg, mikrobus ) \
116  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
117  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
118  cfg.slp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
119  cfg.dsr = MIKROBUS( mikrobus, MIKROBUS_CS ); \
120  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
121  cfg.iot = MIKROBUS( mikrobus, MIKROBUS_INT )
122  // anynet3gea_map // anynet3gea
125 
130 typedef struct
131 {
132  // Output pins
133  digital_out_t slp;
134  digital_out_t dtr;
135  digital_out_t iot;
137  // Input pins
138  digital_in_t dsr;
140  // Modules
141  uart_t uart;
143  // Buffers
144  uint8_t uart_rx_buffer[ ANYNET3GEA_RX_DRV_BUFFER_SIZE ];
145  uint8_t uart_tx_buffer[ ANYNET3GEA_TX_DRV_BUFFER_SIZE ];
147 } anynet3gea_t;
148 
153 typedef struct
154 {
155  // Communication gpio pins
156  pin_name_t rx_pin;
157  pin_name_t tx_pin;
159  // Additional gpio pins
160  pin_name_t slp;
161  pin_name_t dtr;
162  pin_name_t iot;
163  pin_name_t dsr;
165  // Static variable
166  uint32_t baud_rate;
168  uart_data_bits_t data_bit;
169  uart_parity_t parity_bit;
170  uart_stop_bits_t stop_bit;
173 
178 typedef enum
179 {
186 
188 
205 
220 
233 err_t anynet3gea_generic_write ( anynet3gea_t *ctx, uint8_t *data_in, uint16_t len );
234 
247 err_t anynet3gea_generic_read ( anynet3gea_t *ctx, uint8_t *data_out, uint16_t len );
248 
258 void anynet3gea_set_slp_pin ( anynet3gea_t *ctx, uint8_t state );
259 
269 void anynet3gea_set_dtr_pin ( anynet3gea_t *ctx, uint8_t state );
270 
280 void anynet3gea_set_iot_pin ( anynet3gea_t *ctx, uint8_t state );
281 
291 
301 void anynet3gea_send_cmd ( anynet3gea_t *ctx, uint8_t *cmd );
302 
313 void anynet3gea_send_cmd_with_par ( anynet3gea_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
314 
324 void anynet3gea_send_cmd_check ( anynet3gea_t *ctx, uint8_t *at_cmd_buf );
325 
335 void anynet3gea_send_cmd_par_check ( anynet3gea_t *ctx, uint8_t *at_cmd_buf );
336 
337 #ifdef __cplusplus
338 }
339 #endif
340 #endif // ANYNET3GEA_H
341  // anynet3gea
343 
344 // ------------------------------------------------------------------------ END
anynet3gea_cfg_t::iot
pin_name_t iot
Definition: anynet3gea.h:162
anynet3gea_cfg_t::dtr
pin_name_t dtr
Definition: anynet3gea.h:161
anynet3gea_t::dtr
digital_out_t dtr
Definition: anynet3gea.h:134
anynet3gea_cfg_t::tx_pin
pin_name_t tx_pin
Definition: anynet3gea.h:157
ANYNET3GEA_OK
@ ANYNET3GEA_OK
Definition: anynet3gea.h:180
anynet3gea_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: anynet3gea.h:169
anynet3gea_init
err_t anynet3gea_init(anynet3gea_t *ctx, anynet3gea_cfg_t *cfg)
AnyNet 3G-EA initialization function.
anynet3gea_send_cmd
void anynet3gea_send_cmd(anynet3gea_t *ctx, uint8_t *cmd)
Send command function.
anynet3gea_set_dtr_pin
void anynet3gea_set_dtr_pin(anynet3gea_t *ctx, uint8_t state)
AnyNet 3G-EA set dtr pin function.
anynet3gea_cfg_t::uart_blocking
bool uart_blocking
Definition: anynet3gea.h:167
anynet3gea_t::slp
digital_out_t slp
Definition: anynet3gea.h:133
ANYNET3GEA_TX_DRV_BUFFER_SIZE
#define ANYNET3GEA_TX_DRV_BUFFER_SIZE
Definition: anynet3gea.h:97
anynet3gea_cfg_setup
void anynet3gea_cfg_setup(anynet3gea_cfg_t *cfg)
AnyNet 3G-EA configuration object setup function.
anynet3gea_t::dsr
digital_in_t dsr
Definition: anynet3gea.h:138
anynet3gea_generic_read
err_t anynet3gea_generic_read(anynet3gea_t *ctx, uint8_t *data_out, uint16_t len)
AnyNet 3G-EA data reading function.
ANYNET3GEA_ERROR_SEND
@ ANYNET3GEA_ERROR_SEND
Definition: anynet3gea.h:184
anynet3gea_send_cmd_check
void anynet3gea_send_cmd_check(anynet3gea_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.
anynet3gea_send_cmd_par_check
void anynet3gea_send_cmd_par_check(anynet3gea_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
anynet3gea_return_value_t
anynet3gea_return_value_t
AnyNet 3G-EA Click return value data.
Definition: anynet3gea.h:179
anynet3gea_t::iot
digital_out_t iot
Definition: anynet3gea.h:135
anynet3gea_set_slp_pin
void anynet3gea_set_slp_pin(anynet3gea_t *ctx, uint8_t state)
AnyNet 3G-EA set slp pin function.
anynet3gea_cfg_t::rx_pin
pin_name_t rx_pin
Definition: anynet3gea.h:156
anynet3gea_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: anynet3gea.h:170
anynet3gea_cfg_t::slp
pin_name_t slp
Definition: anynet3gea.h:160
anynet3gea_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: anynet3gea.h:168
ANYNET3GEA_ERROR_UNKNOWN
@ ANYNET3GEA_ERROR_UNKNOWN
Definition: anynet3gea.h:185
ANYNET3GEA_ERROR_CMD
@ ANYNET3GEA_ERROR_CMD
Definition: anynet3gea.h:183
anynet3gea_send_cmd_with_par
void anynet3gea_send_cmd_with_par(anynet3gea_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
anynet3gea_cfg_t::baud_rate
uint32_t baud_rate
Definition: anynet3gea.h:166
ANYNET3GEA_RX_DRV_BUFFER_SIZE
#define ANYNET3GEA_RX_DRV_BUFFER_SIZE
AnyNet 3G-EA driver buffer size.
Definition: anynet3gea.h:96
ANYNET3GEA_ERROR_TIMEOUT
@ ANYNET3GEA_ERROR_TIMEOUT
Definition: anynet3gea.h:182
anynet3gea_t::uart
uart_t uart
Definition: anynet3gea.h:141
ANYNET3GEA_ERROR
@ ANYNET3GEA_ERROR
Definition: anynet3gea.h:181
anynet3gea_cfg_t
AnyNet 3G-EA Click configuration object.
Definition: anynet3gea.h:154
anynet3gea_cfg_t::dsr
pin_name_t dsr
Definition: anynet3gea.h:163
anynet3gea_get_dsr_pin
uint8_t anynet3gea_get_dsr_pin(anynet3gea_t *ctx)
AnyNet 3G-EA get dsr pin function.
anynet3gea_t
AnyNet 3G-EA Click context object.
Definition: anynet3gea.h:131
anynet3gea_set_iot_pin
void anynet3gea_set_iot_pin(anynet3gea_t *ctx, uint8_t state)
AnyNet 3G-EA set iot pin function.
anynet3gea_generic_write
err_t anynet3gea_generic_write(anynet3gea_t *ctx, uint8_t *data_in, uint16_t len)
AnyNet 3G-EA data writing function.