c4gltegnss  2.1.0.0
c4gltegnss.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 C4GLTEGNSS_H
29 #define C4GLTEGNSS_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define C4GLTEGNSS_CMD_AT "AT"
70 #define C4GLTEGNSS_CMD_ATI "ATI"
71 #define C4GLTEGNSS_CMD_CGMR "AT+CGMR"
72 #define C4GLTEGNSS_CMD_CFUN "AT+CFUN"
73 #define C4GLTEGNSS_CMD_CREG "AT+CREG"
74 #define C4GLTEGNSS_CMD_CGREG "AT+CGREG"
75 #define C4GLTEGNSS_CMD_CGDCONT "AT+CGDCONT"
76 #define C4GLTEGNSS_CMD_CIMI "AT+CIMI"
77 #define C4GLTEGNSS_CMD_CMEE "AT+CMEE"
78 #define C4GLTEGNSS_CMD_CGATT "AT+CGATT"
79 #define C4GLTEGNSS_CMD_CSQ "AT+CSQ"
80 #define C4GLTEGNSS_CMD_COPS "AT+COPS"
81 #define C4GLTEGNSS_CMD_CMGS "AT+CMGS"
82 #define C4GLTEGNSS_CMD_CMGF "AT+CMGF"
83 #define C4GLTEGNSS_CMD_CGACT "AT+CGACT"
84 #define C4GLTEGNSS_CMD_UPSDA "AT+UPSDA"
85 #define C4GLTEGNSS_CMD_USOCR "AT+USOCR"
86 #define C4GLTEGNSS_CMD_USOCO "AT+USOCO"
87 #define C4GLTEGNSS_CMD_USOWR "AT+USOWR"
88 #define C4GLTEGNSS_CMD_USORD "AT+USORD"
89 #define C4GLTEGNSS_CMD_USORF "AT+USORF"
90 #define C4GLTEGNSS_CMD_USOCL "AT+USOCL"
91 #define C4GLTEGNSS_CMD_UGPS "AT+UGPS"
92 #define C4GLTEGNSS_CMD_UGGGA "AT+UGGGA"
93 
98 #define C4GLTEGNSS_RSP_OK "OK"
99 #define C4GLTEGNSS_RSP_ERROR "ERROR"
100 
105 #define C4GLTEGNSS_POWER_STATE_OFF 0
106 #define C4GLTEGNSS_POWER_STATE_ON 1
107 
112 #define C4GLTEGNSS_RSP_START "$"
113 #define C4GLTEGNSS_RSP_DELIMITER ","
114 #define C4GLTEGNSS_RSP_END "\r\n"
115 #define C4GLTEGNSS_RSP_GGA "GGA"
116 
121 #define C4GLTEGNSS_GGA_ELEMENT_SIZE 15
122 #define C4GLTEGNSS_GGA_TIME 1
123 #define C4GLTEGNSS_GGA_LATITUDE 2
124 #define C4GLTEGNSS_GGA_LATITUDE_SIDE 3
125 #define C4GLTEGNSS_GGA_LONGITUDE 4
126 #define C4GLTEGNSS_GGA_LONGITUDE_SIDE 5
127 #define C4GLTEGNSS_GGA_QUALITY_INDICATOR 6
128 #define C4GLTEGNSS_GGA_NUMBER_OF_SATELLITES 7
129 #define C4GLTEGNSS_GGA_H_DILUTION_OF_POS 8
130 #define C4GLTEGNSS_GGA_ALTITUDE 9
131 #define C4GLTEGNSS_GGA_ALTITUDE_UNIT 10
132 #define C4GLTEGNSS_GGA_GEOIDAL_SEPARATION 11
133 #define C4GLTEGNSS_GGA_GEOIDAL_SEPARATION_UNIT 12
134 #define C4GLTEGNSS_GGA_TIME_SINCE_LAST_DGPS 13
135 #define C4GLTEGNSS_GGA_DGPS_REFERENCE_STATION_ID 14
136 
142 #define C4GLTEGNSS_TX_DRV_BUFFER_SIZE 256
143 #define C4GLTEGNSS_RX_DRV_BUFFER_SIZE 256
144  // c4gltegnss_cmd
146 
161 #define C4GLTEGNSS_MAP_MIKROBUS( cfg, mikrobus ) \
162  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
163  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
164  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
165  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
166  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
167  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
168  // c4gltegnss_map // c4gltegnss
171 
176 typedef struct
177 {
178  // Output pins
179  digital_out_t pwr;
180  digital_out_t rts;
182  // Input pins
183  digital_in_t ri;
184  digital_in_t cts;
186  // Modules
187  uart_t uart;
189  // Buffers
190  uint8_t uart_rx_buffer[ C4GLTEGNSS_RX_DRV_BUFFER_SIZE ];
191  uint8_t uart_tx_buffer[ C4GLTEGNSS_TX_DRV_BUFFER_SIZE ];
193 } c4gltegnss_t;
194 
199 typedef struct
200 {
201  // Communication gpio pins
202  pin_name_t rx_pin;
203  pin_name_t tx_pin;
205  // Additional gpio pins
206  pin_name_t pwr;
207  pin_name_t rts;
208  pin_name_t ri;
209  pin_name_t cts;
211  // Static variable
212  uint32_t baud_rate;
214  uart_data_bits_t data_bit;
215  uart_parity_t parity_bit;
216  uart_stop_bits_t stop_bit;
219 
224 typedef enum
225 {
231 
233 
250 
265 
278 err_t c4gltegnss_generic_write ( c4gltegnss_t *ctx, uint8_t *data_in, uint16_t len );
279 
292 err_t c4gltegnss_generic_read ( c4gltegnss_t *ctx, uint8_t *data_out, uint16_t len );
293 
303 void c4gltegnss_set_pwr_pin ( c4gltegnss_t *ctx, uint8_t state );
304 
314 void c4gltegnss_set_rts_pin ( c4gltegnss_t *ctx, uint8_t state );
315 
325 
335 
346 void c4gltegnss_set_power_state ( c4gltegnss_t *ctx, uint8_t state );
347 
357 void c4gltegnss_send_cmd ( c4gltegnss_t *ctx, uint8_t *cmd );
358 
369 void c4gltegnss_send_cmd_with_par ( c4gltegnss_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
370 
380 void c4gltegnss_send_cmd_check ( c4gltegnss_t *ctx, uint8_t *at_cmd_buf );
381 
391 void c4gltegnss_send_cmd_par_check ( c4gltegnss_t *ctx, uint8_t *at_cmd_buf );
392 
402 void c4gltegnss_set_sim_apn ( c4gltegnss_t *ctx, uint8_t *sim_apn );
403 
414 void c4gltegnss_send_sms_text ( c4gltegnss_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
415 
429 err_t c4gltegnss_send_sms_pdu ( c4gltegnss_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
430 
442 err_t c4gltegnss_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
443 
444 #ifdef __cplusplus
445 }
446 #endif
447 #endif // C4GLTEGNSS_H
448  // c4gltegnss
450 
451 // ------------------------------------------------------------------------ END
c4gltegnss_set_power_state
void c4gltegnss_set_power_state(c4gltegnss_t *ctx, uint8_t state)
4G LTE GNSS set power state function.
c4gltegnss_t::pwr
digital_out_t pwr
Definition: c4gltegnss.h:179
c4gltegnss_set_rts_pin
void c4gltegnss_set_rts_pin(c4gltegnss_t *ctx, uint8_t state)
4G LTE GNSS set rts pin function.
c4gltegnss_cfg_t::rx_pin
pin_name_t rx_pin
Definition: c4gltegnss.h:202
c4gltegnss_t::cts
digital_in_t cts
Definition: c4gltegnss.h:184
c4gltegnss_cfg_t::tx_pin
pin_name_t tx_pin
Definition: c4gltegnss.h:203
c4gltegnss_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: c4gltegnss.h:216
c4gltegnss_set_sim_apn
void c4gltegnss_set_sim_apn(c4gltegnss_t *ctx, uint8_t *sim_apn)
Set sim card APN.
c4gltegnss_return_value_t
c4gltegnss_return_value_t
4G LTE GNSS Click return value data.
Definition: c4gltegnss.h:225
c4gltegnss_cfg_t::uart_blocking
bool uart_blocking
Definition: c4gltegnss.h:213
c4gltegnss_t::uart
uart_t uart
Definition: c4gltegnss.h:187
c4gltegnss_t::ri
digital_in_t ri
Definition: c4gltegnss.h:183
c4gltegnss_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: c4gltegnss.h:215
c4gltegnss_generic_read
err_t c4gltegnss_generic_read(c4gltegnss_t *ctx, uint8_t *data_out, uint16_t len)
4G LTE GNSS data reading function.
C4GLTEGNSS_ERROR_UNKNOWN
@ C4GLTEGNSS_ERROR_UNKNOWN
Definition: c4gltegnss.h:230
C4GLTEGNSS_RX_DRV_BUFFER_SIZE
#define C4GLTEGNSS_RX_DRV_BUFFER_SIZE
Definition: c4gltegnss.h:143
c4gltegnss_set_pwr_pin
void c4gltegnss_set_pwr_pin(c4gltegnss_t *ctx, uint8_t state)
4G LTE GNSS set PWR pin function.
c4gltegnss_cfg_t
4G LTE GNSS Click configuration object.
Definition: c4gltegnss.h:200
c4gltegnss_send_sms_pdu
err_t c4gltegnss_send_sms_pdu(c4gltegnss_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
4G LTE GNSS send SMS in PDU mode.
c4gltegnss_cfg_t::ri
pin_name_t ri
Definition: c4gltegnss.h:208
c4gltegnss_send_cmd
void c4gltegnss_send_cmd(c4gltegnss_t *ctx, uint8_t *cmd)
Send command function.
c4gltegnss_get_cts_pin
uint8_t c4gltegnss_get_cts_pin(c4gltegnss_t *ctx)
4G LTE GNSS get cts pin function.
c4gltegnss_t
4G LTE GNSS Click context object.
Definition: c4gltegnss.h:177
c4gltegnss_t::rts
digital_out_t rts
Definition: c4gltegnss.h:180
c4gltegnss_cfg_setup
void c4gltegnss_cfg_setup(c4gltegnss_cfg_t *cfg)
4G LTE GNSS configuration object setup function.
c4gltegnss_send_cmd_with_par
void c4gltegnss_send_cmd_with_par(c4gltegnss_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
c4gltegnss_send_cmd_par_check
void c4gltegnss_send_cmd_par_check(c4gltegnss_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
c4gltegnss_parse_gga
err_t c4gltegnss_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
4G LTE GNSS parse GGA function.
c4gltegnss_get_ri_pin
uint8_t c4gltegnss_get_ri_pin(c4gltegnss_t *ctx)
4G LTE GNSS get RI pin function.
c4gltegnss_send_cmd_check
void c4gltegnss_send_cmd_check(c4gltegnss_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.
c4gltegnss_generic_write
err_t c4gltegnss_generic_write(c4gltegnss_t *ctx, uint8_t *data_in, uint16_t len)
4G LTE GNSS data writing function.
c4gltegnss_cfg_t::rts
pin_name_t rts
Definition: c4gltegnss.h:207
C4GLTEGNSS_ERROR
@ C4GLTEGNSS_ERROR
Definition: c4gltegnss.h:227
c4gltegnss_cfg_t::cts
pin_name_t cts
Definition: c4gltegnss.h:209
c4gltegnss_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: c4gltegnss.h:214
C4GLTEGNSS_TX_DRV_BUFFER_SIZE
#define C4GLTEGNSS_TX_DRV_BUFFER_SIZE
4G LTE GNSS driver buffer size.
Definition: c4gltegnss.h:142
C4GLTEGNSS_ERROR_TIMEOUT
@ C4GLTEGNSS_ERROR_TIMEOUT
Definition: c4gltegnss.h:228
c4gltegnss_cfg_t::pwr
pin_name_t pwr
Definition: c4gltegnss.h:206
c4gltegnss_cfg_t::baud_rate
uint32_t baud_rate
Definition: c4gltegnss.h:212
C4GLTEGNSS_ERROR_CMD
@ C4GLTEGNSS_ERROR_CMD
Definition: c4gltegnss.h:229
c4gltegnss_send_sms_text
void c4gltegnss_send_sms_text(c4gltegnss_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
4G LTE GNSS send SMS in text mode.
C4GLTEGNSS_OK
@ C4GLTEGNSS_OK
Definition: c4gltegnss.h:226
c4gltegnss_init
err_t c4gltegnss_init(c4gltegnss_t *ctx, c4gltegnss_cfg_t *cfg)
4G LTE GNSS initialization function.