vehicle_prop_config Struct Reference

Data Fields
vehicle_prop_config Struct Reference

#include < vehicle.h >

Data Fields

int32_t  prop
 
int32_t  access
 
int32_t  change_mode
 
int32_t  value_type
 
int32_t  permission_model
 
union {
   int32_t    vehicle_zone_flags
 
   int32_t    vehicle_seat_flags
 
   int32_t    vehicle_window_flags
 
}; 
 
union {
   int32_t    config_flags
 
   int32_t    vehicle_radio_num_presets
 
   int32_t    config_array [4]
 
}; 
 
vehicle_str_t   config_string
 
union {
   float    float_min_value
 
   int32_t    int32_min_value
 
   int64_t    int64_min_value
 
}; 
 
union {
   float    float_max_value
 
   int32_t    int32_max_value
 
   int64_t    int64_max_value
 
}; 
 
union {
   float *    float_min_values
 
   int32_t *    int32_min_values
 
   int64_t *    int64_min_values
 
}; 
 
union {
   float *    float_max_values
 
   int32_t *    int32_max_values
 
   int64_t *    int64_max_values
 
}; 
 
float  min_sample_rate
 
float  max_sample_rate
 
void *  hal_data
 

Detailed Description

Definition at line 1319 of file vehicle.h .

Field Documentation

union { ... }

Specify minimum allowed value for the property. This is necessary for property which does not have specified enum.

union { ... }

Specify maximum allowed value for the property. This is necessary for property which does not have specified enum.

union { ... }

Array of min values for zoned properties. Zoned property can specify min / max value in two different ways:

  1. All zones having the same min / max value: *_min/max_value should be set and this array should be set to NULL.
  2. All zones having separate min / max value: *_min/max_values array should be populated and its length should be the same as number of active zones specified by *_zone_flags.

Should be NULL if each zone does not have separate max values.

union { ... }

Array of max values for zoned properties. See above for its usage. Should be NULL if each zone does not have separate max values. If not NULL, length of array should match that of min_values.

union { ... }

Some of the properties may have associated zones (such as hvac), in these cases the config should contain an ORed value for the associated zone.

union { ... }

Property specific configuration information. Usage of this will be defined per each property.

int32_t access

Defines if the property is read or write. Value should be one of enum vehicle_prop_access.

Definition at line 1326 of file vehicle.h .

int32_t change_mode

Defines if the property is continuous or on-change. Value should be one of enum vehicle_prop_change_mode.

Definition at line 1332 of file vehicle.h .

int32_t config_array[4]

Definition at line 1373 of file vehicle.h .

int32_t config_flags

For generic configuration information

Definition at line 1367 of file vehicle.h .

vehicle_str_t config_string

Some properties may require additional information passed over this string. Most properties do not need to set this and in that case, config_string.data should be NULL and config_string.len should be 0.

Definition at line 1381 of file vehicle.h .

float float_max_value

Definition at line 1398 of file vehicle.h .

float* float_max_values

Definition at line 1425 of file vehicle.h .

float float_min_value

Definition at line 1388 of file vehicle.h .

float* float_min_values

Definition at line 1414 of file vehicle.h .

void* hal_data

Place holder for putting HAL implementation specific data. Usage is wholly up to HAL implementation.

Definition at line 1442 of file vehicle.h .

int32_t int32_max_value

Definition at line 1399 of file vehicle.h .

int32_t* int32_max_values

Definition at line 1426 of file vehicle.h .

int32_t int32_min_value

Definition at line 1389 of file vehicle.h .

int32_t* int32_min_values

Definition at line 1415 of file vehicle.h .

int64_t int64_max_value

Definition at line 1400 of file vehicle.h .

int64_t* int64_max_values

Definition at line 1427 of file vehicle.h .

int64_t int64_min_value

Definition at line 1390 of file vehicle.h .

int64_t* int64_min_values

Definition at line 1416 of file vehicle.h .

float max_sample_rate

Max sample rate in Hz. Should be 0 for sensor type of VEHICLE_PROP_CHANGE_MODE_ON_CHANGE

Definition at line 1437 of file vehicle.h .

float min_sample_rate

Min sample rate in Hz. Should be 0 for sensor type of VEHICLE_PROP_CHANGE_MODE_ON_CHANGE

Definition at line 1433 of file vehicle.h .

int32_t permission_model

Define necessary permission model to access the data.

Definition at line 1343 of file vehicle.h .

int32_t prop

Definition at line 1320 of file vehicle.h .

int32_t value_type

Type of data used for this property. This type is fixed per each property. Check vehicle_value_type for allowed value.

Definition at line 1338 of file vehicle.h .

int32_t vehicle_radio_num_presets

The number of presets that are stored by the radio module. Pass 0 if there are no presets available. The range of presets is defined to be from 1 (see VEHICLE_RADIO_PRESET_MIN_VALUE) to vehicle_radio_num_presets.

Definition at line 1372 of file vehicle.h .

int32_t vehicle_seat_flags

The value is derived by ORing one or more of enum vehicle_seat members.

Definition at line 1355 of file vehicle.h .

int32_t vehicle_window_flags

The value is derived by ORing one or more of enum vehicle_window members.

Definition at line 1357 of file vehicle.h .

int32_t vehicle_zone_flags

The value is derived by ORing one or more of enum vehicle_zone members.

Definition at line 1353 of file vehicle.h .

The documentation for this struct was generated from the following file: