Reference   Language | Libraries | Comparison | Changes

ArduinoAPDS9960 : APDS class

setLEDBoost()

Description

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 - it’s a number, between 0 and 3, that specify the desired power increase:
0 - sets boost to 100% (this is the default)
1 - sets boost to 150%
2 - sets boost to 200%
3 - sets boost to 300%

Returns

1 on success, 0 on failure

Example

…
  APDS.setLEDBoost(3); // Set LED output to maximum power
…
[Get Code]

See Also



Reference Home

Corrections, suggestions, and new documentation should be posted to the Forum.

The text of the Arduino reference is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.