gnsszoe  2.0.0.0
gnsszoe.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 GNSSZOE_H
29 #define GNSSZOE_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_spi_master.h"
39 #include "drv_uart.h"
40 #include "spi_specifics.h"
41 
62 #define GNSSZOE_RSP_START "$"
63 #define GNSSZOE_RSP_DELIMITER ","
64 #define GNSSZOE_RSP_GNGGA "$GNGGA"
65 
70 #define GNSSZOE_GNGGA_ELEMENT_SIZE 15
71 #define GNSSZOE_GNGGA_TIME 1
72 #define GNSSZOE_GNGGA_LATITUDE 2
73 #define GNSSZOE_GNGGA_LATITUDE_SIDE 3
74 #define GNSSZOE_GNGGA_LONGITUDE 4
75 #define GNSSZOE_GNGGA_LONGITUDE_SIDE 5
76 #define GNSSZOE_GNGGA_QUALITY_INDICATOR 6
77 #define GNSSZOE_GNGGA_NUMBER_OF_SATELLITES 7
78 #define GNSSZOE_GNGGA_H_DILUTION_OF_POS 8
79 #define GNSSZOE_GNGGA_ALTITUDE 9
80 #define GNSSZOE_GNGGA_ALTITUDE_UNIT 10
81 #define GNSSZOE_GNGGA_GEOIDAL_SEPARATION 11
82 #define GNSSZOE_GNGGA_GEOIDAL_SEPARATION_UNIT 12
83 #define GNSSZOE_GNGGA_TIME_SINCE_LAST_DGPS 13
84 #define GNSSZOE_GNGGA_DGPS_REFERENCE_STATION_ID 14
85 
90 #define GNSSZOE_DUMMY 0xFF
91 
97 #define GNSSZOE_SET_DEV_ADDR 0x42
98 
104 #define GNSSZOE_DRV_TX_BUFFER_SIZE 100
105 #define GNSSZOE_DRV_RX_BUFFER_SIZE 600
106 
115 #define GNSSZOE_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
116 #define GNSSZOE_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
117  // gnsszoe_set
119 
134 #define GNSSZOE_MAP_MIKROBUS( cfg, mikrobus ) \
135  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
136  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
137  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
138  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
139  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
140  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
141  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
142  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
143  cfg.exi = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
144  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
145  // gnsszoe_map // gnsszoe
148 
153 typedef enum
154 {
160 
165 typedef err_t ( *gnsszoe_master_io_t )( struct gnsszoe_s*, uint8_t*, uint8_t );
171 typedef struct gnsszoe_s
172 {
173  digital_out_t rst;
175  digital_in_t exi;
177  i2c_master_t i2c;
178  spi_master_t spi;
179  uart_t uart;
181  // Buffers
185  uint8_t slave_address;
186  pin_name_t chip_select;
193 
198 typedef struct
199 {
200  pin_name_t scl;
201  pin_name_t sda;
202  pin_name_t miso;
203  pin_name_t mosi;
204  pin_name_t sck;
205  pin_name_t cs;
206  pin_name_t rx_pin;
207  pin_name_t tx_pin;
209  pin_name_t exi;
210  pin_name_t rst;
212  uint32_t i2c_speed;
213  uint8_t i2c_address;
215  uint32_t spi_speed;
216  spi_master_mode_t spi_mode;
217  spi_master_chip_select_polarity_t cs_polarity;
219  uint32_t baud_rate;
221  uart_data_bits_t data_bit;
222  uart_parity_t parity_bit;
223  uart_stop_bits_t stop_bit;
227 } gnsszoe_cfg_t;
228 
233 typedef enum
234 {
236  GNSSZOE_ERROR = -1
237 
239 
256 
272 
286 err_t gnsszoe_init ( gnsszoe_t *ctx, gnsszoe_cfg_t *cfg );
287 
300 err_t gnsszoe_generic_write ( gnsszoe_t *ctx, uint8_t *data_in, uint8_t len );
301 
314 err_t gnsszoe_generic_read ( gnsszoe_t *ctx, uint8_t *data_out, uint8_t len );
315 
325 void gnsszoe_set_rst_pin ( gnsszoe_t *ctx, uint8_t state );
326 
336 
346 
358 err_t gnsszoe_parse_gngga ( char *rsp_buf, uint8_t gngga_element, char *element_data );
359 
360 #ifdef __cplusplus
361 }
362 #endif
363 #endif // GNSSZOE_H
364  // gnsszoe
366 
367 // ------------------------------------------------------------------------ END
gnsszoe_s::uart_tx_buffer
char uart_tx_buffer[GNSSZOE_DRV_TX_BUFFER_SIZE]
Definition: gnsszoe.h:183
gnsszoe_s::i2c
i2c_master_t i2c
Definition: gnsszoe.h:177
gnsszoe_cfg_t::mosi
pin_name_t mosi
Definition: gnsszoe.h:203
GNSSZOE_OK
@ GNSSZOE_OK
Definition: gnsszoe.h:235
gnsszoe_cfg_t::drv_sel
gnsszoe_drv_t drv_sel
Definition: gnsszoe.h:225
gnsszoe_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gnsszoe.h:221
gnsszoe_set_rst_pin
void gnsszoe_set_rst_pin(gnsszoe_t *ctx, uint8_t state)
GNSS ZOE set RST pin function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
GNSSZOE_DRV_SEL_I2C
@ GNSSZOE_DRV_SEL_I2C
Definition: gnsszoe.h:157
gnsszoe_cfg_t::rst
pin_name_t rst
Definition: gnsszoe.h:210
gnsszoe_s::slave_address
uint8_t slave_address
Definition: gnsszoe.h:185
gnsszoe_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gnsszoe.h:206
gnsszoe_cfg_t
GNSS ZOE Click configuration object.
Definition: gnsszoe.h:199
gnsszoe_cfg_t::exi
pin_name_t exi
Definition: gnsszoe.h:209
GNSSZOE_DRV_SEL_UART
@ GNSSZOE_DRV_SEL_UART
Definition: gnsszoe.h:155
gnsszoe_master_io_t
err_t(* gnsszoe_master_io_t)(struct gnsszoe_s *, uint8_t *, uint8_t)
GNSS ZOE Click driver interface.
Definition: gnsszoe.h:165
gnsszoe_s
GNSS ZOE Click context object.
Definition: gnsszoe.h:172
gnsszoe_cfg_t::cs
pin_name_t cs
Definition: gnsszoe.h:205
gnsszoe_s::write_f
gnsszoe_master_io_t write_f
Definition: gnsszoe.h:189
gnsszoe_drv_t
gnsszoe_drv_t
GNSS ZOE Click driver selector.
Definition: gnsszoe.h:154
GNSSZOE_DRV_RX_BUFFER_SIZE
#define GNSSZOE_DRV_RX_BUFFER_SIZE
Definition: gnsszoe.h:105
gnsszoe_s::read_f
gnsszoe_master_io_t read_f
Definition: gnsszoe.h:190
gnsszoe_cfg_t::spi_speed
uint32_t spi_speed
Definition: gnsszoe.h:215
gnsszoe_cfg_t::i2c_address
uint8_t i2c_address
Definition: gnsszoe.h:213
gnsszoe_cfg_t::sck
pin_name_t sck
Definition: gnsszoe.h:204
gnsszoe_s::uart_rx_buffer
char uart_rx_buffer[GNSSZOE_DRV_RX_BUFFER_SIZE]
Definition: gnsszoe.h:182
gnsszoe_cfg_t::scl
pin_name_t scl
Definition: gnsszoe.h:200
gnsszoe_s::spi
spi_master_t spi
Definition: gnsszoe.h:178
gnsszoe_t
struct gnsszoe_s gnsszoe_t
GNSS ZOE Click context object.
gnsszoe_drv_interface_selection
void gnsszoe_drv_interface_selection(gnsszoe_cfg_t *cfg, gnsszoe_drv_t drv_sel)
GNSS ZOE driver interface setup function.
GNSSZOE_DRV_SEL_SPI
@ GNSSZOE_DRV_SEL_SPI
Definition: gnsszoe.h:156
gnsszoe_init
err_t gnsszoe_init(gnsszoe_t *ctx, gnsszoe_cfg_t *cfg)
GNSS ZOE initialization function.
gnsszoe_reset_device
void gnsszoe_reset_device(gnsszoe_t *ctx)
GNSS ZOE reset device function.
gnsszoe_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gnsszoe.h:207
gnsszoe_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gnsszoe.h:222
gnsszoe_cfg_setup
void gnsszoe_cfg_setup(gnsszoe_cfg_t *cfg)
GNSS ZOE configuration object setup function.
gnsszoe_s::uart
uart_t uart
Definition: gnsszoe.h:179
gnsszoe_cfg_t::baud_rate
uint32_t baud_rate
Definition: gnsszoe.h:219
gnsszoe_generic_read
err_t gnsszoe_generic_read(gnsszoe_t *ctx, uint8_t *data_out, uint8_t len)
GNSS ZOE data reading function.
gnsszoe_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: gnsszoe.h:212
gnsszoe_s::rst
digital_out_t rst
Definition: gnsszoe.h:173
GNSSZOE_ERROR
@ GNSSZOE_ERROR
Definition: gnsszoe.h:236
gnsszoe_s::chip_select
pin_name_t chip_select
Definition: gnsszoe.h:186
gnsszoe_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: gnsszoe.h:217
gnsszoe_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gnsszoe.h:223
gnsszoe_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: gnsszoe.h:216
gnsszoe_cfg_t::uart_blocking
bool uart_blocking
Definition: gnsszoe.h:220
GNSSZOE_DRV_TX_BUFFER_SIZE
#define GNSSZOE_DRV_TX_BUFFER_SIZE
GNSS ZOE driver buffer size.
Definition: gnsszoe.h:104
gnsszoe_cfg_t::sda
pin_name_t sda
Definition: gnsszoe.h:201
gnsszoe_s::exi
digital_in_t exi
Definition: gnsszoe.h:175
gnsszoe_return_value_t
gnsszoe_return_value_t
GNSS ZOE Click return value data.
Definition: gnsszoe.h:234
gnsszoe_s::drv_sel
gnsszoe_drv_t drv_sel
Definition: gnsszoe.h:187
gnsszoe_parse_gngga
err_t gnsszoe_parse_gngga(char *rsp_buf, uint8_t gngga_element, char *element_data)
GNSS ZOE parse GNGGA function.
gnsszoe_cfg_t::miso
pin_name_t miso
Definition: gnsszoe.h:202
gnsszoe_generic_write
err_t gnsszoe_generic_write(gnsszoe_t *ctx, uint8_t *data_in, uint8_t len)
GNSS ZOE data writing function.
gnsszoe_get_exi_pin
uint8_t gnsszoe_get_exi_pin(gnsszoe_t *ctx)
GNSS ZOE get EXI pin function.