Summary: Nested Classes | Methods | Inherited Methods | [Expand All]

UserSensor

public class UserSensor
extends Object

java.lang.Object
↳	com.google.android.things.userdriver.sensor.UserSensor

---

A user-defined sensor backed by a UserSensorDriver. Use UserSensor.Builder to create user sensors, and registerSensor(UserSensor) to register them.

Summary

Nested classes
class	UserSensor.Builder Builder to allow for flexible UserSensor construction.

Public methods
final UserSensorDriver	getDriver() Returns the sensor driver.
final int	getMaxDelay() Returns the sensor max delay between readings.
final float	getMaxRange() Returns the sensor maximum reading range.
final int	getMinDelay() Returns the sensor min delay between readings.
final String	getName() Returns the sensor name.
final float	getPower() Returns the sensor power consumption while enabled.
final int	getReportingMode() Returns the sensor reporting mode.
final float	getResolution() Returns the sensor minimum detectable resolution.
final String	getStringType() Returns the sensor type string.
final int	getType() Returns the sensor type.
final UUID	getUuid() Returns the sensor UUID.
final String	getVendor() Returns the sensor driver vendor name.
final int	getVersion() Returns the sensor driver version.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long millis, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long millis) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.

Public methods

getDriver

UserSensorDriver getDriver ()

Returns the sensor driver.

Returns
UserSensorDriver	controlling UserSensorDriver

See also:

• setDriver(UserSensorDriver)

getMaxDelay

int getMaxDelay ()

Returns the sensor max delay between readings.

Returns
int	max delay in microseconds

See also:

• setMaxDelay(int)

getMaxRange

float getMaxRange ()

Returns the sensor maximum reading range.

Returns
float	maximum sensor range in the sensor's reporting units

See also:

• setMaxRange(float)

getMinDelay

int getMinDelay ()

Returns the sensor min delay between readings.

Returns
int	min delay in microseconds

See also:

• setMinDelay(int)

getName

String getName ()

Returns the sensor name.

Returns
String	name string

See also:

• setName(String)

getPower

float getPower ()

Returns the sensor power consumption while enabled.

Returns
float	power consumption in milliAmps

See also:

• setPower(float)

getReportingMode

int getReportingMode ()

Returns the sensor reporting mode.

Returns
int	android.hardware.Sensor.REPORTING_MODE_* constant

See also:

• setType(int)
• setCustomType(int, String, int)

getResolution

float getResolution ()

Returns the sensor minimum detectable resolution.

Returns
float	resolution in the sensor's reporting units

See also:

• setResolution(float)

getStringType

String getStringType ()

Returns the sensor type string.

Returns
String	sensor type as a string

See also:

• setType(int)
• setCustomType(int, String, int)

getType

int getType ()

Returns the sensor type.

Returns
int	android.hardware.Sensor type

See also:

• setType(int)
• setCustomType(int, String, int)

getUuid

UUID getUuid ()

Returns the sensor UUID.

Returns
UUID	sensor UUID, or 0 if not set

See also:

• setUuid(UUID)

getVendor

String getVendor ()

Returns the sensor driver vendor name.

Returns
String	vendor name

See also:

• setVendor(String)

getVersion

int getVersion ()

Returns the sensor driver version.

Returns
int	version number

See also:

• setVersion(int)

• Interfaces

  • UserSensorDriver

• Classes

  • UserSensor
  • UserSensor.Builder
  • UserSensorReading