NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
GPS.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2016-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
29 #ifndef DW_SENSORS_GPS_GPS_H_
30 #define DW_SENSORS_GPS_GPS_H_
31 
32 #include <dw/core/base/Config.h>
33 #include <dw/core/base/Exports.h>
34 #include <dw/core/base/Types.h>
35 
36 #include "GPSFrame.h"
37 #include <dw/sensors/common/SensorTypes.h>
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
86 dwStatus dwSensorGPS_readFrame(dwGPSFrame* const frame, dwTime_t const timeoutUs, dwSensorHandle_t const sensor);
87 
125 dwStatus dwSensorGPS_processRawData(uint8_t const* const data, size_t const size, dwSensorHandle_t const sensor);
126 
156 
163 typedef struct dwGPSFrameNew
164 {
167 
173 
179 
185 
191 
197 
203 
209 
215 
221 
227 
233 
239 
245 
251  uint8_t satelliteCount;
252 
264 
276 
295 
297  uint8_t reserved[508];
298 } dwGPSFrameNew DW_DEPRECATED("dwGPSFrameNew is deprecated and will be removed soon. Please use dwGPSFrame instead");
299 
321 #pragma GCC diagnostic push // TODO(pshu): Remove in next major release
322 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
325  DW_DEPRECATED("dwSensorGPS_readFrameNew() is deprecated and will be removed soon. Please use dwSensorGPS_readFrame() instead");
326 #pragma GCC diagnostic pop
327 
347 dwStatus dwSensorGPS_processRawDataNew(uint8_t const* const data, size_t const size, dwSensorHandle_t const sensor)
348  DW_DEPRECATED("dwSensorGPS_processRawDataNew() is deprecated and will be removed soon. Please use dwSensorGPS_processRawData() instead");
349 
366 #pragma GCC diagnostic push // TODO(pshu): Remove in next major release
367 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
370  DW_DEPRECATED("dwSensorGPS_popFrameNew() is deprecated and will be removed soon. Please use dwSensorGPS_popFrame() instead");
371 #pragma GCC diagnostic pop
372 
373 #ifdef __cplusplus
374 }
375 #endif
376 #endif // DW_SENSORS_GPS_GPS_H_
dwGPSFrame
A GPS packet containing localization information.
Definition: GPSFrame.h:284
dwSensorHandle_t
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: SensorTypes.h:42
dwGPSFrameNew::pdop
float64_t pdop
Definition: GPS.h:226
dwGPSFrameNew::timestamp_us
dwTime_t timestamp_us
Definition: GPS.h:172
dwGPSFixStatus
dwGPSFixStatus
GPS satellite fix status.
Definition: GPSFrame.h:166
dwGPSFrameNew::reserved
uint8_t reserved[508]
Reserved space.
Definition: GPS.h:297
dwGPSFrameNew::altitude
float64_t altitude
Definition: GPS.h:190
dwGPSFrameNew::utcTime
dwTime_t utcTime
Definition: GPS.h:244
dwGPSFrameNew::timestampQuality
dwGPSTimestampQuality timestampQuality
Definition: GPS.h:275
dwGPSFrameNew::hacc
float64_t hacc
Definition: GPS.h:232
dwGPSFrameNew
This structure contains one frame of data from an GPS/GNSS sensor.
Definition: GPS.h:163
dwGPSFrameNew::vacc
float64_t vacc
Definition: GPS.h:238
dwGPSFrameNew::course
float64_t course
Definition: GPS.h:196
dwSensorGPS_processRawDataNew
DW_API_PUBLIC dwStatus dwSensorGPS_processRawDataNew(uint8_t const *const data, size_t const size, dwSensorHandle_t const sensor) DW_DEPRECATED("dwSensorGPS_processRawDataNew() is deprecated and will be removed soon. Please use dwSensorGPS_processRawData() instead")
Decodes RAW data previously read.
dwGPSTimestampQuality
dwGPSTimestampQuality
GPS timestamp quality.
Definition: GPSFrame.h:181
sensor
DW_API_PUBLIC const dwSensorHandle_t sensor
Definition: Camera.h:714
dwGPSMode
dwGPSMode
The GPS mode gives the status of the GNSS data.
Definition: GPSFrame.h:130
dwTime_t
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:54
dwSensorGPS_popFrame
DW_API_PUBLIC dwStatus dwSensorGPS_popFrame(dwGPSFrame *const frame, dwSensorHandle_t const sensor)
Returns any GPS frame previously processed through RAW data stream.
dwGPSFrameNew::vdop
float64_t vdop
Definition: GPS.h:220
dwGPSFrameNew::fixStatus
dwGPSFixStatus fixStatus
Definition: GPS.h:263
dwGPSFrameNew::hdop
float64_t hdop
Definition: GPS.h:214
dwGPSFrameNew::longitude
float64_t longitude
Definition: GPS.h:184
DW_DEPRECATED
struct dwGPSFrameNew DW_DEPRECATED("dwGPSFrameNew is deprecated and will be removed soon. Please use dwGPSFrame instead")
This structure contains one frame of data from an GPS/GNSS sensor.
float64_t
double float64_t
Definition: BasicTypes.h:42
dwSensorGPS_processRawData
DW_API_PUBLIC dwStatus dwSensorGPS_processRawData(uint8_t const *const data, size_t const size, dwSensorHandle_t const sensor)
Decodes RAW data previously read.
dwGPSFrameNew::speed
float64_t speed
Definition: GPS.h:202
dwGPSFrameNew::latitude
float64_t latitude
Definition: GPS.h:178
GPSFrame.h
dwStatus
dwStatus
Status definition.
Definition: ErrorDefs.h:27
dwSensorGPS_popFrameNew
DW_API_PUBLIC dwStatus dwSensorGPS_popFrameNew(dwGPSFrameNew *const frame, dwSensorHandle_t const sensor) DW_DEPRECATED("dwSensorGPS_popFrameNew() is deprecated and will be removed soon. Please use dwSensorGPS_popFrame() instead")
Returns any GPS frame New previously processed through RAW data stream.
DW_API_PUBLIC
#define DW_API_PUBLIC
Definition: Exports.h:38
dwGPSSignalValidityInfo
This structure contains validity of each signal provided by GPS sensors.
Definition: GPSFrame.h:197
dwSensorGPS_readFrame
DW_API_PUBLIC dwStatus dwSensorGPS_readFrame(dwGPSFrame *const frame, dwTime_t const timeoutUs, dwSensorHandle_t const sensor)
Reads the next available GPS data frame with a given timeout.
dwGPSFrameNew::climb
float64_t climb
Definition: GPS.h:208
dwGPSFrameNew::mode
dwGPSMode mode
Definition: GPS.h:294
dwSensorGPS_readFrameNew
DW_API_PUBLIC dwStatus dwSensorGPS_readFrameNew(dwGPSFrameNew *const frame, dwTime_t const timeoutUs, dwSensorHandle_t const sensor) DW_DEPRECATED("dwSensorGPS_readFrameNew() is deprecated and will be removed soon. Please use dwSensorGPS_readFrame() instead")
Reads the next GPS packet with a given timeout.
dwGPSFrameNew::satelliteCount
uint8_t satelliteCount
Definition: GPS.h:251
dwGPSFrameNew::validityInfo
dwGPSSignalValidityInfo validityInfo
Signal validity information.
Definition: GPS.h:166