AmbientLightSensor

You’re reading the English version of this content since no translation exists yet for this locale. Help us translate this article!

The AmbientLightSensor interface of the the Sensor APIs returns the current light level or illuminance of the ambient light around the hosting device.

To use this sensor, the user must grant permission to the 'ambient-light-sensor' device sensor through the Permissions API.

If a feature policy blocks use of a feature it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. See Feature-Policy for implementation instructions.

Constructor

AmbientLightSensor.AmbientLightSensor()
Creates a new AmbientLightSensor object.

Properties

AmbientLightSensor.illuminance
Returns the current light level in lux of the ambient light level around the hosting device.

Example

if ( 'AmbientLightSensor' in window ) {
  const sensor = new AmbientLightSensor();
  sensor.onreading = () => {
    console.log('Current light level:', sensor.illuminance);
  };
  sensor.onerror = (event) => {
    console.log(event.error.name, event.error.message);
  };
  sensor.start();
}

Specifications

Specification Status Comment
Generic Sensor API Candidate Recommendation Defines sensors in general.
Ambient Light Sensor
The definition of 'AmbientLightSensor' in that specification.
Candidate Recommendation  

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
AmbientLightSensorChrome Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Chrome Android Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Firefox Android ? Opera Android Full support 48Safari iOS ? Samsung Internet Android ?
AmbientLightSensor() constructorChrome Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Chrome Android Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Firefox Android ? Opera Android Full support 48Safari iOS ? Samsung Internet Android ?
illuminanceChrome Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Full support 79
Notes
Notes Stopped returning floats and returned integers avoid fingerprinting.
Edge ? Firefox ? IE ? Opera Full support 56Safari ? WebView Android Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Full support 79
Notes
Notes Stopped returning floats and returned integers avoid fingerprinting.
Chrome Android Full support 54
Full support 54
Full support 69
Notes
Notes Based on Generic Sensor API.
Full support 79
Notes
Notes Stopped returning floats and returned integers avoid fingerprinting.
Firefox Android ? Opera Android Full support 48Safari iOS ? Samsung Internet Android ?

Legend

Full support  
Full support
Compatibility unknown  
Compatibility unknown
See implementation notes.
See implementation notes.