Classes | |
| struct | nmea_params |
| NMEA Device specific parameters. More... | |
Functions | |
| void * | nmea_setup (void *ptargs) |
| NMEA Setup. More... | |
| void * | nmea_logging (void *ptargs) |
| NMEA logging (with pthread function signature) More... | |
| void * | nmea_shutdown (void *ptargs) |
| NMEA Shutdown. More... | |
| void * | nmea_channels (void *ptargs) |
| NMEA Channel map. More... | |
| device_callbacks | nmea_getCallbacks (void) |
| Fill out device callback functions for logging. More... | |
| nmea_params | nmea_getParams (void) |
| Fill out default NMEA parameters. More... | |
| bool | nmea_parseConfig (log_thread_args_t *lta, config_section *s) |
| Take a configuration section and parse parameters. More... | |
Detailed Description
Adds support for reading messages from an NMEA0183 serial device.
Reading messages from the device and parsing to the internal message pack format used by the logger is handled in SELKIELoggerNMEA.h
Function Documentation
◆ nmea_channels()
| void* nmea_channels | ( | void * | ptargs | ) |
NMEA Channel map.
Populate list of channels and push to queue as a map message
Exits thread in case of error.
- Parameters
-
[in] ptargs Pointer to log_thread_args_t
- Returns
- NULL - Exit code in ptargs->returnCode if required
Definition at line 186 of file LoggerNMEA.c.
◆ nmea_getCallbacks()
| device_callbacks nmea_getCallbacks | ( | void | ) |
Fill out device callback functions for logging.
- Returns
- device_callbacks for NMEA serial sources
Definition at line 227 of file LoggerNMEA.c.
◆ nmea_getParams()
| nmea_params nmea_getParams | ( | void | ) |
Fill out default NMEA parameters.
- Returns
- Default parameters for NMEA serial sources
Definition at line 238 of file LoggerNMEA.c.
◆ nmea_logging()
| void* nmea_logging | ( | void * | ptargs | ) |
NMEA logging (with pthread function signature)
Takes a nmea_params struct (passed via log_thread_args_t) messages from a device configured with nmea_setup() and pushes them to the message queue.
Exits on error or when shutdown is signalled.
- Parameters
-
[in] ptargs Pointer to log_thread_args_t
- Returns
- NULL - Exit code in ptargs->returnCode if required
Definition at line 60 of file LoggerNMEA.c.
◆ nmea_parseConfig()
| bool nmea_parseConfig | ( | log_thread_args_t * | lta, |
| config_section * | s | ||
| ) |
Take a configuration section and parse parameters.
- Parameters
-
[in] lta Pointer to log_thread_args_t [in] s Pointer to config_section to be parsed
- Returns
- True on success, false on error
Definition at line 249 of file LoggerNMEA.c.
◆ nmea_setup()
| void* nmea_setup | ( | void * | ptargs | ) |
NMEA Setup.
Set up connection to an NMEA serial gateway device.
No other steps required.
- Parameters
-
[in] ptargs Pointer to log_thread_args_t
- Returns
- NULL - Exit code in ptargs->returnCode if required
Definition at line 34 of file LoggerNMEA.c.
◆ nmea_shutdown()
| void* nmea_shutdown | ( | void * | ptargs | ) |
NMEA Shutdown.
Calls nmea_closeConnection(), which will do any cleanup required.
- Parameters
-
[in] ptargs Pointer to log_thread_args_t
- Returns
- NULL - Exit code in ptargs->returnCode if required
Definition at line 159 of file LoggerNMEA.c.
