All Implemented Interfaces:

com.diozero.api.DeviceInterface , com.diozero.devices.LuminositySensorInterface , com.diozero.devices.SensorInterface , java.lang.AutoCloseable
```
public final class VCNL4040
 implements LuminositySensorInterface
                    
```
Proximity and ambient light sensor on I2C bus. Note that this is not a "ranging" device as the proximity _ increases as an object approaches the sensor. The value is also not linear, but geometric.
- Datasheet
- Adafruit guide

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`VCNL4040.AmbientLightIntegrationTime`
`public enum`	`VCNL4040.AmbientLightPersistence`
`public enum`	`VCNL4040.ProximityIntegrationTime`
`public enum`	`VCNL4040.ProximityMultipulse`
`public enum`	`VCNL4040.LEDCurrent`
`public enum`	`VCNL4040.LEDDutyCycle`
`public enum`	`VCNL4040.ProximityInterruptType`
`public enum`	`VCNL4040.ProximityResolution`
`public enum`	`VCNL4040.ProximityOperation`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static Integer`	`DEFAULT_I2C_ADDRESS`
`public final static Integer`	`DEVICE_ID`
`private final Short`	`proximity`
`private final Short`	`ambientLight`
`private final Short`	`whiteLight`
`private final Integer`	`interruptStatus`
`private Short`	`ambientLightHighThreshold`
`private Short`	`ambientLightLowThreshold`
`private Short`	`proximityLowThreshold`
`private Short`	`proximityHighThreshold`
`private VCNL4040.AmbientLightIntegrationTime`	`ambientLightIntegrationTime`
`private VCNL4040.AmbientLightPersistence`	`ambientLightInterruptPersistence`
`private Boolean`	`ambientLightInterruptsEnabled`
`private Boolean`	`ambientLightEnabled`
`private VCNL4040.LEDDutyCycle`	`proximityLEDDutyCycle`
`private Integer`	`proximityInterruptPersistence`
`private VCNL4040.ProximityIntegrationTime`	`proximityIntegrationTime`
`private Boolean`	`proximityEnabled`
`private VCNL4040.ProximityResolution`	`proximityHighResolution`
`private VCNL4040.ProximityInterruptType`	`proximityInterrupts`
`private VCNL4040.ProximityMultipulse`	`proximityMultipulse`
`private Boolean`	`proximitySmartPersistenceEnabled`
`private Boolean`	`proximityActiveForceEnabled`
`private Boolean`	`sunlightCancelEnabled`
`private Boolean`	`whiteLightEnabled`
`private VCNL4040.ProximityOperation`	`proximityOperation`
`private VCNL4040.LEDCurrent`	`proximityLEDCurrent`

Constructor Summary

Constructors
Constructor	Description
`VCNL4040(Integer controller, Integer address)`
`VCNL4040(Integer controller)`
`VCNL4040()`
`VCNL4040(I2CDeviceInterface delegate)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Short`	`getProximity()`
`final Short`	`getAmbientLight()`
`final Short`	`getWhiteLight()`
`final Integer`	`getInterruptStatus()`
`final Short`	`getAmbientLightHighThreshold()`
`final Unit`	`setAmbientLightHighThreshold(Short ambientLightHighThreshold)`
`final Short`	`getAmbientLightLowThreshold()`
`final Unit`	`setAmbientLightLowThreshold(Short ambientLightLowThreshold)`
`final Short`	`getProximityLowThreshold()`
`final Unit`	`setProximityLowThreshold(Short proximityLowThreshold)`
`final Short`	`getProximityHighThreshold()`
`final Unit`	`setProximityHighThreshold(Short proximityHighThreshold)`
`final VCNL4040.AmbientLightIntegrationTime`	`getAmbientLightIntegrationTime()`
`final Unit`	`setAmbientLightIntegrationTime(VCNL4040.AmbientLightIntegrationTime ambientLightIntegrationTime)`
`final VCNL4040.AmbientLightPersistence`	`getAmbientLightInterruptPersistence()`
`final Unit`	`setAmbientLightInterruptPersistence(VCNL4040.AmbientLightPersistence ambientLightInterruptPersistence)`
`final Boolean`	`getAmbientLightInterruptsEnabled()`
`final Unit`	`setAmbientLightInterruptsEnabled(Boolean ambientLightInterruptsEnabled)`
`final Boolean`	`getAmbientLightEnabled()`
`final Unit`	`setAmbientLightEnabled(Boolean ambientLightEnabled)`
`final VCNL4040.LEDDutyCycle`	`getProximityLEDDutyCycle()`
`final Unit`	`setProximityLEDDutyCycle(VCNL4040.LEDDutyCycle proximityLEDDutyCycle)`
`final Integer`	`getProximityInterruptPersistence()`
`final Unit`	`setProximityInterruptPersistence(Integer proximityInterruptPersistence)`
`final VCNL4040.ProximityIntegrationTime`	`getProximityIntegrationTime()`
`final Unit`	`setProximityIntegrationTime(VCNL4040.ProximityIntegrationTime proximityIntegrationTime)`
`final Boolean`	`getProximityEnabled()`
`final Unit`	`setProximityEnabled(Boolean proximityEnabled)`
`final VCNL4040.ProximityResolution`	`getProximityHighResolution()`
`final Unit`	`setProximityHighResolution(VCNL4040.ProximityResolution proximityHighResolution)`
`final VCNL4040.ProximityInterruptType`	`getProximityInterrupts()`
`final Unit`	`setProximityInterrupts(VCNL4040.ProximityInterruptType proximityInterrupts)`
`final VCNL4040.ProximityMultipulse`	`getProximityMultipulse()`
`final Unit`	`setProximityMultipulse(VCNL4040.ProximityMultipulse proximityMultipulse)`
`final Boolean`	`getProximitySmartPersistenceEnabled()`
`final Unit`	`setProximitySmartPersistenceEnabled(Boolean proximitySmartPersistenceEnabled)`
`final Boolean`	`getProximityActiveForceEnabled()`
`final Unit`	`setProximityActiveForceEnabled(Boolean proximityActiveForceEnabled)`
`final Boolean`	`getSunlightCancelEnabled()`
`final Unit`	`setSunlightCancelEnabled(Boolean sunlightCancelEnabled)`
`final Boolean`	`getWhiteLightEnabled()`
`final Unit`	`setWhiteLightEnabled(Boolean whiteLightEnabled)`
`final VCNL4040.ProximityOperation`	`getProximityOperation()`
`final Unit`	`setProximityOperation(VCNL4040.ProximityOperation proximityOperation)`
`final VCNL4040.LEDCurrent`	`getProximityLEDCurrent()`
`final Unit`	`setProximityLEDCurrent(VCNL4040.LEDCurrent proximityLEDCurrent)`
`final Unit`	`dumpRegisters()`
`Unit`	`close()`
`Float`	`getLuminosity()`
`final Integer`	`isEnteringProtectionMode(Integer interruptStatus)`
`final Integer`	`isAmbientLightLow(Integer interruptStatus)`
`final Integer`	`isAmbientLightHigh(Integer interruptStatus)`
`final Integer`	`isProximityClose(Integer interruptStatus)`
`final Integer`	`isProximityFar(Integer interruptStatus)`
`final Unit`	`activeForceModeTrigger()`	Outputs one data cycle - see p.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VCNL4040

VCNL4040(Integer controller, Integer address)

VCNL4040
```
VCNL4040(Integer controller)
```

VCNL4040
```
VCNL4040()
```

VCNL4040
```
VCNL4040(I2CDeviceInterface delegate)
```

Method Detail

getProximity
```
 final Short getProximity()
```

getAmbientLight
```
 final Short getAmbientLight()
```

getWhiteLight
```
 final Short getWhiteLight()
```

getInterruptStatus
```
 final Integer getInterruptStatus()
```

getAmbientLightHighThreshold

 final Short getAmbientLightHighThreshold()

setAmbientLightHighThreshold

 final Unit setAmbientLightHighThreshold(Short ambientLightHighThreshold)

getAmbientLightLowThreshold

 final Short getAmbientLightLowThreshold()

setAmbientLightLowThreshold

 final Unit setAmbientLightLowThreshold(Short ambientLightLowThreshold)

getProximityLowThreshold
```
 final Short getProximityLowThreshold()
```

setProximityLowThreshold

 final Unit setProximityLowThreshold(Short proximityLowThreshold)

getProximityHighThreshold

 final Short getProximityHighThreshold()

setProximityHighThreshold

 final Unit setProximityHighThreshold(Short proximityHighThreshold)

getAmbientLightIntegrationTime

 final VCNL4040.AmbientLightIntegrationTime getAmbientLightIntegrationTime()

setAmbientLightIntegrationTime

 final Unit setAmbientLightIntegrationTime(VCNL4040.AmbientLightIntegrationTime ambientLightIntegrationTime)

getAmbientLightInterruptPersistence

 final VCNL4040.AmbientLightPersistence getAmbientLightInterruptPersistence()

setAmbientLightInterruptPersistence

 final Unit setAmbientLightInterruptPersistence(VCNL4040.AmbientLightPersistence ambientLightInterruptPersistence)

getAmbientLightInterruptsEnabled

 final Boolean getAmbientLightInterruptsEnabled()

setAmbientLightInterruptsEnabled

 final Unit setAmbientLightInterruptsEnabled(Boolean ambientLightInterruptsEnabled)

getAmbientLightEnabled
```
 final Boolean getAmbientLightEnabled()
```

setAmbientLightEnabled

 final Unit setAmbientLightEnabled(Boolean ambientLightEnabled)

getProximityLEDDutyCycle

 final VCNL4040.LEDDutyCycle getProximityLEDDutyCycle()

setProximityLEDDutyCycle

 final Unit setProximityLEDDutyCycle(VCNL4040.LEDDutyCycle proximityLEDDutyCycle)

getProximityInterruptPersistence

 final Integer getProximityInterruptPersistence()

setProximityInterruptPersistence

 final Unit setProximityInterruptPersistence(Integer proximityInterruptPersistence)

getProximityIntegrationTime

 final VCNL4040.ProximityIntegrationTime getProximityIntegrationTime()

setProximityIntegrationTime

 final Unit setProximityIntegrationTime(VCNL4040.ProximityIntegrationTime proximityIntegrationTime)

getProximityEnabled
```
 final Boolean getProximityEnabled()
```

setProximityEnabled

 final Unit setProximityEnabled(Boolean proximityEnabled)

getProximityHighResolution

 final VCNL4040.ProximityResolution getProximityHighResolution()

setProximityHighResolution

 final Unit setProximityHighResolution(VCNL4040.ProximityResolution proximityHighResolution)

getProximityInterrupts

 final VCNL4040.ProximityInterruptType getProximityInterrupts()

setProximityInterrupts

 final Unit setProximityInterrupts(VCNL4040.ProximityInterruptType proximityInterrupts)

getProximityMultipulse

 final VCNL4040.ProximityMultipulse getProximityMultipulse()

setProximityMultipulse

 final Unit setProximityMultipulse(VCNL4040.ProximityMultipulse proximityMultipulse)

getProximitySmartPersistenceEnabled

 final Boolean getProximitySmartPersistenceEnabled()

setProximitySmartPersistenceEnabled

 final Unit setProximitySmartPersistenceEnabled(Boolean proximitySmartPersistenceEnabled)

getProximityActiveForceEnabled

 final Boolean getProximityActiveForceEnabled()

setProximityActiveForceEnabled

 final Unit setProximityActiveForceEnabled(Boolean proximityActiveForceEnabled)

getSunlightCancelEnabled

 final Boolean getSunlightCancelEnabled()

setSunlightCancelEnabled

 final Unit setSunlightCancelEnabled(Boolean sunlightCancelEnabled)

getWhiteLightEnabled
```
 final Boolean getWhiteLightEnabled()
```

setWhiteLightEnabled

 final Unit setWhiteLightEnabled(Boolean whiteLightEnabled)

getProximityOperation

 final VCNL4040.ProximityOperation getProximityOperation()

setProximityOperation

 final Unit setProximityOperation(VCNL4040.ProximityOperation proximityOperation)

getProximityLEDCurrent

 final VCNL4040.LEDCurrent getProximityLEDCurrent()

setProximityLEDCurrent

 final Unit setProximityLEDCurrent(VCNL4040.LEDCurrent proximityLEDCurrent)

dumpRegisters
```
 final Unit dumpRegisters()
```

close
```
 Unit close()
```

getLuminosity
```
 Float getLuminosity()
```

isEnteringProtectionMode

 final Integer isEnteringProtectionMode(Integer interruptStatus)

isAmbientLightLow

 final Integer isAmbientLightLow(Integer interruptStatus)

isAmbientLightHigh

 final Integer isAmbientLightHigh(Integer interruptStatus)

isProximityClose

 final Integer isProximityClose(Integer interruptStatus)

isProximityFar

 final Integer isProximityFar(Integer interruptStatus)

activeForceModeTrigger
```
 final Unit activeForceModeTrigger()
```
Outputs one data cycle - see p. 10

Class VCNL4040

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VCNL4040

VCNL4040

VCNL4040

VCNL4040

Method Detail

getProximity

getAmbientLight

getWhiteLight

getInterruptStatus

getAmbientLightHighThreshold

setAmbientLightHighThreshold

getAmbientLightLowThreshold

setAmbientLightLowThreshold

getProximityLowThreshold

setProximityLowThreshold

getProximityHighThreshold

setProximityHighThreshold

getAmbientLightIntegrationTime

setAmbientLightIntegrationTime

getAmbientLightInterruptPersistence

setAmbientLightInterruptPersistence

getAmbientLightInterruptsEnabled

setAmbientLightInterruptsEnabled

getAmbientLightEnabled

setAmbientLightEnabled

getProximityLEDDutyCycle

setProximityLEDDutyCycle

getProximityInterruptPersistence

setProximityInterruptPersistence

getProximityIntegrationTime

setProximityIntegrationTime

getProximityEnabled

setProximityEnabled

getProximityHighResolution

setProximityHighResolution

getProximityInterrupts

setProximityInterrupts

getProximityMultipulse

setProximityMultipulse

getProximitySmartPersistenceEnabled

setProximitySmartPersistenceEnabled

getProximityActiveForceEnabled

setProximityActiveForceEnabled

getSunlightCancelEnabled

setSunlightCancelEnabled

getWhiteLightEnabled

setWhiteLightEnabled

getProximityOperation

setProximityOperation

getProximityLEDCurrent

setProximityLEDCurrent

dumpRegisters

close

getLuminosity

isEnteringProtectionMode

isAmbientLightLow

isAmbientLightHigh

isProximityClose

isProximityFar

activeForceModeTrigger