AmbientLightSensor

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The AmbientLightSensor interface of 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

BCD tables only load in the browser