NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
RadarDecoder.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2017-2024 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 
20 #ifndef DW_SENSORS_PLUGINS_RADAR_DECODER_H_
21 #define DW_SENSORS_PLUGINS_RADAR_DECODER_H_
22 
31 #include <dw/core/base/Types.h>
32 #include <dw/sensors/radar/Radar.h>
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
39 typedef struct
40 {
43 
45  size_t headerSize;
46 
49 
52 
54  size_t mountSize;
56 
64 
72 
82 
96  const uint8_t* buffer,
97  const size_t length,
98  const dwRadarScanType scanType);
99 
110 dwStatus _dwRadarDecoder_synchronize(const uint8_t* buffer,
111  const size_t length,
112  size_t* remaining);
113 
125 dwStatus _dwRadarDecoder_validatePacket(const uint8_t* buffer,
126  const size_t length,
127  dwRadarScanType* scanType);
128 
142  const uint8_t** buffer,
143  size_t* length,
144  size_t numPackets);
145 
160  const size_t maxOutputSize,
161  const dwRadarVehicleState* packet);
162 
177  const size_t maxOutputSize,
178  const dwRadarMountPosition* packet);
179 
182 #ifdef __cplusplus
183 }
184 #endif
185 
186 #endif
dwRadarScanType
Defines the type of scan (combination of return type & range)
Definition: RadarTypes.h:189
_dwRadarDecoder_constants
Holds constants for a given radar.
Definition: RadarDecoder.h:39
dwRadarProperties
Defines the properties of the radar.
Definition: RadarTypes.h:424
_dwRadarDecoder_release
dwStatus _dwRadarDecoder_release()
Releases the radar decoder.
_dwRadarDecoder_validatePacket
dwStatus _dwRadarDecoder_validatePacket(const uint8_t *buffer, const size_t length, dwRadarScanType *scanType)
Determines whether a byte array of packet data is valid.
dwRadarMountPosition
Defines the structure for reporting sensor mount position.
Definition: RadarTypes.h:402
dwRadarScan
Defines the structure for a complete radar scan.
Definition: RadarFullTypes.h:42
_dwRadarDecoder_decodePacket
dwStatus _dwRadarDecoder_decodePacket(dwRadarScan *output, const uint8_t *buffer, const size_t length, const dwRadarScanType scanType)
Decodes a packet from the radar, given a raw byte array and a specified decoding format.
_dwRadarDecoder_constants::maxPayloadSize
size_t maxPayloadSize
Packet max payload size (in bytes).
Definition: RadarDecoder.h:48
_dwRadarDecoder_getConstants
dwStatus _dwRadarDecoder_getConstants(_dwRadarDecoder_constants *constants)
Gets constants associated with this radar sensor.
_dwRadarDecoder_constants::properties
dwRadarProperties properties
Radar properties.
Definition: RadarDecoder.h:42
_dwRadarDecoder_constants::vehicleStateSize
size_t vehicleStateSize
Size of the vehicle state message to be sent to the radar.
Definition: RadarDecoder.h:51
_dwRadarDecoder_synchronize
dwStatus _dwRadarDecoder_synchronize(const uint8_t *buffer, const size_t length, size_t *remaining)
Determines whether a byte array of packet data has a valid radar signature.
_dwRadarDecoder_initialize
dwStatus _dwRadarDecoder_initialize()
Initializes the radar decoder.
_dwRadarDecoder_isScanComplete
bool _dwRadarDecoder_isScanComplete(dwRadarScanType scanType, const uint8_t **buffer, size_t *length, size_t numPackets)
Returns the status of the scan.
_dwRadarDecoder_encodeVehicleState
dwStatus _dwRadarDecoder_encodeVehicleState(uint8_t *buffer, const size_t maxOutputSize, const dwRadarVehicleState *packet)
Encodes data from a /ref dwRadarVehicleState into a raw byte array.
_dwRadarDecoder_encodeMountPosition
dwStatus _dwRadarDecoder_encodeMountPosition(uint8_t *buffer, const size_t maxOutputSize, const dwRadarMountPosition *packet)
Encodes data from a /ref dwRadarMountPosition into a raw byte array.
_dwRadarDecoder_constants::mountSize
size_t mountSize
Size of the mount poisition message to be sent to the radar.
Definition: RadarDecoder.h:54
_dwRadarDecoder_constants::headerSize
size_t headerSize
Packet header size (in bytes).
Definition: RadarDecoder.h:45
dwStatus
dwStatus
Status definition.
Definition: ErrorDefs.h:27
dwRadarVehicleState
Defines the structure for reporting current vehicle dynamics state.
Definition: RadarTypes.h:383