gnssrtk  2.0.0.0
gnssrtk.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 GNSSRTK_H
29 #define GNSSRTK_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 
55 #define GNSSRTK_GNGGA_TIME 1
56 #define GNSSRTK_GNGGA_LATITUDE 2
57 #define GNSSRTK_GNGGA_LATITUDE_SIDE 3
58 #define GNSSRTK_GNGGA_LONGITUDE 4
59 #define GNSSRTK_GNGGA_LONGITUDE_SIDE 5
60 #define GNSSRTK_GNGGA_QUALITY_INDICATOR 6
61 #define GNSSRTK_GNGGA_NUMBER_OF_SATELLITES 7
62 #define GNSSRTK_GNGGA_H_DILUTION_OF_POS 8
63 #define GNSSRTK_GNGGA_ALTITUDE 9
64 #define GNSSRTK_GNGGA_ALTITUDE_UNIT 10
65 #define GNSSRTK_GNGGA_GEOIDAL_SEPARATION 11
66 #define GNSSRTK_GNGGA_GEOIDAL_SEPARATION_UNIT 12
67 #define GNSSRTK_GNGGA_TIME_SINCE_LAST_DGPS 13
68 #define GNSSRTK_GNGGA_DGPS_REFERENCE_STATION_ID 14
69 
75 #define GNSSRTK_GNGLL_LATITUDE 1
76 #define GNSSRTK_GNGLL_LATITUDE_SIDE 2
77 #define GNSSRTK_GNGLL_LONGITUDE 3
78 #define GNSSRTK_GNGLL_LONGITUDE_SIDE 4
79  // element
81 
92 #define GNSSRTK_ERROR_COMMAND_OR_ELEMENT 0xFF
93 #define GNSSRTK_ERROR_START_OR_END_COMMAND 0x8F
94 #define GNSSRTK_ERROR_NEXT_ELEMENT 0x4F
95 #define GNSSRTK_ERROR_CURRENT_ELEMENT 0x2F
96 #define GNSSRTK_NO_ERROR 0x00
97  // gnssrtk_error_t
99 
110 #define GNSSRTK_NMEA_GNGGA 1
111 #define GNSSRTK_NMEA_GNGLL 3
112  // command
114 
126 #define DRV_BUFFER_SIZE_RX 200
127 #define DRV_BUFFER_SIZE_TX 50
128  // gnssrtk_set
130 
145 #define GNSSRTK_MAP_MIKROBUS( cfg, mikrobus ) \
146  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
147  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
148  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_AN ); \
149  cfg.rtk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
150  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
151  cfg.tmp = MIKROBUS( mikrobus, MIKROBUS_INT )
152  // gnssrtk_map // gnssrtk
155 
160 typedef struct
161 {
162  // Output pins
163 
164  digital_out_t rst;
166  // Input pins
167 
168  digital_in_t rdy;
169  digital_in_t rtk;
170  digital_in_t tmp;
172  // Modules
173 
174  uart_t uart;
176  // Buffers
177 
178  char uart_rx_buffer[ DRV_BUFFER_SIZE_RX ];
179  char uart_tx_buffer[ DRV_BUFFER_SIZE_TX ];
181 } gnssrtk_t;
182 
187 typedef struct
188 {
189  // Communication gpio pins
190 
191  pin_name_t rx_pin;
192  pin_name_t tx_pin;
194  // Additional gpio pins
195 
196  pin_name_t rdy;
197  pin_name_t rtk;
198  pin_name_t rst;
199  pin_name_t tmp;
201  // Static variable
202 
203  uint32_t baud_rate;
205  uart_data_bits_t data_bit;
206  uart_parity_t parity_bit;
207  uart_stop_bits_t stop_bit;
209 } gnssrtk_cfg_t;
210 
214 typedef uint8_t gnssrtk_error_t;
215 
232 
247 err_t gnssrtk_init ( gnssrtk_t *ctx, gnssrtk_cfg_t *cfg );
248 
260 
269 
280 void gnssrtk_set_rst_pin ( gnssrtk_t *ctx, uint8_t state );
281 
295 
307 
320 
334 err_t gnssrtk_generic_write ( gnssrtk_t *ctx, char *data_buf, uint16_t len );
335 
349 err_t gnssrtk_generic_read ( gnssrtk_t *ctx, char *data_buf, uint16_t max_len );
350 
362 gnssrtk_error_t gnssrtk_generic_parser ( char *rsp, uint8_t command, uint8_t element, char *parser_buf );
363 
364 #ifdef __cplusplus
365 }
366 #endif
367 #endif // GNSSRTK_H
368  // gnssrtk
370 
371 // ------------------------------------------------------------------------ END
gnssrtk_generic_parser
gnssrtk_error_t gnssrtk_generic_parser(char *rsp, uint8_t command, uint8_t element, char *parser_buf)
Generic parser function.
gnssrtk_get_rdy_pin
uint8_t gnssrtk_get_rdy_pin(gnssrtk_t *ctx)
Check rdy pin function.
gnssrtk_t::rst
digital_out_t rst
Definition: gnssrtk.h:164
gnssrtk_cfg_t::rst
pin_name_t rst
Definition: gnssrtk.h:198
gnssrtk_cfg_t::rdy
pin_name_t rdy
Definition: gnssrtk.h:196
gnssrtk_get_tmp_pin
uint8_t gnssrtk_get_tmp_pin(gnssrtk_t *ctx)
Check tmp pin function.
gnssrtk_error_t
uint8_t gnssrtk_error_t
Error type.
Definition: gnssrtk.h:214
gnssrtk_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnssrtk.h:205
gnssrtk_t::uart
uart_t uart
Definition: gnssrtk.h:174
gnssrtk_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnssrtk.h:191
gnssrtk_t
GNSS RTK Click context object.
Definition: gnssrtk.h:161
gnssrtk_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnssrtk.h:203
gnssrtk_t::tmp
digital_in_t tmp
Definition: gnssrtk.h:170
gnssrtk_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnssrtk.h:192
gnssrtk_set_rst_pin
void gnssrtk_set_rst_pin(gnssrtk_t *ctx, uint8_t state)
Set rst pin function.
gnssrtk_cfg_t::tmp
pin_name_t tmp
Definition: gnssrtk.h:199
gnssrtk_cfg_t::rtk
pin_name_t rtk
Definition: gnssrtk.h:197
gnssrtk_cfg_t::uart_blocking
bool uart_blocking
Definition: gnssrtk.h:204
gnssrtk_module_cold_start
void gnssrtk_module_cold_start(gnssrtk_t *ctx)
Module cold start function.
gnssrtk_cfg_t
GNSS RTK Click configuration object.
Definition: gnssrtk.h:188
gnssrtk_default_cfg
void gnssrtk_default_cfg(gnssrtk_t *ctx)
GNSS RTK default configuration function.
gnssrtk_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnssrtk.h:207
gnssrtk_get_rtk_pin
uint8_t gnssrtk_get_rtk_pin(gnssrtk_t *ctx)
Check rtk pin function.
gnssrtk_t::rtk
digital_in_t rtk
Definition: gnssrtk.h:169
gnssrtk_t::rdy
digital_in_t rdy
Definition: gnssrtk.h:168
gnssrtk_cfg_setup
void gnssrtk_cfg_setup(gnssrtk_cfg_t *cfg)
GNSS RTK configuration object setup function.
gnssrtk_init
err_t gnssrtk_init(gnssrtk_t *ctx, gnssrtk_cfg_t *cfg)
GNSS RTK initialization function.
gnssrtk_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnssrtk.h:206
DRV_BUFFER_SIZE_TX
#define DRV_BUFFER_SIZE_TX
Definition: gnssrtk.h:127
DRV_BUFFER_SIZE_RX
#define DRV_BUFFER_SIZE_RX
GNSS RTK driver buffer size.
Definition: gnssrtk.h:126
gnssrtk_generic_write
err_t gnssrtk_generic_write(gnssrtk_t *ctx, char *data_buf, uint16_t len)
GNSS RTK data writing function.
gnssrtk_generic_read
err_t gnssrtk_generic_read(gnssrtk_t *ctx, char *data_buf, uint16_t max_len)
GNSS RTK data reading function.