gnss12  2.0.0.0
gnss12.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 GNSS12_H
29 #define GNSS12_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 GNSS12_RSP_START "$"
63 #define GNSS12_RSP_DELIMITER ","
64 #define GNSS12_RSP_GNGGA "$GNGGA"
65 
70 #define GNSS12_GNGGA_ELEMENT_SIZE 15
71 #define GNSS12_GNGGA_TIME 1
72 #define GNSS12_GNGGA_LATITUDE 2
73 #define GNSS12_GNGGA_LATITUDE_SIDE 3
74 #define GNSS12_GNGGA_LONGITUDE 4
75 #define GNSS12_GNGGA_LONGITUDE_SIDE 5
76 #define GNSS12_GNGGA_QUALITY_INDICATOR 6
77 #define GNSS12_GNGGA_NUMBER_OF_SATELLITES 7
78 #define GNSS12_GNGGA_H_DILUTION_OF_POS 8
79 #define GNSS12_GNGGA_ALTITUDE 9
80 #define GNSS12_GNGGA_ALTITUDE_UNIT 10
81 #define GNSS12_GNGGA_GEOIDAL_SEPARATION 11
82 #define GNSS12_GNGGA_GEOIDAL_SEPARATION_UNIT 12
83 #define GNSS12_GNGGA_TIME_SINCE_LAST_DGPS 13
84 #define GNSS12_GNGGA_DGPS_REFERENCE_STATION_ID 14
85 
90 #define GNSS12_DUMMY 0xFF
91 
97 #define GNSS12_SET_DEV_ADDR 0x42
98 
104 #define GNSS12_DRV_BUFFER_SIZE 200
105 
114 #define GNSS12_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
115 #define GNSS12_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
116  // gnss12_set
118 
133 #define GNSS12_MAP_MIKROBUS( cfg, mikrobus ) \
134  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
135  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
136  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
137  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
138  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
139  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
140  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
141  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
142  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
143  cfg.lna_en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
144  cfg.eint = MIKROBUS( mikrobus, MIKROBUS_INT )
145  // gnss12_map // gnss12
148 
153 typedef enum
154 {
160 
165 typedef err_t ( *gnss12_master_io_t )( struct gnss12_s*, uint8_t*, uint8_t );
171 typedef struct gnss12_s
172 {
173  digital_out_t rst;
175  digital_in_t eint;
176  digital_in_t lna_en;
178  i2c_master_t i2c;
179  spi_master_t spi;
180  uart_t uart;
182  // Buffers
186  uint8_t slave_address;
187  pin_name_t chip_select;
194 
199 typedef struct
200 {
201  pin_name_t scl;
202  pin_name_t sda;
203  pin_name_t miso;
204  pin_name_t mosi;
205  pin_name_t sck;
206  pin_name_t cs;
207  pin_name_t rx_pin;
208  pin_name_t tx_pin;
209  pin_name_t rst;
210  pin_name_t lna_en;
211  pin_name_t eint;
213  uint32_t i2c_speed;
214  uint8_t i2c_address;
216  uint32_t spi_speed;
217  spi_master_mode_t spi_mode;
218  spi_master_chip_select_polarity_t cs_polarity;
220  uint32_t baud_rate;
222  uart_data_bits_t data_bit;
223  uart_parity_t parity_bit;
224  uart_stop_bits_t stop_bit;
228 } gnss12_cfg_t;
229 
234 typedef enum
235 {
237  GNSS12_ERROR = -1
238 
240 
257 
273 
287 err_t gnss12_init ( gnss12_t *ctx, gnss12_cfg_t *cfg );
288 
301 err_t gnss12_generic_write ( gnss12_t *ctx, uint8_t *data_in, uint8_t len );
302 
315 err_t gnss12_generic_read ( gnss12_t *ctx, uint8_t *data_out, uint8_t len );
316 
326 void gnss12_set_rst_pin ( gnss12_t *ctx, uint8_t state );
327 
337 
346 uint8_t gnss12_get_eint_pin ( gnss12_t *ctx );
347 
357 
369 err_t gnss12_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
370 
371 #ifdef __cplusplus
372 }
373 #endif
374 #endif // GNSS12_H
375  // gnss12
377 
378 // ------------------------------------------------------------------------ END
gnss12_s::chip_select
pin_name_t chip_select
Definition: gnss12.h:187
gnss12_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss12.h:220
gnss12_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnss12.h:214
gnss12_s::eint
digital_in_t eint
Definition: gnss12.h:175
gnss12_cfg_t::sck
pin_name_t sck
Definition: gnss12.h:205
spi_specifics.h
This file contains SPI specific macros, functions, etc.
GNSS12_OK
@ GNSS12_OK
Definition: gnss12.h:236
gnss12_cfg_t::mosi
pin_name_t mosi
Definition: gnss12.h:204
gnss12_cfg_t::cs
pin_name_t cs
Definition: gnss12.h:206
gnss12_s::write_f
gnss12_master_io_t write_f
Definition: gnss12.h:190
gnss12_s::drv_sel
gnss12_drv_t drv_sel
Definition: gnss12.h:188
gnss12_get_lna_en_pin
uint8_t gnss12_get_lna_en_pin(gnss12_t *ctx)
GNSS 12 get LNA EN pin function.
gnss12_t
struct gnss12_s gnss12_t
GNSS 12 Click context object.
gnss12_drv_t
gnss12_drv_t
GNSS 12 Click driver selector.
Definition: gnss12.h:154
gnss12_cfg_t::miso
pin_name_t miso
Definition: gnss12.h:203
gnss12_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnss12.h:213
gnss12_generic_write
err_t gnss12_generic_write(gnss12_t *ctx, uint8_t *data_in, uint8_t len)
GNSS 12 data writing function.
gnss12_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss12.h:223
gnss12_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss12.h:221
gnss12_get_eint_pin
uint8_t gnss12_get_eint_pin(gnss12_t *ctx)
GNSS 12 get Ext INT pin function.
gnss12_generic_read
err_t gnss12_generic_read(gnss12_t *ctx, uint8_t *data_out, uint8_t len)
GNSS 12 data reading function.
gnss12_cfg_t::eint
pin_name_t eint
Definition: gnss12.h:211
gnss12_cfg_setup
void gnss12_cfg_setup(gnss12_cfg_t *cfg)
GNSS 12 configuration object setup function.
gnss12_s
GNSS 12 Click context object.
Definition: gnss12.h:172
gnss12_s::rst
digital_out_t rst
Definition: gnss12.h:173
gnss12_set_rst_pin
void gnss12_set_rst_pin(gnss12_t *ctx, uint8_t state)
GNSS 12 set RST pin function.
gnss12_s::read_f
gnss12_master_io_t read_f
Definition: gnss12.h:191
GNSS12_DRV_SEL_I2C
@ GNSS12_DRV_SEL_I2C
Definition: gnss12.h:157
gnss12_cfg_t::drv_sel
gnss12_drv_t drv_sel
Definition: gnss12.h:226
gnss12_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: gnss12.h:218
GNSS12_ERROR
@ GNSS12_ERROR
Definition: gnss12.h:237
gnss12_s::i2c
i2c_master_t i2c
Definition: gnss12.h:178
gnss12_master_io_t
err_t(* gnss12_master_io_t)(struct gnss12_s *, uint8_t *, uint8_t)
GNSS 12 Click driver interface.
Definition: gnss12.h:165
gnss12_cfg_t::sda
pin_name_t sda
Definition: gnss12.h:202
gnss12_reset_device
void gnss12_reset_device(gnss12_t *ctx)
GNSS 12 reset device function.
gnss12_cfg_t::lna_en
pin_name_t lna_en
Definition: gnss12.h:210
gnss12_s::lna_en
digital_in_t lna_en
Definition: gnss12.h:176
GNSS12_DRV_SEL_SPI
@ GNSS12_DRV_SEL_SPI
Definition: gnss12.h:156
gnss12_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss12.h:208
gnss12_drv_interface_selection
void gnss12_drv_interface_selection(gnss12_cfg_t *cfg, gnss12_drv_t drv_sel)
GNSS 12 driver interface setup function.
gnss12_s::slave_address
uint8_t slave_address
Definition: gnss12.h:186
GNSS12_DRV_BUFFER_SIZE
#define GNSS12_DRV_BUFFER_SIZE
GNSS 12 driver buffer size.
Definition: gnss12.h:104
gnss12_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss12.h:207
gnss12_cfg_t
GNSS 12 Click configuration object.
Definition: gnss12.h:200
gnss12_s::uart_tx_buffer
char uart_tx_buffer[GNSS12_DRV_BUFFER_SIZE]
Definition: gnss12.h:184
gnss12_cfg_t::rst
pin_name_t rst
Definition: gnss12.h:209
gnss12_s::uart
uart_t uart
Definition: gnss12.h:180
gnss12_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss12.h:222
gnss12_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss12.h:224
gnss12_parse_gngga
err_t gnss12_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GNSS 12 parse GNGGA function.
gnss12_s::spi
spi_master_t spi
Definition: gnss12.h:179
gnss12_init
err_t gnss12_init(gnss12_t *ctx, gnss12_cfg_t *cfg)
GNSS 12 initialization function.
gnss12_cfg_t::spi_speed
uint32_t spi_speed
Definition: gnss12.h:216
gnss12_s::uart_rx_buffer
char uart_rx_buffer[GNSS12_DRV_BUFFER_SIZE]
Definition: gnss12.h:183
gnss12_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gnss12.h:217
gnss12_cfg_t::scl
pin_name_t scl
Definition: gnss12.h:201
GNSS12_DRV_SEL_UART
@ GNSS12_DRV_SEL_UART
Definition: gnss12.h:155
gnss12_return_value_t
gnss12_return_value_t
GNSS 12 Click return value data.
Definition: gnss12.h:235