OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
hardware_io.android.ambient_light.AndroidAmbientLight Class Reference

Read Android illuminance measurements through the localhost bridge. More...

Inheritance diagram for hardware_io.android.ambient_light.AndroidAmbientLight:
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

Read Android illuminance measurements through the localhost bridge.

Member Function Documentation

◆ get_illuminance_lux()

float hardware_io.android.ambient_light.AndroidAmbientLight.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 hardware_io.android.ambient_light.AndroidAmbientLight.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: