gsmgnss2  2.0.0.0
gsmgnss2.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 GSMGNSS2_H
29 #define GSMGNSS2_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 GSMGNSS2_CMD_AT "AT"
60 #define GSMGNSS2_CMD_ATI "ATI"
61 #define GSMGNSS2_CMD_CGMR "AT+CGMR"
62 #define GSMGNSS2_CMD_CFUN "AT+CFUN"
63 #define GSMGNSS2_CMD_CREG "AT+CREG"
64 #define GSMGNSS2_CMD_CGREG "AT+CGREG"
65 #define GSMGNSS2_CMD_CGDCONT "AT+CGDCONT"
66 #define GSMGNSS2_CMD_CIMI "AT+CIMI"
67 #define GSMGNSS2_CMD_CMEE "AT+CMEE"
68 #define GSMGNSS2_CMD_CGATT "AT+CGATT"
69 #define GSMGNSS2_CMD_CSQ "AT+CSQ"
70 #define GSMGNSS2_CMD_COPS "AT+COPS"
71 #define GSMGNSS2_CMD_CMGS "AT+CMGS"
72 #define GSMGNSS2_CMD_CMGF "AT+CMGF"
73 #define GSMGNSS2_CMD_CGNSPWR "AT+CGNSPWR"
74 #define GSMGNSS2_CMD_CGNSTST "AT+CGNSTST"
75 
80 #define GSMGNSS2_RSP_START "$"
81 #define GSMGNSS2_RSP_DELIMITER ","
82 #define GSMGNSS2_RSP_GNGGA "$GNGGA"
83 
88 #define GSMGNSS2_GNGGA_ELEMENT_SIZE 15
89 #define GSMGNSS2_GNGGA_TIME 1
90 #define GSMGNSS2_GNGGA_LATITUDE 2
91 #define GSMGNSS2_GNGGA_LATITUDE_SIDE 3
92 #define GSMGNSS2_GNGGA_LONGITUDE 4
93 #define GSMGNSS2_GNGGA_LONGITUDE_SIDE 5
94 #define GSMGNSS2_GNGGA_QUALITY_INDICATOR 6
95 #define GSMGNSS2_GNGGA_NUMBER_OF_SATELLITES 7
96 #define GSMGNSS2_GNGGA_H_DILUTION_OF_POS 8
97 #define GSMGNSS2_GNGGA_ALTITUDE 9
98 #define GSMGNSS2_GNGGA_ALTITUDE_UNIT 10
99 #define GSMGNSS2_GNGGA_GEOIDAL_SEPARATION 11
100 #define GSMGNSS2_GNGGA_GEOIDAL_SEPARATION_UNIT 12
101 #define GSMGNSS2_GNGGA_TIME_SINCE_LAST_DGPS 13
102 #define GSMGNSS2_GNGGA_DGPS_REFERENCE_STATION_ID 14
103 
108 #define GSMGNSS2_MODULE_POWER_ON 1
109 #define GSMGNSS2_MODULE_POWER_OFF 0
110 
116 #define DRV_BUFFER_SIZE_RX 256
117 #define DRV_BUFFER_SIZE_TX 256
118  // gsmgnss2_cmd
120 
135 #define GSMGNSS2_MAP_MIKROBUS( cfg, mikrobus ) \
136  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
137  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
138  cfg.det = MIKROBUS( mikrobus, MIKROBUS_AN ); \
139  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
140  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
141  cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
142  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
143  // gsmgnss2_map // gsmgnss2
146 
151 typedef struct
152 {
153  // Output pins
154 
155  digital_out_t rst;
156  digital_out_t rts;
157 
158  // Input pins
159 
160  digital_in_t det;
161  digital_in_t ring;
162  digital_in_t cts;
163 
164  // Modules
165  uart_t uart;
167  // Buffers
168  char uart_rx_buffer[ DRV_BUFFER_SIZE_RX ];
169  char uart_tx_buffer[ DRV_BUFFER_SIZE_TX ];
171 } gsmgnss2_t;
172 
177 typedef struct
178 {
179  // Communication gpio pins
180  pin_name_t rx_pin;
181  pin_name_t tx_pin;
183  // Additional gpio pins
184 
185  pin_name_t det;
186  pin_name_t rst;
187  pin_name_t rts;
188  pin_name_t ring;
189  pin_name_t cts;
190 
191  // Static variable
192  uint32_t baud_rate;
194  uart_data_bits_t data_bit;
195  uart_parity_t parity_bit;
196  uart_stop_bits_t stop_bit;
199 
204 typedef enum
205 {
207  GSMGNSS2_ERROR = -1
208 
210 
227 
242 
248 void gsmgnss2_module_power ( gsmgnss2_t *ctx, uint8_t state );
249 
262 err_t gsmgnss2_generic_write ( gsmgnss2_t *ctx, char *data_buf, uint16_t len );
263 
276 err_t gsmgnss2_generic_read ( gsmgnss2_t *ctx, char *data_buf, uint16_t max_len );
277 
286 void gsmgnss2_send_cmd ( gsmgnss2_t *ctx, char *cmd );
287 
297 void gsmgnss2_send_cmd_with_parameter ( gsmgnss2_t *ctx, char *at_cmd_buf, char *param_buf );
298 
307 void gsmgnss2_send_cmd_check ( gsmgnss2_t *ctx, char *at_cmd_buf );
308 
317 void gsmgnss2_send_cmd_parameter_check ( gsmgnss2_t *ctx, char *at_cmd_buf );
318 
327 void gsmgnss2_set_sim_apn ( gsmgnss2_t *ctx, char *sim_apn );
328 
338 void gsmgnss2_send_sms_text ( gsmgnss2_t *ctx, char *phone_number, char *sms_text );
339 
352 err_t gsmgnss2_send_sms_pdu ( gsmgnss2_t *ctx, char *service_center_number,
353  char *phone_number, char *sms_text );
354 
366 err_t gsmgnss2_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
367 
368 #ifdef __cplusplus
369 }
370 #endif
371 #endif // GSMGNSS2_H
372  // gsmgnss2
374 
375 // ------------------------------------------------------------------------ END
GSMGNSS2_ERROR
@ GSMGNSS2_ERROR
Definition: gsmgnss2.h:207
gsmgnss2_init
err_t gsmgnss2_init(gsmgnss2_t *ctx, gsmgnss2_cfg_t *cfg)
GSM/GNSS 2 initialization function.
DRV_BUFFER_SIZE_TX
#define DRV_BUFFER_SIZE_TX
Definition: gsmgnss2.h:117
gsmgnss2_send_sms_pdu
err_t gsmgnss2_send_sms_pdu(gsmgnss2_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
GSM GNSS 2 send SMS in PDU mode.
gsmgnss2_parse_gngga
err_t gsmgnss2_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GSM GNSS 2 parse GNGGA function.
gsmgnss2_send_cmd_check
void gsmgnss2_send_cmd_check(gsmgnss2_t *ctx, char *at_cmd_buf)
Check the sent command.
gsmgnss2_generic_read
err_t gsmgnss2_generic_read(gsmgnss2_t *ctx, char *data_buf, uint16_t max_len)
GSM/GNSS 2 data reading function.
gsmgnss2_t
GSM/GNSS 2 Click context object.
Definition: gsmgnss2.h:152
DRV_BUFFER_SIZE_RX
#define DRV_BUFFER_SIZE_RX
GSM/GNSS 2 driver buffer size.
Definition: gsmgnss2.h:116
gsmgnss2_cfg_t::uart_blocking
bool uart_blocking
Definition: gsmgnss2.h:193
gsmgnss2_return_value_t
gsmgnss2_return_value_t
GSM/GNSS 2 Click return value data.
Definition: gsmgnss2.h:205
gsmgnss2_t::rts
digital_out_t rts
Definition: gsmgnss2.h:156
gsmgnss2_module_power
void gsmgnss2_module_power(gsmgnss2_t *ctx, uint8_t state)
Power ON/OFF the module.
gsmgnss2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gsmgnss2.h:195
gsmgnss2_cfg_t::det
pin_name_t det
Definition: gsmgnss2.h:185
gsmgnss2_send_cmd_with_parameter
void gsmgnss2_send_cmd_with_parameter(gsmgnss2_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
gsmgnss2_generic_write
err_t gsmgnss2_generic_write(gsmgnss2_t *ctx, char *data_buf, uint16_t len)
GSM/GNSS 2 data writing function.
gsmgnss2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gsmgnss2.h:196
gsmgnss2_cfg_setup
void gsmgnss2_cfg_setup(gsmgnss2_cfg_t *cfg)
GSM/GNSS 2 configuration object setup function.
gsmgnss2_set_sim_apn
void gsmgnss2_set_sim_apn(gsmgnss2_t *ctx, char *sim_apn)
Set sim card APN.
gsmgnss2_t::uart
uart_t uart
Definition: gsmgnss2.h:165
gsmgnss2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gsmgnss2.h:181
gsmgnss2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gsmgnss2.h:194
gsmgnss2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gsmgnss2.h:180
GSMGNSS2_OK
@ GSMGNSS2_OK
Definition: gsmgnss2.h:206
gsmgnss2_send_cmd
void gsmgnss2_send_cmd(gsmgnss2_t *ctx, char *cmd)
Send command function.
gsmgnss2_cfg_t::rst
pin_name_t rst
Definition: gsmgnss2.h:186
gsmgnss2_send_cmd_parameter_check
void gsmgnss2_send_cmd_parameter_check(gsmgnss2_t *ctx, char *at_cmd_buf)
Check the command parameters.
gsmgnss2_cfg_t
GSM/GNSS 2 Click configuration object.
Definition: gsmgnss2.h:178
gsmgnss2_cfg_t::ring
pin_name_t ring
Definition: gsmgnss2.h:188
gsmgnss2_cfg_t::rts
pin_name_t rts
Definition: gsmgnss2.h:187
gsmgnss2_t::rst
digital_out_t rst
Definition: gsmgnss2.h:155
gsmgnss2_t::cts
digital_in_t cts
Definition: gsmgnss2.h:162
gsmgnss2_cfg_t::baud_rate
uint32_t baud_rate
Definition: gsmgnss2.h:192
gsmgnss2_t::ring
digital_in_t ring
Definition: gsmgnss2.h:161
gsmgnss2_send_sms_text
void gsmgnss2_send_sms_text(gsmgnss2_t *ctx, char *phone_number, char *sms_text)
GSM GNSS 2 send SMS in text mode.
gsmgnss2_t::det
digital_in_t det
Definition: gsmgnss2.h:160
gsmgnss2_cfg_t::cts
pin_name_t cts
Definition: gsmgnss2.h:189