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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define GNSS7_RSP_START "$"
60 #define GNSS7_RSP_DELIMITER ","
61 #define GNSS7_RSP_END_SEQ "\r\n"
62 #define GNSS7_RSP_GNGGA "$GNGGA"
63 
68 #define GNSS7_GNGGA_ELEMENT_SIZE 15
69 #define GNSS7_GNGGA_TIME 1
70 #define GNSS7_GNGGA_LATITUDE 2
71 #define GNSS7_GNGGA_LATITUDE_SIDE 3
72 #define GNSS7_GNGGA_LONGITUDE 4
73 #define GNSS7_GNGGA_LONGITUDE_SIDE 5
74 #define GNSS7_GNGGA_QUALITY_INDICATOR 6
75 #define GNSS7_GNGGA_NUMBER_OF_SATELLITES 7
76 #define GNSS7_GNGGA_H_DILUTION_OF_POS 8
77 #define GNSS7_GNGGA_ALTITUDE 9
78 #define GNSS7_GNGGA_ALTITUDE_UNIT 10
79 #define GNSS7_GNGGA_GEOIDAL_SEPARATION 11
80 #define GNSS7_GNGGA_GEOIDAL_SEPARATION_UNIT 12
81 #define GNSS7_GNGGA_TIME_SINCE_LAST_DGPS 13
82 #define GNSS7_GNGGA_DGPS_REFERENCE_STATION_ID 14
83 
89 #define GNSS7_DRV_TX_BUFFER_SIZE 100
90 #define GNSS7_DRV_RX_BUFFER_SIZE 1000
91  // gnss7_cmd
93 
108 #define GNSS7_MAP_MIKROBUS( cfg, mikrobus ) \
109  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
110  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
111  cfg.sel = MIKROBUS( mikrobus, MIKROBUS_AN ); \
112  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
113  cfg.exi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
114  cfg.pls = MIKROBUS( mikrobus, MIKROBUS_INT )
115  // gnss7_map // gnss7
118 
123 typedef struct
124 {
125  // Output pins
126  digital_out_t sel;
127  digital_out_t rst;
128 
129  // Input pins
130  digital_in_t exi;
131  digital_in_t pls;
132 
133  // Modules
134  uart_t uart;
136  // Buffers
137  char uart_rx_buffer[ GNSS7_DRV_RX_BUFFER_SIZE ];
138  char uart_tx_buffer[ GNSS7_DRV_TX_BUFFER_SIZE ];
140 } gnss7_t;
141 
146 typedef struct
147 {
148  // Communication gpio pins
149  pin_name_t rx_pin;
150  pin_name_t tx_pin;
152  // Additional gpio pins
153  pin_name_t sel;
154  pin_name_t rst;
155  pin_name_t exi;
156  pin_name_t pls;
157 
158  // Static variable
159  uint32_t baud_rate;
161  uart_data_bits_t data_bit;
162  uart_parity_t parity_bit;
163  uart_stop_bits_t stop_bit;
165 } gnss7_cfg_t;
166 
171 typedef enum
172 {
173  GNSS7_OK = 0,
174  GNSS7_ERROR = -1
175 
177 
194 
208 err_t gnss7_init ( gnss7_t *ctx, gnss7_cfg_t *cfg );
209 
222 err_t gnss7_generic_write ( gnss7_t *ctx, char *data_in, uint16_t len );
223 
236 err_t gnss7_generic_read ( gnss7_t *ctx, char *data_out, uint16_t len );
237 
247 
257 void gnss7_set_sel_pin ( gnss7_t *ctx, uint8_t state );
258 
268 void gnss7_set_rst_pin ( gnss7_t *ctx, uint8_t state );
269 
278 uint8_t gnss7_get_exi_pin ( gnss7_t *ctx );
279 
288 uint8_t gnss7_get_pls_pin ( gnss7_t *ctx );
289 
301 err_t gnss7_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
302 
303 #ifdef __cplusplus
304 }
305 #endif
306 #endif // GNSS7_H
307  // gnss7
309 
310 // ------------------------------------------------------------------------ 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:155
gnss7_t::rst
digital_out_t rst
Definition: gnss7.h:127
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:156
gnss7_init
err_t gnss7_init(gnss7_t *ctx, gnss7_cfg_t *cfg)
GNSS 7 initialization function.
GNSS7_OK
@ GNSS7_OK
Definition: gnss7.h:173
gnss7_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss7.h:163
GNSS7_DRV_TX_BUFFER_SIZE
#define GNSS7_DRV_TX_BUFFER_SIZE
GNSS 7 driver buffer size.
Definition: gnss7.h:89
gnss7_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss7.h:162
gnss7_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss7.h:161
gnss7_t
GNSS 7 Click context object.
Definition: gnss7.h:124
gnss7_t::pls
digital_in_t pls
Definition: gnss7.h:131
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:130
gnss7_t::uart
uart_t uart
Definition: gnss7.h:134
gnss7_t::sel
digital_out_t sel
Definition: gnss7.h:126
gnss7_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss7.h:150
gnss7_return_value_t
gnss7_return_value_t
GNSS 7 Click return value data.
Definition: gnss7.h:172
gnss7_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss7.h:160
gnss7_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss7.h:159
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:149
gnss7_cfg_t::sel
pin_name_t sel
Definition: gnss7.h:153
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:147
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:90
GNSS7_ERROR
@ GNSS7_ERROR
Definition: gnss7.h:174
gnss7_cfg_t::rst
pin_name_t rst
Definition: gnss7.h:154
gnss7_clear_ring_buffers
void gnss7_clear_ring_buffers(gnss7_t *ctx)
GNSS 7 clear ring buffers function.