OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
environmental.buffered_ambient_light_sensor.BufferedAmbientLightSensor Class Reference

Store the latest pushed illuminance for AmbientLightController. More...

Inheritance diagram for environmental.buffered_ambient_light_sensor.BufferedAmbientLightSensor:
hardware_io.environmental.ambient_light_sensor_if.AmbientLightSensorIf

Public Member Functions

bool is_started (self)
 Return whether the sensor has been initialized.
 
None start (self)
 Initialize the sensor and prepare it for use.
 
None stop (self)
 Release resources owned by the sensor.
 
float get_illuminance_lux (self)
 Read ambient illuminance.
 

Detailed Description

Store the latest pushed illuminance for AmbientLightController.

Member Function Documentation

◆ get_illuminance_lux()

float environmental.buffered_ambient_light_sensor.BufferedAmbientLightSensor.get_illuminance_lux (   self)

Read ambient illuminance.

Returns
Ambient illuminance in lux.

Reimplemented from hardware_io.environmental.ambient_light_sensor_if.AmbientLightSensorIf.

◆ is_started()

bool environmental.buffered_ambient_light_sensor.BufferedAmbientLightSensor.is_started (   self)

Return whether the sensor has been initialized.

Return values
TrueThe sensor is initialized and readable.
FalseThe sensor has not been started.

Reimplemented from hardware_io.environmental.ambient_light_sensor_if.AmbientLightSensorIf.


The documentation for this class was generated from the following file: