gsmgps  2.0.0.0
gsmgps.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef GSMGPS_H
36 #define GSMGPS_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define GSMGPS_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.sta = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.pwk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
58  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
60  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
61 
67 #define GSMGPS_RETVAL uint8_t
68 
74 #define GSMGPS_NEMA_GPGGA 1
75 #define GSMGPS_NEMA_GPGLL 3
76 #define GSMGPS_NEMA_GPGGA_NUM_ELEMENT 15
77 #define GSMGPS_NEMA_GPGLL_NUM_ELEMENT 5
78 
84 #define GSMGPS_GPGGA_TIME 1
85 #define GSMGPS_GPGGA_LATITUDE 2
86 #define GSMGPS_GPGGA_LATITUDE_SIDE 3
87 #define GSMGPS_GPGGA_LONGITUDE 4
88 #define GSMGPS_GPGGA_LONGITUDE_SIDE 5
89 #define GSMGPS_GPGGA_QUALITY_INDICATOR 6
90 #define GSMGPS_GPGGA_NUMBER_OF_SATELLITES 7
91 #define GSMGPS_GPGGA_H_DILUTION_OF_POS 8
92 #define GSMGPS_GPGGA_ALTITUDE 9
93 #define GSMGPS_GPGGA_ALTITUDE_UNIT 10
94 #define GSMGPS_GPGGA_GEOIDAL_SEPARATION 11
95 #define GSMGPS_GPGGA_GEOIDAL_SEPARATION_UNIT 12
96 #define GSMGPS_GPGGA_TIME_SINCE_LAST_DGPS 13
97 #define GSMGPS_GPGGA_DGPS_REFERENCE_STATION_ID 14
98 
104 #define GSMGPS_GPGLL_LATITUDE 1
105 #define GSMGPS_GPGLL_LATITUDE_SIDE 2
106 #define GSMGPS_GPGLL_LONGITUDE 3
107 #define GSMGPS_GPGLL_LONGITUDE_SIDE 4
108 
114 #define GSMGPS_ERROR_COMMAND_OR_ELEMENT 0xFF
115 #define GSMGPS_ERROR_START_OR_END_COMMAND 0x8F
116 #define GSMGPS_ERROR_NEXT_ELEMENT 0x4F
117 #define GSMGPS_ERROR_CURRENT_ELEMENT 0x2F
118 #define GSMGPS_NO_ERROR 0x00
119 
125 #define GSMGPS_MODULE_POWER_ON 1
126 #define GSMGPS_MODULE_POWER_OFF 0
127 
133 #define GSMGPS_CMD_AT "AT"
134 #define GSMGPS_CMD_ATI "ATI"
135 #define GSMGPS_CMD_CGMR "AT+CGMR"
136 
137 #define GSMGPS_CMD_CFUN "AT+CFUN"
138 #define GSMGPS_CMD_CREG "AT+CREG"
139 #define GSMGPS_CMD_CGDCONT "AT+CGDCONT"
140 #define GSMGPS_CMD_CIMI "AT+CIMI"
141 #define GSMGPS_CMD_CGATT "AT+CGATT"
142 #define GSMGPS_CMD_CSQ "AT+CSQ"
143 #define GSMGPS_CMD_COPS "AT+COPS"
144 #define GSMGPS_CMD_CMGS "AT+CMGS"
145 #define GSMGPS_CMD_CMGF "AT+CMGF"
146 #define GSMGPS_CMD_CGNSPWR "AT+CGNSPWR"
147 #define GSMGPS_CMD_CGPSINF "AT+CGPSINF"
148 
154 #define DRV_RX_BUFFER_SIZE 256
155 #define DRV_TX_BUFFER_SIZE 256
156  // End group macro
159 // --------------------------------------------------------------- PUBLIC TYPES
167 typedef struct
168 {
169  // Output pins
170 
171  digital_out_t pwk;
172  digital_out_t rts;
173 
174  // Input pins
175 
176  digital_in_t sta;
177  digital_in_t ri;
178  digital_in_t cts;
179 
180  // Modules
181 
182  uart_t uart;
183 
184  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
185  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
186 
187 } gsmgps_t;
188 
192 typedef struct
193 {
194  // Communication gpio pins
195 
196  pin_name_t rx_pin;
197  pin_name_t tx_pin;
198 
199  // Additional gpio pins
200 
201  pin_name_t sta;
202  pin_name_t pwk;
203  pin_name_t rts;
204  pin_name_t ri;
205  pin_name_t cts;
206 
207  // static variable
208 
209  uint32_t baud_rate; // Clock speed.
211  uart_data_bits_t data_bit; // Data bits.
212  uart_parity_t parity_bit; // Parity bit.
213  uart_stop_bits_t stop_bit; // Stop bits.
214 
215 } gsmgps_cfg_t;
216 
221 typedef enum
222 {
224  GSMGPS_ERROR = -1
225 
227 
231 typedef uint8_t gsmgps_error_t;
232  // End types group
234 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
235 
241 #ifdef __cplusplus
242 extern "C"{
243 #endif
244 
254 
263 
269 void gsmgps_module_power ( gsmgps_t *ctx, uint8_t state );
270 
277 void gsmgps_generic_write ( gsmgps_t *ctx, char *data_buf, uint16_t len );
278 
286 int32_t gsmgps_generic_read ( gsmgps_t *ctx, char *data_buf, uint16_t max_len );
287 
296 void gsmgps_set_rts ( gsmgps_t *ctx, uint8_t state );
297 
306 uint8_t gsmgps_get_cts ( gsmgps_t *ctx );
307 
317 void gsmgps_send_cmd ( gsmgps_t *ctx, char *cmd );
318 
329 void gsmgps_send_cmd_with_parameter ( gsmgps_t *ctx, char *at_cmd_buf, char *param_buf );
330 
340 void gsmgps_send_cmd_check ( gsmgps_t *ctx, char *at_cmd_buf );
341 
351 void gsmgps_send_cmd_parameter_check ( gsmgps_t *ctx, char *at_cmd_buf );
352 
362 void gsmgps_set_sim_apn ( gsmgps_t *ctx, char *sim_apn );
363 
374 void gsmgps_send_sms_text ( gsmgps_t *ctx, char *phone_number, char *sms_text );
375 
389 err_t gsmgps_send_sms_pdu ( gsmgps_t *ctx, char *service_center_number,
390  char *phone_number, char *sms_text );
391 
401 (
402  char *rsp, uint8_t command,
403  uint8_t element, char *parser_buf
404 );
405 
406 #ifdef __cplusplus
407 }
408 #endif
409 #endif // _GSMGPS_H_
410  // End public_function group
413 
414 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: gsmgps.h:154
gsmgps_cfg_t::baud_rate
uint32_t baud_rate
Definition: gsmgps.h:209
gsmgps_t::pwk
digital_out_t pwk
Definition: gsmgps.h:171
gsmgps_send_cmd_check
void gsmgps_send_cmd_check(gsmgps_t *ctx, char *at_cmd_buf)
Check the sent command.
gsmgps_cfg_t::rts
pin_name_t rts
Definition: gsmgps.h:203
gsmgps_set_rts
void gsmgps_set_rts(gsmgps_t *ctx, uint8_t state)
Sets state of the RTS pin.
gsmgps_cfg_t
Click configuration structure definition.
Definition: gsmgps.h:193
GSMGPS_RETVAL
#define GSMGPS_RETVAL
Definition: gsmgps.h:67
gsmgps_t::rts
digital_out_t rts
Definition: gsmgps.h:172
gsmgps_cfg_setup
void gsmgps_cfg_setup(gsmgps_cfg_t *cfg)
Config Object Initialization function.
gsmgps_send_sms_pdu
err_t gsmgps_send_sms_pdu(gsmgps_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
GSM-GPS send SMS in PDU mode.
gsmgps_generic_parser
gsmgps_error_t gsmgps_generic_parser(char *rsp, uint8_t command, uint8_t element, char *parser_buf)
Generic parser function.
gsmgps_t::ri
digital_in_t ri
Definition: gsmgps.h:177
gsmgps_t::uart
uart_t uart
Definition: gsmgps.h:182
gsmgps_t::cts
digital_in_t cts
Definition: gsmgps.h:178
gsmgps_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gsmgps.h:196
gsmgps_cfg_t::ri
pin_name_t ri
Definition: gsmgps.h:204
gsmgps_cfg_t::uart_blocking
bool uart_blocking
Definition: gsmgps.h:210
gsmgps_t
Click ctx object definition.
Definition: gsmgps.h:168
gsmgps_return_value_t
gsmgps_return_value_t
GSM-GPS Click return value data.
Definition: gsmgps.h:222
gsmgps_send_cmd_with_parameter
void gsmgps_send_cmd_with_parameter(gsmgps_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
gsmgps_cfg_t::sta
pin_name_t sta
Definition: gsmgps.h:201
gsmgps_init
GSMGPS_RETVAL gsmgps_init(gsmgps_t *ctx, gsmgps_cfg_t *cfg)
Initialization function.
gsmgps_cfg_t::cts
pin_name_t cts
Definition: gsmgps.h:205
gsmgps_send_sms_text
void gsmgps_send_sms_text(gsmgps_t *ctx, char *phone_number, char *sms_text)
GSM-GPS send SMS in text mode.
gsmgps_generic_read
int32_t gsmgps_generic_read(gsmgps_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
gsmgps_get_cts
uint8_t gsmgps_get_cts(gsmgps_t *ctx)
CTS Pin Get function.
GSMGPS_ERROR
@ GSMGPS_ERROR
Definition: gsmgps.h:224
gsmgps_t::sta
digital_in_t sta
Definition: gsmgps.h:176
gsmgps_send_cmd_parameter_check
void gsmgps_send_cmd_parameter_check(gsmgps_t *ctx, char *at_cmd_buf)
Check the command parameters.
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: gsmgps.h:155
gsmgps_cfg_t::pwk
pin_name_t pwk
Definition: gsmgps.h:202
gsmgps_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gsmgps.h:211
gsmgps_set_sim_apn
void gsmgps_set_sim_apn(gsmgps_t *ctx, char *sim_apn)
Set sim card APN.
gsmgps_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gsmgps.h:197
gsmgps_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gsmgps.h:212
gsmgps_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gsmgps.h:213
GSMGPS_OK
@ GSMGPS_OK
Definition: gsmgps.h:223
gsmgps_error_t
uint8_t gsmgps_error_t
Error type.
Definition: gsmgps.h:231
gsmgps_send_cmd
void gsmgps_send_cmd(gsmgps_t *ctx, char *cmd)
Send command function.
gsmgps_generic_write
void gsmgps_generic_write(gsmgps_t *ctx, char *data_buf, uint16_t len)
Generic write function.
gsmgps_module_power
void gsmgps_module_power(gsmgps_t *ctx, uint8_t state)
Power ON/OFF the module.