src/dw/sensors/gps/docs/usecase1.md

Go to the documentation of this file.

# Copyright (c) 2019-2020, NVIDIA CORPORATION.  All rights reserved.

@page gps_usecase1 Reading GPS data from sensor

The `dwSensorGPS_readFrame()` function reads the next available GPS data
frame with a given timeout. The function call is blocking, until a GPS
frame is available or the timeout is exceeded. Frames read from the sensor
do not have to be returned because the messages are copied.

Depending on the particular GPS sensor capabilities, a GPS frame can be
only partially filled with data. The `::dwGPSFlags` are used to indicate
which fields in `dwGPSFrame` are valid.

#### Example

The following code shows the general structure of a program reading data
from a GPS sensor.
```{.cpp}
dwSensorParams params;
params.protocol = "gps.uart";
params.parameters = "device=/dev/<serial device>,baud=<baudrate>";

dwSensorHandle_t gpsSensor;
dwSAL_createSensor(&gpsSensor, params, ...);

dwSensor_start(gpsSensor);

while(loop)
{
    dwGPSFrame frame;
    dwSensorGPS_readFrame(&frame, 50000, gpsSensor);
    ...
}

dwSensor_stop(gpsSensor);
dwSAL_releaseSensor(&gpsSensor);
```
For more details see @ref dwx_gps_loc_sample