Vision Apps User Guide

Introduction

This section contains module APIs for the image sensor framework.

Data Structures

struct  SensorObj
 Sensor Module Data Structure. More...
 

Functions

vx_status app_querry_sensor (SensorObj *sensorObj)
 Sensor module query sensor helper function. More...
 
vx_status app_init_sensor (SensorObj *sensorObj, char *objName)
 Sensor module init sensor helper function. More...
 
void app_deinit_sensor (SensorObj *sensorObj)
 Sensor module deinit sensor helper function. More...
 

Macros

#define APP_SENSOR_FEATURE_CFG_UC0   (0)
 Use case config value corresponding to ISS_SENSOR_FEATURE_CFG_UC0. More...
 
#define APP_SENSOR_FEATURE_CFG_UC1   (1)
 Use case config value corresponding to ISS_SENSOR_FEATURE_CFG_UC1. More...
 
#define APP_SENSOR_FEATURE_CFG_UC2   (2)
 Use case config value corresponding to ISS_SENSOR_FEATURE_CFG_UC2. More...
 

Macro Definition Documentation

◆ APP_SENSOR_FEATURE_CFG_UC0

#define APP_SENSOR_FEATURE_CFG_UC0   (0)

Use case config value corresponding to ISS_SENSOR_FEATURE_CFG_UC0.

◆ APP_SENSOR_FEATURE_CFG_UC1

#define APP_SENSOR_FEATURE_CFG_UC1   (1)

Use case config value corresponding to ISS_SENSOR_FEATURE_CFG_UC1.

◆ APP_SENSOR_FEATURE_CFG_UC2

#define APP_SENSOR_FEATURE_CFG_UC2   (2)

Use case config value corresponding to ISS_SENSOR_FEATURE_CFG_UC2.

Function Documentation

◆ app_querry_sensor()

vx_status app_querry_sensor ( SensorObj sensorObj)

Sensor module query sensor helper function.

This Sensor module query function queries the user for which sensor to use and populates sensor object parameters based on the chosen sensor; also supports automatic detection of available sensors

Parameters
[in,out]sensorObjSensor Module object which contains the sensor parameters

◆ app_init_sensor()

vx_status app_init_sensor ( SensorObj sensorObj,
char *  objName 
)

Sensor module init sensor helper function.

This Sensor module init function initializes the sensor after the sensor has been queried and set using the app_querry_sensor

Parameters
[in,out]sensorObjSensor Module object which contains the sensor parameters
[in]objNameString of the name of this object

◆ app_deinit_sensor()

void app_deinit_sensor ( SensorObj sensorObj)

Sensor module deinit sensor helper function.

This Sensor module deinit function deinitializes the sensor

Parameters
[in,out]sensorObjSensor Module object which contains the sensor parameters