SELKIELogger  1.0.0
LoggerNMEA.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Swansea University
3  *
4  * This file is part of the SELKIELogger suite of tools.
5  *
6  * SELKIELogger is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the Free
8  * Software Foundation, either version 3 of the License, or (at your option)
9  * any later version.
10  *
11  * SELKIELogger is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this SELKIELogger product.
18  * If not, see <http://www.gnu.org/licenses/>.
19 */
20 
21 #ifndef SL_LOGGER_NMEA_H
22 #define SL_LOGGER_NMEA_H
23 
24 #include <errno.h>
25 #include <stdint.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <unistd.h>
29 
30 #include "SELKIELoggerBase.h"
31 #include "SELKIELoggerNMEA.h"
32 
34 
47 typedef struct {
48  char *portName;
49  char *sourceName;
50  uint8_t sourceNum;
51  int baudRate;
52  int handle;
53  // Future expansion: Talker/Message -> Source/Message map?
54 } nmea_params;
55 
57 void *nmea_setup(void *ptargs);
58 
60 void *nmea_logging(void *ptargs);
61 
63 void *nmea_shutdown(void *ptargs);
64 
66 void *nmea_channels(void *ptargs);
67 
70 
73 
77 #endif
void * nmea_shutdown(void *ptargs)
NMEA Shutdown.
Definition: LoggerNMEA.c:159
void * nmea_logging(void *ptargs)
NMEA logging (with pthread function signature)
Definition: LoggerNMEA.c:60
device_callbacks nmea_getCallbacks(void)
Fill out device callback functions for logging.
Definition: LoggerNMEA.c:227
void * nmea_channels(void *ptargs)
NMEA Channel map.
Definition: LoggerNMEA.c:186
nmea_params nmea_getParams(void)
Fill out default NMEA parameters.
Definition: LoggerNMEA.c:238
bool nmea_parseConfig(log_thread_args_t *lta, config_section *s)
Take a configuration section and parse parameters.
Definition: LoggerNMEA.c:249
void * nmea_setup(void *ptargs)
NMEA Setup.
Definition: LoggerNMEA.c:34
Configuration file section.
Definition: LoggerConfig.h:54
Device specific function information.
Definition: Logger.h.in:72
Logging thread information.
Definition: Logger.h.in:86
NMEA Device specific parameters.
Definition: LoggerNMEA.h:47
uint8_t sourceNum
Source ID for messages.
Definition: LoggerNMEA.h:50
char * sourceName
User defined name for this source.
Definition: LoggerNMEA.h:49
int handle
Handle for currently opened device.
Definition: LoggerNMEA.h:52
char * portName
Target port name.
Definition: LoggerNMEA.h:48
int baudRate
Baud rate for operations.
Definition: LoggerNMEA.h:51