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
32 extern "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_i2c_master.h"
52 #include "drv_uart.h"
53 
74 #define GNSS18_RSP_START "$"
75 #define GNSS18_RSP_DELIMITER ","
76 #define GNSS18_RSP_END_SEQ "\r\n"
77 #define GNSS18_RSP_GPGGA "$GNGGA"
78 #define GNSS18_RSP_NO_FIX ""
79 
84 #define GNSS18_GPGGA_ELEMENT_SIZE 15
85 #define GNSS18_GPGGA_TIME 1
86 #define GNSS18_GPGGA_LATITUDE 2
87 #define GNSS18_GPGGA_LATITUDE_SIDE 3
88 #define GNSS18_GPGGA_LONGITUDE 4
89 #define GNSS18_GPGGA_LONGITUDE_SIDE 5
90 #define GNSS18_GPGGA_QUALITY_INDICATOR 6
91 #define GNSS18_GPGGA_NUMBER_OF_SATELLITES 7
92 #define GNSS18_GPGGA_H_DILUTION_OF_POS 8
93 #define GNSS18_GPGGA_ALTITUDE 9
94 #define GNSS18_GPGGA_ALTITUDE_UNIT 10
95 #define GNSS18_GPGGA_GEOIDAL_SEPARATION 11
96 #define GNSS18_GPGGA_GEOIDAL_SEPARATION_UNIT 12
97 #define GNSS18_GPGGA_TIME_SINCE_LAST_DGPS 13
98 #define GNSS18_GPGGA_DGPS_REFERENCE_STATION_ID 14
99 
104 #define GNSS18_DUMMY 0xFF
105 
111 #define GNSS18_DEVICE_ADDRESS 0x42
112 
118 #define GNSS18_DRV_TX_BUFFER_SIZE 100
119 #define GNSS18_DRV_RX_BUFFER_SIZE 500
120  // gnss18_cmd
122 
137 #define GNSS18_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.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
144  // gnss18_map // gnss18
147 
152 typedef enum
153 {
158 
163 typedef err_t ( *gnss18_master_io_t )( struct gnss18_s*, uint8_t*, uint8_t );
169 typedef struct gnss18_s
170 {
171  // Output pins
172  digital_out_t rst;
174  // Input pins
175  digital_in_t int_pin;
177  // Modules
178  i2c_master_t i2c;
179  uart_t uart;
181  // Buffers
185  uint8_t slave_address;
192 
197 typedef struct
198 {
199  // Communication gpio pins
200  pin_name_t scl;
201  pin_name_t sda;
202  pin_name_t rx_pin;
203  pin_name_t tx_pin;
205  // Additional gpio pins
206  pin_name_t rst;
207  pin_name_t int_pin;
209  // Static variable
210  uint32_t baud_rate;
212  uart_data_bits_t data_bit;
213  uart_parity_t parity_bit;
214  uart_stop_bits_t stop_bit;
217  uint32_t i2c_speed;
218  uint8_t i2c_address;
222 } gnss18_cfg_t;
223 
228 typedef enum
229 {
231  GNSS18_ERROR = -1
232 
234 
251 
267 
281 err_t gnss18_init ( gnss18_t *ctx, gnss18_cfg_t *cfg );
282 
295 err_t gnss18_generic_write ( gnss18_t *ctx, uint8_t *data_in, uint8_t len );
296 
309 err_t gnss18_generic_read ( gnss18_t *ctx, uint8_t *data_out, uint8_t len );
310 
320 void gnss18_set_rst_pin ( gnss18_t *ctx, uint8_t state );
321 
330 uint8_t gnss18_get_int_pin ( gnss18_t *ctx );
331 
341 
353 err_t gnss18_parse_gpgga ( uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data );
354 
355 #ifdef __cplusplus
356 }
357 #endif
358 #endif // GNSS18_H
359  // gnss18
361 
362 // ------------------------------------------------------------------------ END
gnss18_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss18.h:214
gnss18_cfg_t::drv_sel
gnss18_drv_t drv_sel
Definition: gnss18.h:220
gnss18_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnss18.h:217
gnss18_init
err_t gnss18_init(gnss18_t *ctx, gnss18_cfg_t *cfg)
GNSS 18 initialization function.
gnss18_get_int_pin
uint8_t gnss18_get_int_pin(gnss18_t *ctx)
GNSS 18 get INT pin function.
gnss18_drv_t
gnss18_drv_t
GNSS 18 Click driver selector.
Definition: gnss18.h:153
GNSS18_ERROR
@ GNSS18_ERROR
Definition: gnss18.h:231
gnss18_generic_read
err_t gnss18_generic_read(gnss18_t *ctx, uint8_t *data_out, uint8_t len)
GNSS 18 data reading function.
gnss18_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss18.h:213
gnss18_cfg_t::sda
pin_name_t sda
Definition: gnss18.h:201
GNSS18_DRV_TX_BUFFER_SIZE
#define GNSS18_DRV_TX_BUFFER_SIZE
GNSS 18 driver buffer size.
Definition: gnss18.h:118
gnss18_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss18.h:210
gnss18_s::i2c
i2c_master_t i2c
Definition: gnss18.h:178
GNSS18_OK
@ GNSS18_OK
Definition: gnss18.h:230
gnss18_drv_interface_selection
void gnss18_drv_interface_selection(gnss18_cfg_t *cfg, gnss18_drv_t drv_sel)
GNSS 18 driver interface setup function.
gnss18_s::uart_tx_buffer
uint8_t uart_tx_buffer[GNSS18_DRV_TX_BUFFER_SIZE]
Definition: gnss18.h:183
gnss18_s::rst
digital_out_t rst
Definition: gnss18.h:172
gnss18_cfg_t::int_pin
pin_name_t int_pin
Definition: gnss18.h:207
GNSS18_DRV_SEL_UART
@ GNSS18_DRV_SEL_UART
Definition: gnss18.h:154
gnss18_generic_write
err_t gnss18_generic_write(gnss18_t *ctx, uint8_t *data_in, uint8_t len)
GNSS 18 data writing function.
gnss18_s::drv_sel
gnss18_drv_t drv_sel
Definition: gnss18.h:186
gnss18_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss18.h:202
gnss18_t
struct gnss18_s gnss18_t
GNSS 18 Click context object.
gnss18_reset_device
void gnss18_reset_device(gnss18_t *ctx)
GNSS 18 reset device function.
gnss18_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss18.h:212
gnss18_set_rst_pin
void gnss18_set_rst_pin(gnss18_t *ctx, uint8_t state)
GNSS 18 set RST pin function.
gnss18_s::int_pin
digital_in_t int_pin
Definition: gnss18.h:175
gnss18_cfg_t
GNSS 18 Click configuration object.
Definition: gnss18.h:198
gnss18_s::uart
uart_t uart
Definition: gnss18.h:179
gnss18_cfg_t::scl
pin_name_t scl
Definition: gnss18.h:200
gnss18_s::write_f
gnss18_master_io_t write_f
Definition: gnss18.h:188
gnss18_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnss18.h:218
gnss18_s::slave_address
uint8_t slave_address
Definition: gnss18.h:185
gnss18_return_value_t
gnss18_return_value_t
GNSS 18 Click return value data.
Definition: gnss18.h:229
gnss18_s::uart_rx_buffer
uint8_t uart_rx_buffer[GNSS18_DRV_RX_BUFFER_SIZE]
Definition: gnss18.h:182
gnss18_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss18.h:211
gnss18_parse_gpgga
err_t gnss18_parse_gpgga(uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data)
GNSS 18 parse GPGGA function.
gnss18_s::read_f
gnss18_master_io_t read_f
Definition: gnss18.h:189
gnss18_cfg_setup
void gnss18_cfg_setup(gnss18_cfg_t *cfg)
GNSS 18 configuration object setup function.
GNSS18_DRV_RX_BUFFER_SIZE
#define GNSS18_DRV_RX_BUFFER_SIZE
Definition: gnss18.h:119
gnss18_master_io_t
err_t(* gnss18_master_io_t)(struct gnss18_s *, uint8_t *, uint8_t)
GNSS 18 Click driver interface.
Definition: gnss18.h:163
gnss18_s
GNSS 18 Click context object.
Definition: gnss18.h:170
gnss18_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss18.h:203
GNSS18_DRV_SEL_I2C
@ GNSS18_DRV_SEL_I2C
Definition: gnss18.h:155
gnss18_cfg_t::rst
pin_name_t rst
Definition: gnss18.h:206