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 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define GNSS7_RSP_START "$"
74 #define GNSS7_RSP_DELIMITER ","
75 #define GNSS7_RSP_END_SEQ "\r\n"
76 #define GNSS7_RSP_GNGGA "$GNGGA"
77 
82 #define GNSS7_GNGGA_ELEMENT_SIZE 15
83 #define GNSS7_GNGGA_TIME 1
84 #define GNSS7_GNGGA_LATITUDE 2
85 #define GNSS7_GNGGA_LATITUDE_SIDE 3
86 #define GNSS7_GNGGA_LONGITUDE 4
87 #define GNSS7_GNGGA_LONGITUDE_SIDE 5
88 #define GNSS7_GNGGA_QUALITY_INDICATOR 6
89 #define GNSS7_GNGGA_NUMBER_OF_SATELLITES 7
90 #define GNSS7_GNGGA_H_DILUTION_OF_POS 8
91 #define GNSS7_GNGGA_ALTITUDE 9
92 #define GNSS7_GNGGA_ALTITUDE_UNIT 10
93 #define GNSS7_GNGGA_GEOIDAL_SEPARATION 11
94 #define GNSS7_GNGGA_GEOIDAL_SEPARATION_UNIT 12
95 #define GNSS7_GNGGA_TIME_SINCE_LAST_DGPS 13
96 #define GNSS7_GNGGA_DGPS_REFERENCE_STATION_ID 14
97 
103 #define GNSS7_DRV_TX_BUFFER_SIZE 100
104 #define GNSS7_DRV_RX_BUFFER_SIZE 1000
105  // gnss7_cmd
107 
122 #define GNSS7_MAP_MIKROBUS( cfg, mikrobus ) \
123  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
124  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
125  cfg.sel = MIKROBUS( mikrobus, MIKROBUS_AN ); \
126  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
127  cfg.exi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
128  cfg.pls = MIKROBUS( mikrobus, MIKROBUS_INT )
129  // gnss7_map // gnss7
132 
137 typedef struct
138 {
139  // Output pins
140  digital_out_t sel;
141  digital_out_t rst;
142 
143  // Input pins
144  digital_in_t exi;
145  digital_in_t pls;
146 
147  // Modules
148  uart_t uart;
150  // Buffers
151  char uart_rx_buffer[ GNSS7_DRV_RX_BUFFER_SIZE ];
152  char uart_tx_buffer[ GNSS7_DRV_TX_BUFFER_SIZE ];
154 } gnss7_t;
155 
160 typedef struct
161 {
162  // Communication gpio pins
163  pin_name_t rx_pin;
164  pin_name_t tx_pin;
166  // Additional gpio pins
167  pin_name_t sel;
168  pin_name_t rst;
169  pin_name_t exi;
170  pin_name_t pls;
171 
172  // Static variable
173  uint32_t baud_rate;
175  uart_data_bits_t data_bit;
176  uart_parity_t parity_bit;
177  uart_stop_bits_t stop_bit;
179 } gnss7_cfg_t;
180 
185 typedef enum
186 {
187  GNSS7_OK = 0,
188  GNSS7_ERROR = -1
189 
191 
208 
222 err_t gnss7_init ( gnss7_t *ctx, gnss7_cfg_t *cfg );
223 
236 err_t gnss7_generic_write ( gnss7_t *ctx, char *data_in, uint16_t len );
237 
250 err_t gnss7_generic_read ( gnss7_t *ctx, char *data_out, uint16_t len );
251 
261 
271 void gnss7_set_sel_pin ( gnss7_t *ctx, uint8_t state );
272 
282 void gnss7_set_rst_pin ( gnss7_t *ctx, uint8_t state );
283 
292 uint8_t gnss7_get_exi_pin ( gnss7_t *ctx );
293 
302 uint8_t gnss7_get_pls_pin ( gnss7_t *ctx );
303 
315 err_t gnss7_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
316 
317 #ifdef __cplusplus
318 }
319 #endif
320 #endif // GNSS7_H
321  // gnss7
323 
324 // ------------------------------------------------------------------------ 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:169
gnss7_t::rst
digital_out_t rst
Definition: gnss7.h:141
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:170
gnss7_init
err_t gnss7_init(gnss7_t *ctx, gnss7_cfg_t *cfg)
GNSS 7 initialization function.
GNSS7_OK
@ GNSS7_OK
Definition: gnss7.h:187
gnss7_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss7.h:177
GNSS7_DRV_TX_BUFFER_SIZE
#define GNSS7_DRV_TX_BUFFER_SIZE
GNSS 7 driver buffer size.
Definition: gnss7.h:103
gnss7_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss7.h:176
gnss7_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss7.h:175
gnss7_t
GNSS 7 Click context object.
Definition: gnss7.h:138
gnss7_t::pls
digital_in_t pls
Definition: gnss7.h:145
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:144
gnss7_t::uart
uart_t uart
Definition: gnss7.h:148
gnss7_t::sel
digital_out_t sel
Definition: gnss7.h:140
gnss7_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss7.h:164
gnss7_return_value_t
gnss7_return_value_t
GNSS 7 Click return value data.
Definition: gnss7.h:186
gnss7_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss7.h:174
gnss7_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss7.h:173
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:163
gnss7_cfg_t::sel
pin_name_t sel
Definition: gnss7.h:167
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:161
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:104
GNSS7_ERROR
@ GNSS7_ERROR
Definition: gnss7.h:188
gnss7_cfg_t::rst
pin_name_t rst
Definition: gnss7.h:168
gnss7_clear_ring_buffers
void gnss7_clear_ring_buffers(gnss7_t *ctx)
GNSS 7 clear ring buffers function.