com.qualcomm.hardware.ams

Class AMSColorSensor.Parameters

java.lang.Object

com.qualcomm.hardware.ams.AMSColorSensor.Parameters

All Implemented Interfaces:

java.lang.Cloneable

Enclosing interface:

AMSColorSensor

public static class AMSColorSensor.Parameters
extends java.lang.Object
implements java.lang.Cloneable

Instances of Parameters contain data indicating how the sensor is to be initialized.

See Also:

AMSColorSensor.initialize(Parameters)

Field Summary

Fields

Modifier and Type	Field and Description
int	atime the integration time to use for color sensing
int	deviceId the device id expected to be reported by the color sensor chip
AMSColorSensor.Gain	gain the gain level to use for color sensing
I2cAddr	i2cAddr the address at which the sensor resides on the I2C bus.
AMSColorSensor.LEDDrive	ledDrive when using proximity, controls the nominal proximity LED drive current
boolean	loggingEnabled debugging aid: enable logging for this device?
java.lang.String	loggingTag debugging aid: the logging tag to use when logging
int	proximityPulseCount when using the proximity functionality, controls the number of times the proximity LED is pulsed each cycle.
int	proximitySaturation the maximum possible raw proximity value read.
I2cDeviceSynch.ReadWindow	readWindow set of registers to read in background, if supported by underlying I2cDeviceSynch
boolean	useProximityIfAvailable whether we should turn on the proximity functionality if it is available on the chip in question

Constructor Summary

Constructors

Constructor and Description
Parameters(I2cAddr i2cAddr, int deviceId)

Method Summary

Modifier and Type	Method and Description
static int	atimeFromMs(float msAccumulationInterval) Returns the minimum integration register value ('atime') for which the accumulation interval is at least the indicated duration in length.
AMSColorSensor.Parameters	clone()
static AMSColorSensor.Parameters	createForTCS34725()
static AMSColorSensor.Parameters	createForTMD37821()
int	getMaximumReading() Returns the maximum intensity count that can be reached in the currently configured accumulation time interval
int	integrationCycles() Returns the number of 2.4ms integration cycles currently configured for each accumulation time interval
float	msAccumulationInterval() Returns the duration of the accumulation interval

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deviceId

public int deviceId

the device id expected to be reported by the color sensor chip

i2cAddr

public I2cAddr i2cAddr

the address at which the sensor resides on the I2C bus.

gain

public AMSColorSensor.Gain gain

the gain level to use for color sensing

atime

public int atime

the integration time to use for color sensing

useProximityIfAvailable

public boolean useProximityIfAvailable

whether we should turn on the proximity functionality if it is available on the chip in question

proximityPulseCount

public int proximityPulseCount

when using the proximity functionality, controls the number of times the proximity LED is pulsed each cycle.

ledDrive

public AMSColorSensor.LEDDrive ledDrive

when using proximity, controls the nominal proximity LED drive current

proximitySaturation

public int proximitySaturation

the maximum possible raw proximity value read. is sensitive to ledDrive and proximityPulseCount.

loggingEnabled

public boolean loggingEnabled

debugging aid: enable logging for this device?

loggingTag

public java.lang.String loggingTag

debugging aid: the logging tag to use when logging

readWindow

public I2cDeviceSynch.ReadWindow readWindow

set of registers to read in background, if supported by underlying I2cDeviceSynch

Constructor Detail

Parameters

public Parameters(I2cAddr i2cAddr,
                  int deviceId)

Method Detail

atimeFromMs

public static int atimeFromMs(float msAccumulationInterval)

Returns the minimum integration register value ('atime') for which the accumulation interval is at least the indicated duration in length.

integrationCycles

public int integrationCycles()

Returns the number of 2.4ms integration cycles currently configured for each accumulation time interval

getMaximumReading

public int getMaximumReading()

Returns the maximum intensity count that can be reached in the currently configured accumulation time interval

msAccumulationInterval

public float msAccumulationInterval()

Returns the duration of the accumulation interval

createForTCS34725

public static AMSColorSensor.Parameters createForTCS34725()

createForTMD37821

public static AMSColorSensor.Parameters createForTMD37821()

clone

public AMSColorSensor.Parameters clone()

Overrides:

clone in class java.lang.Object