gnss  2.0.0.0
gnss.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 GNSS_H
29 #define GNSS_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 GNSS_RSP_START "$"
60 #define GNSS_RSP_DELIMITER ","
61 #define GNSS_RSP_END_SEQ "\r\n"
62 #define GNSS_RSP_GPGGA "$GPGGA"
63 
68 #define GNSS_GPGGA_ELEMENT_SIZE 15
69 #define GNSS_GPGGA_TIME 1
70 #define GNSS_GPGGA_LATITUDE 2
71 #define GNSS_GPGGA_LATITUDE_SIDE 3
72 #define GNSS_GPGGA_LONGITUDE 4
73 #define GNSS_GPGGA_LONGITUDE_SIDE 5
74 #define GNSS_GPGGA_QUALITY_INDICATOR 6
75 #define GNSS_GPGGA_NUMBER_OF_SATELLITES 7
76 #define GNSS_GPGGA_H_DILUTION_OF_POS 8
77 #define GNSS_GPGGA_ALTITUDE 9
78 #define GNSS_GPGGA_ALTITUDE_UNIT 10
79 #define GNSS_GPGGA_GEOIDAL_SEPARATION 11
80 #define GNSS_GPGGA_GEOIDAL_SEPARATION_UNIT 12
81 #define GNSS_GPGGA_TIME_SINCE_LAST_DGPS 13
82 #define GNSS_GPGGA_DGPS_REFERENCE_STATION_ID 14
83 
89 #define GNSS_DRV_TX_BUFFER_SIZE 100
90 #define GNSS_DRV_RX_BUFFER_SIZE 1000
91  // gnss_cmd
93 
108 #define GNSS_MAP_MIKROBUS( cfg, mikrobus ) \
109  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
110  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
111  cfg.fon = MIKROBUS( mikrobus, MIKROBUS_CS ); \
112  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
113  // gnss_map // gnss
116 
121 typedef struct
122 {
123  // Output pins
124  digital_out_t rst;
125  digital_out_t fon;
126 
127  // Modules
128  uart_t uart;
130  // Buffers
131  char uart_rx_buffer[ GNSS_DRV_RX_BUFFER_SIZE ];
132  char uart_tx_buffer[ GNSS_DRV_TX_BUFFER_SIZE ];
134 } gnss_t;
135 
140 typedef struct
141 {
142  // Communication gpio pins
143  pin_name_t rx_pin;
144  pin_name_t tx_pin;
146  // Additional gpio pins
147  pin_name_t rst;
148  pin_name_t fon;
149 
150  // Static variable
151  uint32_t baud_rate;
153  uart_data_bits_t data_bit;
154  uart_parity_t parity_bit;
155  uart_stop_bits_t stop_bit;
157 } gnss_cfg_t;
158 
163 typedef enum
164 {
165  GNSS_OK = 0,
166  GNSS_ERROR = -1
167 
169 
186 
200 err_t gnss_init ( gnss_t *ctx, gnss_cfg_t *cfg );
201 
214 err_t gnss_generic_write ( gnss_t *ctx, char *data_in, uint16_t len );
215 
228 err_t gnss_generic_read ( gnss_t *ctx, char *data_out, uint16_t len );
229 
239 
249 void gnss_set_rst_pin ( gnss_t *ctx, uint8_t state );
250 
260 void gnss_set_fon_pin ( gnss_t *ctx, uint8_t state );
261 
273 err_t gnss_parse_gpgga ( char *rsp_buf, uint8_t gpgga_element, char *element_data );
274 
275 #ifdef __cplusplus
276 }
277 #endif
278 #endif // GNSS_H
279  // gnss
281 
282 // ------------------------------------------------------------------------ END
gnss_init
err_t gnss_init(gnss_t *ctx, gnss_cfg_t *cfg)
GNSS initialization function.
gnss_return_value_t
gnss_return_value_t
GNSS Click return value data.
Definition: gnss.h:164
gnss_t::rst
digital_out_t rst
Definition: gnss.h:124
GNSS_DRV_TX_BUFFER_SIZE
#define GNSS_DRV_TX_BUFFER_SIZE
GNSS driver buffer size.
Definition: gnss.h:89
gnss_generic_read
err_t gnss_generic_read(gnss_t *ctx, char *data_out, uint16_t len)
GNSS data reading function.
gnss_t
GNSS Click context object.
Definition: gnss.h:122
gnss_t::uart
uart_t uart
Definition: gnss.h:128
GNSS_ERROR
@ GNSS_ERROR
Definition: gnss.h:166
gnss_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss.h:151
gnss_generic_write
err_t gnss_generic_write(gnss_t *ctx, char *data_in, uint16_t len)
GNSS data writing function.
gnss_cfg_t
GNSS Click configuration object.
Definition: gnss.h:141
gnss_cfg_t::rst
pin_name_t rst
Definition: gnss.h:147
gnss_clear_ring_buffers
void gnss_clear_ring_buffers(gnss_t *ctx)
GNSS clear ring buffers function.
gnss_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss.h:155
gnss_set_rst_pin
void gnss_set_rst_pin(gnss_t *ctx, uint8_t state)
GNSS set RST pin function.
gnss_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss.h:143
gnss_parse_gpgga
err_t gnss_parse_gpgga(char *rsp_buf, uint8_t gpgga_element, char *element_data)
GNSS parse GPGGA function.
gnss_t::fon
digital_out_t fon
Definition: gnss.h:125
gnss_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss.h:144
gnss_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss.h:153
GNSS_OK
@ GNSS_OK
Definition: gnss.h:165
gnss_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss.h:152
GNSS_DRV_RX_BUFFER_SIZE
#define GNSS_DRV_RX_BUFFER_SIZE
Definition: gnss.h:90
gnss_cfg_t::fon
pin_name_t fon
Definition: gnss.h:148
gnss_cfg_setup
void gnss_cfg_setup(gnss_cfg_t *cfg)
GNSS configuration object setup function.
gnss_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss.h:154
gnss_set_fon_pin
void gnss_set_fon_pin(gnss_t *ctx, uint8_t state)
GNSS set FON pin function.