upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
nmea_gps.h
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2016 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 #pragma once
26 
27 #include <stdint.h>
28 #include "upm.h"
29 #include "mraa/uart.h"
30 #include "mraa/i2c.h"
31 #include "mraa/gpio.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
51  typedef struct _nmea_gps_context {
52  mraa_uart_context uart;
53  mraa_gpio_context gpio_en;
54  mraa_i2c_context i2c;
56 
67  nmea_gps_context nmea_gps_init(unsigned int uart, unsigned int baudrate,
68  int enable_pin);
69 
78  nmea_gps_context nmea_gps_init_raw(const char* uart, unsigned int baudrate);
79 
88  nmea_gps_context nmea_gps_init_ublox_i2c(unsigned int bus, uint8_t addr);
89 
93  void nmea_gps_close(nmea_gps_context dev);
94 
103  int nmea_gps_read(const nmea_gps_context dev, char *buffer, size_t len);
104 
114  int nmea_gps_write(const nmea_gps_context dev, char *buffer, size_t len);
115 
125  upm_result_t nmea_gps_enable(const nmea_gps_context dev, bool enable);
126 
135  upm_result_t nmea_gps_set_baudrate(const nmea_gps_context dev,
136  unsigned int baudrate);
137 
150  bool nmea_gps_data_available(const nmea_gps_context dev,
151  unsigned int millis);
152 
153 #ifdef __cplusplus
154 }
155 #endif
Definition: nmea_gps.h:51