gnss21 2.2.1
Loading...
Searching...
No Matches
gnss21.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
27
28#ifndef GNSS21_H
29#define GNSS21_H
30
31#ifdef __cplusplus
32extern "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_uart.h"
52#include "drv_i2c_master.h"
53
59
64
69
74#define GNSS21_RSP_START "$"
75#define GNSS21_RSP_DELIMITER ","
76#define GNSS21_RSP_END "\r\n"
77#define GNSS21_RSP_GGA "GGA"
78#define GNSS21_RSP_NO_FIX "0000.00000"
79
84#define GNSS21_GGA_ELEMENT_SIZE 15
85#define GNSS21_GGA_TIME 1
86#define GNSS21_GGA_LATITUDE 2
87#define GNSS21_GGA_LATITUDE_SIDE 3
88#define GNSS21_GGA_LONGITUDE 4
89#define GNSS21_GGA_LONGITUDE_SIDE 5
90#define GNSS21_GGA_QUALITY_INDICATOR 6
91#define GNSS21_GGA_NUMBER_OF_SATELLITES 7
92#define GNSS21_GGA_H_DILUTION_OF_POS 8
93#define GNSS21_GGA_ALTITUDE 9
94#define GNSS21_GGA_ALTITUDE_UNIT 10
95#define GNSS21_GGA_GEOIDAL_SEPARATION 11
96#define GNSS21_GGA_GEOIDAL_SEPARATION_UNIT 12
97#define GNSS21_GGA_TIME_SINCE_LAST_DGPS 13
98#define GNSS21_GGA_DGPS_REFERENCE_STATION_ID 14
99
104#define GNSS21_DUMMY 0xFF
105
111#define GNSS21_TX_DRV_BUFFER_SIZE 100
112#define GNSS21_RX_DRV_BUFFER_SIZE 1000
113
119#define GNSS21_DEVICE_ADDRESS 0x3A
120 // gnss21_cmd
122
127
132
137#define GNSS21_MAP_MIKROBUS( cfg, mikrobus ) \
138 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
139 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
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.pps = MIKROBUS( mikrobus, MIKROBUS_INT );
144 // gnss21_map // gnss21
147
158
163struct gnss21_s;
164typedef err_t ( *gnss21_master_io_t )( struct gnss21_s*, uint8_t*, uint16_t );
165
170typedef struct gnss21_s
171{
172 // Output pins
173 digital_out_t rst;
174
175 // Input pins
176 digital_in_t pps;
177
178 // Modules
179 uart_t uart;
180 i2c_master_t i2c;
181
182 // Buffers
185
188
191
193
198typedef struct
199{
200 // Communication gpio pins
201 pin_name_t scl;
202 pin_name_t sda;
203 pin_name_t rx_pin;
204 pin_name_t tx_pin;
205
206 // Additional gpio pins
207 pin_name_t rst;
208 pin_name_t pps;
209
210 uint32_t i2c_speed;
211 uint8_t i2c_address;
212
213 // Static variable
214 uint32_t baud_rate;
216 uart_data_bits_t data_bit;
217 uart_parity_t parity_bit;
218 uart_stop_bits_t stop_bit;
219
221
223
228typedef enum
229{
232
234
240
251
267
281err_t gnss21_init ( gnss21_t *ctx, gnss21_cfg_t *cfg );
282
295err_t gnss21_generic_write ( gnss21_t *ctx, uint8_t *data_in, uint16_t len );
296
309err_t gnss21_generic_read ( gnss21_t *ctx, uint8_t *data_out, uint16_t len );
310
320
330void gnss21_set_rst_pin ( gnss21_t *ctx, uint8_t state );
331
341
353err_t gnss21_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
354
355#ifdef __cplusplus
356}
357#endif
358#endif // GNSS21_H
359 // gnss21
361
362// ------------------------------------------------------------------------ END
struct gnss21_s gnss21_t
GNSS 21 Click context object.
err_t(* gnss21_master_io_t)(struct gnss21_s *, uint8_t *, uint16_t)
Definition gnss21.h:164
gnss21_return_value_t
GNSS 21 Click return value data.
Definition gnss21.h:229
@ GNSS21_OK
Definition gnss21.h:230
@ GNSS21_ERROR
Definition gnss21.h:231
gnss21_drv_t
GNSS 21 Click driver selector.
Definition gnss21.h:153
@ GNSS21_DRV_SEL_I2C
Definition gnss21.h:155
@ GNSS21_DRV_SEL_UART
Definition gnss21.h:154
#define GNSS21_TX_DRV_BUFFER_SIZE
GNSS 21 driver buffer size.
Definition gnss21.h:111
#define GNSS21_RX_DRV_BUFFER_SIZE
Definition gnss21.h:112
err_t gnss21_generic_read(gnss21_t *ctx, uint8_t *data_out, uint16_t len)
GNSS 21 data reading function.
err_t gnss21_generic_write(gnss21_t *ctx, uint8_t *data_in, uint16_t len)
GNSS 21 data writing function.
uint8_t gnss21_get_pps_pin(gnss21_t *ctx)
GNSS 21 get PPS pin function.
void gnss21_reset_device(gnss21_t *ctx)
GNSS 21 reset device function.
void gnss21_set_rst_pin(gnss21_t *ctx, uint8_t state)
GNSS 21 set RST pin function.
err_t gnss21_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
GNSS 21 parse GGA function.
void gnss21_cfg_setup(gnss21_cfg_t *cfg)
GNSS 21 configuration object setup function.
err_t gnss21_init(gnss21_t *ctx, gnss21_cfg_t *cfg)
GNSS 21 initialization function.
void gnss21_drv_interface_sel(gnss21_cfg_t *cfg, gnss21_drv_t drv_sel)
GNSS 21 driver interface setup function.
GNSS 21 Click configuration object.
Definition gnss21.h:199
uint32_t baud_rate
Definition gnss21.h:214
pin_name_t pps
Definition gnss21.h:208
uint32_t i2c_speed
Definition gnss21.h:210
bool uart_blocking
Definition gnss21.h:215
uart_data_bits_t data_bit
Definition gnss21.h:216
gnss21_drv_t drv_sel
Definition gnss21.h:220
pin_name_t tx_pin
Definition gnss21.h:204
pin_name_t rx_pin
Definition gnss21.h:203
uart_stop_bits_t stop_bit
Definition gnss21.h:218
pin_name_t scl
Definition gnss21.h:201
uart_parity_t parity_bit
Definition gnss21.h:217
pin_name_t sda
Definition gnss21.h:202
pin_name_t rst
Definition gnss21.h:207
uint8_t i2c_address
Definition gnss21.h:211
GNSS 21 Click context object.
Definition gnss21.h:171
gnss21_master_io_t write_f
Definition gnss21.h:189
gnss21_master_io_t read_f
Definition gnss21.h:190
digital_in_t pps
Definition gnss21.h:176
uart_t uart
Definition gnss21.h:179
uint8_t uart_tx_buffer[GNSS21_TX_DRV_BUFFER_SIZE]
Definition gnss21.h:184
gnss21_drv_t drv_sel
Definition gnss21.h:187
i2c_master_t i2c
Definition gnss21.h:180
digital_out_t rst
Definition gnss21.h:173
uint8_t slave_address
Definition gnss21.h:186
uint8_t uart_rx_buffer[GNSS21_RX_DRV_BUFFER_SIZE]
Definition gnss21.h:183