nanogps3  2.1.0.0
nanogps3.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 NANOGPS3_H
29 #define NANOGPS3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 #include "drv_uart.h"
39  // nanogps3_reg
63 
84 #define NANOGPS3_RSP_START "$"
85 #define NANOGPS3_RSP_DELIMITER ","
86 #define NANOGPS3_CMD_GNGGA "$GNGGA"
87 #define NANOGPS3_RSP_GNGGA "$GNGGA"
88 #define NANOGPS3_CMD_GPGLL "$GPGLL"
89 #define NANOGPS3_RSP_GPGLL "$GPGLL"
90 
95 #define NANOGPS3_NMEA_GNGGA 1
96 #define NANOGPS3_NMEA_GPGLL 3
97 #define NANOGPS3_NMEA_GNGGA_NUM_ELEMENT 15
98 #define NANOGPS3_NMEA_GPGLL_NUM_ELEMENT 5
99 
104 #define NANOGPS3_GNGGA_TIME 1
105 #define NANOGPS3_GNGGA_LATITUDE 2
106 #define NANOGPS3_GNGGA_LATITUDE_SIDE 3
107 #define NANOGPS3_GNGGA_LONGITUDE 4
108 #define NANOGPS3_GNGGA_LONGITUDE_SIDE 5
109 #define NANOGPS3_GNGGA_QUALITY_INDICATOR 6
110 #define NANOGPS3_GNGGA_NUMBER_OF_SATELLITES 7
111 #define NANOGPS3_GNGGA_H_DILUTION_OF_POS 8
112 #define NANOGPS3_GNGGA_ALTITUDE 9
113 #define NANOGPS3_GNGGA_ALTITUDE_UNIT 10
114 #define NANOGPS3_GNGGA_GEOIDAL_SEPARATION 11
115 #define NANOGPS3_GNGGA_GEOIDAL_SEPARATION_UNIT 12
116 #define NANOGPS3_GNGGA_TIME_SINCE_LAST_DGPS 13
117 #define NANOGPS3_GNGGA_DGPS_REFERENCE_STATION_ID 14
118 
119 
124 #define NANOGPS3_GPGLL_LATITUDE 1
125 #define NANOGPS3_GPGLL_LATITUDE_SIDE 2
126 #define NANOGPS3_GPGLL_LONGITUDE 3
127 #define NANOGPS3_GPGLL_LONGITUDE_SIDE 4
128 
133 #define NANOGPS3_ERROR_COMMAND_OR_ELEMENT 0xFF
134 #define NANOGPS3_ERROR_START_OR_END_COMMAND 0x8F
135 #define NANOGPS3_ERROR_NEXT_ELEMENT 0x4F
136 #define NANOGPS3_ERROR_CURRENT_ELEMENT 0x2F
137 #define NANOGPS3_NO_ERROR 0x00
138 #define NANOGPS3_PARSER_READY 0
139 #define NANOGPS3_PARSER_COMMAND_NOT_SUPPORTED 1
140 #define NANOGPS3_PARSER_ELEMENT_NOT_SUPPORTED 2
141 
146 #define NANOGPS3_PROCESS_COUNTER 10
147 #define NANOGPS3_DUMMY 0xFF
148 
153 #define NANOGPS3_PIN_STATE_LOW 0
154 #define NANOGPS3_PIN_STATE_HIGH 1
155 
161 #define NANOGPS3_TX_DRV_BUFFER_SIZE 100
162 #define NANOGPS3_RX_DRV_BUFFER_SIZE 600
163 
169 #define NANOGPS3_DEVICE_ADDRESS 0x10
170  // nanogps3_set
172 
187 #define NANOGPS3_MAP_MIKROBUS( cfg, mikrobus ) \
188  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
189  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
190  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
191  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_AN ); \
192  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
193  cfg.fon = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
194  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
195  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
196  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
197  // nanogps3_map // nanogps3
200 
205 typedef enum
206 {
211 
216 typedef err_t ( *nanogps3_master_io_t )( struct nanogps3_s*, uint8_t*, uint8_t );
222 typedef struct nanogps3_s
223 {
224  // Output pins
225  digital_out_t rts;
226  digital_out_t rst;
227  digital_out_t fon;
229  // Input pins
230  digital_in_t wup;
231  digital_in_t cts;
233  // Modules
234  i2c_master_t i2c;
235  uart_t uart;
237  // I2C slave address
238  uint8_t slave_address;
240  // Buffers
249 
254 typedef struct
255 {
256  // Communication gpio pins
257  pin_name_t scl;
258  pin_name_t sda;
260  pin_name_t rx_pin;
261  pin_name_t tx_pin;
263  pin_name_t rts;
264  pin_name_t wup;
265  pin_name_t rst;
266  pin_name_t fon;
267  pin_name_t cts;
269  uint32_t i2c_speed;
270  uint8_t i2c_address;
272  // Static variable
273  uint32_t baud_rate;
275  uart_data_bits_t data_bit;
276  uart_parity_t parity_bit;
277  uart_stop_bits_t stop_bit;
282 
287 typedef enum
288 {
290  NANOGPS3_ERROR = -1
291 
293 
310 
325 
337 
350 err_t nanogps3_generic_write ( nanogps3_t *ctx, uint8_t *data_in, uint8_t len );
351 
364 err_t nanogps3_generic_read ( nanogps3_t *ctx, uint8_t *data_out, uint8_t len );
365 
376 void nanogps3_request_to_send ( nanogps3_t *ctx, uint8_t rts );
377 
388 
399 void nanogps3_set_reset_state ( nanogps3_t *ctx, uint8_t rst_state );
400 
411 void nanogps3_set_force_on_state ( nanogps3_t *ctx, uint8_t pwr_state );
412 
423 
435 err_t nanogps3_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
436 
437 #ifdef __cplusplus
438 }
439 #endif
440 #endif // NANOGPS3_H
441  // nanogps3
443 
444 // ------------------------------------------------------------------------ END
nanogps3_return_value_t
nanogps3_return_value_t
Nano GPS 3 Click return value data.
Definition: nanogps3.h:288
nanogps3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: nanogps3.h:260
nanogps3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: nanogps3.h:276
nanogps3_s::slave_address
uint8_t slave_address
Definition: nanogps3.h:238
nanogps3_s::uart_rx_buffer
char uart_rx_buffer[NANOGPS3_RX_DRV_BUFFER_SIZE]
Definition: nanogps3.h:241
nanogps3_cfg_t::rst
pin_name_t rst
Definition: nanogps3.h:265
nanogps3_clear_to_send
uint8_t nanogps3_clear_to_send(nanogps3_t *ctx)
Nano GPS 3 clear to send function.
nanogps3_s::wup
digital_in_t wup
Definition: nanogps3.h:230
nanogps3_set_force_on_state
void nanogps3_set_force_on_state(nanogps3_t *ctx, uint8_t pwr_state)
Nano GPS 3 set force on state function.
nanogps3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: nanogps3.h:275
NANOGPS3_DRV_SEL_I2C
@ NANOGPS3_DRV_SEL_I2C
Definition: nanogps3.h:207
nanogps3_s::uart
uart_t uart
Definition: nanogps3.h:235
NANOGPS3_OK
@ NANOGPS3_OK
Definition: nanogps3.h:289
nanogps3_cfg_t::rts
pin_name_t rts
Definition: nanogps3.h:263
nanogps3_s::i2c
i2c_master_t i2c
Definition: nanogps3.h:234
nanogps3_cfg_t::i2c_address
uint8_t i2c_address
Definition: nanogps3.h:270
nanogps3_set_reset_state
void nanogps3_set_reset_state(nanogps3_t *ctx, uint8_t rst_state)
Nano GPS 3 set reset state function.
nanogps3_master_io_t
err_t(* nanogps3_master_io_t)(struct nanogps3_s *, uint8_t *, uint8_t)
Nano GPS 3 Click driver interface.
Definition: nanogps3.h:216
nanogps3_generic_write
err_t nanogps3_generic_write(nanogps3_t *ctx, uint8_t *data_in, uint8_t len)
Nano GPS 3 data writing function.
nanogps3_cfg_t::drv_sel
nanogps3_drv_t drv_sel
Definition: nanogps3.h:279
nanogps3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: nanogps3.h:269
nanogps3_init
err_t nanogps3_init(nanogps3_t *ctx, nanogps3_cfg_t *cfg)
Nano GPS 3 initialization function.
nanogps3_s::rst
digital_out_t rst
Definition: nanogps3.h:226
nanogps3_parse_gngga
err_t nanogps3_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
Nano GPS 3 parse GNGGA function.
nanogps3_cfg_t::cts
pin_name_t cts
Definition: nanogps3.h:267
nanogps3_cfg_t::scl
pin_name_t scl
Definition: nanogps3.h:257
nanogps3_cfg_t::baud_rate
uint32_t baud_rate
Definition: nanogps3.h:273
NANOGPS3_DRV_SEL_UART
@ NANOGPS3_DRV_SEL_UART
Definition: nanogps3.h:208
NANOGPS3_RX_DRV_BUFFER_SIZE
#define NANOGPS3_RX_DRV_BUFFER_SIZE
Definition: nanogps3.h:162
nanogps3_cfg_t
Nano GPS 3 Click configuration object.
Definition: nanogps3.h:255
nanogps3_cfg_setup
void nanogps3_cfg_setup(nanogps3_cfg_t *cfg)
Nano GPS 3 configuration object setup function.
nanogps3_cfg_t::uart_blocking
bool uart_blocking
Definition: nanogps3.h:274
nanogps3_request_to_send
void nanogps3_request_to_send(nanogps3_t *ctx, uint8_t rts)
Nano GPS 3 request to send function.
nanogps3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: nanogps3.h:261
nanogps3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: nanogps3.h:277
nanogps3_s::uart_tx_buffer
char uart_tx_buffer[NANOGPS3_TX_DRV_BUFFER_SIZE]
Definition: nanogps3.h:242
nanogps3_cfg_t::wup
pin_name_t wup
Definition: nanogps3.h:264
NANOGPS3_ERROR
@ NANOGPS3_ERROR
Definition: nanogps3.h:290
NANOGPS3_TX_DRV_BUFFER_SIZE
#define NANOGPS3_TX_DRV_BUFFER_SIZE
Nano GPS 3 driver buffer size.
Definition: nanogps3.h:161
nanogps3_s::cts
digital_in_t cts
Definition: nanogps3.h:231
nanogps3_s::drv_sel
nanogps3_drv_t drv_sel
Definition: nanogps3.h:244
nanogps3_s
Nano GPS 3 Click context object.
Definition: nanogps3.h:223
nanogps3_s::rts
digital_out_t rts
Definition: nanogps3.h:225
nanogps3_default_cfg
void nanogps3_default_cfg(nanogps3_t *ctx)
Nano GPS 3 default configuration function.
nanogps3_drv_t
nanogps3_drv_t
Nano GPS 3 Click driver selector.
Definition: nanogps3.h:206
nanogps3_cfg_t::fon
pin_name_t fon
Definition: nanogps3.h:266
nanogps3_s::write_f
nanogps3_master_io_t write_f
Definition: nanogps3.h:245
nanogps3_generic_read
err_t nanogps3_generic_read(nanogps3_t *ctx, uint8_t *data_out, uint8_t len)
Nano GPS 3 data reading function.
nanogps3_s::fon
digital_out_t fon
Definition: nanogps3.h:227
nanogps3_cfg_t::sda
pin_name_t sda
Definition: nanogps3.h:258
nanogps3_s::read_f
nanogps3_master_io_t read_f
Definition: nanogps3.h:246
nanogps3_t
struct nanogps3_s nanogps3_t
Nano GPS 3 Click context object.
nanogps3_get_wup_pin
uint8_t nanogps3_get_wup_pin(nanogps3_t *ctx)
Nano GPS 3 get wakeup pin function.