NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
Radar.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2017-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_RADAR_RADAR_H_
30 #define DW_SENSORS_RADAR_RADAR_H_
31 
32 #include "RadarFullTypes.h"
33 
34 #include <dw/core/base/Config.h>
35 #include <dw/sensors/common/Sensors.h>
36 #include <dw/sensors/radar/RadarScan.h>
37 #include <dw/sensors/radar/RadarTypes.h>
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
65 dwStatus dwSensorRadar_toggleScanType(bool const enable, dwRadarScanType const scanType, dwSensorHandle_t const sensor);
66 
86 
116  const dwTime_t timeoutUs, dwSensorHandle_t const sensor);
117 
139 
167 dwStatus dwSensorRadar_readScan(const dwRadarScan** const data,
168  const dwTime_t timeoutUs, dwSensorHandle_t const sensor);
169 
191 
216  const uint8_t* const rawData, size_t const size, dwSensorHandle_t const sensor);
217 
236 
255 
274 
301 
318 dwStatus dwSensorRadar_getScanDataSize(size_t* size, dwRadarScan const* scan);
319 
320 #ifdef __cplusplus
321 }
322 #endif
323 
325 #endif // DW_SENSORS_RADAR_RADAR_H_
dwRadarScanType
Defines the type of scan (combination of return type & range)
Definition: RadarTypes.h:189
dwRadarProperties
Defines the properties of the radar.
Definition: RadarTypes.h:424
dwSensorHandle_t
struct dwSensorObject * dwSensorHandle_t
Handle representing a sensor.
Definition: SensorTypes.h:42
dwSensorRadar_returnData
DW_API_PUBLIC dwStatus dwSensorRadar_returnData(const dwRadarScan *const scan, dwSensorHandle_t const sensor)
Returns the data read to the internal pool.
dwSensorRadar_setMountPosition
DW_API_PUBLIC dwStatus dwSensorRadar_setMountPosition(dwRadarMountPosition *const data, dwSensorHandle_t const sensor)
Sends the radar mount position information to the radar.
dwRadarMountPosition
Defines the structure for reporting sensor mount position.
Definition: RadarTypes.h:402
dwSensorRadar_setDataDecoding
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.
dwSensorRadar_getScanDataSize
DW_API_PUBLIC dwStatus dwSensorRadar_getScanDataSize(size_t *size, dwRadarScan const *scan)
Get size of the data buffer of a radar scan.
dwRadarScan
Defines the structure for a complete radar scan.
Definition: RadarFullTypes.h:42
dwSensorRadar_processRawData
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.
sensor
DW_API_PUBLIC const dwSensorHandle_t sensor
Definition: Camera.h:714
dwSensorRadar_getProperties
DW_API_PUBLIC dwStatus dwSensorRadar_getProperties(dwRadarProperties *const radarProperties, dwSensorHandle_t const sensor)
Gets information about the radar sensor.
dwTime_t
int64_t dwTime_t
Specifies a timestamp unit, in microseconds.
Definition: BasicTypes.h:54
WFDCommitType
WFDCommitType
Definition: wfd.h:112
dwSensorRadar_readScan
DW_API_PUBLIC dwStatus dwSensorRadar_readScan(const dwRadarScan **const data, const dwTime_t timeoutUs, dwSensorHandle_t const sensor)
Reads one scan chunk.
dwSensorRadar_setVehicleState
DW_API_PUBLIC dwStatus dwSensorRadar_setVehicleState(dwRadarVehicleState *const data, dwSensorHandle_t const sensor)
Sends vehicle dynamics information to the radar.
dwStatus
dwStatus
Status definition.
Definition: ErrorDefs.h:27
dwSensorRadar_returnScan
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.
dwSensorRadar_copyScan
DW_API_PUBLIC dwStatus dwSensorRadar_copyScan(dwRadarScan *dst, dwRadarScan const *src)
Deep-copy a radar scan.
dwSensorRadar_toggleScanType
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.
dwRadarVehicleState
Defines the structure for reporting current vehicle dynamics state.
Definition: RadarTypes.h:383
DW_API_PUBLIC
#define DW_API_PUBLIC
Definition: Exports.h:38
RadarFullTypes.h
dwSensorRadar_readData
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...