DriveWorks SDK Reference
5.12.103 Release
For Test and Development only

GPS.h
Go to the documentation of this file.
1
2//
3// Notice
4// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
5// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
6// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
7// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
8//
9// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
10// information or for any infringement of patents or other rights of third parties that may
11// result from its use. No license is granted by implication or otherwise under any patent
12// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
13// expressly authorized by NVIDIA. Details are subject to change without notice.
14// This code supersedes and replaces all information previously supplied.
15// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
16// components in life support devices or systems without express written approval of
17// NVIDIA CORPORATION & AFFILIATES.
18//
19// SPDX-FileCopyrightText: Copyright (c) 2016-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
20// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
21//
22// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
23// property and proprietary rights in and to this material, related
24// documentation and any modifications thereto. Any use, reproduction,
25// disclosure or distribution of this material and related documentation
26// without an express license agreement from NVIDIA CORPORATION or
27// its affiliates is strictly prohibited.
28//
30
47#ifndef DW_SENSORS_GPS_GPS_H_
48#define DW_SENSORS_GPS_GPS_H_
49
50#include <dw/core/base/Config.h>
52#include <dw/core/base/Types.h>
53
54#include <dw/sensors/Sensors.h>
55
56#include "GPSFrame.h"
57
58#ifdef __cplusplus
59extern "C" {
60#endif
61
65typedef struct dwGPSFrameNew
66{
69
75
81
87
93
99
105
111
117
123
129
135
141
147
154
166
178
197
199 uint8_t reserved[508];
201 DW_DEPRECATED("dwGPSFrameNew is deprecated and will be removed soon. Please use dwGPSFrame instead");
202
221dwStatus dwSensorGPS_readFrame(dwGPSFrame* const frame, dwTime_t const timeoutUs, dwSensorHandle_t const sensor);
222
238dwStatus dwSensorGPS_processRawData(uint8_t const* const data, size_t const size, dwSensorHandle_t const sensor);
239
254
272#pragma GCC diagnostic push // TODO(pshu): Remove in next major release
273#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
275dwStatus dwSensorGPS_readFrameNew(dwGPSFrameNew* const frame, dwTime_t const timeoutUs, dwSensorHandle_t const sensor)
276 DW_DEPRECATED("dwSensorGPS_readFrameNew() is deprecated and will be removed soon. Please use dwSensorGPS_readFrame() instead");
277#pragma GCC diagnostic pop
278
294dwStatus dwSensorGPS_processRawDataNew(uint8_t const* const data, size_t const size, dwSensorHandle_t const sensor)
295 DW_DEPRECATED("dwSensorGPS_processRawDataNew() is deprecated and will be removed soon. Please use dwSensorGPS_processRawData() instead");
296
309#pragma GCC diagnostic push // TODO(pshu): Remove in next major release
310#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
313 DW_DEPRECATED("dwSensorGPS_popFrameNew() is deprecated and will be removed soon. Please use dwSensorGPS_popFrame() instead");
314#pragma GCC diagnostic pop
315
316#ifdef __cplusplus
317}
318#endif
319#endif // DW_SENSORS_GPS_GPS_H_
dwStatus
Status definition.
Definition: ErrorDefs.h:45
dwGPSFixStatus
GPS satellite fix status.
Definition: GPSFrame.h:118
dwGPSMode
The GPS mode gives the status of the GNSS data.
Definition: GPSFrame.h:84
dwGPSTimestampQuality
GPS timestamp quality.
Definition: GPSFrame.h:131
A GPS packet containing localization information.
Definition: GPSFrame.h:205
This structure contains validity of each signal provided by GPS sensors.
Definition: GPSFrame.h:146
NVIDIA DriveWorks API: Sensors
NVIDIA DriveWorks API: Core Types
NVIDIA DriveWorks API: Core Exports
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:64
double float64_t
Definition: BasicTypes.h:59
#define DW_DEPRECATED(msg)
Definition: Exports.h:66
#define DW_API_PUBLIC
Definition: Exports.h:54
float64_t pdop
Definition: GPS.h:128
float64_t latitude
Definition: GPS.h:80
float64_t hacc
Definition: GPS.h:134
float64_t longitude
Definition: GPS.h:86
dwGPSSignalValidityInfo validityInfo
Signal validity information.
Definition: GPS.h:68
float64_t course
Definition: GPS.h:98
float64_t hdop
Definition: GPS.h:116
dwTime_t timestamp_us
Definition: GPS.h:74
float64_t vacc
Definition: GPS.h:140
float64_t speed
Definition: GPS.h:104
dwGPSTimestampQuality timestampQuality
Definition: GPS.h:177
dwGPSMode mode
Definition: GPS.h:196
dwGPSFixStatus fixStatus
Definition: GPS.h:165
uint8_t satelliteCount
Definition: GPS.h:153
float64_t climb
Definition: GPS.h:110
float64_t altitude
Definition: GPS.h:92
float64_t vdop
Definition: GPS.h:122
uint8_t reserved[508]
Reserved space.
Definition: GPS.h:199
dwTime_t utcTime
Definition: GPS.h:146
DW_API_PUBLIC dwStatus dwSensorGPS_processRawDataNew(uint8_t const *const data, size_t const size, dwSensorHandle_t const sensor)
Decodes RAW data previously read.
DW_API_PUBLIC dwStatus dwSensorGPS_readFrame(dwGPSFrame *const frame, dwTime_t const timeoutUs, dwSensorHandle_t const sensor)
Reads the next GPS packet with a given timeout.
DW_API_PUBLIC dwStatus dwSensorGPS_popFrame(dwGPSFrame *const frame, dwSensorHandle_t const sensor)
Returns any GPS frame previously processed through RAW data stream.
DW_API_PUBLIC dwStatus dwSensorGPS_processRawData(uint8_t const *const data, size_t const size, dwSensorHandle_t const sensor)
Decodes RAW data previously read.
DW_API_PUBLIC dwStatus dwSensorGPS_popFrameNew(dwGPSFrameNew *const frame, dwSensorHandle_t const sensor)
Returns any GPS frame New previously processed through RAW data stream.
DW_API_PUBLIC dwStatus dwSensorGPS_readFrameNew(dwGPSFrameNew *const frame, dwTime_t const timeoutUs, dwSensorHandle_t const sensor)
Reads the next GPS packet with a given timeout.
This structure contains one frame of data from an GPS/GNSS sensor.
Definition: GPS.h:66
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: Sensors.h:86