gnss7  2.0.0.0
gnss7.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 GNSS7_H
36 #define GNSS7_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 GNSS7_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
55  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
56  cfg.sel = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
58  cfg.exi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59  cfg.pls = MIKROBUS( mikrobus, MIKROBUS_INT )
60 
66 #define GNSS7_RETVAL uint8_t
67 
68 #define GNSS7_OK 0x00
69 #define GNSS7_INIT_ERROR 0xFF
70 
76 #define GNSS7_NEMA_GNGGA 1
77 #define GNSS7_NEMA_GNGLL 3
78 #define GNSS7_NEMA_GNGGA_NUM_ELEMENT 15
79 #define GNSS7_NEMA_GNGLL_NUM_ELEMENT 5
80 
86 #define GNSS7_GNGGA_TIME 1
87 #define GNSS7_GNGGA_LATITUDE 2
88 #define GNSS7_GNGGA_LATITUDE_SIDE 3
89 #define GNSS7_GNGGA_LONGITUDE 4
90 #define GNSS7_GNGGA_LONGITUDE_SIDE 5
91 #define GNSS7_GNGGA_QUALITY_INDICATOR 6
92 #define GNSS7_GNGGA_NUMBER_OF_SATELLITES 7
93 #define GNSS7_GNGGA_H_DILUTION_OF_POS 8
94 #define GNSS7_GNGGA_ALTITUDE 9
95 #define GNSS7_GNGGA_ALTITUDE_UNIT 10
96 #define GNSS7_GNGGA_GEOIDAL_SEPARATION 11
97 #define GNSS7_GNGGA_GEOIDAL_SEPARATION_UNIT 12
98 #define GNSS7_GNGGA_TIME_SINCE_LAST_DGPS 13
99 #define GNSS7_GNGGA_DGPS_REFERENCE_STATION_ID 14
100 
106 #define GNSS7_GNGLL_LATITUDE 1
107 #define GNSS7_GNGLL_LATITUDE_SIDE 2
108 #define GNSS7_GNGLL_LONGITUDE 3
109 #define GNSS7_GNGLL_LONGITUDE_SIDE 4
110 
116 #define GNSS7_ERROR_COMMAND_OR_ELEMENT 0xFF
117 #define GNSS7_ERROR_START_OR_END_COMMAND 0x8F
118 #define GNSS7_ERROR_NEXT_ELEMENT 0x4F
119 #define GNSS7_ERROR_CURRENT_ELEMENT 0x2F
120 #define GNSS7_NO_ERROR 0x00
121 
127 #define DRV_RX_BUFFER_SIZE 500
128  // End group macro
131 // --------------------------------------------------------------- PUBLIC TYPES
139 typedef struct
140 {
141  // Output pins
142 
143  digital_out_t sel;
144  digital_out_t rst;
145 
146  // Input pins
147 
148  digital_in_t exi;
149  digital_in_t pls;
150 
151  // Modules
152 
153  uart_t uart;
154 
155  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
156  char uart_tx_buffer[ DRV_RX_BUFFER_SIZE ];
157 
158 } gnss7_t;
159 
163 typedef struct
164 {
165  // Communication gpio pins
166 
167  pin_name_t rx_pin;
168  pin_name_t tx_pin;
169 
170  // Additional gpio pins
171 
172  pin_name_t sel;
173  pin_name_t rst;
174  pin_name_t exi;
175  pin_name_t pls;
176 
177  // static variable
178 
179  uint32_t baud_rate; // Clock speed.
181  uart_data_bits_t data_bit; // Data bits.
182  uart_parity_t parity_bit; // Parity bit.
183  uart_stop_bits_t stop_bit; // Stop bits.
184 
185 } gnss7_cfg_t;
186 
190 typedef uint8_t gnss7_error_t;
191  // End types group
193 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
194 
200 #ifdef __cplusplus
201 extern "C"{
202 #endif
203 
212 void gnss7_cfg_setup ( gnss7_cfg_t *cfg );
213 
222 
227 void gnss7_module_wakeup ( gnss7_t *ctx );
228 
234 uint8_t gnss7_get_exi_pin ( gnss7_t *ctx );
235 
241 void gnss7_set_rst_pin ( gnss7_t *ctx, uint8_t state );
242 
248 void gnss7_set_sel_pin ( gnss7_t *ctx, uint8_t state );
249 
255 uint8_t gnss7_get_pls_pin ( gnss7_t *ctx );
256 
263 void gnss7_generic_write ( gnss7_t *ctx, char *data_buf, uint16_t len );
264 
272 int32_t gnss7_generic_read ( gnss7_t *ctx, char *data_buf, uint16_t max_len );
273 
283 (
284  char *rsp, uint8_t command,
285  uint8_t element, char *parser_buf
286 );
287 
288 #ifdef __cplusplus
289 }
290 #endif
291 #endif // _GNSS7_H_
292  // End public_function group
295 
296 // ------------------------------------------------------------------------- END
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
Definition: gnss7.h:127
gnss7_cfg_t::exi
pin_name_t exi
Definition: gnss7.h:174
gnss7_t::rst
digital_out_t rst
Definition: gnss7.h:144
gnss7_cfg_t::pls
pin_name_t pls
Definition: gnss7.h:175
gnss7_init
GNSS7_RETVAL gnss7_init(gnss7_t *ctx, gnss7_cfg_t *cfg)
Initialization function.
gnss7_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnss7.h:183
gnss7_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnss7.h:182
gnss7_get_pls_pin
uint8_t gnss7_get_pls_pin(gnss7_t *ctx)
Get PLS pin state.
gnss7_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnss7.h:181
gnss7_t
Click ctx object definition.
Definition: gnss7.h:139
gnss7_error_t
uint8_t gnss7_error_t
Error type.
Definition: gnss7.h:190
gnss7_generic_read
int32_t gnss7_generic_read(gnss7_t *ctx, char *data_buf, uint16_t max_len)
Generic read function.
gnss7_t::pls
digital_in_t pls
Definition: gnss7.h:149
gnss7_t::exi
digital_in_t exi
Definition: gnss7.h:148
gnss7_t::uart
uart_t uart
Definition: gnss7.h:153
gnss7_get_exi_pin
uint8_t gnss7_get_exi_pin(gnss7_t *ctx)
Get EXI ( external interrupt ) pin state.
gnss7_module_wakeup
void gnss7_module_wakeup(gnss7_t *ctx)
Wake-up module.
gnss7_t::sel
digital_out_t sel
Definition: gnss7.h:143
gnss7_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnss7.h:168
gnss7_cfg_t::uart_blocking
bool uart_blocking
Definition: gnss7.h:180
gnss7_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnss7.h:179
gnss7_cfg_setup
void gnss7_cfg_setup(gnss7_cfg_t *cfg)
Config Object Initialization function.
GNSS7_RETVAL
#define GNSS7_RETVAL
Definition: gnss7.h:66
gnss7_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnss7.h:167
gnss7_cfg_t::sel
pin_name_t sel
Definition: gnss7.h:172
gnss7_generic_parser
gnss7_error_t gnss7_generic_parser(char *rsp, uint8_t command, uint8_t element, char *parser_buf)
Generic parser function.
gnss7_cfg_t
Click configuration structure definition.
Definition: gnss7.h:163
gnss7_set_sel_pin
void gnss7_set_sel_pin(gnss7_t *ctx, uint8_t state)
Set SEL ( mode select ) pin state.
gnss7_set_rst_pin
void gnss7_set_rst_pin(gnss7_t *ctx, uint8_t state)
Set RST ( reset ) pin state.
gnss7_cfg_t::rst
pin_name_t rst
Definition: gnss7.h:173
gnss7_generic_write
void gnss7_generic_write(gnss7_t *ctx, char *data_buf, uint16_t len)
Generic write function.