Arduino_APDS9960 - setLEDBoost()

Sets APDS LED boost to increase the power of the infra-red LED emitters embedded into the sensor. Up to 3 times of the nominal power may be set.

Syntax

APDS.setLEDBoost(boost_mode)

Parameters

• boost_mode: a number, between 0 and 3, that specify the desired power increase. 0 sets boost to 100% (this is the default power value), 1 sets boost to 150%, 2 sets boost to 200% and 3 sets boost to 300%.

Returns

1 on success, 0 on failure

Example

// Set LED output to maximum power.
APDS.setLEDBoost(3);

See also

• begin()
• end()
• gestureAvailable()
• readGesture()
• colorAvailable()
• readColor()
• proximityAvailable()
• readProximity()
• setGestureSensitivity()
• setInterruptPin()