DriveWorks SDK Reference
5.20.37 Release
For Test and Development only

Radar.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) 2017-2024 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_RADAR_RADAR_H_
48#define DW_SENSORS_RADAR_RADAR_H_
49
50#include "RadarFullTypes.h"
51
52#include <dw/core/base/Config.h>
56
57#ifdef __cplusplus
58extern "C" {
59#endif
60
82dwStatus dwSensorRadar_toggleScanType(bool const enable, dwRadarScanType const scanType, dwSensorHandle_t const sensor);
83
102
130 const dwTime_t timeoutUs, dwSensorHandle_t const sensor);
151
179 const dwTime_t timeoutUs, dwSensorHandle_t const sensor);
180
201
225 const uint8_t* const rawData, size_t const size, dwSensorHandle_t const sensor);
226
244
262
280
306
323
324#ifdef __cplusplus
325}
326#endif
327
329#endif // DW_SENSORS_RADAR_RADAR_H_
dwStatus
Status definition.
Definition: ErrorDefs.h:44
NVIDIA DriveWorks API: Radar
NVIDIA DriveWorks API: RadarScan
Defines the structure for reporting sensor mount position.
Definition: RadarTypes.h:362
Defines the properties of the radar.
Definition: RadarTypes.h:381
Defines the type of scan (combination of return type & range)
Definition: RadarTypes.h:168
Defines the structure for reporting current vehicle dynamics state.
Definition: RadarTypes.h:346
NVIDIA DriveWorks API: Sensors
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:65
#define DW_API_PUBLIC
Definition: Exports.h:56
DW_API_PUBLIC dwStatus dwSensorRadar_readScan(const dwRadarScan **const data, const dwTime_t timeoutUs, dwSensorHandle_t const sensor)
Reads one scan chunk.
DW_API_PUBLIC dwStatus dwSensorRadar_toggleScanType(bool const enable, dwRadarScanType const scanType, dwSensorHandle_t const sensor)
Enables/Disables a scan type for the radar sensor.
DW_API_PUBLIC dwStatus dwSensorRadar_readData(const dwRadarScan **const data, const dwRadarScanType type, const dwTime_t timeoutUs, dwSensorHandle_t const sensor)
Reads a single packet, which might be an entire scan or a fraction of a scan, which is sensor depende...
DW_API_PUBLIC dwStatus dwSensorRadar_processRawData(const dwRadarScan **const data, const uint8_t *const rawData, size_t const size, dwSensorHandle_t const sensor)
Decodes raw data previously read onto the application side structure.
DW_API_PUBLIC dwStatus dwSensorRadar_setMountPosition(dwRadarMountPosition *const data, dwSensorHandle_t const sensor)
Sends the radar mount position information to the radar.
DW_API_PUBLIC dwStatus dwSensorRadar_returnData(const dwRadarScan *const scan, dwSensorHandle_t const sensor)
Returns the data read to the internal pool.
DW_API_PUBLIC dwStatus dwSensorRadar_setDataDecoding(bool const enable, dwSensorHandle_t const sensor)
Enables/disables the decoding of the Radar packets, which incurs in additional CPU load.
DW_API_PUBLIC dwStatus dwSensorRadar_setVehicleState(dwRadarVehicleState *const data, dwSensorHandle_t const sensor)
Sends vehicle dynamics information to the radar.
DW_API_PUBLIC dwStatus dwSensorRadar_getProperties(dwRadarProperties *const radarProperties, dwSensorHandle_t const sensor)
Gets information about the radar sensor.
DW_API_PUBLIC dwStatus dwSensorRadar_returnScan(const dwRadarScan *const scan, dwSensorHandle_t const sensor)
Returns the data covering an entire scan read to the internal pool.
DW_API_PUBLIC dwStatus dwSensorRadar_getScanDataSize(size_t *size, dwRadarScan const *scan)
Get size of the data buffer of a radar scan.
DW_API_PUBLIC dwStatus dwSensorRadar_copyScan(dwRadarScan *dst, dwRadarScan const *src)
Deep-copy a radar scan.
Defines the structure for a complete radar scan.
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: SensorTypes.h:75