gnss  2.0.0.0
gnss.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 GNSS_H
36 #define GNSS_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_uart.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define GNSS_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.fon = MIKROBUS( mikrobus, MIKROBUS_CS )
58 
64 #define GNSS_RETVAL uint8_t
65 
66 #define GNSS_OK 0x00
67 #define GNSS_INIT_ERROR 0xFF
68 
74 #define GNSS_NEMA_GPGGA 1
75 #define GNSS_NEMA_GPGLL 3
76 #define GNSS_NEMA_GPGGA_NUM_ELEMENT 15
77 #define GNSS_NEMA_GPGLL_NUM_ELEMENT 5
78 
84 #define GNSS_GPGGA_TIME 1
85 #define GNSS_GPGGA_LATITUDE 2
86 #define GNSS_GPGGA_LATITUDE_SIDE 3
87 #define GNSS_GPGGA_LONGITUDE 4
88 #define GNSS_GPGGA_LONGITUDE_SIDE 5
89 #define GNSS_GPGGA_QUALITY_INDICATOR 6
90 #define GNSS_GPGGA_NUMBER_OF_SATELLITES 7
91 #define GNSS_GPGGA_H_DILUTION_OF_POS 8
92 #define GNSS_GPGGA_ALTITUDE 9
93 #define GNSS_GPGGA_ALTITUDE_UNIT 10
94 #define GNSS_GPGGA_GEOIDAL_SEPARATION 11
95 #define GNSS_GPGGA_GEOIDAL_SEPARATION_UNIT 12
96 #define GNSS_GPGGA_TIME_SINCE_LAST_DGPS 13
97 #define GNSS_GPGGA_DGPS_REFERENCE_STATION_ID 14
98 
104 #define GNSS_GPGLL_LATITUDE 1
105 #define GNSS_GPGLL_LATITUDE_SIDE 2
106 #define GNSS_GPGLL_LONGITUDE 3
107 #define GNSS_GPGLL_LONGITUDE_SIDE 4
108 
114 #define GNSS_ERROR_COMMAND_OR_ELEMENT 0xFF
115 #define GNSS_ERROR_START_OR_END_COMMAND 0x8F
116 #define GNSS_ERROR_NEXT_ELEMENT 0x4F
117 #define GNSS_ERROR_CURRENT_ELEMENT 0x2F
118 #define GNSS_NO_ERROR 0x00
119 
125 #define DRV_RX_BUFFER_SIZE 500
126  // End group macro
129 // --------------------------------------------------------------- PUBLIC TYPES
137 typedef struct
138 {
139  // Output pins
140 
141  digital_out_t rst;
142  digital_out_t fon;
143 
144  // Modules
145 
146  uart_t uart;
147 
148  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
149  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
150 
151 } gnss_t;
152 
156 typedef struct
157 {
158  // Communication gpio pins
159 
160  pin_name_t rx_pin;
161  pin_name_t tx_pin;
162 
163  // Additional gpio pins
164 
165  pin_name_t rst;
166  pin_name_t fon;
167 
168  // static variable
169 
170  uint32_t baud_rate; // Clock speed.
172  uart_data_bits_t data_bit; // Data bits.
173  uart_parity_t parity_bit; // Parity bit.
174  uart_stop_bits_t stop_bit; // Stop bits.
175 
176 } gnss_cfg_t;
177 
181 typedef uint8_t gnss_error_t;
182  // End types group
184 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
185 
191 #ifdef __cplusplus
192 extern "C"{
193 #endif
194 
203 void gnss_cfg_setup ( gnss_cfg_t *cfg );
204 
212 GNSS_RETVAL gnss_init ( gnss_t *ctx, gnss_cfg_t *cfg );
213 
218 void gnss_module_wakeup ( gnss_t *ctx );
219 
225 void gnss_set_rst_pin ( gnss_t *ctx, uint8_t state );
226 
232 void gnss_set_fon_pin ( gnss_t *ctx, uint8_t state );
233 
240 void gnss_generic_write ( gnss_t *ctx, char *data_buf, uint16_t len );
241 
249 int32_t gnss_generic_read ( gnss_t *ctx, char *data_buf, uint16_t max_len );
250 
260 (
261  char *rsp, uint8_t command,
262  uint8_t element, char *parser_buf
263 );
264 
265 #ifdef __cplusplus
266 }
267 #endif
268 #endif // _GNSS_H_
269  // End public_function group
272 
273 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: gnss.h:125
gnss_generic_parser
gnss_error_t gnss_generic_parser(char *rsp, uint8_t command, uint8_t element, char *parser_buf)
Generic parser function.
gnss_t::rst
digital_out_t rst
Definition: gnss.h:141
gnss_t
Click ctx object definition.
Definition: gnss.h:137
gnss_set_fon_pin
void gnss_set_fon_pin(gnss_t *ctx, uint8_t state)
Set FON ( Force ON ) pin state.
gnss_error_t
uint8_t gnss_error_t
Error type.
Definition: gnss.h:181
gnss_t::uart
uart_t uart
Definition: gnss.h:146
gnss_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss.h:170
gnss_cfg_t
Click configuration structure definition.
Definition: gnss.h:156
gnss_cfg_t::rst
pin_name_t rst
Definition: gnss.h:165
gnss_generic_read
int32_t gnss_generic_read(gnss_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
gnss_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss.h:174
gnss_init
GNSS_RETVAL gnss_init(gnss_t *ctx, gnss_cfg_t *cfg)
Initialization function.
gnss_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss.h:160
GNSS_RETVAL
#define GNSS_RETVAL
Definition: gnss.h:64
gnss_generic_write
void gnss_generic_write(gnss_t *ctx, char *data_buf, uint16_t len)
Generic write function.
gnss_t::fon
digital_out_t fon
Definition: gnss.h:142
gnss_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss.h:161
gnss_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss.h:172
gnss_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss.h:171
gnss_set_rst_pin
void gnss_set_rst_pin(gnss_t *ctx, uint8_t state)
Set RST ( reset ) pin state.
gnss_cfg_setup
void gnss_cfg_setup(gnss_cfg_t *cfg)
Config Object Initialization function.
gnss_module_wakeup
void gnss_module_wakeup(gnss_t *ctx)
Wake-up or reset module.
gnss_cfg_t::fon
pin_name_t fon
Definition: gnss.h:166
gnss_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss.h:173