Sensors.h File Reference

Detailed Description

NVIDIA DriveWorks API: Sensors

Description: This file defines the sensor abstraction layer.

Definition in file Sensors.h.

Go to the source code of this file.

Data Structures
struct	dwSensorParams
	Holds sets of parameters for sensor creation. More...
struct	dwSensorStats
	Holds the available statistics for a sensor. More...

Macros
#define	DW_SENSOR_MAX_PROTOCOL_NAME_LENGTH   32
	Maximal length of the protocol name of a sensor. More...

Typedefs
typedef struct dwSALObject *	dwSALHandle_t
	Handle representing the Sensor Abstraction Layer interface. More...
typedef struct dwSensorObject *	dwSensorHandle_t
	Handle representing a sensor. More...

Enumerations
enum	dwPlatformOS {   DW_PLATFORM_OS_LINUX = 0,   DW_PLATFORM_OS_V5L = 1,   DW_PLATFORM_NUM = 2 }
	Defines the operating system in use. More...
enum	dwSensorType {   DW_SENSOR_CAMERA = 0,   DW_SENSOR_LIDAR,   DW_SENSOR_GPS,   DW_SENSOR_IMU,   DW_SENSOR_CAN,   DW_SENSOR_RADAR }
	Defines the type of sensors that are available in DriveWorks. More...

Functions
DW_API_PUBLIC dwStatus	dwSAL_createSensor (dwSensorHandle_t *sensor, dwSensorParams params, dwSALHandle_t sal)
	Creates a new sensor managed by the SAL module with the given parameters. More...
DW_API_PUBLIC dwStatus	dwSAL_getNumSensors (uint32_t *num, dwPlatformOS os, dwSALHandle_t sal)
	Gets number of available sensors for a platform. More...
DW_API_PUBLIC dwStatus	dwSAL_getPlatform (dwPlatformOS *os, dwSALHandle_t sal)
	Gets current platform the SDK is running on. More...
DW_API_PUBLIC dwStatus	dwSAL_getPlatformInfo (const char **osName, dwPlatformOS os, dwSALHandle_t sal)
	Gets detailed information about the running hardware platform and operating system. More...
DW_API_PUBLIC dwStatus	dwSAL_getSensorParameterString (const char **parameters, uint32_t idx, dwPlatformOS os, dwSALHandle_t sal)
	Gets the parameter string acceptable by a sensor. More...
DW_API_PUBLIC dwStatus	dwSAL_getSensorProtocol (const char **name, uint32_t idx, dwPlatformOS os, dwSALHandle_t sal)
	Gets protocol name of a sensor for a given index, e.g., camera.gmsl or can.file. More...
DW_API_PUBLIC dwStatus	dwSAL_initialize (dwSALHandle_t *sal, dwContextHandle_t context)
	Creates and initializes a SAL module. More...
DW_API_PUBLIC dwStatus	dwSAL_release (dwSALHandle_t *sal)
	Releases the SAL module. More...
DW_API_PUBLIC dwStatus	dwSAL_releaseSensor (dwSensorHandle_t *sensor)
	Releases a sensor managed by the SAL module. More...
DW_API_PUBLIC dwStatus	dwSAL_reset (dwSALHandle_t sal)
	Resets the SAL module. More...
DW_API_PUBLIC dwStatus	dwSensor_createSeekTable (dwSensorHandle_t sensor)
	Forces recreation of the seek table, for sensors that support seeking. More...
DW_API_PUBLIC dwStatus	dwSensor_getCurrentSeekPosition (size_t *event, dwSensorHandle_t sensor)
	Gets the current seek position of the sensor. More...
DW_API_PUBLIC dwStatus	dwSensor_getSeekRange (size_t *eventCount, dwTime_t *startTimestamp_us, dwTime_t *endTimestamp_us, dwSensorHandle_t sensor)
	Retrieves the valid range of seek parameters, for sensors that support seeking. More...
DW_API_PUBLIC dwStatus	dwSensor_getStats (dwSensorStats *stats, dwSensorHandle_t sensor)
	Gets sensor statistics (if available). More...
DW_API_PUBLIC dwStatus	dwSensor_readRawData (const uint8_t **data, size_t *size, dwTime_t timeout_us, dwSensorHandle_t sensor)
	Reads RAW data from sensor as byte array. More...
DW_API_PUBLIC dwStatus	dwSensor_reset (dwSensorHandle_t sensor)
	Resets the sensor. More...
DW_API_PUBLIC dwStatus	dwSensor_returnRawData (const uint8_t *data, dwSensorHandle_t sensor)
	Returns RAW data to sensor as a byte array. More...
DW_API_PUBLIC dwStatus	dwSensor_saveSeekTable (const char *fileName, dwSensorHandle_t sensor)
	Saves the seek table for the sensor to a file, for sensors that support seek tables. More...
DW_API_PUBLIC dwStatus	dwSensor_seekToEvent (size_t event, dwSensorHandle_t sensor)
	Seeks the sensor to an event, for sensors that support seeking. More...
DW_API_PUBLIC dwStatus	dwSensor_seekToTime (dwTime_t timestamp_us, dwSensorHandle_t sensor)
	Seeks the sensor to a specific timestamp, for sensors that support seeking. More...
DW_API_PUBLIC dwStatus	dwSensor_setThreadAffinity (int32_t affinityMask, dwSensorHandle_t sensor)
	Sets the affinity of the internal thread, for sensors that use an internal thread to communicate to the OS drivers. More...
DW_API_PUBLIC dwStatus	dwSensor_setThreadPriority (int32_t priority, dwSensorHandle_t sensor)
	Sets the priority of the internal thread, for sensors that use an internal thread to communicate to the OS drivers. More...
DW_API_PUBLIC dwStatus	dwSensor_start (dwSensorHandle_t sensor)
	Starts the sensor previously successfully created with dwSAL_createSensor(). More...
DW_API_PUBLIC dwStatus	dwSensor_stop (dwSensorHandle_t sensor)
	Stops the sensor. More...