Evolution-x/hardware_interfaces
1
0
Fork 0
mirror of https://github.com/Evolution-X/hardware_interfaces synced 2026-02-01 11:36:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Update documentation of SensorInfo.aidl"

Browse Source
This commit is contained in:
TreeHugger Robot
2022-02-03 21:21:46 +00:00
committed by Android (Google) Code Review
parent 01b299483d b30f4556fc
commit c3ada23eb3
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
sensors/aidl/android/hardware/sensors/SensorInfo.aidl
View File

@@ -21,7 +21,7 @@ import android.hardware.sensors.SensorType;
@VintfStability
parcelable SensorInfo {
/**
* handle that identifies this sensors. This handle is used to reference
* Handle that identifies this sensors. This handle is used to reference
* this sensor throughout the HAL API.
*/
int sensorHandle;
@@ -33,25 +33,25 @@ parcelable SensorInfo {
String name;
/**
* vendor of the hardware part
* Vendor of the hardware part.
*/
String vendor;
/**
* version of the hardware part + driver. The value of this field
* must increase when the driver is updated in a way that changes the
* output of this sensor. This is important for fused sensors when the
* fusion algorithm is updated.
* Version of the hardware part + driver, used for informational purposes.
* The value of this field must increase when the driver is updated in a
* way that changes the output of this sensor. This is important for fused
* sensors when the fusion algorithm is updated.
*/
int version;
/**
* this sensor's type.
* This sensor's type.
*/
SensorType type;
/**
* type of this sensor as a string.
* Type of this sensor as a string.
*
* When defining an OEM specific sensor or sensor manufacturer specific
* sensor, use your reserve domain name as a prefix.
@@ -63,22 +63,22 @@ parcelable SensorInfo {
String typeAsString;
/**
* maximum range of this sensor's value in SI units
* Maximum range of this sensor's value in SI units
*/
float maxRange;
/**
* smallest difference between two values reported by this sensor
* Smallest difference between two values reported by this sensor
*/
float resolution;
/**
* rough estimate of this sensor's power consumption in mA
* Rough estimate of this sensor's power consumption in mA
*/
float power;
/**
* this value depends on the reporting mode:
* This value depends on the reporting mode:
*
* continuous: minimum sample period allowed in microseconds
* on-change : 0
@@ -88,7 +88,7 @@ parcelable SensorInfo {
int minDelayUs;
/**
* number of events reserved for this sensor in the batch mode FIFO.
* Number of events reserved for this sensor in the batch mode FIFO.
* If there is a dedicated FIFO for this sensor, then this is the
* size of this FIFO. If the FIFO is shared with other sensors,
* this is the size reserved for that sensor and it can be zero.
@@ -96,14 +96,14 @@ parcelable SensorInfo {
int fifoReservedEventCount;
/**
* maximum number of events of this sensor that could be batched.
* Maximum number of events of this sensor that could be batched.
* This is especially relevant when the FIFO is shared between
* several sensors; this value is then set to the size of that FIFO.
*/
int fifoMaxEventCount;
/**
* permission required to see this sensor, register to it and receive data.
* Permission required to see this sensor, register to it and receive data.
* Set to "" if no permission is required. Some sensor types like the
* heart rate monitor have a mandatory require_permission.
* For sensors that always require a specific permission, like the heart