c4glte2voicena  2.1.0.0
c4glte2voicena.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 C4GLTE2VOICENA_H
29 #define C4GLTE2VOICENA_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 C4GLTE2VOICENA_CMD_AT "AT"
60 #define C4GLTE2VOICENA_CMD_ATI "ATI"
61 #define C4GLTE2VOICENA_CMD_CGMR "AT+CGMR"
62 #define C4GLTE2VOICENA_CMD_CFUN "AT+CFUN"
63 #define C4GLTE2VOICENA_CMD_CREG "AT+CREG"
64 #define C4GLTE2VOICENA_CMD_CGREG "AT+CGREG"
65 #define C4GLTE2VOICENA_CMD_CGDCONT "AT+CGDCONT"
66 #define C4GLTE2VOICENA_CMD_CIMI "AT+CIMI"
67 #define C4GLTE2VOICENA_CMD_CMEE "AT+CMEE"
68 #define C4GLTE2VOICENA_CMD_CGATT "AT+CGATT"
69 #define C4GLTE2VOICENA_CMD_CSQ "AT+CSQ"
70 #define C4GLTE2VOICENA_CMD_COPS "AT+COPS"
71 #define C4GLTE2VOICENA_CMD_CMGS "AT+CMGS"
72 #define C4GLTE2VOICENA_CMD_CMGF "AT+CMGF"
73 #define C4GLTE2VOICENA_CMD_CGACT "AT+CGACT"
74 #define C4GLTE2VOICENA_CMD_USOCR "AT+USOCR"
75 #define C4GLTE2VOICENA_CMD_USOCO "AT+USOCO"
76 #define C4GLTE2VOICENA_CMD_USOWR "AT+USOWR"
77 #define C4GLTE2VOICENA_CMD_USOST "AT+USOST"
78 #define C4GLTE2VOICENA_CMD_USORD "AT+USORD"
79 #define C4GLTE2VOICENA_CMD_USORF "AT+USORF"
80 #define C4GLTE2VOICENA_CMD_USOCL "AT+USOCL"
81 #define C4GLTE2VOICENA_CMD_UGPS "AT+UGPS"
82 #define C4GLTE2VOICENA_CMD_UGGGA "AT+UGGGA"
83 
88 #define C4GLTE2VOICENA_RSP_OK "OK"
89 #define C4GLTE2VOICENA_RSP_ERROR "ERROR"
90 
95 #define C4GLTE2VOICENA_POWER_STATE_OFF 0
96 #define C4GLTE2VOICENA_POWER_STATE_ON 1
97 
103 #define C4GLTE2VOICENA_DRV_BUFFER_SIZE 256
104  // c4glte2voicena_cmd
106 
121 #define C4GLTE2VOICENA_MAP_MIKROBUS( cfg, mikrobus ) \
122  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
123  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
124  cfg.sts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
125  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
126  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
127  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
128  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
129  // c4glte2voicena_map // c4glte2voicena
132 
137 typedef struct
138 {
139  // Output pins
140  digital_out_t sts;
141  digital_out_t pwr;
142  digital_out_t rts;
144  // Input pins
145  digital_in_t ri;
146  digital_in_t cts;
148  // Modules
149  uart_t uart;
151  // Buffers
152  char uart_rx_buffer[ C4GLTE2VOICENA_DRV_BUFFER_SIZE ];
153  char uart_tx_buffer[ C4GLTE2VOICENA_DRV_BUFFER_SIZE ];
156 
161 typedef struct
162 {
163  // Communication gpio pins
164  pin_name_t rx_pin;
165  pin_name_t tx_pin;
167  // Additional gpio pins
168  pin_name_t sts;
169  pin_name_t pwr;
170  pin_name_t rts;
171  pin_name_t ri;
172  pin_name_t cts;
174  // Static variable
175  uint32_t baud_rate;
177  uart_data_bits_t data_bit;
178  uart_parity_t parity_bit;
179  uart_stop_bits_t stop_bit;
182 
187 typedef enum
188 {
194 
196 
213 
228 
241 err_t c4glte2voicena_generic_write ( c4glte2voicena_t *ctx, char *data_in, uint16_t len );
242 
255 err_t c4glte2voicena_generic_read ( c4glte2voicena_t *ctx, char *data_out, uint16_t len );
256 
266 void c4glte2voicena_set_pwr_pin ( c4glte2voicena_t *ctx, uint8_t state );
267 
277 void c4glte2voicena_set_sts_pin ( c4glte2voicena_t *ctx, uint8_t state );
278 
288 void c4glte2voicena_set_rts_pin ( c4glte2voicena_t *ctx, uint8_t state );
289 
299 
309 
321 
331 void c4glte2voicena_send_cmd ( c4glte2voicena_t *ctx, char *cmd );
332 
343 void c4glte2voicena_send_cmd_par ( c4glte2voicena_t *ctx, char *at_cmd_buf, char *param_buf );
344 
354 void c4glte2voicena_send_cmd_check ( c4glte2voicena_t *ctx, char *at_cmd_buf );
355 
365 void c4glte2voicena_set_sim_apn ( c4glte2voicena_t *ctx, char *sim_apn );
366 
377 void c4glte2voicena_send_sms_text ( c4glte2voicena_t *ctx, char *phone_number, char *sms_text );
378 
392 err_t c4glte2voicena_send_sms_pdu ( c4glte2voicena_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
393 
394 #ifdef __cplusplus
395 }
396 #endif
397 #endif // C4GLTE2VOICENA_H
398  // c4glte2voicena
400 
401 // ------------------------------------------------------------------------ END
c4glte2voicena_t::pwr
digital_out_t pwr
Definition: c4glte2voicena.h:141
C4GLTE2VOICENA_ERROR_TIMEOUT
@ C4GLTE2VOICENA_ERROR_TIMEOUT
Definition: c4glte2voicena.h:191
c4glte2voicena_cfg_t::pwr
pin_name_t pwr
Definition: c4glte2voicena.h:169
c4glte2voicena_set_sts_pin
void c4glte2voicena_set_sts_pin(c4glte2voicena_t *ctx, uint8_t state)
4G LTE 2 Voice-NA set STS pin function.
C4GLTE2VOICENA_ERROR
@ C4GLTE2VOICENA_ERROR
Definition: c4glte2voicena.h:190
c4glte2voicena_send_sms_text
void c4glte2voicena_send_sms_text(c4glte2voicena_t *ctx, char *phone_number, char *sms_text)
4G LTE 2 Voice-NA send SMS in text mode.
c4glte2voicena_set_rts_pin
void c4glte2voicena_set_rts_pin(c4glte2voicena_t *ctx, uint8_t state)
4G LTE 2 Voice-NA set RTS pin function.
c4glte2voicena_get_cts_pin
uint8_t c4glte2voicena_get_cts_pin(c4glte2voicena_t *ctx)
4G LTE 2 Voice-NA get CTS pin function.
c4glte2voicena_set_power_state
void c4glte2voicena_set_power_state(c4glte2voicena_t *ctx, uint8_t state)
4G LTE 2 Voice-NA set power state function.
c4glte2voicena_cfg_t
4G LTE 2 Voice-NA Click configuration object.
Definition: c4glte2voicena.h:162
c4glte2voicena_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: c4glte2voicena.h:179
c4glte2voicena_get_ri_pin
uint8_t c4glte2voicena_get_ri_pin(c4glte2voicena_t *ctx)
4G LTE 2 Voice-NA get RI pin function.
c4glte2voicena_send_sms_pdu
err_t c4glte2voicena_send_sms_pdu(c4glte2voicena_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
4G LTE 2 Voice-NA send SMS in PDU mode.
c4glte2voicena_t::uart
uart_t uart
Definition: c4glte2voicena.h:149
C4GLTE2VOICENA_ERROR_UNKNOWN
@ C4GLTE2VOICENA_ERROR_UNKNOWN
Definition: c4glte2voicena.h:193
c4glte2voicena_cfg_t::uart_blocking
bool uart_blocking
Definition: c4glte2voicena.h:176
c4glte2voicena_generic_read
err_t c4glte2voicena_generic_read(c4glte2voicena_t *ctx, char *data_out, uint16_t len)
4G LTE 2 Voice-NA data reading function.
c4glte2voicena_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: c4glte2voicena.h:177
c4glte2voicena_cfg_t::tx_pin
pin_name_t tx_pin
Definition: c4glte2voicena.h:165
c4glte2voicena_t::ri
digital_in_t ri
Definition: c4glte2voicena.h:145
c4glte2voicena_cfg_t::cts
pin_name_t cts
Definition: c4glte2voicena.h:172
c4glte2voicena_cfg_t::ri
pin_name_t ri
Definition: c4glte2voicena.h:171
c4glte2voicena_generic_write
err_t c4glte2voicena_generic_write(c4glte2voicena_t *ctx, char *data_in, uint16_t len)
4G LTE 2 Voice-NA data writing function.
c4glte2voicena_return_value_t
c4glte2voicena_return_value_t
4G LTE 2 Voice-NA Click return value data.
Definition: c4glte2voicena.h:188
c4glte2voicena_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: c4glte2voicena.h:178
c4glte2voicena_t::rts
digital_out_t rts
Definition: c4glte2voicena.h:142
c4glte2voicena_send_cmd_check
void c4glte2voicena_send_cmd_check(c4glte2voicena_t *ctx, char *at_cmd_buf)
Check the sent command.
c4glte2voicena_cfg_t::rts
pin_name_t rts
Definition: c4glte2voicena.h:170
C4GLTE2VOICENA_DRV_BUFFER_SIZE
#define C4GLTE2VOICENA_DRV_BUFFER_SIZE
4G LTE 2 Voice-NA driver buffer size.
Definition: c4glte2voicena.h:103
c4glte2voicena_t
4G LTE 2 Voice-NA Click context object.
Definition: c4glte2voicena.h:138
C4GLTE2VOICENA_ERROR_CMD
@ C4GLTE2VOICENA_ERROR_CMD
Definition: c4glte2voicena.h:192
c4glte2voicena_cfg_t::baud_rate
uint32_t baud_rate
Definition: c4glte2voicena.h:175
c4glte2voicena_init
err_t c4glte2voicena_init(c4glte2voicena_t *ctx, c4glte2voicena_cfg_t *cfg)
4G LTE 2 Voice-NA initialization function.
c4glte2voicena_cfg_setup
void c4glte2voicena_cfg_setup(c4glte2voicena_cfg_t *cfg)
4G LTE 2 Voice-NA configuration object setup function.
c4glte2voicena_cfg_t::sts
pin_name_t sts
Definition: c4glte2voicena.h:168
c4glte2voicena_send_cmd
void c4glte2voicena_send_cmd(c4glte2voicena_t *ctx, char *cmd)
Send command function.
c4glte2voicena_cfg_t::rx_pin
pin_name_t rx_pin
Definition: c4glte2voicena.h:164
c4glte2voicena_t::sts
digital_out_t sts
Definition: c4glte2voicena.h:140
C4GLTE2VOICENA_OK
@ C4GLTE2VOICENA_OK
Definition: c4glte2voicena.h:189
c4glte2voicena_set_sim_apn
void c4glte2voicena_set_sim_apn(c4glte2voicena_t *ctx, char *sim_apn)
Set sim card APN.
c4glte2voicena_send_cmd_par
void c4glte2voicena_send_cmd_par(c4glte2voicena_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
c4glte2voicena_set_pwr_pin
void c4glte2voicena_set_pwr_pin(c4glte2voicena_t *ctx, uint8_t state)
4G LTE 2 Voice-NA set PWR pin function.
c4glte2voicena_t::cts
digital_in_t cts
Definition: c4glte2voicena.h:146