gnss14  2.1.0.0
gnss14.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 GNSS14_H
29 #define GNSS14_H
30 
31 #ifdef __cplusplus
32 extern "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_uart.h"
48 #include "drv_i2c_master.h"
49 
70 #define GNSS14_RSP_START "$"
71 #define GNSS14_RSP_DELIMITER ","
72 #define GNSS14_RSP_GNGGA "$GNGGA"
73 
78 #define GNSS14_GNGGA_ELEMENT_SIZE 15
79 #define GNSS14_GNGGA_TIME 1
80 #define GNSS14_GNGGA_LATITUDE 2
81 #define GNSS14_GNGGA_LATITUDE_SIDE 3
82 #define GNSS14_GNGGA_LONGITUDE 4
83 #define GNSS14_GNGGA_LONGITUDE_SIDE 5
84 #define GNSS14_GNGGA_QUALITY_INDICATOR 6
85 #define GNSS14_GNGGA_NUMBER_OF_SATELLITES 7
86 #define GNSS14_GNGGA_H_DILUTION_OF_POS 8
87 #define GNSS14_GNGGA_ALTITUDE 9
88 #define GNSS14_GNGGA_ALTITUDE_UNIT 10
89 #define GNSS14_GNGGA_GEOIDAL_SEPARATION 11
90 #define GNSS14_GNGGA_GEOIDAL_SEPARATION_UNIT 12
91 #define GNSS14_GNGGA_TIME_SINCE_LAST_DGPS 13
92 #define GNSS14_GNGGA_DGPS_REFERENCE_STATION_ID 14
93 
98 #define GNSS14_DUMMY 0xFF
99 
105 #define GNSS14_SET_DEV_ADDR 0x42
106 
112 #define GNSS14_DRV_BUFFER_SIZE 200
113  // gnss14_set
115 
130 #define GNSS14_MAP_MIKROBUS( cfg, mikrobus ) \
131  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
132  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
133  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
134  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
135  cfg.io6 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
136  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
137  cfg.eit = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
138  cfg.tp = MIKROBUS( mikrobus, MIKROBUS_INT )
139  // gnss14_map // gnss14
142 
147 typedef enum
148 {
153 
158 typedef err_t ( *gnss14_master_io_t )( struct gnss14_s*, uint8_t*, uint8_t );
164 typedef struct gnss14_s
165 {
166  // Output pins
167  digital_out_t io6;
168  digital_out_t rst;
170  // Input pins
171  digital_in_t eit;
172  digital_in_t tp;
174  // Modules
175  i2c_master_t i2c;
176  uart_t uart;
178  // Buffers
182  uint8_t slave_address;
183  pin_name_t chip_select;
190 
195 typedef struct
196 {
197  // Communication gpio pins
198  pin_name_t scl;
199  pin_name_t sda;
200  pin_name_t rx_pin;
201  pin_name_t tx_pin;
203  // Additional gpio pins
204  pin_name_t io6;
205  pin_name_t rst;
206  pin_name_t eit;
207  pin_name_t tp;
209  uint32_t i2c_speed;
210  uint8_t i2c_address;
212  // Static variable
213  uint32_t baud_rate;
215  uart_data_bits_t data_bit;
216  uart_parity_t parity_bit;
217  uart_stop_bits_t stop_bit;
221 } gnss14_cfg_t;
222 
227 typedef enum
228 {
230  GNSS14_ERROR = -1
231 
233 
250 
264 err_t gnss14_init ( gnss14_t *ctx, gnss14_cfg_t *cfg );
265 
278 err_t gnss14_generic_write ( gnss14_t *ctx, uint8_t *data_in, uint16_t len );
279 
292 err_t gnss14_generic_read ( gnss14_t *ctx, uint8_t *data_out, uint16_t len );
293 
302 void gnss14_set_io6_pin ( gnss14_t *ctx, uint8_t state );
303 
312 void gnss14_set_rst_pin ( gnss14_t *ctx, uint8_t state );
313 
322 uint8_t gnss14_get_eit_pin ( gnss14_t *ctx );
323 
332 uint8_t gnss14_get_tp_pin ( gnss14_t *ctx );
333 
343 
355 err_t gnss14_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
356 
357 #ifdef __cplusplus
358 }
359 #endif
360 #endif // GNSS14_H
361  // gnss14
363 
364 // ------------------------------------------------------------------------ END
gnss14_init
err_t gnss14_init(gnss14_t *ctx, gnss14_cfg_t *cfg)
GNSS 14 initialization function.
gnss14_s::i2c
i2c_master_t i2c
Definition: gnss14.h:175
gnss14_s::drv_sel
gnss14_drv_t drv_sel
Definition: gnss14.h:184
gnss14_get_tp_pin
uint8_t gnss14_get_tp_pin(gnss14_t *ctx)
GNSS 14 get time pulse signal pin state function.
GNSS14_DRV_SEL_UART
@ GNSS14_DRV_SEL_UART
Definition: gnss14.h:149
GNSS14_OK
@ GNSS14_OK
Definition: gnss14.h:229
gnss14_return_value_t
gnss14_return_value_t
GNSS 14 Click return value data.
Definition: gnss14.h:228
gnss14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnss14.h:209
GNSS14_DRV_BUFFER_SIZE
#define GNSS14_DRV_BUFFER_SIZE
GNSS 14 driver buffer size.
Definition: gnss14.h:112
gnss14_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss14.h:213
gnss14_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss14.h:216
gnss14_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss14.h:214
gnss14_s::read_f
gnss14_master_io_t read_f
Definition: gnss14.h:187
gnss14_s::io6
digital_out_t io6
Definition: gnss14.h:167
gnss14_s
GNSS 14 Click context object.
Definition: gnss14.h:165
gnss14_s::eit
digital_in_t eit
Definition: gnss14.h:171
gnss14_cfg_t::scl
pin_name_t scl
Definition: gnss14.h:198
gnss14_master_io_t
err_t(* gnss14_master_io_t)(struct gnss14_s *, uint8_t *, uint8_t)
GNSS 14 Click driver interface.
Definition: gnss14.h:158
gnss14_parse_gngga
err_t gnss14_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GNSS 14 parse GNGGA function.
gnss14_cfg_t::tp
pin_name_t tp
Definition: gnss14.h:207
gnss14_drv_t
gnss14_drv_t
GNSS 14 Click driver selector.
Definition: gnss14.h:148
gnss14_get_eit_pin
uint8_t gnss14_get_eit_pin(gnss14_t *ctx)
GNSS 14 get external interrupt pin state function.
gnss14_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss14.h:200
gnss14_reset_device
void gnss14_reset_device(gnss14_t *ctx)
GNSS 14 reset device function.
gnss14_cfg_t::drv_sel
gnss14_drv_t drv_sel
Definition: gnss14.h:219
gnss14_s::uart_rx_buffer
uint8_t uart_rx_buffer[GNSS14_DRV_BUFFER_SIZE]
Definition: gnss14.h:179
gnss14_s::uart
uart_t uart
Definition: gnss14.h:176
gnss14_s::chip_select
pin_name_t chip_select
Definition: gnss14.h:183
GNSS14_ERROR
@ GNSS14_ERROR
Definition: gnss14.h:230
gnss14_cfg_t::rst
pin_name_t rst
Definition: gnss14.h:205
gnss14_generic_read
err_t gnss14_generic_read(gnss14_t *ctx, uint8_t *data_out, uint16_t len)
GNSS 14 data reading function.
gnss14_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss14.h:215
gnss14_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss14.h:217
gnss14_t
struct gnss14_s gnss14_t
GNSS 14 Click context object.
GNSS14_DRV_SEL_I2C
@ GNSS14_DRV_SEL_I2C
Definition: gnss14.h:150
gnss14_s::write_f
gnss14_master_io_t write_f
Definition: gnss14.h:186
gnss14_cfg_t::sda
pin_name_t sda
Definition: gnss14.h:199
gnss14_set_io6_pin
void gnss14_set_io6_pin(gnss14_t *ctx, uint8_t state)
GNSS 14 set IO6 pin function.
gnss14_cfg_t::io6
pin_name_t io6
Definition: gnss14.h:204
gnss14_cfg_t
GNSS 14 Click configuration object.
Definition: gnss14.h:196
gnss14_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnss14.h:210
gnss14_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss14.h:201
gnss14_cfg_setup
void gnss14_cfg_setup(gnss14_cfg_t *cfg)
GNSS 14 configuration object setup function.
gnss14_s::uart_tx_buffer
uint8_t uart_tx_buffer[GNSS14_DRV_BUFFER_SIZE]
Definition: gnss14.h:180
gnss14_s::rst
digital_out_t rst
Definition: gnss14.h:168
gnss14_generic_write
err_t gnss14_generic_write(gnss14_t *ctx, uint8_t *data_in, uint16_t len)
GNSS 14 data writing function.
gnss14_s::slave_address
uint8_t slave_address
Definition: gnss14.h:182
gnss14_cfg_t::eit
pin_name_t eit
Definition: gnss14.h:206
gnss14_s::tp
digital_in_t tp
Definition: gnss14.h:172
gnss14_set_rst_pin
void gnss14_set_rst_pin(gnss14_t *ctx, uint8_t state)
GNSS 14 set RST pin function.