gnssrtk5 2.2.1
Loading...
Searching...
No Matches
gnssrtk5.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 GNSSRTK5_H
29#define GNSSRTK5_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 GNSSRTK5_CMD_GET_VERSION "VERSION"
74#define GNSSRTK5_CMD_GET_CONFIG "CONFIG"
75#define GNSSRTK5_CMD_ENABLE_GGA "GNGGA 1"
76
81#define GNSSRTK5_RSP_RESET "$devicename"
82#define GNSSRTK5_RSP_COMMAND "$command"
83#define GNSSRTK5_RSP_START "$"
84#define GNSSRTK5_RSP_DELIMITER ","
85#define GNSSRTK5_RSP_END "\r\n"
86#define GNSSRTK5_RSP_GGA "GGA"
87
92#define GNSSRTK5_GGA_ELEMENT_SIZE 15
93#define GNSSRTK5_GGA_TIME 1
94#define GNSSRTK5_GGA_LATITUDE 2
95#define GNSSRTK5_GGA_LATITUDE_SIDE 3
96#define GNSSRTK5_GGA_LONGITUDE 4
97#define GNSSRTK5_GGA_LONGITUDE_SIDE 5
98#define GNSSRTK5_GGA_QUALITY_INDICATOR 6
99#define GNSSRTK5_GGA_NUMBER_OF_SATELLITES 7
100#define GNSSRTK5_GGA_H_DILUTION_OF_POS 8
101#define GNSSRTK5_GGA_ALTITUDE 9
102#define GNSSRTK5_GGA_ALTITUDE_UNIT 10
103#define GNSSRTK5_GGA_GEOIDAL_SEPARATION 11
104#define GNSSRTK5_GGA_GEOIDAL_SEPARATION_UNIT 12
105#define GNSSRTK5_GGA_TIME_SINCE_LAST_DGPS 13
106#define GNSSRTK5_GGA_DGPS_REFERENCE_STATION_ID 14
107
113#define GNSSRTK5_TX_DRV_BUFFER_SIZE 100
114#define GNSSRTK5_RX_DRV_BUFFER_SIZE 800
115 // gnssrtk5_cmd
117
122
127
132#define GNSSRTK5_MAP_MIKROBUS( cfg, mikrobus ) \
133 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
134 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
135 cfg.pvt = MIKROBUS( mikrobus, MIKROBUS_AN ); \
136 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
137 cfg.evt = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
138 cfg.err = MIKROBUS( mikrobus, MIKROBUS_INT );
139 // gnssrtk5_map // gnssrtk5
142
147typedef struct
148{
149 // Output pins
150 digital_out_t rst;
151 digital_out_t evt;
152
153 // Input pins
154 digital_in_t pvt;
155 digital_in_t err;
156
157 // Modules
158 uart_t uart;
159
160 // Buffers
164
165} gnssrtk5_t;
166
171typedef struct
172{
173 // Communication gpio pins
174 pin_name_t rx_pin;
175 pin_name_t tx_pin;
176
177 // Additional gpio pins
178 pin_name_t pvt;
179 pin_name_t rst;
180 pin_name_t evt;
181 pin_name_t err;
182
183 // Static variable
184 uint32_t baud_rate;
186 uart_data_bits_t data_bit;
187 uart_parity_t parity_bit;
188 uart_stop_bits_t stop_bit;
189
191
203
209
220
235
248err_t gnssrtk5_generic_write ( gnssrtk5_t *ctx, uint8_t *data_in, uint16_t len );
249
262err_t gnssrtk5_generic_read ( gnssrtk5_t *ctx, uint8_t *data_out, uint16_t len );
263
273void gnssrtk5_set_rst_pin ( gnssrtk5_t *ctx, uint8_t state );
274
284
294void gnssrtk5_set_evt_pin ( gnssrtk5_t *ctx, uint8_t state );
295
305
315
327err_t gnssrtk5_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
328
338void gnssrtk5_cmd_run ( gnssrtk5_t *ctx, uint8_t *cmd );
339
340#ifdef __cplusplus
341}
342#endif
343#endif // GNSSRTK5_H
344 // gnssrtk5
346
347// ------------------------------------------------------------------------ END
gnssrtk5_return_value_t
GNSS RTK 5 Click return value data.
Definition gnssrtk5.h:197
@ GNSSRTK5_OK
Definition gnssrtk5.h:198
@ GNSSRTK5_ERROR_TIMEOUT
Definition gnssrtk5.h:200
@ GNSSRTK5_ERROR
Definition gnssrtk5.h:199
#define GNSSRTK5_RX_DRV_BUFFER_SIZE
Definition gnssrtk5.h:114
#define GNSSRTK5_TX_DRV_BUFFER_SIZE
GNSS RTK 5 driver buffer size.
Definition gnssrtk5.h:113
void gnssrtk5_cmd_run(gnssrtk5_t *ctx, uint8_t *cmd)
GNSS RTK 5 cmd run function.
err_t gnssrtk5_generic_write(gnssrtk5_t *ctx, uint8_t *data_in, uint16_t len)
GNSS RTK 5 data writing function.
uint8_t gnssrtk5_get_pvt_pin(gnssrtk5_t *ctx)
GNSS RTK 5 get PVT pin function.
void gnssrtk5_set_rst_pin(gnssrtk5_t *ctx, uint8_t state)
GNSS RTK 5 set RST pin function.
void gnssrtk5_reset_device(gnssrtk5_t *ctx)
GNSS RTK 5 reset device function.
void gnssrtk5_cfg_setup(gnssrtk5_cfg_t *cfg)
GNSS RTK 5 configuration object setup function.
err_t gnssrtk5_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
GNSS RTK 5 parse GGA function.
err_t gnssrtk5_init(gnssrtk5_t *ctx, gnssrtk5_cfg_t *cfg)
GNSS RTK 5 initialization function.
err_t gnssrtk5_generic_read(gnssrtk5_t *ctx, uint8_t *data_out, uint16_t len)
GNSS RTK 5 data reading function.
uint8_t gnssrtk5_get_err_pin(gnssrtk5_t *ctx)
GNSS RTK 5 get ERR pin function.
void gnssrtk5_set_evt_pin(gnssrtk5_t *ctx, uint8_t state)
GNSS RTK 5 set EVT pin function.
GNSS RTK 5 Click configuration object.
Definition gnssrtk5.h:172
uint32_t baud_rate
Definition gnssrtk5.h:184
bool uart_blocking
Definition gnssrtk5.h:185
pin_name_t evt
Definition gnssrtk5.h:180
pin_name_t err
Definition gnssrtk5.h:181
pin_name_t pvt
Definition gnssrtk5.h:178
uart_data_bits_t data_bit
Definition gnssrtk5.h:186
pin_name_t tx_pin
Definition gnssrtk5.h:175
pin_name_t rx_pin
Definition gnssrtk5.h:174
uart_stop_bits_t stop_bit
Definition gnssrtk5.h:188
uart_parity_t parity_bit
Definition gnssrtk5.h:187
pin_name_t rst
Definition gnssrtk5.h:179
GNSS RTK 5 Click context object.
Definition gnssrtk5.h:148
uint8_t cmd_buffer[GNSSRTK5_TX_DRV_BUFFER_SIZE]
Definition gnssrtk5.h:163
digital_out_t evt
Definition gnssrtk5.h:151
uint8_t uart_rx_buffer[GNSSRTK5_RX_DRV_BUFFER_SIZE]
Definition gnssrtk5.h:161
uart_t uart
Definition gnssrtk5.h:158
uint8_t uart_tx_buffer[GNSSRTK5_TX_DRV_BUFFER_SIZE]
Definition gnssrtk5.h:162
digital_in_t pvt
Definition gnssrtk5.h:154
digital_out_t rst
Definition gnssrtk5.h:150
digital_in_t err
Definition gnssrtk5.h:155