gnss13  2.1.0.0
gnss13.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 GNSS13_H
29 #define GNSS13_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_uart.h"
38 #include "drv_i2c_master.h"
39 
60 #define GNSS13_RSP_START "$"
61 #define GNSS13_RSP_DELIMITER ","
62 #define GNSS13_RSP_END_SEQ "\r\n"
63 #define GNSS13_RSP_GNGGA "$GNGGA"
64 
69 #define GNSS13_GNGGA_ELEMENT_SIZE 15
70 #define GNSS13_GNGGA_TIME 1
71 #define GNSS13_GNGGA_LATITUDE 2
72 #define GNSS13_GNGGA_LATITUDE_SIDE 3
73 #define GNSS13_GNGGA_LONGITUDE 4
74 #define GNSS13_GNGGA_LONGITUDE_SIDE 5
75 #define GNSS13_GNGGA_QUALITY_INDICATOR 6
76 #define GNSS13_GNGGA_NUMBER_OF_SATELLITES 7
77 #define GNSS13_GNGGA_H_DILUTION_OF_POS 8
78 #define GNSS13_GNGGA_ALTITUDE 9
79 #define GNSS13_GNGGA_ALTITUDE_UNIT 10
80 #define GNSS13_GNGGA_GEOIDAL_SEPARATION 11
81 #define GNSS13_GNGGA_GEOIDAL_SEPARATION_UNIT 12
82 #define GNSS13_GNGGA_TIME_SINCE_LAST_DGPS 13
83 #define GNSS13_GNGGA_DGPS_REFERENCE_STATION_ID 14
84 
90 #define GNSS13_DEVICE_ADDRESS 0x10
91 
97 #define GNSS13_DRV_TX_BUFFER_SIZE 100
98 #define GNSS13_DRV_RX_BUFFER_SIZE 1200
99  // gnss13_cmd
101 
116 #define GNSS13_MAP_MIKROBUS( cfg, mikrobus ) \
117  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
118  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
119  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
120  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
121  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
122  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_PWM );
123  // gnss13_map // gnss13
126 
131 typedef enum
132 {
137 
142 typedef err_t ( *gnss13_master_io_t )( struct gnss13_s*, uint8_t*, uint8_t );
148 typedef struct gnss13_s
149 {
150  // Output pins
151  digital_out_t rst;
152  digital_out_t wup;
154  // Modules
155  uart_t uart;
156  i2c_master_t i2c;
158  // Buffers
162  uint8_t slave_address;
169 
174 typedef struct
175 {
176  // Communication gpio pins
177  pin_name_t scl;
178  pin_name_t sda;
179  pin_name_t rx_pin;
180  pin_name_t tx_pin;
182  // Additional gpio pins
183  pin_name_t rst;
184  pin_name_t wup;
186  // Static variable
187  uint32_t baud_rate;
189  uart_data_bits_t data_bit;
190  uart_parity_t parity_bit;
191  uart_stop_bits_t stop_bit;
193  uint32_t i2c_speed;
194  uint8_t i2c_address;
198 } gnss13_cfg_t;
199 
204 typedef enum
205 {
207  GNSS13_ERROR = -1
208 
210 
227 
243 
257 err_t gnss13_init ( gnss13_t *ctx, gnss13_cfg_t *cfg );
258 
271 err_t gnss13_generic_write ( gnss13_t *ctx, uint8_t *data_in, uint8_t len );
272 
285 err_t gnss13_generic_read ( gnss13_t *ctx, uint8_t *data_out, uint8_t len );
286 
296 
306 void gnss13_set_rst_pin ( gnss13_t *ctx, uint8_t state );
307 
317 void gnss13_set_wup_pin ( gnss13_t *ctx, uint8_t state );
318 
330 err_t gnss13_parse_gngga ( uint8_t *rsp_buf, uint8_t gngga_element, uint8_t *element_data );
331 
332 #ifdef __cplusplus
333 }
334 #endif
335 #endif // GNSS13_H
336  // gnss13
338 
339 // ------------------------------------------------------------------------ END
GNSS13_DRV_TX_BUFFER_SIZE
#define GNSS13_DRV_TX_BUFFER_SIZE
GNSS 13 driver buffer size.
Definition: gnss13.h:97
gnss13_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss13.h:187
gnss13_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss13.h:188
gnss13_drv_t
gnss13_drv_t
GNSS 13 Click driver selector.
Definition: gnss13.h:132
gnss13_t
struct gnss13_s gnss13_t
GNSS 13 Click context object.
gnss13_set_wup_pin
void gnss13_set_wup_pin(gnss13_t *ctx, uint8_t state)
GNSS 13 set WUP pin function.
gnss13_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnss13.h:194
gnss13_s
GNSS 13 Click context object.
Definition: gnss13.h:149
gnss13_drv_interface_selection
void gnss13_drv_interface_selection(gnss13_cfg_t *cfg, gnss13_drv_t drv_sel)
GNSS 13 driver interface setup function.
gnss13_s::rst
digital_out_t rst
Definition: gnss13.h:151
gnss13_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss13.h:189
gnss13_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss13.h:179
gnss13_cfg_t::rst
pin_name_t rst
Definition: gnss13.h:183
gnss13_s::write_f
gnss13_master_io_t write_f
Definition: gnss13.h:165
gnss13_generic_read
err_t gnss13_generic_read(gnss13_t *ctx, uint8_t *data_out, uint8_t len)
GNSS 13 generic read function.
gnss13_clear_ring_buffers
void gnss13_clear_ring_buffers(gnss13_t *ctx)
GNSS 13 clear ring buffers function.
gnss13_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss13.h:180
gnss13_parse_gngga
err_t gnss13_parse_gngga(uint8_t *rsp_buf, uint8_t gngga_element, uint8_t *element_data)
GNSS 13 parse GNGGA function.
gnss13_set_rst_pin
void gnss13_set_rst_pin(gnss13_t *ctx, uint8_t state)
GNSS 13 set RST pin function.
gnss13_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss13.h:190
gnss13_s::drv_sel
gnss13_drv_t drv_sel
Definition: gnss13.h:163
gnss13_cfg_t::wup
pin_name_t wup
Definition: gnss13.h:184
GNSS13_DRV_SEL_UART
@ GNSS13_DRV_SEL_UART
Definition: gnss13.h:133
gnss13_cfg_setup
void gnss13_cfg_setup(gnss13_cfg_t *cfg)
GNSS 13 configuration object setup function.
gnss13_s::i2c
i2c_master_t i2c
Definition: gnss13.h:156
gnss13_return_value_t
gnss13_return_value_t
GNSS 13 Click return value data.
Definition: gnss13.h:205
gnss13_s::uart_rx_buffer
char uart_rx_buffer[GNSS13_DRV_RX_BUFFER_SIZE]
Definition: gnss13.h:159
gnss13_s::wup
digital_out_t wup
Definition: gnss13.h:152
gnss13_s::uart_tx_buffer
char uart_tx_buffer[GNSS13_DRV_TX_BUFFER_SIZE]
Definition: gnss13.h:160
gnss13_s::read_f
gnss13_master_io_t read_f
Definition: gnss13.h:166
gnss13_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss13.h:191
gnss13_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnss13.h:193
GNSS13_OK
@ GNSS13_OK
Definition: gnss13.h:206
gnss13_cfg_t
GNSS 13 Click configuration object.
Definition: gnss13.h:175
gnss13_init
err_t gnss13_init(gnss13_t *ctx, gnss13_cfg_t *cfg)
GNSS 13 initialization function.
gnss13_s::slave_address
uint8_t slave_address
Definition: gnss13.h:162
GNSS13_ERROR
@ GNSS13_ERROR
Definition: gnss13.h:207
GNSS13_DRV_SEL_I2C
@ GNSS13_DRV_SEL_I2C
Definition: gnss13.h:134
gnss13_cfg_t::drv_sel
gnss13_drv_t drv_sel
Definition: gnss13.h:196
GNSS13_DRV_RX_BUFFER_SIZE
#define GNSS13_DRV_RX_BUFFER_SIZE
Definition: gnss13.h:98
gnss13_master_io_t
err_t(* gnss13_master_io_t)(struct gnss13_s *, uint8_t *, uint8_t)
GNSS 13 Click driver interface.
Definition: gnss13.h:142
gnss13_s::uart
uart_t uart
Definition: gnss13.h:155
gnss13_cfg_t::scl
pin_name_t scl
Definition: gnss13.h:177
gnss13_cfg_t::sda
pin_name_t sda
Definition: gnss13.h:178
gnss13_generic_write
err_t gnss13_generic_write(gnss13_t *ctx, uint8_t *data_in, uint8_t len)
GNSS 13 generic write function.