gnss7  2.0.0.0
gnss7.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 GNSS7_H
29 #define GNSS7_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 GNSS7_RSP_START "$"
70 #define GNSS7_RSP_DELIMITER ","
71 #define GNSS7_RSP_END_SEQ "\r\n"
72 #define GNSS7_RSP_GNGGA "$GNGGA"
73 
78 #define GNSS7_GNGGA_ELEMENT_SIZE 15
79 #define GNSS7_GNGGA_TIME 1
80 #define GNSS7_GNGGA_LATITUDE 2
81 #define GNSS7_GNGGA_LATITUDE_SIDE 3
82 #define GNSS7_GNGGA_LONGITUDE 4
83 #define GNSS7_GNGGA_LONGITUDE_SIDE 5
84 #define GNSS7_GNGGA_QUALITY_INDICATOR 6
85 #define GNSS7_GNGGA_NUMBER_OF_SATELLITES 7
86 #define GNSS7_GNGGA_H_DILUTION_OF_POS 8
87 #define GNSS7_GNGGA_ALTITUDE 9
88 #define GNSS7_GNGGA_ALTITUDE_UNIT 10
89 #define GNSS7_GNGGA_GEOIDAL_SEPARATION 11
90 #define GNSS7_GNGGA_GEOIDAL_SEPARATION_UNIT 12
91 #define GNSS7_GNGGA_TIME_SINCE_LAST_DGPS 13
92 #define GNSS7_GNGGA_DGPS_REFERENCE_STATION_ID 14
93 
99 #define GNSS7_DRV_TX_BUFFER_SIZE 100
100 #define GNSS7_DRV_RX_BUFFER_SIZE 1000
101  // gnss7_cmd
103 
118 #define GNSS7_MAP_MIKROBUS( cfg, mikrobus ) \
119  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
120  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
121  cfg.sel = MIKROBUS( mikrobus, MIKROBUS_AN ); \
122  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
123  cfg.exi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
124  cfg.pls = MIKROBUS( mikrobus, MIKROBUS_INT )
125  // gnss7_map // gnss7
128 
133 typedef struct
134 {
135  // Output pins
136  digital_out_t sel;
137  digital_out_t rst;
138 
139  // Input pins
140  digital_in_t exi;
141  digital_in_t pls;
142 
143  // Modules
144  uart_t uart;
146  // Buffers
147  char uart_rx_buffer[ GNSS7_DRV_RX_BUFFER_SIZE ];
148  char uart_tx_buffer[ GNSS7_DRV_TX_BUFFER_SIZE ];
150 } gnss7_t;
151 
156 typedef struct
157 {
158  // Communication gpio pins
159  pin_name_t rx_pin;
160  pin_name_t tx_pin;
162  // Additional gpio pins
163  pin_name_t sel;
164  pin_name_t rst;
165  pin_name_t exi;
166  pin_name_t pls;
167 
168  // Static variable
169  uint32_t baud_rate;
171  uart_data_bits_t data_bit;
172  uart_parity_t parity_bit;
173  uart_stop_bits_t stop_bit;
175 } gnss7_cfg_t;
176 
181 typedef enum
182 {
183  GNSS7_OK = 0,
184  GNSS7_ERROR = -1
185 
187 
204 
218 err_t gnss7_init ( gnss7_t *ctx, gnss7_cfg_t *cfg );
219 
232 err_t gnss7_generic_write ( gnss7_t *ctx, char *data_in, uint16_t len );
233 
246 err_t gnss7_generic_read ( gnss7_t *ctx, char *data_out, uint16_t len );
247 
257 
267 void gnss7_set_sel_pin ( gnss7_t *ctx, uint8_t state );
268 
278 void gnss7_set_rst_pin ( gnss7_t *ctx, uint8_t state );
279 
288 uint8_t gnss7_get_exi_pin ( gnss7_t *ctx );
289 
298 uint8_t gnss7_get_pls_pin ( gnss7_t *ctx );
299 
311 err_t gnss7_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 #endif // GNSS7_H
317  // gnss7
319 
320 // ------------------------------------------------------------------------ END
gnss7_generic_write
err_t gnss7_generic_write(gnss7_t *ctx, char *data_in, uint16_t len)
GNSS 7 data writing function.
gnss7_cfg_t::exi
pin_name_t exi
Definition: gnss7.h:165
gnss7_t::rst
digital_out_t rst
Definition: gnss7.h:137
gnss7_generic_read
err_t gnss7_generic_read(gnss7_t *ctx, char *data_out, uint16_t len)
GNSS 7 data reading function.
gnss7_get_exi_pin
uint8_t gnss7_get_exi_pin(gnss7_t *ctx)
GNSS 7 get EXI pin function.
gnss7_cfg_setup
void gnss7_cfg_setup(gnss7_cfg_t *cfg)
GNSS 7 configuration object setup function.
gnss7_cfg_t::pls
pin_name_t pls
Definition: gnss7.h:166
gnss7_init
err_t gnss7_init(gnss7_t *ctx, gnss7_cfg_t *cfg)
GNSS 7 initialization function.
GNSS7_OK
@ GNSS7_OK
Definition: gnss7.h:183
gnss7_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss7.h:173
GNSS7_DRV_TX_BUFFER_SIZE
#define GNSS7_DRV_TX_BUFFER_SIZE
GNSS 7 driver buffer size.
Definition: gnss7.h:99
gnss7_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss7.h:172
gnss7_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss7.h:171
gnss7_t
GNSS 7 Click context object.
Definition: gnss7.h:134
gnss7_t::pls
digital_in_t pls
Definition: gnss7.h:141
gnss7_set_rst_pin
void gnss7_set_rst_pin(gnss7_t *ctx, uint8_t state)
GNSS 7 set RST pin function.
gnss7_t::exi
digital_in_t exi
Definition: gnss7.h:140
gnss7_t::uart
uart_t uart
Definition: gnss7.h:144
gnss7_t::sel
digital_out_t sel
Definition: gnss7.h:136
gnss7_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss7.h:160
gnss7_return_value_t
gnss7_return_value_t
GNSS 7 Click return value data.
Definition: gnss7.h:182
gnss7_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss7.h:170
gnss7_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss7.h:169
gnss7_get_pls_pin
uint8_t gnss7_get_pls_pin(gnss7_t *ctx)
GNSS 7 get PLS pin function.
gnss7_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss7.h:159
gnss7_cfg_t::sel
pin_name_t sel
Definition: gnss7.h:163
gnss7_set_sel_pin
void gnss7_set_sel_pin(gnss7_t *ctx, uint8_t state)
GNSS 7 set SEL pin function.
gnss7_cfg_t
GNSS 7 Click configuration object.
Definition: gnss7.h:157
gnss7_parse_gngga
err_t gnss7_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GNSS 7 parse GNGGA function.
GNSS7_DRV_RX_BUFFER_SIZE
#define GNSS7_DRV_RX_BUFFER_SIZE
Definition: gnss7.h:100
GNSS7_ERROR
@ GNSS7_ERROR
Definition: gnss7.h:184
gnss7_cfg_t::rst
pin_name_t rst
Definition: gnss7.h:164
gnss7_clear_ring_buffers
void gnss7_clear_ring_buffers(gnss7_t *ctx)
GNSS 7 clear ring buffers function.