UserSensorDriver
public
abstract
class
UserSensorDriver
extends Object
| java.lang.Object | |
| ↳ | com.google.android.things.userdriver.UserSensorDriver |
Driver to interface with a user-connected sensor.
This class is responsible for the actual I/O operations to talk to the sensor. Usage is to
pass this to a UserSensor.Builder to create a UserSensor.
Summary
Public constructors | |
|---|---|
UserSensorDriver()
|
|
Public methods | |
|---|---|
abstract
UserSensorReading
|
read()
Reads the sensor. |
void
|
setEnabled(boolean enabled)
Enables or disables the sensor. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
Public constructors
UserSensorDriver
</div>
UserSensorDriver ()
</div>
Public methods
read
</div>
UserSensorReading read ()
Reads the sensor.
Will not be called before the sensor has been successfully enabled, or after the sensor has been disabled.
If an exception is thrown, nothing will be reported to the framework and the sensor will be re-read on the next iteration.</p>
| Returns | |
|---|---|
UserSensorReading |
A new UserSensorReading. |
| Throws | |
|---|---|
IOException |
if reading fails. |
</div>
setEnabled
</div>
void setEnabled (boolean enabled)
Enables or disables the sensor.
If the sensor has a low power/sleep mode, this should be overridden to start sleep when enable == false and leave sleep when enable == true.
If an exception is thrown while enabling, the sensor will remain in disabled mode and will not be polled for readings. Further attempts may be made to re-enable the sensor.
If an exception is thrown while disabling, the sensor will still be put in disabled mode and will stop being polled for readings. Subsequent attempts may be made to re-enable it.</p>
| Parameters | |
|---|---|
enabled |
boolean:
True to enable the sensor, false to disable. |
| Throws | |
|---|---|
IOException |
if sensor configuration fails. |
</div>