0

Summarize platform sensor support in device/generic_sensor/README.md

This patch adds a table to device/generic_sensor/README.md which
documents the support matrix for the various sensor types exposed by
this service's public Mojo interface and how they map to the sensor APIs
on each platform.

BUG=None

Review-Url: https://codereview.chromium.org/2875793003
Cr-Commit-Position: refs/heads/master@{#470749}
This commit is contained in:
reillyg
2017-05-10 16:40:42 -07:00
committed by Commit bot
parent 8658a9aea0
commit 690014d5da

@ -8,6 +8,49 @@ Sensors Mojo interfaces are defined in the `public/interfaces` subdirectory.
The JS bindings are implemented in `third_party/WebKit/Source/modules/sensor`.
## Platform Support
Support for the SensorTypes defined by the Mojo interface is summarized in this
table. An empty cell indicates that the sensor type is not supported on that
platform.
| SensorType | Android | Linux | macOS | Windows |
| -------------------- | ------------------------- | -------------- | ------------------ | ----------------------------------------- |
| AMBIENT_LIGHT | TYPE_LIGHT | in_illuminance | AppleLMUController | SENSOR_TYPE_AMBIENT_LIGHT |
| PROXIMITY | | | | |
| ACCELEROMETER | TYPE_ACCELEROMETER | in_accel | | SENSOR_TYPE_ACCELEROMETER_3D |
| LINEAR_ACCELEROMETER | TYPE_LINEAR_ACCELEROMETER | | | |
| GYROSCOPE | TYPE_GYROSCOPE | in_anglvel | | SENSOR_TYPE_GYROMETER_3D |
| MAGNETOMETER | TYPE_MAGNETIC_FIELD | in_magn | | SENSOR_TYPE_COMPASS_3D |
| PRESSURE | | | | |
| ABSOLUTE_ORIENTATION | TYPE_ROTATION_VECTOR | | | SENSOR_TYPE_AGGREGATED_DEVICE_ORIENTATION |
### Android
Sensors are implemented by passing through values provided by the
[Sensor](https://developer.android.com/reference/android/hardware/Sensor.html)
class. The values in the "Android" column of the table above correspond to the
integer constants from the android.hardware.Sensor used to provide data for a
SensorType.
### Linux (and Chrome OS)
Sensors are implemented by reading values from the IIO subsystem. The values in
the "Linux" column of the table above are the prefix of the sysfs files Chrome
searches for to provide data for a SensorType.
### macOS
On this platform there is limited support for sensors. The AMBIENT_LIGHT sensor
type is provided by interpreting the value that can be read from the LMU.
### Windows
Sensors are implemented by passing through values provided by the
[Sensor API](https://msdn.microsoft.com/en-us/library/windows/desktop/dd318953(v=vs.85).aspx).
The values in the "Windows" column of the table above correspond to the names of
the sensor type GUIDs used to provide data for a SensorType.
## Testing
Sensors platform unit tests are located in the current directory and its