gnssrtk  2.1.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 
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_i2c_master.h"
52 #include "drv_spi_master.h"
53 #include "drv_uart.h"
54 #include "spi_specifics.h"
55 
76 #define GNSSRTK_RSP_START "$"
77 #define GNSSRTK_RSP_DELIMITER ","
78 #define GNSSRTK_RSP_GNGGA "$GNGGA"
79 
84 #define GNSSRTK_GNGGA_ELEMENT_SIZE 15
85 #define GNSSRTK_GNGGA_TIME 1
86 #define GNSSRTK_GNGGA_LATITUDE 2
87 #define GNSSRTK_GNGGA_LATITUDE_SIDE 3
88 #define GNSSRTK_GNGGA_LONGITUDE 4
89 #define GNSSRTK_GNGGA_LONGITUDE_SIDE 5
90 #define GNSSRTK_GNGGA_QUALITY_INDICATOR 6
91 #define GNSSRTK_GNGGA_NUMBER_OF_SATELLITES 7
92 #define GNSSRTK_GNGGA_H_DILUTION_OF_POS 8
93 #define GNSSRTK_GNGGA_ALTITUDE 9
94 #define GNSSRTK_GNGGA_ALTITUDE_UNIT 10
95 #define GNSSRTK_GNGGA_GEOIDAL_SEPARATION 11
96 #define GNSSRTK_GNGGA_GEOIDAL_SEPARATION_UNIT 12
97 #define GNSSRTK_GNGGA_TIME_SINCE_LAST_DGPS 13
98 #define GNSSRTK_GNGGA_DGPS_REFERENCE_STATION_ID 14
99 
104 #define GNSSRTK_DUMMY 0xFF
105 
111 #define GNSSRTK_SET_DEV_ADDR 0x42
112 
118 #define GNSSRTK_DRV_TX_BUFFER_SIZE 100
119 #define GNSSRTK_DRV_RX_BUFFER_SIZE 300
120 
129 #define GNSSRTK_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
130 #define GNSSRTK_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
131  // gnssrtk_set
133 
148 #define GNSSRTK_MAP_MIKROBUS( cfg, mikrobus ) \
149  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
150  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
151  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
152  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
153  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
154  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
155  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
156  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
157  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_AN ); \
158  cfg.rtk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
159  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
160  cfg.tmp = MIKROBUS( mikrobus, MIKROBUS_INT )
161  // gnssrtk_map // gnssrtk
164 
169 typedef enum
170 {
176 
181 typedef err_t ( *gnssrtk_master_io_t )( struct gnssrtk_s*, uint8_t*, uint8_t );
187 typedef struct gnssrtk_s
188 {
189  digital_out_t rst;
191  digital_in_t rdy;
192  digital_in_t rtk;
193  digital_in_t tmp;
195  i2c_master_t i2c;
196  spi_master_t spi;
197  uart_t uart;
199  // Buffers
203  uint8_t slave_address;
204  pin_name_t chip_select;
211 
216 typedef struct
217 {
218  pin_name_t scl;
219  pin_name_t sda;
220  pin_name_t miso;
221  pin_name_t mosi;
222  pin_name_t sck;
223  pin_name_t cs;
224  pin_name_t rx_pin;
225  pin_name_t tx_pin;
227  pin_name_t rdy;
228  pin_name_t rtk;
229  pin_name_t rst;
230  pin_name_t tmp;
232  uint32_t i2c_speed;
233  uint8_t i2c_address;
235  uint32_t spi_speed;
236  spi_master_mode_t spi_mode;
237  spi_master_chip_select_polarity_t cs_polarity;
239  uint32_t baud_rate;
241  uart_data_bits_t data_bit;
242  uart_parity_t parity_bit;
243  uart_stop_bits_t stop_bit;
247 } gnssrtk_cfg_t;
248 
253 typedef enum
254 {
256  GNSSRTK_ERROR = -1
257 
259 
276 
292 
306 err_t gnssrtk_init ( gnssrtk_t *ctx, gnssrtk_cfg_t *cfg );
307 
320 err_t gnssrtk_generic_write ( gnssrtk_t *ctx, uint8_t *data_in, uint8_t len );
321 
334 err_t gnssrtk_generic_read ( gnssrtk_t *ctx, uint8_t *data_out, uint8_t len );
335 
345 void gnssrtk_set_rst_pin ( gnssrtk_t *ctx, uint8_t state );
346 
356 
366 
376 
386 
398 err_t gnssrtk_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
399 
400 #ifdef __cplusplus
401 }
402 #endif
403 #endif // GNSSRTK_H
404  // gnssrtk
406 
407 // ------------------------------------------------------------------------ END
gnssrtk_s::write_f
gnssrtk_master_io_t write_f
Definition: gnssrtk.h:207
gnssrtk_s::uart_rx_buffer
char uart_rx_buffer[GNSSRTK_DRV_RX_BUFFER_SIZE]
Definition: gnssrtk.h:200
gnssrtk_get_rdy_pin
uint8_t gnssrtk_get_rdy_pin(gnssrtk_t *ctx)
GNSS RTK get RDY pin function.
gnssrtk_s::slave_address
uint8_t slave_address
Definition: gnssrtk.h:203
gnssrtk_cfg_t::rst
pin_name_t rst
Definition: gnssrtk.h:229
gnssrtk_s
GNSS RTK Click context object.
Definition: gnssrtk.h:188
gnssrtk_cfg_t::rdy
pin_name_t rdy
Definition: gnssrtk.h:227
gnssrtk_get_tmp_pin
uint8_t gnssrtk_get_tmp_pin(gnssrtk_t *ctx)
GNSS RTK get TMP pin function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
gnssrtk_drv_interface_selection
void gnssrtk_drv_interface_selection(gnssrtk_cfg_t *cfg, gnssrtk_drv_t drv_sel)
GNSS RTK driver interface setup function.
gnssrtk_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnssrtk.h:241
gnssrtk_s::tmp
digital_in_t tmp
Definition: gnssrtk.h:193
gnssrtk_reset_device
void gnssrtk_reset_device(gnssrtk_t *ctx)
GNSS RTK reset device function.
gnssrtk_cfg_t::scl
pin_name_t scl
Definition: gnssrtk.h:218
gnssrtk_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnssrtk.h:224
gnssrtk_drv_t
gnssrtk_drv_t
GNSS RTK Click driver selector.
Definition: gnssrtk.h:170
GNSSRTK_DRV_SEL_UART
@ GNSSRTK_DRV_SEL_UART
Definition: gnssrtk.h:171
gnssrtk_t
struct gnssrtk_s gnssrtk_t
GNSS RTK Click context object.
gnssrtk_cfg_t::drv_sel
gnssrtk_drv_t drv_sel
Definition: gnssrtk.h:245
gnssrtk_parse_gngga
err_t gnssrtk_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GNSS RTK parse GNGGA function.
GNSSRTK_ERROR
@ GNSSRTK_ERROR
Definition: gnssrtk.h:256
GNSSRTK_OK
@ GNSSRTK_OK
Definition: gnssrtk.h:255
gnssrtk_master_io_t
err_t(* gnssrtk_master_io_t)(struct gnssrtk_s *, uint8_t *, uint8_t)
GNSS RTK Click driver interface.
Definition: gnssrtk.h:181
gnssrtk_return_value_t
gnssrtk_return_value_t
GNSS RTK Click return value data.
Definition: gnssrtk.h:254
gnssrtk_s::read_f
gnssrtk_master_io_t read_f
Definition: gnssrtk.h:208
gnssrtk_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnssrtk.h:239
gnssrtk_s::uart_tx_buffer
char uart_tx_buffer[GNSSRTK_DRV_TX_BUFFER_SIZE]
Definition: gnssrtk.h:201
gnssrtk_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnssrtk.h:233
gnssrtk_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnssrtk.h:225
gnssrtk_cfg_t::mosi
pin_name_t mosi
Definition: gnssrtk.h:221
gnssrtk_s::drv_sel
gnssrtk_drv_t drv_sel
Definition: gnssrtk.h:205
gnssrtk_cfg_t::sck
pin_name_t sck
Definition: gnssrtk.h:222
gnssrtk_cfg_t::spi_speed
uint32_t spi_speed
Definition: gnssrtk.h:235
gnssrtk_s::uart
uart_t uart
Definition: gnssrtk.h:197
gnssrtk_set_rst_pin
void gnssrtk_set_rst_pin(gnssrtk_t *ctx, uint8_t state)
GNSS RTK set RST pin function.
gnssrtk_cfg_t::tmp
pin_name_t tmp
Definition: gnssrtk.h:230
gnssrtk_cfg_t::rtk
pin_name_t rtk
Definition: gnssrtk.h:228
gnssrtk_cfg_t::uart_blocking
bool uart_blocking
Definition: gnssrtk.h:240
GNSSRTK_DRV_SEL_I2C
@ GNSSRTK_DRV_SEL_I2C
Definition: gnssrtk.h:173
GNSSRTK_DRV_SEL_SPI
@ GNSSRTK_DRV_SEL_SPI
Definition: gnssrtk.h:172
gnssrtk_cfg_t
GNSS RTK Click configuration object.
Definition: gnssrtk.h:217
gnssrtk_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnssrtk.h:243
gnssrtk_cfg_t::sda
pin_name_t sda
Definition: gnssrtk.h:219
gnssrtk_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gnssrtk.h:236
gnssrtk_s::rst
digital_out_t rst
Definition: gnssrtk.h:189
gnssrtk_s::i2c
i2c_master_t i2c
Definition: gnssrtk.h:195
gnssrtk_get_rtk_pin
uint8_t gnssrtk_get_rtk_pin(gnssrtk_t *ctx)
GNSS RTK get RTK pin function.
gnssrtk_generic_read
err_t gnssrtk_generic_read(gnssrtk_t *ctx, uint8_t *data_out, uint8_t len)
GNSS RTK data reading function.
gnssrtk_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: gnssrtk.h:237
GNSSRTK_DRV_RX_BUFFER_SIZE
#define GNSSRTK_DRV_RX_BUFFER_SIZE
Definition: gnssrtk.h:119
gnssrtk_s::spi
spi_master_t spi
Definition: gnssrtk.h:196
gnssrtk_cfg_setup
void gnssrtk_cfg_setup(gnssrtk_cfg_t *cfg)
GNSS RTK configuration object setup function.
GNSSRTK_DRV_TX_BUFFER_SIZE
#define GNSSRTK_DRV_TX_BUFFER_SIZE
GNSS RTK driver buffer size.
Definition: gnssrtk.h:118
gnssrtk_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnssrtk.h:232
gnssrtk_generic_write
err_t gnssrtk_generic_write(gnssrtk_t *ctx, uint8_t *data_in, uint8_t len)
GNSS RTK data writing 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:242
gnssrtk_s::chip_select
pin_name_t chip_select
Definition: gnssrtk.h:204
gnssrtk_cfg_t::miso
pin_name_t miso
Definition: gnssrtk.h:220
gnssrtk_cfg_t::cs
pin_name_t cs
Definition: gnssrtk.h:223
gnssrtk_s::rtk
digital_in_t rtk
Definition: gnssrtk.h:192
gnssrtk_s::rdy
digital_in_t rdy
Definition: gnssrtk.h:191