gnssrtk3ea  2.1.0.0
gnssrtk3ea.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 GNSSRTK3EA_H
29 #define GNSSRTK3EA_H
30 
31 #ifdef __cplusplus
32 extern "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_i2c_master.h"
52 #include "drv_uart.h"
53 
74 #define GNSSRTK3EA_RSP_START "$"
75 #define GNSSRTK3EA_RSP_DELIMITER ","
76 #define GNSSRTK3EA_RSP_END "\r\n"
77 #define GNSSRTK3EA_RSP_GGA "GGA"
78 
83 #define GNSSRTK3EA_GGA_ELEMENT_SIZE 15
84 #define GNSSRTK3EA_GGA_TIME 1
85 #define GNSSRTK3EA_GGA_LATITUDE 2
86 #define GNSSRTK3EA_GGA_LATITUDE_SIDE 3
87 #define GNSSRTK3EA_GGA_LONGITUDE 4
88 #define GNSSRTK3EA_GGA_LONGITUDE_SIDE 5
89 #define GNSSRTK3EA_GGA_QUALITY_INDICATOR 6
90 #define GNSSRTK3EA_GGA_NUMBER_OF_SATELLITES 7
91 #define GNSSRTK3EA_GGA_H_DILUTION_OF_POS 8
92 #define GNSSRTK3EA_GGA_ALTITUDE 9
93 #define GNSSRTK3EA_GGA_ALTITUDE_UNIT 10
94 #define GNSSRTK3EA_GGA_GEOIDAL_SEPARATION 11
95 #define GNSSRTK3EA_GGA_GEOIDAL_SEPARATION_UNIT 12
96 #define GNSSRTK3EA_GGA_TIME_SINCE_LAST_DGPS 13
97 #define GNSSRTK3EA_GGA_DGPS_REFERENCE_STATION_ID 14
98 
103 #define GNSSRTK3EA_I2C_SLAVE_CR_CMD 0xAA51u
104 #define GNSSRTK3EA_I2C_SLAVE_CW_CMD 0xAA53u
105 #define GNSSRTK3EA_I2C_SLAVE_CMD_LEN 8
106 #define GNSSRTK3EA_I2C_SLAVE_RX_LEN 4
107 #define GNSSRTK3EA_I2C_SLAVE_TX_LEN_REG_OFFSET 0x0008u
108 #define GNSSRTK3EA_I2C_SLAVE_TX_BUF_REG_OFFSET 0x2000u
109 #define GNSSRTK3EA_I2C_SLAVE_RX_LEN_REG_OFFSET 0x0004u
110 #define GNSSRTK3EA_I2C_SLAVE_RX_BUF_REG_OFFSET 0x1000u
111 #define GNSSRTK3EA_I2C_SLAVE_ADDRESS_CR_OR_CW 0x50
112 #define GNSSRTK3EA_I2C_SLAVE_ADDRESS_R 0x54
113 #define GNSSRTK3EA_I2C_SLAVE_ADDRESS_W 0x58
114 #define GNSSRTK3EA_I2C_SLAVE_MAX_ERRORS 10
115 
121 #define GNSSRTK3EA_TX_DRV_BUFFER_SIZE 100
122 #define GNSSRTK3EA_RX_DRV_BUFFER_SIZE 1000u
123  // gnssrtk3ea_cmd
125 
140 #define GNSSRTK3EA_MAP_MIKROBUS( cfg, mikrobus ) \
141  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
142  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
143  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
144  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
145  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
146  cfg.cen = MIKROBUS( mikrobus, MIKROBUS_CS ); \
147  cfg.wup = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
148  cfg.pps = MIKROBUS( mikrobus, MIKROBUS_INT );
149  // gnssrtk3ea_map // gnssrtk3ea
152 
157 typedef enum
158 {
163 
168 struct gnssrtk3ea_s;
169 typedef err_t ( *gnssrtk3ea_master_io_t )( struct gnssrtk3ea_s*, uint8_t*, uint16_t );
175 typedef struct gnssrtk3ea_s
176 {
177  digital_out_t rst;
178  digital_out_t cen;
179  digital_out_t wup;
180  digital_in_t pps;
182  uart_t uart;
183  i2c_master_t i2c;
194 
199 typedef struct
200 {
201  pin_name_t scl;
202  pin_name_t sda;
203  pin_name_t rx_pin;
204  pin_name_t tx_pin;
205  pin_name_t rst;
206  pin_name_t cen;
207  pin_name_t wup;
208  pin_name_t pps;
210  uint32_t i2c_speed;
211  uint8_t i2c_address;
213  uint32_t baud_rate;
215  uart_data_bits_t data_bit;
216  uart_parity_t parity_bit;
217  uart_stop_bits_t stop_bit;
222 
227 typedef enum
228 {
230  GNSSRTK3EA_ERROR = -1
231 
233 
250 
266 
281 
294 err_t gnssrtk3ea_generic_write ( gnssrtk3ea_t *ctx, uint8_t *data_in, uint16_t len );
295 
308 err_t gnssrtk3ea_generic_read ( gnssrtk3ea_t *ctx, uint8_t *data_out, uint16_t len );
309 
319 void gnssrtk3ea_set_rst_pin ( gnssrtk3ea_t *ctx, uint8_t state );
320 
330 void gnssrtk3ea_set_cen_pin ( gnssrtk3ea_t *ctx, uint8_t state );
331 
341 void gnssrtk3ea_set_wup_pin ( gnssrtk3ea_t *ctx, uint8_t state );
342 
352 
362 
372 
382 
394 err_t gnssrtk3ea_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
395 
396 #ifdef __cplusplus
397 }
398 #endif
399 #endif // GNSSRTK3EA_H
400  // gnssrtk3ea
402 
403 // ------------------------------------------------------------------------ END
gnssrtk3ea_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnssrtk3ea.h:213
GNSSRTK3EA_TX_DRV_BUFFER_SIZE
#define GNSSRTK3EA_TX_DRV_BUFFER_SIZE
GNSS RTK 3 EA driver buffer size.
Definition: gnssrtk3ea.h:121
gnssrtk3ea_cfg_t::cen
pin_name_t cen
Definition: gnssrtk3ea.h:206
gnssrtk3ea_enable_device
void gnssrtk3ea_enable_device(gnssrtk3ea_t *ctx)
GNSS RTK 3 EA enable device function.
GNSSRTK3EA_ERROR
@ GNSSRTK3EA_ERROR
Definition: gnssrtk3ea.h:230
gnssrtk3ea_s::cen
digital_out_t cen
Definition: gnssrtk3ea.h:178
gnssrtk3ea_cfg_t::drv_sel
gnssrtk3ea_drv_t drv_sel
Definition: gnssrtk3ea.h:219
gnssrtk3ea_s::wup
digital_out_t wup
Definition: gnssrtk3ea.h:179
gnssrtk3ea_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnssrtk3ea.h:215
gnssrtk3ea_s::uart
uart_t uart
Definition: gnssrtk3ea.h:182
gnssrtk3ea_set_wup_pin
void gnssrtk3ea_set_wup_pin(gnssrtk3ea_t *ctx, uint8_t state)
GNSS RTK 3 EA set WUP pin function.
gnssrtk3ea_cfg_t::scl
pin_name_t scl
Definition: gnssrtk3ea.h:201
gnssrtk3ea_get_pps_pin
uint8_t gnssrtk3ea_get_pps_pin(gnssrtk3ea_t *ctx)
GNSS RTK 3 EA get PPS pin function.
gnssrtk3ea_drv_interface_sel
void gnssrtk3ea_drv_interface_sel(gnssrtk3ea_cfg_t *cfg, gnssrtk3ea_drv_t drv_sel)
GNSS RTK 3 EA driver interface setup function.
gnssrtk3ea_set_rst_pin
void gnssrtk3ea_set_rst_pin(gnssrtk3ea_t *ctx, uint8_t state)
GNSS RTK 3 EA set RST pin function.
gnssrtk3ea_cfg_t::rst
pin_name_t rst
Definition: gnssrtk3ea.h:205
gnssrtk3ea_generic_read
err_t gnssrtk3ea_generic_read(gnssrtk3ea_t *ctx, uint8_t *data_out, uint16_t len)
GNSS RTK 3 EA data reading function.
gnssrtk3ea_parse_gga
err_t gnssrtk3ea_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
GNSS RTK 3 EA parse GGA function.
gnssrtk3ea_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnssrtk3ea.h:216
gnssrtk3ea_reset_device
void gnssrtk3ea_reset_device(gnssrtk3ea_t *ctx)
GNSS RTK 3 EA reset device function.
gnssrtk3ea_s::read_f
gnssrtk3ea_master_io_t read_f
Definition: gnssrtk3ea.h:191
gnssrtk3ea_s::uart_rx_buffer
uint8_t uart_rx_buffer[GNSSRTK3EA_RX_DRV_BUFFER_SIZE]
Definition: gnssrtk3ea.h:185
gnssrtk3ea_init
err_t gnssrtk3ea_init(gnssrtk3ea_t *ctx, gnssrtk3ea_cfg_t *cfg)
GNSS RTK 3 EA initialization function.
gnssrtk3ea_cfg_t::sda
pin_name_t sda
Definition: gnssrtk3ea.h:202
gnssrtk3ea_s
GNSS RTK 3 EA Click context object.
Definition: gnssrtk3ea.h:176
gnssrtk3ea_generic_write
err_t gnssrtk3ea_generic_write(gnssrtk3ea_t *ctx, uint8_t *data_in, uint16_t len)
GNSS RTK 3 EA data writing function.
gnssrtk3ea_s::drv_sel
gnssrtk3ea_drv_t drv_sel
Definition: gnssrtk3ea.h:188
gnssrtk3ea_s::pps
digital_in_t pps
Definition: gnssrtk3ea.h:180
gnssrtk3ea_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnssrtk3ea.h:204
gnssrtk3ea_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnssrtk3ea.h:211
gnssrtk3ea_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnssrtk3ea.h:217
GNSSRTK3EA_RX_DRV_BUFFER_SIZE
#define GNSSRTK3EA_RX_DRV_BUFFER_SIZE
Definition: gnssrtk3ea.h:122
gnssrtk3ea_return_value_t
gnssrtk3ea_return_value_t
GNSS RTK 3 EA Click return value data.
Definition: gnssrtk3ea.h:228
gnssrtk3ea_cfg_setup
void gnssrtk3ea_cfg_setup(gnssrtk3ea_cfg_t *cfg)
GNSS RTK 3 EA configuration object setup function.
gnssrtk3ea_cfg_t
GNSS RTK 3 EA Click configuration object.
Definition: gnssrtk3ea.h:200
gnssrtk3ea_master_io_t
err_t(* gnssrtk3ea_master_io_t)(struct gnssrtk3ea_s *, uint8_t *, uint16_t)
Definition: gnssrtk3ea.h:169
gnssrtk3ea_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnssrtk3ea.h:210
gnssrtk3ea_set_cen_pin
void gnssrtk3ea_set_cen_pin(gnssrtk3ea_t *ctx, uint8_t state)
GNSS RTK 3 EA set CEN pin function.
gnssrtk3ea_s::uart_tx_buffer
uint8_t uart_tx_buffer[GNSSRTK3EA_TX_DRV_BUFFER_SIZE]
Definition: gnssrtk3ea.h:186
gnssrtk3ea_drv_t
gnssrtk3ea_drv_t
GNSS RTK 3 EA Click driver selector.
Definition: gnssrtk3ea.h:158
gnssrtk3ea_cfg_t::uart_blocking
bool uart_blocking
Definition: gnssrtk3ea.h:214
GNSSRTK3EA_OK
@ GNSSRTK3EA_OK
Definition: gnssrtk3ea.h:229
gnssrtk3ea_s::i2c
i2c_master_t i2c
Definition: gnssrtk3ea.h:183
gnssrtk3ea_cfg_t::wup
pin_name_t wup
Definition: gnssrtk3ea.h:207
gnssrtk3ea_s::rst
digital_out_t rst
Definition: gnssrtk3ea.h:177
gnssrtk3ea_s::write_f
gnssrtk3ea_master_io_t write_f
Definition: gnssrtk3ea.h:190
gnssrtk3ea_disable_device
void gnssrtk3ea_disable_device(gnssrtk3ea_t *ctx)
GNSS RTK 3 EA disable device function.
gnssrtk3ea_cfg_t::pps
pin_name_t pps
Definition: gnssrtk3ea.h:208
GNSSRTK3EA_DRV_SEL_I2C
@ GNSSRTK3EA_DRV_SEL_I2C
Definition: gnssrtk3ea.h:160
gnssrtk3ea_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnssrtk3ea.h:203
GNSSRTK3EA_DRV_SEL_UART
@ GNSSRTK3EA_DRV_SEL_UART
Definition: gnssrtk3ea.h:159
gnssrtk3ea_t
struct gnssrtk3ea_s gnssrtk3ea_t
GNSS RTK 3 EA Click context object.