gnss3  2.0.0.0
gnss3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef GNSS3_H
36 #define GNSS3_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_uart.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define GNSS3_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
65  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
66  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
67  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_CS )
68 
74 #define GNSS3_RSP_START "$"
75 #define GNSS3_RSP_DELIMITER ","
76 #define GNSS3_RSP_GNGGA "$GNGGA"
77 
82 #define GNSS3_GNGGA_ELEMENT_SIZE 15
83 #define GNSS3_GNGGA_TIME 1
84 #define GNSS3_GNGGA_LATITUDE 2
85 #define GNSS3_GNGGA_LATITUDE_SIDE 3
86 #define GNSS3_GNGGA_LONGITUDE 4
87 #define GNSS3_GNGGA_LONGITUDE_SIDE 5
88 #define GNSS3_GNGGA_QUALITY_INDICATOR 6
89 #define GNSS3_GNGGA_NUMBER_OF_SATELLITES 7
90 #define GNSS3_GNGGA_H_DILUTION_OF_POS 8
91 #define GNSS3_GNGGA_ALTITUDE 9
92 #define GNSS3_GNGGA_ALTITUDE_UNIT 10
93 #define GNSS3_GNGGA_GEOIDAL_SEPARATION 11
94 #define GNSS3_GNGGA_GEOIDAL_SEPARATION_UNIT 12
95 #define GNSS3_GNGGA_TIME_SINCE_LAST_DGPS 13
96 #define GNSS3_GNGGA_DGPS_REFERENCE_STATION_ID 14
97 
102 #define GNSS3_DRV_RX_BUFFER_SIZE 500
103  // End group macro
106 // --------------------------------------------------------------- PUBLIC TYPES
114 typedef struct
115 {
116  digital_out_t rst;
117  digital_in_t int_pin;
118 
119  uart_t uart;
120 
121  char uart_rx_buffer[ GNSS3_DRV_RX_BUFFER_SIZE ];
122  char uart_tx_buffer[ GNSS3_DRV_RX_BUFFER_SIZE ];
123 
124 } gnss3_t;
125 
129 typedef struct
130 {
131  // Communication gpio pins
132  pin_name_t rx_pin;
133  pin_name_t tx_pin;
134 
135  // Additional gpio pins
136  pin_name_t rst;
137  pin_name_t int_pin;
138 
139  // static variable
140  uint32_t baud_rate; // Clock speed.
142  uart_data_bits_t data_bit; // Data bits.
143  uart_parity_t parity_bit; // Parity bit.
144  uart_stop_bits_t stop_bit; // Stop bits.
145 
146 } gnss3_cfg_t;
147 
152 typedef enum
153 {
154  GNSS3_OK = 0,
155  GNSS3_ERROR = -1
156 
158  // End types group
160 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
161 
167 #ifdef __cplusplus
168 extern "C"{
169 #endif
170 
180 
188 err_t gnss3_init ( gnss3_t *ctx, gnss3_cfg_t *cfg );
189 
195 
201 void gnss3_set_rst_pin ( gnss3_t *ctx, uint8_t state );
202 
208 uint8_t gnss3_get_int_pin ( gnss3_t *ctx );
209 
216 void gnss3_generic_write ( gnss3_t *ctx, char *data_buf, uint16_t len );
217 
225 int32_t gnss3_generic_read ( gnss3_t *ctx, char *data_buf, uint16_t max_len );
226 
238 err_t gnss3_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 #endif // _GNSS3_H_
244  // End public_function group
247 
248 // ------------------------------------------------------------------------- END
gnss3_cfg_t::rst
pin_name_t rst
Definition: gnss3.h:136
gnss3_get_int_pin
uint8_t gnss3_get_int_pin(gnss3_t *ctx)
Get PPS pin state.
gnss3_return_value_t
gnss3_return_value_t
GNSS 3 Click return value data.
Definition: gnss3.h:153
gnss3_t::rst
digital_out_t rst
Definition: gnss3.h:116
gnss3_init
err_t gnss3_init(gnss3_t *ctx, gnss3_cfg_t *cfg)
Initialization function.
gnss3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss3.h:133
gnss3_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss3.h:140
gnss3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss3.h:144
gnss3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss3.h:143
gnss3_t
Click ctx object definition.
Definition: gnss3.h:115
gnss3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss3.h:142
GNSS3_OK
@ GNSS3_OK
Definition: gnss3.h:154
gnss3_module_wakeup
void gnss3_module_wakeup(gnss3_t *ctx)
Wake-up module.
GNSS3_ERROR
@ GNSS3_ERROR
Definition: gnss3.h:155
gnss3_generic_read
int32_t gnss3_generic_read(gnss3_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
gnss3_generic_write
void gnss3_generic_write(gnss3_t *ctx, char *data_buf, uint16_t len)
Generic write function.
GNSS3_DRV_RX_BUFFER_SIZE
#define GNSS3_DRV_RX_BUFFER_SIZE
Definition: gnss3.h:102
gnss3_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss3.h:141
gnss3_t::int_pin
digital_in_t int_pin
Definition: gnss3.h:117
gnss3_cfg_t
Click configuration structure definition.
Definition: gnss3.h:130
gnss3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss3.h:132
gnss3_t::uart
uart_t uart
Definition: gnss3.h:119
gnss3_cfg_t::int_pin
pin_name_t int_pin
Definition: gnss3.h:137
gnss3_cfg_setup
void gnss3_cfg_setup(gnss3_cfg_t *cfg)
Config Object Initialization function.
gnss3_parse_gngga
err_t gnss3_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GNSS 3 parse GNGGA function.
gnss3_set_rst_pin
void gnss3_set_rst_pin(gnss3_t *ctx, uint8_t state)
Set RST ( reset ) pin state.