gnssmax2  2.1.0.0
gnssmax2.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 GNSSMAX2_H
29 #define GNSSMAX2_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_uart.h"
52 #include "drv_i2c_master.h"
53 
74 #define GNSSMAX2_RSP_START "$"
75 #define GNSSMAX2_RSP_DELIMITER ","
76 #define GNSSMAX2_RSP_END "\r\n"
77 #define GNSSMAX2_RSP_GGA "GGA"
78 
83 #define GNSSMAX2_GGA_ELEMENT_SIZE 15
84 #define GNSSMAX2_GGA_TIME 1
85 #define GNSSMAX2_GGA_LATITUDE 2
86 #define GNSSMAX2_GGA_LATITUDE_SIDE 3
87 #define GNSSMAX2_GGA_LONGITUDE 4
88 #define GNSSMAX2_GGA_LONGITUDE_SIDE 5
89 #define GNSSMAX2_GGA_QUALITY_INDICATOR 6
90 #define GNSSMAX2_GGA_NUMBER_OF_SATELLITES 7
91 #define GNSSMAX2_GGA_H_DILUTION_OF_POS 8
92 #define GNSSMAX2_GGA_ALTITUDE 9
93 #define GNSSMAX2_GGA_ALTITUDE_UNIT 10
94 #define GNSSMAX2_GGA_GEOIDAL_SEPARATION 11
95 #define GNSSMAX2_GGA_GEOIDAL_SEPARATION_UNIT 12
96 #define GNSSMAX2_GGA_TIME_SINCE_LAST_DGPS 13
97 #define GNSSMAX2_GGA_DGPS_REFERENCE_STATION_ID 14
98 
103 #define GNSSMAX2_DUMMY 0xFF
104 
110 #define GNSSMAX2_TX_DRV_BUFFER_SIZE 100
111 #define GNSSMAX2_RX_DRV_BUFFER_SIZE 1000
112 
118 #define GNSSMAX2_DEVICE_ADDRESS 0x42
119  // gnssmax2_cmd
121 
136 #define GNSSMAX2_MAP_MIKROBUS( cfg, mikrobus ) \
137  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
138  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
139  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
140  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
141  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
142  cfg.exi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
143  cfg.pps = MIKROBUS( mikrobus, MIKROBUS_INT );
144  // gnssmax2_map // gnssmax2
147 
152 typedef enum
153 {
158 
163 struct gnssmax2_s;
164 typedef err_t ( *gnssmax2_master_io_t )( struct gnssmax2_s*, uint8_t*, uint16_t );
170 typedef struct gnssmax2_s
171 {
172  // Output pins
173  digital_out_t rst;
174  digital_out_t exi;
176  // Input pins
177  digital_in_t pps;
179  // Modules
180  uart_t uart;
181  i2c_master_t i2c;
183  // Buffers
187  uint8_t slave_address;
194 
199 typedef struct
200 {
201  // Communication gpio pins
202  pin_name_t scl;
203  pin_name_t sda;
204  pin_name_t rx_pin;
205  pin_name_t tx_pin;
207  // Additional gpio pins
208  pin_name_t rst;
209  pin_name_t exi;
210  pin_name_t pps;
212  uint32_t i2c_speed;
213  uint8_t i2c_address;
215  // Static variable
216  uint32_t baud_rate;
218  uart_data_bits_t data_bit;
219  uart_parity_t parity_bit;
220  uart_stop_bits_t stop_bit;
225 
230 typedef enum
231 {
233  GNSSMAX2_ERROR = -1
234 
236 
253 
269 
284 
297 err_t gnssmax2_generic_write ( gnssmax2_t *ctx, uint8_t *data_in, uint16_t len );
298 
311 err_t gnssmax2_generic_read ( gnssmax2_t *ctx, uint8_t *data_out, uint16_t len );
312 
322 
332 void gnssmax2_set_exi_pin ( gnssmax2_t *ctx, uint8_t state );
333 
343 void gnssmax2_set_rst_pin ( gnssmax2_t *ctx, uint8_t state );
344 
354 
366 err_t gnssmax2_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
367 
368 #ifdef __cplusplus
369 }
370 #endif
371 #endif // GNSSMAX2_H
372  // gnssmax2
374 
375 // ------------------------------------------------------------------------ END
gnssmax2_s::pps
digital_in_t pps
Definition: gnssmax2.h:177
gnssmax2_drv_t
gnssmax2_drv_t
GNSS MAX 2 Click driver selector.
Definition: gnssmax2.h:153
gnssmax2_set_exi_pin
void gnssmax2_set_exi_pin(gnssmax2_t *ctx, uint8_t state)
GNSS MAX 2 set EXI pin function.
gnssmax2_s::exi
digital_out_t exi
Definition: gnssmax2.h:174
gnssmax2_s::i2c
i2c_master_t i2c
Definition: gnssmax2.h:181
gnssmax2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnssmax2.h:212
gnssmax2_set_rst_pin
void gnssmax2_set_rst_pin(gnssmax2_t *ctx, uint8_t state)
GNSS MAX 2 set RST pin function.
gnssmax2_s
GNSS MAX 2 Click context object.
Definition: gnssmax2.h:171
gnssmax2_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnssmax2.h:205
gnssmax2_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnssmax2.h:204
GNSSMAX2_OK
@ GNSSMAX2_OK
Definition: gnssmax2.h:232
gnssmax2_s::uart
uart_t uart
Definition: gnssmax2.h:180
GNSSMAX2_ERROR
@ GNSSMAX2_ERROR
Definition: gnssmax2.h:233
gnssmax2_cfg_t::sda
pin_name_t sda
Definition: gnssmax2.h:203
gnssmax2_cfg_t::scl
pin_name_t scl
Definition: gnssmax2.h:202
gnssmax2_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnssmax2.h:216
gnssmax2_cfg_t::uart_blocking
bool uart_blocking
Definition: gnssmax2.h:217
gnssmax2_master_io_t
err_t(* gnssmax2_master_io_t)(struct gnssmax2_s *, uint8_t *, uint16_t)
Definition: gnssmax2.h:164
gnssmax2_s::read_f
gnssmax2_master_io_t read_f
Definition: gnssmax2.h:191
gnssmax2_parse_gga
err_t gnssmax2_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
GNSS MAX 2 parse GGA function.
gnssmax2_cfg_t::pps
pin_name_t pps
Definition: gnssmax2.h:210
gnssmax2_s::write_f
gnssmax2_master_io_t write_f
Definition: gnssmax2.h:190
gnssmax2_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnssmax2.h:213
gnssmax2_cfg_t::rst
pin_name_t rst
Definition: gnssmax2.h:208
gnssmax2_cfg_t
GNSS MAX 2 Click configuration object.
Definition: gnssmax2.h:200
gnssmax2_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnssmax2.h:219
gnssmax2_cfg_setup
void gnssmax2_cfg_setup(gnssmax2_cfg_t *cfg)
GNSS MAX 2 configuration object setup function.
gnssmax2_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnssmax2.h:220
gnssmax2_drv_interface_sel
void gnssmax2_drv_interface_sel(gnssmax2_cfg_t *cfg, gnssmax2_drv_t drv_sel)
GNSS MAX 2 driver interface setup function.
gnssmax2_s::slave_address
uint8_t slave_address
Definition: gnssmax2.h:187
gnssmax2_cfg_t::exi
pin_name_t exi
Definition: gnssmax2.h:209
gnssmax2_reset_device
void gnssmax2_reset_device(gnssmax2_t *ctx)
GNSS MAX 2 reset device function.
gnssmax2_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnssmax2.h:218
gnssmax2_s::uart_tx_buffer
uint8_t uart_tx_buffer[GNSSMAX2_TX_DRV_BUFFER_SIZE]
Definition: gnssmax2.h:185
gnssmax2_return_value_t
gnssmax2_return_value_t
GNSS MAX 2 Click return value data.
Definition: gnssmax2.h:231
gnssmax2_get_pps_pin
uint8_t gnssmax2_get_pps_pin(gnssmax2_t *ctx)
GNSS MAX 2 get PPS pin function.
gnssmax2_generic_read
err_t gnssmax2_generic_read(gnssmax2_t *ctx, uint8_t *data_out, uint16_t len)
GNSS MAX 2 data reading function.
GNSSMAX2_DRV_SEL_UART
@ GNSSMAX2_DRV_SEL_UART
Definition: gnssmax2.h:154
gnssmax2_t
struct gnssmax2_s gnssmax2_t
GNSS MAX 2 Click context object.
gnssmax2_init
err_t gnssmax2_init(gnssmax2_t *ctx, gnssmax2_cfg_t *cfg)
GNSS MAX 2 initialization function.
gnssmax2_s::drv_sel
gnssmax2_drv_t drv_sel
Definition: gnssmax2.h:188
gnssmax2_cfg_t::drv_sel
gnssmax2_drv_t drv_sel
Definition: gnssmax2.h:222
gnssmax2_s::uart_rx_buffer
uint8_t uart_rx_buffer[GNSSMAX2_RX_DRV_BUFFER_SIZE]
Definition: gnssmax2.h:184
gnssmax2_generic_write
err_t gnssmax2_generic_write(gnssmax2_t *ctx, uint8_t *data_in, uint16_t len)
GNSS MAX 2 data writing function.
GNSSMAX2_RX_DRV_BUFFER_SIZE
#define GNSSMAX2_RX_DRV_BUFFER_SIZE
Definition: gnssmax2.h:111
gnssmax2_s::rst
digital_out_t rst
Definition: gnssmax2.h:173
GNSSMAX2_DRV_SEL_I2C
@ GNSSMAX2_DRV_SEL_I2C
Definition: gnssmax2.h:155
GNSSMAX2_TX_DRV_BUFFER_SIZE
#define GNSSMAX2_TX_DRV_BUFFER_SIZE
GNSS MAX 2 driver buffer size.
Definition: gnssmax2.h:110