gnss18 2.1.0.0
gnss18.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 GNSS18_H
29#define GNSS18_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "mikrosdk_version.h"
36
37#ifdef __GNUC__
38#if mikroSDK_GET_VERSION < 20800ul
39#include "rcu_delays.h"
40#else
41#include "delays.h"
42#endif
43#endif
44
45#include "drv_digital_out.h"
46#include "drv_digital_in.h"
47#include "drv_i2c_master.h"
48#include "drv_uart.h"
49
70#define GNSS18_RSP_START "$"
71#define GNSS18_RSP_DELIMITER ","
72#define GNSS18_RSP_END_SEQ "\r\n"
73#define GNSS18_RSP_GPGGA "$GNGGA"
74#define GNSS18_RSP_NO_FIX ""
75
80#define GNSS18_GPGGA_ELEMENT_SIZE 15
81#define GNSS18_GPGGA_TIME 1
82#define GNSS18_GPGGA_LATITUDE 2
83#define GNSS18_GPGGA_LATITUDE_SIDE 3
84#define GNSS18_GPGGA_LONGITUDE 4
85#define GNSS18_GPGGA_LONGITUDE_SIDE 5
86#define GNSS18_GPGGA_QUALITY_INDICATOR 6
87#define GNSS18_GPGGA_NUMBER_OF_SATELLITES 7
88#define GNSS18_GPGGA_H_DILUTION_OF_POS 8
89#define GNSS18_GPGGA_ALTITUDE 9
90#define GNSS18_GPGGA_ALTITUDE_UNIT 10
91#define GNSS18_GPGGA_GEOIDAL_SEPARATION 11
92#define GNSS18_GPGGA_GEOIDAL_SEPARATION_UNIT 12
93#define GNSS18_GPGGA_TIME_SINCE_LAST_DGPS 13
94#define GNSS18_GPGGA_DGPS_REFERENCE_STATION_ID 14
95
100#define GNSS18_DUMMY 0xFF
101
107#define GNSS18_DEVICE_ADDRESS 0x42
108
114#define GNSS18_DRV_TX_BUFFER_SIZE 100
115#define GNSS18_DRV_RX_BUFFER_SIZE 500
116 // gnss18_cmd
118
133#define GNSS18_MAP_MIKROBUS( cfg, mikrobus ) \
134 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
135 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
136 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
137 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
138 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
139 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
140 // gnss18_map // gnss18
143
148typedef enum
149{
154
159typedef err_t ( *gnss18_master_io_t )( struct gnss18_s*, uint8_t*, uint8_t );
165typedef struct gnss18_s
166{
167 // Output pins
168 digital_out_t rst;
170 // Input pins
171 digital_in_t int_pin;
173 // Modules
174 i2c_master_t i2c;
175 uart_t uart;
177 // Buffers
188
193typedef struct
194{
195 // Communication gpio pins
196 pin_name_t scl;
197 pin_name_t sda;
198 pin_name_t rx_pin;
199 pin_name_t tx_pin;
201 // Additional gpio pins
202 pin_name_t rst;
203 pin_name_t int_pin;
205 // Static variable
206 uint32_t baud_rate;
208 uart_data_bits_t data_bit;
209 uart_parity_t parity_bit;
210 uart_stop_bits_t stop_bit;
213 uint32_t i2c_speed;
214 uint8_t i2c_address;
219
224typedef enum
225{
227 GNSS18_ERROR = -1
228
230
247
263
277err_t gnss18_init ( gnss18_t *ctx, gnss18_cfg_t *cfg );
278
291err_t gnss18_generic_write ( gnss18_t *ctx, uint8_t *data_in, uint8_t len );
292
305err_t gnss18_generic_read ( gnss18_t *ctx, uint8_t *data_out, uint8_t len );
306
316void gnss18_set_rst_pin ( gnss18_t *ctx, uint8_t state );
317
327
337
349err_t gnss18_parse_gpgga ( uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data );
350
351#ifdef __cplusplus
352}
353#endif
354#endif // GNSS18_H
355 // gnss18
357
358// ------------------------------------------------------------------------ END
gnss18_drv_t
GNSS 18 Click driver selector.
Definition: gnss18.h:149
@ GNSS18_DRV_SEL_I2C
Definition: gnss18.h:151
@ GNSS18_DRV_SEL_UART
Definition: gnss18.h:150
gnss18_return_value_t
GNSS 18 Click return value data.
Definition: gnss18.h:225
@ GNSS18_ERROR
Definition: gnss18.h:227
@ GNSS18_OK
Definition: gnss18.h:226
struct gnss18_s gnss18_t
GNSS 18 Click context object.
err_t(* gnss18_master_io_t)(struct gnss18_s *, uint8_t *, uint8_t)
GNSS 18 Click driver interface.
Definition: gnss18.h:159
#define GNSS18_DRV_RX_BUFFER_SIZE
Definition: gnss18.h:115
#define GNSS18_DRV_TX_BUFFER_SIZE
GNSS 18 driver buffer size.
Definition: gnss18.h:114
void gnss18_set_rst_pin(gnss18_t *ctx, uint8_t state)
GNSS 18 set RST pin function.
void gnss18_cfg_setup(gnss18_cfg_t *cfg)
GNSS 18 configuration object setup function.
err_t gnss18_generic_read(gnss18_t *ctx, uint8_t *data_out, uint8_t len)
GNSS 18 data reading function.
void gnss18_drv_interface_selection(gnss18_cfg_t *cfg, gnss18_drv_t drv_sel)
GNSS 18 driver interface setup function.
err_t gnss18_init(gnss18_t *ctx, gnss18_cfg_t *cfg)
GNSS 18 initialization function.
void gnss18_reset_device(gnss18_t *ctx)
GNSS 18 reset device function.
err_t gnss18_parse_gpgga(uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data)
GNSS 18 parse GPGGA function.
err_t gnss18_generic_write(gnss18_t *ctx, uint8_t *data_in, uint8_t len)
GNSS 18 data writing function.
uint8_t gnss18_get_int_pin(gnss18_t *ctx)
GNSS 18 get INT pin function.
GNSS 18 Click configuration object.
Definition: gnss18.h:194
uint32_t baud_rate
Definition: gnss18.h:206
gnss18_drv_t drv_sel
Definition: gnss18.h:216
uint32_t i2c_speed
Definition: gnss18.h:213
bool uart_blocking
Definition: gnss18.h:207
uart_data_bits_t data_bit
Definition: gnss18.h:208
pin_name_t tx_pin
Definition: gnss18.h:199
pin_name_t rx_pin
Definition: gnss18.h:198
uart_stop_bits_t stop_bit
Definition: gnss18.h:210
pin_name_t scl
Definition: gnss18.h:196
pin_name_t int_pin
Definition: gnss18.h:203
uart_parity_t parity_bit
Definition: gnss18.h:209
pin_name_t sda
Definition: gnss18.h:197
pin_name_t rst
Definition: gnss18.h:202
uint8_t i2c_address
Definition: gnss18.h:214
GNSS 18 Click context object.
Definition: gnss18.h:166
gnss18_drv_t drv_sel
Definition: gnss18.h:182
gnss18_master_io_t read_f
Definition: gnss18.h:185
gnss18_master_io_t write_f
Definition: gnss18.h:184
uart_t uart
Definition: gnss18.h:175
digital_in_t int_pin
Definition: gnss18.h:171
i2c_master_t i2c
Definition: gnss18.h:174
uint8_t uart_tx_buffer[GNSS18_DRV_TX_BUFFER_SIZE]
Definition: gnss18.h:179
digital_out_t rst
Definition: gnss18.h:168
uint8_t slave_address
Definition: gnss18.h:181
uint8_t uart_rx_buffer[GNSS18_DRV_RX_BUFFER_SIZE]
Definition: gnss18.h:178