c4glte2voice  2.1.0.0
c4glte2voice.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 C4GLTE2VOICE_H
29 #define C4GLTE2VOICE_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 C4GLTE2VOICE_CMD_AT "AT"
74 #define C4GLTE2VOICE_CMD_ATI "ATI"
75 #define C4GLTE2VOICE_CMD_CGMR "AT+CGMR"
76 #define C4GLTE2VOICE_CMD_CFUN "AT+CFUN"
77 #define C4GLTE2VOICE_CMD_CREG "AT+CREG"
78 #define C4GLTE2VOICE_CMD_CGREG "AT+CGREG"
79 #define C4GLTE2VOICE_CMD_CGDCONT "AT+CGDCONT"
80 #define C4GLTE2VOICE_CMD_CIMI "AT+CIMI"
81 #define C4GLTE2VOICE_CMD_CMEE "AT+CMEE"
82 #define C4GLTE2VOICE_CMD_CGATT "AT+CGATT"
83 #define C4GLTE2VOICE_CMD_CSQ "AT+CSQ"
84 #define C4GLTE2VOICE_CMD_COPS "AT+COPS"
85 #define C4GLTE2VOICE_CMD_CMGS "AT+CMGS"
86 #define C4GLTE2VOICE_CMD_CMGF "AT+CMGF"
87 #define C4GLTE2VOICE_CMD_CGACT "AT+CGACT"
88 #define C4GLTE2VOICE_CMD_USOCR "AT+USOCR"
89 #define C4GLTE2VOICE_CMD_USOCO "AT+USOCO"
90 #define C4GLTE2VOICE_CMD_USOWR "AT+USOWR"
91 #define C4GLTE2VOICE_CMD_USOST "AT+USOST"
92 #define C4GLTE2VOICE_CMD_USORD "AT+USORD"
93 #define C4GLTE2VOICE_CMD_USORF "AT+USORF"
94 #define C4GLTE2VOICE_CMD_USOCL "AT+USOCL"
95 #define C4GLTE2VOICE_CMD_UGPS "AT+UGPS"
96 #define C4GLTE2VOICE_CMD_UGGGA "AT+UGGGA"
97 
102 #define C4GLTE2VOICE_RSP_OK "OK"
103 #define C4GLTE2VOICE_RSP_ERROR "ERROR"
104 
109 #define C4GLTE2VOICE_POWER_STATE_OFF 0
110 #define C4GLTE2VOICE_POWER_STATE_ON 1
111 
117 #define DRV_BUFFER_SIZE 256
118  // c4glte2voice_cmd
120 
135 #define C4GLTE2VOICE_MAP_MIKROBUS( cfg, mikrobus ) \
136  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
137  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
138  cfg.sts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
139  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
140  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
141  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
142  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
143  // c4glte2voice_map // c4glte2voice
146 
151 typedef struct
152 {
153  // Output pins
154  digital_out_t sts;
155  digital_out_t pwr;
156  digital_out_t rts;
158  // Input pins
159  digital_in_t ri;
160  digital_in_t cts;
162  // Modules
163  uart_t uart;
165  // Buffers
166  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
167  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
170 
175 typedef struct
176 {
177  // Communication gpio pins
178  pin_name_t rx_pin;
179  pin_name_t tx_pin;
181  // Additional gpio pins
182  pin_name_t sts;
183  pin_name_t pwr;
184  pin_name_t rts;
185  pin_name_t ri;
186  pin_name_t cts;
188  // Static variable
189  uint32_t baud_rate;
191  uart_data_bits_t data_bit;
192  uart_parity_t parity_bit;
193  uart_stop_bits_t stop_bit;
196 
201 typedef enum
202 {
208 
210 
227 
242 
255 err_t c4glte2voice_generic_write ( c4glte2voice_t *ctx, char *data_in, uint16_t len );
256 
269 err_t c4glte2voice_generic_read ( c4glte2voice_t *ctx, char *data_out, uint16_t len );
270 
280 void c4glte2voice_set_pwr_pin ( c4glte2voice_t *ctx, uint8_t state );
281 
291 void c4glte2voice_set_sts_pin ( c4glte2voice_t *ctx, uint8_t state );
292 
302 void c4glte2voice_set_rts_pin ( c4glte2voice_t *ctx, uint8_t state );
303 
313 
323 
334 void c4glte2voice_set_power_state ( c4glte2voice_t *ctx, uint8_t state );
335 
345 void c4glte2voice_send_cmd ( c4glte2voice_t *ctx, char *cmd );
346 
357 void c4glte2voice_send_cmd_with_parameter ( c4glte2voice_t *ctx, char *at_cmd_buf, char *param_buf );
358 
368 void c4glte2voice_send_cmd_check ( c4glte2voice_t *ctx, char *at_cmd_buf );
369 
380 
390 void c4glte2voice_set_sim_apn ( c4glte2voice_t *ctx, char *sim_apn );
391 
402 void c4glte2voice_send_sms_text ( c4glte2voice_t *ctx, char *phone_number, char *sms_text );
403 
417 err_t c4glte2voice_send_sms_pdu ( c4glte2voice_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
418 
419 #ifdef __cplusplus
420 }
421 #endif
422 #endif // C4GLTE2VOICE_H
423  // c4glte2voice
425 
426 // ------------------------------------------------------------------------ END
c4glte2voice_t::sts
digital_out_t sts
Definition: c4glte2voice.h:154
c4glte2voice_send_sms_text
void c4glte2voice_send_sms_text(c4glte2voice_t *ctx, char *phone_number, char *sms_text)
4G LTE 2 Voice send SMS in text mode.
c4glte2voice_cfg_t::cts
pin_name_t cts
Definition: c4glte2voice.h:186
c4glte2voice_cfg_t
4G LTE 2 Voice Click configuration object.
Definition: c4glte2voice.h:176
c4glte2voice_send_cmd_with_parameter
void c4glte2voice_send_cmd_with_parameter(c4glte2voice_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
c4glte2voice_set_rts_pin
void c4glte2voice_set_rts_pin(c4glte2voice_t *ctx, uint8_t state)
4G LTE 2 Voice set RTS pin function.
c4glte2voice_set_sim_apn
void c4glte2voice_set_sim_apn(c4glte2voice_t *ctx, char *sim_apn)
Set sim card APN.
c4glte2voice_cfg_t::pwr
pin_name_t pwr
Definition: c4glte2voice.h:183
c4glte2voice_cfg_t::tx_pin
pin_name_t tx_pin
Definition: c4glte2voice.h:179
c4glte2voice_send_cmd
void c4glte2voice_send_cmd(c4glte2voice_t *ctx, char *cmd)
Send command function.
c4glte2voice_cfg_t::ri
pin_name_t ri
Definition: c4glte2voice.h:185
c4glte2voice_cfg_t::baud_rate
uint32_t baud_rate
Definition: c4glte2voice.h:189
c4glte2voice_generic_read
err_t c4glte2voice_generic_read(c4glte2voice_t *ctx, char *data_out, uint16_t len)
4G LTE 2 Voice data reading function.
c4glte2voice_t::cts
digital_in_t cts
Definition: c4glte2voice.h:160
c4glte2voice_set_power_state
void c4glte2voice_set_power_state(c4glte2voice_t *ctx, uint8_t state)
4G LTE 2 Voice set power state function.
c4glte2voice_set_pwr_pin
void c4glte2voice_set_pwr_pin(c4glte2voice_t *ctx, uint8_t state)
4G LTE 2 Voice set PWR pin function.
C4GLTE2VOICE_ERROR_CMD
@ C4GLTE2VOICE_ERROR_CMD
Definition: c4glte2voice.h:206
c4glte2voice_cfg_t::rx_pin
pin_name_t rx_pin
Definition: c4glte2voice.h:178
c4glte2voice_t::pwr
digital_out_t pwr
Definition: c4glte2voice.h:155
c4glte2voice_cfg_t::rts
pin_name_t rts
Definition: c4glte2voice.h:184
c4glte2voice_send_cmd_parameter_check
void c4glte2voice_send_cmd_parameter_check(c4glte2voice_t *ctx, char *at_cmd_buf)
Check the command parameters.
c4glte2voice_cfg_t::sts
pin_name_t sts
Definition: c4glte2voice.h:182
c4glte2voice_t::uart
uart_t uart
Definition: c4glte2voice.h:163
c4glte2voice_get_ri_pin
uint8_t c4glte2voice_get_ri_pin(c4glte2voice_t *ctx)
4G LTE 2 Voice get RI pin function.
c4glte2voice_t
4G LTE 2 Voice Click context object.
Definition: c4glte2voice.h:152
c4glte2voice_return_value_t
c4glte2voice_return_value_t
4G LTE 2 Voice Click return value data.
Definition: c4glte2voice.h:202
c4glte2voice_t::ri
digital_in_t ri
Definition: c4glte2voice.h:159
c4glte2voice_send_sms_pdu
err_t c4glte2voice_send_sms_pdu(c4glte2voice_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
4G LTE 2 Voice send SMS in PDU mode.
c4glte2voice_get_cts_pin
uint8_t c4glte2voice_get_cts_pin(c4glte2voice_t *ctx)
4G LTE 2 Voice get CTS pin function.
c4glte2voice_t::rts
digital_out_t rts
Definition: c4glte2voice.h:156
c4glte2voice_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: c4glte2voice.h:192
c4glte2voice_generic_write
err_t c4glte2voice_generic_write(c4glte2voice_t *ctx, char *data_in, uint16_t len)
4G LTE 2 Voice data writing function.
c4glte2voice_send_cmd_check
void c4glte2voice_send_cmd_check(c4glte2voice_t *ctx, char *at_cmd_buf)
Check the sent command.
c4glte2voice_set_sts_pin
void c4glte2voice_set_sts_pin(c4glte2voice_t *ctx, uint8_t state)
4G LTE 2 Voice set STS pin function.
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
4G LTE 2 Voice driver buffer size.
Definition: c4glte2voice.h:117
C4GLTE2VOICE_OK
@ C4GLTE2VOICE_OK
Definition: c4glte2voice.h:203
C4GLTE2VOICE_ERROR
@ C4GLTE2VOICE_ERROR
Definition: c4glte2voice.h:204
c4glte2voice_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: c4glte2voice.h:191
C4GLTE2VOICE_ERROR_TIMEOUT
@ C4GLTE2VOICE_ERROR_TIMEOUT
Definition: c4glte2voice.h:205
c4glte2voice_cfg_t::uart_blocking
bool uart_blocking
Definition: c4glte2voice.h:190
c4glte2voice_cfg_setup
void c4glte2voice_cfg_setup(c4glte2voice_cfg_t *cfg)
4G LTE 2 Voice configuration object setup function.
c4glte2voice_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: c4glte2voice.h:193
c4glte2voice_init
err_t c4glte2voice_init(c4glte2voice_t *ctx, c4glte2voice_cfg_t *cfg)
4G LTE 2 Voice initialization function.
C4GLTE2VOICE_ERROR_UNKNOWN
@ C4GLTE2VOICE_ERROR_UNKNOWN
Definition: c4glte2voice.h:207