gsmgnss  2.0.0.0
gsmgnss.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef GSMGNSS_H
36 #define GSMGNSS_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 GSMGNSS_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.det = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
58  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
59  cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
60  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
61 
67 #define GSMGNSS_RETVAL uint8_t
68 
74 #define GSMGNSS_NMEA_GNGGA 1
75 #define GSMGNSS_NMEA_GNGLL 3
76 #define GSMGNSS_NMEA_GNGGA_NUM_ELEMENT 15
77 #define GSMGNSS_NMEA_GNGLL_NUM_ELEMENT 5
78 
84 #define GSMGNSS_GNGGA_TIME 1
85 #define GSMGNSS_GNGGA_LATITUDE 2
86 #define GSMGNSS_GNGGA_LATITUDE_SIDE 3
87 #define GSMGNSS_GNGGA_LONGITUDE 4
88 #define GSMGNSS_GNGGA_LONGITUDE_SIDE 5
89 #define GSMGNSS_GNGGA_QUALITY_INDICATOR 6
90 #define GSMGNSS_GNGGA_NUMBER_OF_SATELLITES 7
91 #define GSMGNSS_GNGGA_H_DILUTION_OF_POS 8
92 #define GSMGNSS_GNGGA_ALTITUDE 9
93 #define GSMGNSS_GNGGA_ALTITUDE_UNIT 10
94 #define GSMGNSS_GNGGA_GEOIDAL_SEPARATION 11
95 #define GSMGNSS_GNGGA_GEOIDAL_SEPARATION_UNIT 12
96 #define GSMGNSS_GNGGA_TIME_SINCE_LAST_DGPS 13
97 #define GSMGNSS_GNGGA_DGPS_REFERENCE_STATION_ID 14
98 
104 #define GSMGNSS_GNGLL_LATITUDE 1
105 #define GSMGNSS_GNGLL_LATITUDE_SIDE 2
106 #define GSMGNSS_GNGLL_LONGITUDE 3
107 #define GSMGNSS_GNGLL_LONGITUDE_SIDE 4
108 
114 #define GSMGNSS_ERROR_COMMAND_OR_ELEMENT 0xFF
115 #define GSMGNSS_ERROR_START_OR_END_COMMAND 0x8F
116 #define GSMGNSS_ERROR_NEXT_ELEMENT 0x4F
117 #define GSMGNSS_ERROR_CURRENT_ELEMENT 0x2F
118 #define GSMGNSS_NO_ERROR 0x00
119 
125 #define GSMGNSS_MODULE_POWER_ON 1
126 #define GSMGNSS_MODULE_POWER_OFF 0
127 
133 #define GSMGNSS_CMD_AT "AT"
134 #define GSMGNSS_CMD_ATI "ATI"
135 #define GSMGNSS_CMD_CGMR "AT+CGMR"
136 
137 #define GSMGNSS_CMD_CFUN "AT+CFUN"
138 #define GSMGNSS_CMD_CREG "AT+CREG"
139 #define GSMGNSS_CMD_CGREG "AT+CGREG"
140 #define GSMGNSS_CMD_CGDCONT "AT+CGDCONT"
141 #define GSMGNSS_CMD_CIMI "AT+CIMI"
142 #define GSMGNSS_CMD_CMEE "AT+CMEE"
143 #define GSMGNSS_CMD_CGATT "AT+CGATT"
144 #define GSMGNSS_CMD_CSQ "AT+CSQ"
145 #define GSMGNSS_CMD_COPS "AT+COPS"
146 #define GSMGNSS_CMD_CMGS "AT+CMGS"
147 #define GSMGNSS_CMD_CMGF "AT+CMGF"
148 #define GSMGNSS_CMD_QGNSSC "AT+QGNSSC"
149 #define GSMGNSS_CMD_QGNSSRD "AT+QGNSSRD"
150 
156 #define DRV_RX_BUFFER_SIZE 256
157 #define DRV_TX_BUFFER_SIZE 256
158  // End group macro
161 // --------------------------------------------------------------- PUBLIC TYPES
169 typedef struct
170 {
171  // Output pins
172 
173  digital_out_t rst;
174  digital_out_t rts;
175 
176  // Input pins
177 
178  digital_in_t det;
179  digital_in_t ring;
180  digital_in_t cts;
181 
182  // Modules
183 
184  uart_t uart;
185 
186  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
187  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
188 
189 } gsmgnss_t;
190 
194 typedef struct
195 {
196  // Communication gpio pins
197 
198  pin_name_t rx_pin;
199  pin_name_t tx_pin;
200 
201  // Additional gpio pins
202 
203  pin_name_t det;
204  pin_name_t rst;
205  pin_name_t rts;
206  pin_name_t ring;
207  pin_name_t cts;
208 
209  // static variable
210 
211  uint32_t baud_rate; // Clock speed.
213  uart_data_bits_t data_bit; // Data bits.
214  uart_parity_t parity_bit; // Parity bit.
215  uart_stop_bits_t stop_bit; // Stop bits.
216 
217 } gsmgnss_cfg_t;
218 
223 typedef enum
224 {
226  GSMGNSS_ERROR = -1
227 
229 
233 typedef uint8_t gsmgnss_error_t;
234  // End types group
236 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
237 
243 #ifdef __cplusplus
244 extern "C"{
245 #endif
246 
256 
265 
271 void gsmgnss_module_power ( gsmgnss_t *ctx, uint8_t state );
272 
279 void gsmgnss_generic_write ( gsmgnss_t *ctx, char *data_buf, uint16_t len );
280 
288 int32_t gsmgnss_generic_read ( gsmgnss_t *ctx, char *data_buf, uint16_t max_len );
289 
298 void gsmgnss_set_rts ( gsmgnss_t *ctx, uint8_t state );
299 
308 uint8_t gsmgnss_get_cts ( gsmgnss_t *ctx );
309 
319 void gsmgnss_send_cmd ( gsmgnss_t *ctx, char *cmd );
320 
331 void gsmgnss_send_cmd_with_parameter ( gsmgnss_t *ctx, char *at_cmd_buf, char *param_buf );
332 
342 void gsmgnss_send_cmd_check ( gsmgnss_t *ctx, char *at_cmd_buf );
343 
353 void gsmgnss_send_cmd_parameter_check ( gsmgnss_t *ctx, char *at_cmd_buf );
354 
364 void gsmgnss_set_sim_apn ( gsmgnss_t *ctx, char *sim_apn );
365 
376 void gsmgnss_send_sms_text ( gsmgnss_t *ctx, char *phone_number, char *sms_text );
377 
391 err_t gsmgnss_send_sms_pdu ( gsmgnss_t *ctx, char *service_center_number,
392  char *phone_number, char *sms_text );
393 
403 (
404  char *rsp, uint8_t command,
405  uint8_t element, char *parser_buf
406 );
407 
408 #ifdef __cplusplus
409 }
410 #endif
411 #endif // _GSMGNSS_H_
412  // End public_function group
415 
416 // ------------------------------------------------------------------------- END
gsmgnss_init
GSMGNSS_RETVAL gsmgnss_init(gsmgnss_t *ctx, gsmgnss_cfg_t *cfg)
Initialization function.
gsmgnss_t
Click ctx object definition.
Definition: gsmgnss.h:170
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: gsmgnss.h:156
gsmgnss_cfg_t::det
pin_name_t det
Definition: gsmgnss.h:203
gsmgnss_set_rts
void gsmgnss_set_rts(gsmgnss_t *ctx, uint8_t state)
Sets state of the RTS pin.
gsmgnss_generic_write
void gsmgnss_generic_write(gsmgnss_t *ctx, char *data_buf, uint16_t len)
Generic write function.
gsmgnss_cfg_t::rst
pin_name_t rst
Definition: gsmgnss.h:204
gsmgnss_set_sim_apn
void gsmgnss_set_sim_apn(gsmgnss_t *ctx, char *sim_apn)
Set sim card APN.
GSMGNSS_return_value_t
GSMGNSS_return_value_t
GSM GNSS Click return value data.
Definition: gsmgnss.h:224
gsmgnss_t::rst
digital_out_t rst
Definition: gsmgnss.h:173
gsmgnss_t::ring
digital_in_t ring
Definition: gsmgnss.h:179
gsmgnss_send_cmd_check
void gsmgnss_send_cmd_check(gsmgnss_t *ctx, char *at_cmd_buf)
Check the sent command.
GSMGNSS_ERROR
@ GSMGNSS_ERROR
Definition: gsmgnss.h:226
gsmgnss_send_sms_text
void gsmgnss_send_sms_text(gsmgnss_t *ctx, char *phone_number, char *sms_text)
GSM GNSS send SMS in text mode.
GSMGNSS_RETVAL
#define GSMGNSS_RETVAL
Definition: gsmgnss.h:67
gsmgnss_t::cts
digital_in_t cts
Definition: gsmgnss.h:180
gsmgnss_cfg_t::uart_blocking
bool uart_blocking
Definition: gsmgnss.h:212
gsmgnss_cfg_t::rts
pin_name_t rts
Definition: gsmgnss.h:205
gsmgnss_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gsmgnss.h:213
gsmgnss_t::rts
digital_out_t rts
Definition: gsmgnss.h:174
gsmgnss_module_power
void gsmgnss_module_power(gsmgnss_t *ctx, uint8_t state)
Power ON/OFF the module.
GSMGNSS_OK
@ GSMGNSS_OK
Definition: gsmgnss.h:225
gsmgnss_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gsmgnss.h:199
gsmgnss_cfg_t::baud_rate
uint32_t baud_rate
Definition: gsmgnss.h:211
gsmgnss_cfg_t::ring
pin_name_t ring
Definition: gsmgnss.h:206
gsmgnss_get_cts
uint8_t gsmgnss_get_cts(gsmgnss_t *ctx)
CTS Pin Get function.
gsmgnss_generic_read
int32_t gsmgnss_generic_read(gsmgnss_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
gsmgnss_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gsmgnss.h:215
gsmgnss_cfg_t
Click configuration structure definition.
Definition: gsmgnss.h:195
gsmgnss_cfg_setup
void gsmgnss_cfg_setup(gsmgnss_cfg_t *cfg)
Config Object Initialization function.
gsmgnss_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gsmgnss.h:214
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: gsmgnss.h:157
gsmgnss_cfg_t::cts
pin_name_t cts
Definition: gsmgnss.h:207
gsmgnss_generic_parser
gsmgnss_error_t gsmgnss_generic_parser(char *rsp, uint8_t command, uint8_t element, char *parser_buf)
Generic parser function.
gsmgnss_send_cmd_with_parameter
void gsmgnss_send_cmd_with_parameter(gsmgnss_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
gsmgnss_t::uart
uart_t uart
Definition: gsmgnss.h:184
gsmgnss_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gsmgnss.h:198
gsmgnss_send_cmd_parameter_check
void gsmgnss_send_cmd_parameter_check(gsmgnss_t *ctx, char *at_cmd_buf)
Check the command parameters.
gsmgnss_t::det
digital_in_t det
Definition: gsmgnss.h:178
gsmgnss_send_cmd
void gsmgnss_send_cmd(gsmgnss_t *ctx, char *cmd)
Send command function.
gsmgnss_send_sms_pdu
err_t gsmgnss_send_sms_pdu(gsmgnss_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
GSM GNSS send SMS in PDU mode.
gsmgnss_error_t
uint8_t gsmgnss_error_t
Error type.
Definition: gsmgnss.h:233