Classes | |
| struct | gps_params |
| GPS Device specific parameters. More... | |
Functions | |
| void * | gps_setup (void *ptargs) |
| GPS Setup. More... | |
| void * | gps_logging (void *ptargs) |
| GPS logging (with pthread function signature) More... | |
| void * | gps_shutdown (void *ptargs) |
| GPS Shutdown. More... | |
| void * | gps_channels (void *ptargs) |
| GPS Channel map. More... | |
| device_callbacks | gps_getCallbacks (void) |
| Fill out device callback functions for logging. More... | |
| gps_params | gps_getParams (void) |
| Fill out default GPS parameters. More... | |
| bool | gps_parseConfig (log_thread_args_t *lta, config_section *s) |
| Parse configuration section. More... | |
Detailed Description
Adds support for reading messages from a u-blox GPS receiver.
These functions are device agnostic, but it uses the functions from SELKIELoggerGPS.h to communicate with the module and these are currently u-blox specific.
Function Documentation
◆ gps_channels()
| void* gps_channels | ( | void * | ptargs | ) |
GPS Channel map.
Populate list of channels and push to queue as a map message
Terminates thread on error
- Parameters
-
[in] ptargs Pointer to log_thread_args_t
- Returns
- NULL - Error code set in ptargs->returnCode if required
Definition at line 284 of file LoggerGPS.c.
◆ gps_getCallbacks()
| device_callbacks gps_getCallbacks | ( | void | ) |
Fill out device callback functions for logging.
- Returns
- device_callbacks for uBlox GPS devices
Definition at line 326 of file LoggerGPS.c.
◆ gps_getParams()
| gps_params gps_getParams | ( | void | ) |
Fill out default GPS parameters.
- Returns
- Default parameters for uBlox GPS devices
Definition at line 337 of file LoggerGPS.c.
◆ gps_logging()
| void* gps_logging | ( | void * | ptargs | ) |
GPS logging (with pthread function signature)
Takes a gps_params struct (passed via log_thread_args_t)
Reads messages from a device configured with gps_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 - Error code set in ptargs->returnCode if required
Definition at line 122 of file LoggerGPS.c.
◆ gps_parseConfig()
| bool gps_parseConfig | ( | log_thread_args_t * | lta, |
| config_section * | s | ||
| ) |
Parse configuration section.
- 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 352 of file LoggerGPS.c.
◆ gps_setup()
| void* gps_setup | ( | void * | ptargs | ) |
GPS Setup.
Perform initial setup of a u-blox GPS device.
The serial set up is carried out by ubx_openConnection().
The module is configured for Galileo support, and to output required navigation information. Satellite information is also requested, but at a lower rate (Once per 100 navigation updates - approximately every 50 seconds).
GPS module information is also requested at initial startup, but not on a regular basis.
- Parameters
-
[in] ptargs Pointer to log_thread_args_t
- Returns
- NULL - Error code set in ptargs->returnCode if required
Definition at line 42 of file LoggerGPS.c.
◆ gps_shutdown()
| void* gps_shutdown | ( | void * | ptargs | ) |
GPS Shutdown.
Calls ubx_closeConnection(), which will do any cleanup required.
- Parameters
-
[in] ptargs Pointer to log_thread_args_t
- Returns
- NULL - Error code set in ptargs->returnCode if required
Definition at line 257 of file LoggerGPS.c.
