gnssrtk4 2.2.0
Loading...
Searching...
No Matches
gnssrtk4.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
27
28#ifndef GNSSRTK4_H
29#define GNSSRTK4_H
30
31#ifdef __cplusplus
32extern "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
58
63
68
73#define GNSSRTK4_RSP_START "$"
74#define GNSSRTK4_RSP_DELIMITER ","
75#define GNSSRTK4_RSP_END "\r\n"
76#define GNSSRTK4_RSP_GGA "GGA"
77
82#define GNSSRTK4_GGA_ELEMENT_SIZE 15
83#define GNSSRTK4_GGA_TIME 1
84#define GNSSRTK4_GGA_LATITUDE 2
85#define GNSSRTK4_GGA_LATITUDE_SIDE 3
86#define GNSSRTK4_GGA_LONGITUDE 4
87#define GNSSRTK4_GGA_LONGITUDE_SIDE 5
88#define GNSSRTK4_GGA_QUALITY_INDICATOR 6
89#define GNSSRTK4_GGA_NUMBER_OF_SATELLITES 7
90#define GNSSRTK4_GGA_H_DILUTION_OF_POS 8
91#define GNSSRTK4_GGA_ALTITUDE 9
92#define GNSSRTK4_GGA_ALTITUDE_UNIT 10
93#define GNSSRTK4_GGA_GEOIDAL_SEPARATION 11
94#define GNSSRTK4_GGA_GEOIDAL_SEPARATION_UNIT 12
95#define GNSSRTK4_GGA_TIME_SINCE_LAST_DGPS 13
96#define GNSSRTK4_GGA_DGPS_REFERENCE_STATION_ID 14
97
103#define GNSSRTK4_TX_DRV_BUFFER_SIZE 100
104#define GNSSRTK4_RX_DRV_BUFFER_SIZE 1000
105 // gnssrtk4_cmd
107
112
117
122#define GNSSRTK4_MAP_MIKROBUS( cfg, mikrobus ) \
123 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
124 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
125 cfg.sta = MIKROBUS( mikrobus, MIKROBUS_AN ); \
126 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
127 cfg.evt = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
128 cfg.pps = MIKROBUS( mikrobus, MIKROBUS_INT );
129 // gnssrtk4_map // gnssrtk4
132
137typedef struct
138{
139 // Output pins
140 digital_out_t rst;
141 digital_out_t evt;
142
143 // Input pins
144 digital_in_t sta;
145 digital_in_t pps;
146
147 // Modules
148 uart_t uart;
149
150 // Buffers
153
154} gnssrtk4_t;
155
160typedef struct
161{
162 // Communication gpio pins
163 pin_name_t rx_pin;
164 pin_name_t tx_pin;
165
166 // Additional gpio pins
167 pin_name_t sta;
168 pin_name_t rst;
169 pin_name_t evt;
170 pin_name_t pps;
171
172 // Static variable
173 uint32_t baud_rate;
175 uart_data_bits_t data_bit;
176 uart_parity_t parity_bit;
177 uart_stop_bits_t stop_bit;
178
180
185typedef enum
186{
189
191
197
208
223
236err_t gnssrtk4_generic_write ( gnssrtk4_t *ctx, uint8_t *data_in, uint16_t len );
237
250err_t gnssrtk4_generic_read ( gnssrtk4_t *ctx, uint8_t *data_out, uint16_t len );
251
261void gnssrtk4_set_rst_pin ( gnssrtk4_t *ctx, uint8_t state );
262
272void gnssrtk4_set_evt_pin ( gnssrtk4_t *ctx, uint8_t state );
273
283
293
303
315err_t gnssrtk4_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
316
317#ifdef __cplusplus
318}
319#endif
320#endif // GNSSRTK4_H
321 // gnssrtk4
323
324// ------------------------------------------------------------------------ END
gnssrtk4_return_value_t
GNSS RTK 4 Click return value data.
Definition gnssrtk4.h:186
@ GNSSRTK4_ERROR
Definition gnssrtk4.h:188
@ GNSSRTK4_OK
Definition gnssrtk4.h:187
#define GNSSRTK4_TX_DRV_BUFFER_SIZE
GNSS RTK 4 driver buffer size.
Definition gnssrtk4.h:103
#define GNSSRTK4_RX_DRV_BUFFER_SIZE
Definition gnssrtk4.h:104
uint8_t gnssrtk4_get_sta_pin(gnssrtk4_t *ctx)
GNSS RTK 4 get STA pin function.
void gnssrtk4_set_rst_pin(gnssrtk4_t *ctx, uint8_t state)
GNSS RTK 4 set RST pin function.
err_t gnssrtk4_generic_write(gnssrtk4_t *ctx, uint8_t *data_in, uint16_t len)
GNSS RTK 4 data writing function.
uint8_t gnssrtk4_get_pps_pin(gnssrtk4_t *ctx)
GNSS RTK 4 get PPS pin function.
err_t gnssrtk4_generic_read(gnssrtk4_t *ctx, uint8_t *data_out, uint16_t len)
GNSS RTK 4 data reading function.
err_t gnssrtk4_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
GNSS RTK 4 parse GGA function.
void gnssrtk4_cfg_setup(gnssrtk4_cfg_t *cfg)
GNSS RTK 4 configuration object setup function.
err_t gnssrtk4_init(gnssrtk4_t *ctx, gnssrtk4_cfg_t *cfg)
GNSS RTK 4 initialization function.
void gnssrtk4_set_evt_pin(gnssrtk4_t *ctx, uint8_t state)
GNSS RTK 4 set EVT pin function.
void gnssrtk4_reset_device(gnssrtk4_t *ctx)
GNSS RTK 4 reset device function.
GNSS RTK 4 Click configuration object.
Definition gnssrtk4.h:161
pin_name_t sta
Definition gnssrtk4.h:167
uint32_t baud_rate
Definition gnssrtk4.h:173
pin_name_t pps
Definition gnssrtk4.h:170
bool uart_blocking
Definition gnssrtk4.h:174
pin_name_t evt
Definition gnssrtk4.h:169
uart_data_bits_t data_bit
Definition gnssrtk4.h:175
pin_name_t tx_pin
Definition gnssrtk4.h:164
pin_name_t rx_pin
Definition gnssrtk4.h:163
uart_stop_bits_t stop_bit
Definition gnssrtk4.h:177
uart_parity_t parity_bit
Definition gnssrtk4.h:176
pin_name_t rst
Definition gnssrtk4.h:168
GNSS RTK 4 Click context object.
Definition gnssrtk4.h:138
digital_in_t sta
Definition gnssrtk4.h:144
digital_out_t evt
Definition gnssrtk4.h:141
digital_in_t pps
Definition gnssrtk4.h:145
uint8_t uart_tx_buffer[GNSSRTK4_TX_DRV_BUFFER_SIZE]
Definition gnssrtk4.h:152
uart_t uart
Definition gnssrtk4.h:148
uint8_t uart_rx_buffer[GNSSRTK4_RX_DRV_BUFFER_SIZE]
Definition gnssrtk4.h:151
digital_out_t rst
Definition gnssrtk4.h:140