NVIDIA DriveWorks API: Ultrasonic
Description: This file defines methods to access the Ultrasonic sensor.
Definition in file Ultrasonic.h.
Go to the source code of this file.
Data Structures | |
| struct | dwUltrasonicEnvelope |
| Data structure containing all relevant information about a single envelope measurement Not available as of current release. More... | |
| struct | dwUltrasonicMountingPositions |
| Set of mounting parameters for each sensor. More... | |
| struct | dwUltrasonicProperties |
| Contextual information of the ultrasonic sensors currently used. More... | |
Macros | |
| #define | DW_ULTRASONIC_MAX_NUM_SENSORS 12 |
| The maximum number of sensors of any vendor, to allow compile time declarations. More... | |
| #define | DW_ULTRASONIC_MAX_NUM_SIGNAL_WAYS 32 |
| The maximum number of signal ways in one cycle of any vendor, to allow compile time declarations. More... | |
| #define | DW_ULTRASONIC_MAX_SAMPLE_SIZE 320 |
| The maximum envelope sample array size of any vendor, to allow compile time declarations. More... | |
Enumerations | |
| enum | dwUltrasonicMeasurementMode { DW_ULTRASONIC_MEASURE_MODE_UNKNOWN = 0, DW_ULTRASONIC_MEASURE_MODE_DUAL_AM_LOW = 1, DW_ULTRASONIC_MEASURE_MODE_DUAL_AM_HIGH = 2, DW_ULTRASONIC_MEASURE_MODE_DUAL_CHIRP_LOW = 3, DW_ULTRASONIC_MEASURE_MODE_DUAL_CHIRP_HIGH = 4, DW_ULTRASONIC_MEASURE_MODE_SINGLE_CHIRP_UP = 5, DW_ULTRASONIC_MEASURE_MODE_SINGLE_CHIRP_DOWN = 6 } |
| Measurement modes that define the transmission frequencies and firing patterns. More... | |
| enum | dwUltrasonicNearRangeDetectionStatus { DW_ULTRASONIC_NEAR_RANGE_UNAVAILABLE = 0, DW_ULTRASONIC_NEAR_RANGE_NO_DETECTION = 1, DW_ULTRASONIC_NEAR_RANGE_VALID_DETECTION = 2 } |
| Status to indicate whether the ultrasonic system could estimate a near range detection or not. More... | |
Functions | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_disableDecoding (dwSensorHandle_t sensor) |
| Disable the decoding of the Ultrasonic envelopes, which frees additional CPU load. More... | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_enableDecoding (dwSensorHandle_t sensor) |
| Enables the decoding of the Ultrasonic envelopes, which incurs an additional CPU load. More... | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_getProperties (dwUltrasonicProperties *properties, dwSensorHandle_t sensor) |
| Gets information about the Ultrasonic sensor. More... | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_isDecodingEnabled (bool *enable, dwSensorHandle_t sensor) |
| Retrieves the state of packet decoding. More... | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_processRawData (uint8_t const *data, size_t size, dwSensorHandle_t sensor) |
| Reads the Ultrasonic envelope from raw data. More... | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_readEnvelope (dwUltrasonicEnvelope const **envelope, dwTime_t timeout_us, dwSensorHandle_t sensor) |
| Reads a Ultrasonic envelope. More... | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_returnEnvelope (dwUltrasonicEnvelope const *envelope, dwSensorHandle_t sensor) |
| Returns the Ultrasonic envelope to the internal pool. More... | |
| DW_API_PUBLIC dwStatus | dwSensorUltrasonic_setTemperature (float32_t const temperature, dwSensorHandle_t sensor) |
| Sets the environment temperature to be used in temperature compensation of the incoming data. More... | |