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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 #include "drv_spi_master.h"
39 #include "drv_uart.h"
40 #include "spi_specifics.h"
41 
62 #define GNSSRTK_RSP_START "$"
63 #define GNSSRTK_RSP_DELIMITER ","
64 #define GNSSRTK_RSP_GNGGA "$GNGGA"
65 
70 #define GNSSRTK_GNGGA_ELEMENT_SIZE 15
71 #define GNSSRTK_GNGGA_TIME 1
72 #define GNSSRTK_GNGGA_LATITUDE 2
73 #define GNSSRTK_GNGGA_LATITUDE_SIDE 3
74 #define GNSSRTK_GNGGA_LONGITUDE 4
75 #define GNSSRTK_GNGGA_LONGITUDE_SIDE 5
76 #define GNSSRTK_GNGGA_QUALITY_INDICATOR 6
77 #define GNSSRTK_GNGGA_NUMBER_OF_SATELLITES 7
78 #define GNSSRTK_GNGGA_H_DILUTION_OF_POS 8
79 #define GNSSRTK_GNGGA_ALTITUDE 9
80 #define GNSSRTK_GNGGA_ALTITUDE_UNIT 10
81 #define GNSSRTK_GNGGA_GEOIDAL_SEPARATION 11
82 #define GNSSRTK_GNGGA_GEOIDAL_SEPARATION_UNIT 12
83 #define GNSSRTK_GNGGA_TIME_SINCE_LAST_DGPS 13
84 #define GNSSRTK_GNGGA_DGPS_REFERENCE_STATION_ID 14
85 
90 #define GNSSRTK_DUMMY 0xFF
91 
97 #define GNSSRTK_SET_DEV_ADDR 0x42
98 
104 #define GNSSRTK_DRV_TX_BUFFER_SIZE 100
105 #define GNSSRTK_DRV_RX_BUFFER_SIZE 300
106 
115 #define GNSSRTK_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
116 #define GNSSRTK_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
117  // gnssrtk_set
119 
134 #define GNSSRTK_MAP_MIKROBUS( cfg, mikrobus ) \
135  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
136  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
137  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
138  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
139  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
140  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
141  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
142  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
143  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_AN ); \
144  cfg.rtk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
145  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
146  cfg.tmp = MIKROBUS( mikrobus, MIKROBUS_INT )
147  // gnssrtk_map // gnssrtk
150 
155 typedef enum
156 {
162 
167 typedef err_t ( *gnssrtk_master_io_t )( struct gnssrtk_s*, uint8_t*, uint8_t );
173 typedef struct gnssrtk_s
174 {
175  digital_out_t rst;
177  digital_in_t rdy;
178  digital_in_t rtk;
179  digital_in_t tmp;
181  i2c_master_t i2c;
182  spi_master_t spi;
183  uart_t uart;
185  // Buffers
189  uint8_t slave_address;
190  pin_name_t chip_select;
197 
202 typedef struct
203 {
204  pin_name_t scl;
205  pin_name_t sda;
206  pin_name_t miso;
207  pin_name_t mosi;
208  pin_name_t sck;
209  pin_name_t cs;
210  pin_name_t rx_pin;
211  pin_name_t tx_pin;
213  pin_name_t rdy;
214  pin_name_t rtk;
215  pin_name_t rst;
216  pin_name_t tmp;
218  uint32_t i2c_speed;
219  uint8_t i2c_address;
221  uint32_t spi_speed;
222  spi_master_mode_t spi_mode;
223  spi_master_chip_select_polarity_t cs_polarity;
225  uint32_t baud_rate;
227  uart_data_bits_t data_bit;
228  uart_parity_t parity_bit;
229  uart_stop_bits_t stop_bit;
233 } gnssrtk_cfg_t;
234 
239 typedef enum
240 {
242  GNSSRTK_ERROR = -1
243 
245 
262 
278 
292 err_t gnssrtk_init ( gnssrtk_t *ctx, gnssrtk_cfg_t *cfg );
293 
306 err_t gnssrtk_generic_write ( gnssrtk_t *ctx, uint8_t *data_in, uint8_t len );
307 
320 err_t gnssrtk_generic_read ( gnssrtk_t *ctx, uint8_t *data_out, uint8_t len );
321 
331 void gnssrtk_set_rst_pin ( gnssrtk_t *ctx, uint8_t state );
332 
342 
352 
362 
372 
384 err_t gnssrtk_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
385 
386 #ifdef __cplusplus
387 }
388 #endif
389 #endif // GNSSRTK_H
390  // gnssrtk
392 
393 // ------------------------------------------------------------------------ END
gnssrtk_s::write_f
gnssrtk_master_io_t write_f
Definition: gnssrtk.h:193
gnssrtk_s::uart_rx_buffer
char uart_rx_buffer[GNSSRTK_DRV_RX_BUFFER_SIZE]
Definition: gnssrtk.h:186
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:189
gnssrtk_cfg_t::rst
pin_name_t rst
Definition: gnssrtk.h:215
gnssrtk_s
GNSS RTK Click context object.
Definition: gnssrtk.h:174
gnssrtk_cfg_t::rdy
pin_name_t rdy
Definition: gnssrtk.h:213
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:227
gnssrtk_s::tmp
digital_in_t tmp
Definition: gnssrtk.h:179
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:204
gnssrtk_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnssrtk.h:210
gnssrtk_drv_t
gnssrtk_drv_t
GNSS RTK Click driver selector.
Definition: gnssrtk.h:156
GNSSRTK_DRV_SEL_UART
@ GNSSRTK_DRV_SEL_UART
Definition: gnssrtk.h:157
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:231
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:242
GNSSRTK_OK
@ GNSSRTK_OK
Definition: gnssrtk.h:241
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:167
gnssrtk_return_value_t
gnssrtk_return_value_t
GNSS RTK Click return value data.
Definition: gnssrtk.h:240
gnssrtk_s::read_f
gnssrtk_master_io_t read_f
Definition: gnssrtk.h:194
gnssrtk_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnssrtk.h:225
gnssrtk_s::uart_tx_buffer
char uart_tx_buffer[GNSSRTK_DRV_TX_BUFFER_SIZE]
Definition: gnssrtk.h:187
gnssrtk_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnssrtk.h:219
gnssrtk_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnssrtk.h:211
gnssrtk_cfg_t::mosi
pin_name_t mosi
Definition: gnssrtk.h:207
gnssrtk_s::drv_sel
gnssrtk_drv_t drv_sel
Definition: gnssrtk.h:191
gnssrtk_cfg_t::sck
pin_name_t sck
Definition: gnssrtk.h:208
gnssrtk_cfg_t::spi_speed
uint32_t spi_speed
Definition: gnssrtk.h:221
gnssrtk_s::uart
uart_t uart
Definition: gnssrtk.h:183
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:216
gnssrtk_cfg_t::rtk
pin_name_t rtk
Definition: gnssrtk.h:214
gnssrtk_cfg_t::uart_blocking
bool uart_blocking
Definition: gnssrtk.h:226
GNSSRTK_DRV_SEL_I2C
@ GNSSRTK_DRV_SEL_I2C
Definition: gnssrtk.h:159
GNSSRTK_DRV_SEL_SPI
@ GNSSRTK_DRV_SEL_SPI
Definition: gnssrtk.h:158
gnssrtk_cfg_t
GNSS RTK Click configuration object.
Definition: gnssrtk.h:203
gnssrtk_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnssrtk.h:229
gnssrtk_cfg_t::sda
pin_name_t sda
Definition: gnssrtk.h:205
gnssrtk_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gnssrtk.h:222
gnssrtk_s::rst
digital_out_t rst
Definition: gnssrtk.h:175
gnssrtk_s::i2c
i2c_master_t i2c
Definition: gnssrtk.h:181
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:223
GNSSRTK_DRV_RX_BUFFER_SIZE
#define GNSSRTK_DRV_RX_BUFFER_SIZE
Definition: gnssrtk.h:105
gnssrtk_s::spi
spi_master_t spi
Definition: gnssrtk.h:182
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:104
gnssrtk_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnssrtk.h:218
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:228
gnssrtk_s::chip_select
pin_name_t chip_select
Definition: gnssrtk.h:190
gnssrtk_cfg_t::miso
pin_name_t miso
Definition: gnssrtk.h:206
gnssrtk_cfg_t::cs
pin_name_t cs
Definition: gnssrtk.h:209
gnssrtk_s::rtk
digital_in_t rtk
Definition: gnssrtk.h:178
gnssrtk_s::rdy
digital_in_t rdy
Definition: gnssrtk.h:177