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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define GSMGPS_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
65  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
66  cfg.sta = MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.pwk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
69  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
70  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
71 
77 #define GSMGPS_RETVAL uint8_t
78 
84 #define GSMGPS_NEMA_GPGGA 1
85 #define GSMGPS_NEMA_GPGLL 3
86 #define GSMGPS_NEMA_GPGGA_NUM_ELEMENT 15
87 #define GSMGPS_NEMA_GPGLL_NUM_ELEMENT 5
88 
94 #define GSMGPS_GPGGA_TIME 1
95 #define GSMGPS_GPGGA_LATITUDE 2
96 #define GSMGPS_GPGGA_LATITUDE_SIDE 3
97 #define GSMGPS_GPGGA_LONGITUDE 4
98 #define GSMGPS_GPGGA_LONGITUDE_SIDE 5
99 #define GSMGPS_GPGGA_QUALITY_INDICATOR 6
100 #define GSMGPS_GPGGA_NUMBER_OF_SATELLITES 7
101 #define GSMGPS_GPGGA_H_DILUTION_OF_POS 8
102 #define GSMGPS_GPGGA_ALTITUDE 9
103 #define GSMGPS_GPGGA_ALTITUDE_UNIT 10
104 #define GSMGPS_GPGGA_GEOIDAL_SEPARATION 11
105 #define GSMGPS_GPGGA_GEOIDAL_SEPARATION_UNIT 12
106 #define GSMGPS_GPGGA_TIME_SINCE_LAST_DGPS 13
107 #define GSMGPS_GPGGA_DGPS_REFERENCE_STATION_ID 14
108 
114 #define GSMGPS_GPGLL_LATITUDE 1
115 #define GSMGPS_GPGLL_LATITUDE_SIDE 2
116 #define GSMGPS_GPGLL_LONGITUDE 3
117 #define GSMGPS_GPGLL_LONGITUDE_SIDE 4
118 
124 #define GSMGPS_ERROR_COMMAND_OR_ELEMENT 0xFF
125 #define GSMGPS_ERROR_START_OR_END_COMMAND 0x8F
126 #define GSMGPS_ERROR_NEXT_ELEMENT 0x4F
127 #define GSMGPS_ERROR_CURRENT_ELEMENT 0x2F
128 #define GSMGPS_NO_ERROR 0x00
129 
135 #define GSMGPS_MODULE_POWER_ON 1
136 #define GSMGPS_MODULE_POWER_OFF 0
137 
143 #define GSMGPS_CMD_AT "AT"
144 #define GSMGPS_CMD_ATI "ATI"
145 #define GSMGPS_CMD_CGMR "AT+CGMR"
146 
147 #define GSMGPS_CMD_CFUN "AT+CFUN"
148 #define GSMGPS_CMD_CREG "AT+CREG"
149 #define GSMGPS_CMD_CGDCONT "AT+CGDCONT"
150 #define GSMGPS_CMD_CIMI "AT+CIMI"
151 #define GSMGPS_CMD_CGATT "AT+CGATT"
152 #define GSMGPS_CMD_CSQ "AT+CSQ"
153 #define GSMGPS_CMD_COPS "AT+COPS"
154 #define GSMGPS_CMD_CMGS "AT+CMGS"
155 #define GSMGPS_CMD_CMGF "AT+CMGF"
156 #define GSMGPS_CMD_CGNSPWR "AT+CGNSPWR"
157 #define GSMGPS_CMD_CGPSINF "AT+CGPSINF"
158 
164 #define DRV_RX_BUFFER_SIZE 256
165 #define DRV_TX_BUFFER_SIZE 256
166  // End group macro
169 // --------------------------------------------------------------- PUBLIC TYPES
177 typedef struct
178 {
179  // Output pins
180 
181  digital_out_t pwk;
182  digital_out_t rts;
183 
184  // Input pins
185 
186  digital_in_t sta;
187  digital_in_t ri;
188  digital_in_t cts;
189 
190  // Modules
191 
192  uart_t uart;
193 
194  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
195  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
196 
197 } gsmgps_t;
198 
202 typedef struct
203 {
204  // Communication gpio pins
205 
206  pin_name_t rx_pin;
207  pin_name_t tx_pin;
208 
209  // Additional gpio pins
210 
211  pin_name_t sta;
212  pin_name_t pwk;
213  pin_name_t rts;
214  pin_name_t ri;
215  pin_name_t cts;
216 
217  // static variable
218 
219  uint32_t baud_rate; // Clock speed.
221  uart_data_bits_t data_bit; // Data bits.
222  uart_parity_t parity_bit; // Parity bit.
223  uart_stop_bits_t stop_bit; // Stop bits.
224 
225 } gsmgps_cfg_t;
226 
231 typedef enum
232 {
234  GSMGPS_ERROR = -1
235 
237 
241 typedef uint8_t gsmgps_error_t;
242  // End types group
244 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
245 
251 #ifdef __cplusplus
252 extern "C"{
253 #endif
254 
264 
273 
279 void gsmgps_module_power ( gsmgps_t *ctx, uint8_t state );
280 
287 void gsmgps_generic_write ( gsmgps_t *ctx, char *data_buf, uint16_t len );
288 
296 int32_t gsmgps_generic_read ( gsmgps_t *ctx, char *data_buf, uint16_t max_len );
297 
306 void gsmgps_set_rts ( gsmgps_t *ctx, uint8_t state );
307 
316 uint8_t gsmgps_get_cts ( gsmgps_t *ctx );
317 
327 void gsmgps_send_cmd ( gsmgps_t *ctx, char *cmd );
328 
339 void gsmgps_send_cmd_with_parameter ( gsmgps_t *ctx, char *at_cmd_buf, char *param_buf );
340 
350 void gsmgps_send_cmd_check ( gsmgps_t *ctx, char *at_cmd_buf );
351 
361 void gsmgps_send_cmd_parameter_check ( gsmgps_t *ctx, char *at_cmd_buf );
362 
372 void gsmgps_set_sim_apn ( gsmgps_t *ctx, char *sim_apn );
373 
384 void gsmgps_send_sms_text ( gsmgps_t *ctx, char *phone_number, char *sms_text );
385 
399 err_t gsmgps_send_sms_pdu ( gsmgps_t *ctx, char *service_center_number,
400  char *phone_number, char *sms_text );
401 
411 (
412  char *rsp, uint8_t command,
413  uint8_t element, char *parser_buf
414 );
415 
416 #ifdef __cplusplus
417 }
418 #endif
419 #endif // _GSMGPS_H_
420  // End public_function group
423 
424 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: gsmgps.h:164
gsmgps_cfg_t::baud_rate
uint32_t baud_rate
Definition: gsmgps.h:219
gsmgps_t::pwk
digital_out_t pwk
Definition: gsmgps.h:181
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:213
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:203
GSMGPS_RETVAL
#define GSMGPS_RETVAL
Definition: gsmgps.h:77
gsmgps_t::rts
digital_out_t rts
Definition: gsmgps.h:182
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:187
gsmgps_t::uart
uart_t uart
Definition: gsmgps.h:192
gsmgps_t::cts
digital_in_t cts
Definition: gsmgps.h:188
gsmgps_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gsmgps.h:206
gsmgps_cfg_t::ri
pin_name_t ri
Definition: gsmgps.h:214
gsmgps_cfg_t::uart_blocking
bool uart_blocking
Definition: gsmgps.h:220
gsmgps_t
Click ctx object definition.
Definition: gsmgps.h:178
gsmgps_return_value_t
gsmgps_return_value_t
GSM-GPS Click return value data.
Definition: gsmgps.h:232
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:211
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:215
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:234
gsmgps_t::sta
digital_in_t sta
Definition: gsmgps.h:186
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:165
gsmgps_cfg_t::pwk
pin_name_t pwk
Definition: gsmgps.h:212
gsmgps_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gsmgps.h:221
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:207
gsmgps_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gsmgps.h:222
gsmgps_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gsmgps.h:223
GSMGPS_OK
@ GSMGPS_OK
Definition: gsmgps.h:233
gsmgps_error_t
uint8_t gsmgps_error_t
Error type.
Definition: gsmgps.h:241
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.