gnss11  2.1.0.0
gnss11.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 GNSS11_H
29 #define GNSS11_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 GNSS11_RSP_START "$"
63 #define GNSS11_RSP_DELIMITER ","
64 #define GNSS11_RSP_END "\r\n"
65 #define GNSS11_RSP_GGA "GGA"
66 
71 #define GNSS11_GGA_ELEMENT_SIZE 15
72 #define GNSS11_GGA_TIME 1
73 #define GNSS11_GGA_LATITUDE 2
74 #define GNSS11_GGA_LATITUDE_SIDE 3
75 #define GNSS11_GGA_LONGITUDE 4
76 #define GNSS11_GGA_LONGITUDE_SIDE 5
77 #define GNSS11_GGA_QUALITY_INDICATOR 6
78 #define GNSS11_GGA_NUMBER_OF_SATELLITES 7
79 #define GNSS11_GGA_H_DILUTION_OF_POS 8
80 #define GNSS11_GGA_ALTITUDE 9
81 #define GNSS11_GGA_ALTITUDE_UNIT 10
82 #define GNSS11_GGA_GEOIDAL_SEPARATION 11
83 #define GNSS11_GGA_GEOIDAL_SEPARATION_UNIT 12
84 #define GNSS11_GGA_TIME_SINCE_LAST_DGPS 13
85 #define GNSS11_GGA_DGPS_REFERENCE_STATION_ID 14
86 
91 #define GNSS11_DUMMY 0xFF
92 
98 #define GNSS11_SET_DEV_ADDR 0x42
99 
105 #define GNSS11_TX_DRV_BUFFER_SIZE 100
106 #define GNSS11_RX_DRV_BUFFER_SIZE 1000
107 
116 #define GNSS11_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
117 #define GNSS11_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
118  // gnss11_cmd
120 
135 #define GNSS11_MAP_MIKROBUS( cfg, mikrobus ) \
136  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
137  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
138  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
139  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
140  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
141  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
142  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
143  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
144  cfg.ovc = MIKROBUS( mikrobus, MIKROBUS_AN ); \
145  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
146  cfg.ant_on = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
147  cfg.eint = MIKROBUS( mikrobus, MIKROBUS_INT );
148  // gnss11_map // gnss11
151 
156 typedef enum
157 {
163 
168 struct gnss11_s;
169 typedef err_t ( *gnss11_master_io_t )( struct gnss11_s*, uint8_t*, uint16_t );
175 typedef struct gnss11_s
176 {
177  digital_out_t rst;
178  digital_out_t ant_on;
180  digital_in_t eint;
181  digital_in_t ovc;
183  i2c_master_t i2c;
184  spi_master_t spi;
185  uart_t uart;
190  uint8_t slave_address;
191  pin_name_t chip_select;
198 
203 typedef struct
204 {
205  pin_name_t scl;
206  pin_name_t sda;
207  pin_name_t miso;
208  pin_name_t mosi;
209  pin_name_t sck;
210  pin_name_t cs;
211  pin_name_t rx_pin;
212  pin_name_t tx_pin;
213  pin_name_t rst;
214  pin_name_t ant_on;
215  pin_name_t eint;
216  pin_name_t ovc;
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 } gnss11_cfg_t;
234 
239 typedef enum
240 {
242  GNSS11_ERROR = -1
243 
245 
262 
276 err_t gnss11_init ( gnss11_t *ctx, gnss11_cfg_t *cfg );
277 
293 
307 
320 err_t gnss11_generic_write ( gnss11_t *ctx, uint8_t *data_in, uint16_t len );
321 
334 err_t gnss11_generic_read ( gnss11_t *ctx, uint8_t *data_out, uint16_t len );
335 
344 uint8_t gnss11_get_ovc_pin ( gnss11_t *ctx );
345 
355 void gnss11_set_rst_pin ( gnss11_t *ctx, uint8_t state );
356 
366 void gnss11_set_ant_on_pin ( gnss11_t *ctx, uint8_t state );
367 
376 uint8_t gnss11_get_eint_pin ( gnss11_t *ctx );
377 
387 
399 err_t gnss11_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
400 
401 #ifdef __cplusplus
402 }
403 #endif
404 #endif // GNSS11_H
405  // gnss11
407 
408 // ------------------------------------------------------------------------ END
gnss11_s::chip_select
pin_name_t chip_select
Definition: gnss11.h:191
gnss11_parse_gga
err_t gnss11_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
GNSS 11 parse GGA function.
gnss11_s::rst
digital_out_t rst
Definition: gnss11.h:177
gnss11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnss11.h:218
gnss11_set_rst_pin
void gnss11_set_rst_pin(gnss11_t *ctx, uint8_t state)
GNSS 11 set RST pin function.
gnss11_master_io_t
err_t(* gnss11_master_io_t)(struct gnss11_s *, uint8_t *, uint16_t)
Definition: gnss11.h:169
gnss11_cfg_t::rst
pin_name_t rst
Definition: gnss11.h:213
GNSS11_DRV_SEL_UART
@ GNSS11_DRV_SEL_UART
Definition: gnss11.h:158
spi_specifics.h
This file contains SPI specific macros, functions, etc.
gnss11_drv_t
gnss11_drv_t
GNSS 11 Click driver selector.
Definition: gnss11.h:157
gnss11_set_ant_on_pin
void gnss11_set_ant_on_pin(gnss11_t *ctx, uint8_t state)
GNSS 11 set ANT_ON pin function.
gnss11_cfg_t::sda
pin_name_t sda
Definition: gnss11.h:206
gnss11_t
struct gnss11_s gnss11_t
GNSS 11 Click context object.
gnss11_drv_interface_selection
void gnss11_drv_interface_selection(gnss11_cfg_t *cfg, gnss11_drv_t drv_sel)
GNSS 11 driver interface setup function.
gnss11_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnss11.h:219
GNSS11_RX_DRV_BUFFER_SIZE
#define GNSS11_RX_DRV_BUFFER_SIZE
Definition: gnss11.h:106
gnss11_cfg_t::sck
pin_name_t sck
Definition: gnss11.h:209
GNSS11_TX_DRV_BUFFER_SIZE
#define GNSS11_TX_DRV_BUFFER_SIZE
GNSS 11 driver buffer size.
Definition: gnss11.h:105
GNSS11_ERROR
@ GNSS11_ERROR
Definition: gnss11.h:242
gnss11_s::eint
digital_in_t eint
Definition: gnss11.h:180
gnss11_cfg_t::scl
pin_name_t scl
Definition: gnss11.h:205
gnss11_get_eint_pin
uint8_t gnss11_get_eint_pin(gnss11_t *ctx)
GNSS 11 get Ext INT pin function.
gnss11_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss11.h:211
gnss11_s::ovc
digital_in_t ovc
Definition: gnss11.h:181
gnss11_s
GNSS 11 Click context object.
Definition: gnss11.h:176
gnss11_s::i2c
i2c_master_t i2c
Definition: gnss11.h:183
gnss11_cfg_t::miso
pin_name_t miso
Definition: gnss11.h:207
gnss11_cfg_t::spi_speed
uint32_t spi_speed
Definition: gnss11.h:221
gnss11_cfg_setup
void gnss11_cfg_setup(gnss11_cfg_t *cfg)
GNSS 11 configuration object setup function.
gnss11_cfg_t::ant_on
pin_name_t ant_on
Definition: gnss11.h:214
gnss11_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss11.h:227
gnss11_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss11.h:229
gnss11_cfg_t::eint
pin_name_t eint
Definition: gnss11.h:215
gnss11_return_value_t
gnss11_return_value_t
GNSS 11 Click return value data.
Definition: gnss11.h:240
gnss11_generic_write
err_t gnss11_generic_write(gnss11_t *ctx, uint8_t *data_in, uint16_t len)
GNSS 11 data writing function.
gnss11_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss11.h:225
gnss11_s::write_f
gnss11_master_io_t write_f
Definition: gnss11.h:194
gnss11_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss11.h:228
gnss11_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss11.h:226
gnss11_cfg_t::ovc
pin_name_t ovc
Definition: gnss11.h:216
gnss11_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gnss11.h:222
gnss11_s::read_f
gnss11_master_io_t read_f
Definition: gnss11.h:195
gnss11_default_cfg
err_t gnss11_default_cfg(gnss11_t *ctx)
GNSS 11 default configuration function.
gnss11_init
err_t gnss11_init(gnss11_t *ctx, gnss11_cfg_t *cfg)
GNSS 11 initialization function.
gnss11_get_ovc_pin
uint8_t gnss11_get_ovc_pin(gnss11_t *ctx)
GNSS 11 get OVC pin function.
gnss11_cfg_t
GNSS 11 Click configuration object.
Definition: gnss11.h:204
gnss11_generic_read
err_t gnss11_generic_read(gnss11_t *ctx, uint8_t *data_out, uint16_t len)
GNSS 11 data reading function.
gnss11_s::uart
uart_t uart
Definition: gnss11.h:185
gnss11_cfg_t::drv_sel
gnss11_drv_t drv_sel
Definition: gnss11.h:231
GNSS11_DRV_SEL_SPI
@ GNSS11_DRV_SEL_SPI
Definition: gnss11.h:159
gnss11_s::slave_address
uint8_t slave_address
Definition: gnss11.h:190
gnss11_s::ant_on
digital_out_t ant_on
Definition: gnss11.h:178
gnss11_s::uart_rx_buffer
uint8_t uart_rx_buffer[GNSS11_RX_DRV_BUFFER_SIZE]
Definition: gnss11.h:187
gnss11_s::drv_sel
gnss11_drv_t drv_sel
Definition: gnss11.h:192
gnss11_reset_device
void gnss11_reset_device(gnss11_t *ctx)
GNSS 11 reset device function.
gnss11_s::spi
spi_master_t spi
Definition: gnss11.h:184
gnss11_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss11.h:212
gnss11_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: gnss11.h:223
gnss11_cfg_t::cs
pin_name_t cs
Definition: gnss11.h:210
GNSS11_OK
@ GNSS11_OK
Definition: gnss11.h:241
GNSS11_DRV_SEL_I2C
@ GNSS11_DRV_SEL_I2C
Definition: gnss11.h:160
gnss11_s::uart_tx_buffer
uint8_t uart_tx_buffer[GNSS11_TX_DRV_BUFFER_SIZE]
Definition: gnss11.h:188
gnss11_cfg_t::mosi
pin_name_t mosi
Definition: gnss11.h:208