ESPHome  2024.10.0
Data Structures | Enumerations
esphome::tsl2591 Namespace Reference

Data Structures

class  TSL2591Component
 This class includes support for the TSL2591 i2c ambient light sensor. More...
 

Enumerations

enum  TSL2591IntegrationTime {
  TSL2591_INTEGRATION_TIME_100MS = 0b000, TSL2591_INTEGRATION_TIME_200MS = 0b001, TSL2591_INTEGRATION_TIME_300MS = 0b010, TSL2591_INTEGRATION_TIME_400MS = 0b011,
  TSL2591_INTEGRATION_TIME_500MS = 0b100, TSL2591_INTEGRATION_TIME_600MS = 0b101
}
 Enum listing all conversion/integration time settings for the TSL2591. More...
 
enum  TSL2591ComponentGain {
  TSL2591_CGAIN_LOW, TSL2591_CGAIN_MED, TSL2591_CGAIN_HIGH, TSL2591_CGAIN_MAX,
  TSL2591_CGAIN_AUTO
}
 Enum listing all gain settings for the TSL2591 component. More...
 
enum  TSL2591Gain { TSL2591_GAIN_LOW = 0b00 << 4, TSL2591_GAIN_MED = 0b01 << 4, TSL2591_GAIN_HIGH = 0b10 << 4, TSL2591_GAIN_MAX = 0b11 << 4 }
 Enum listing all gain settings for the TSL2591. More...
 
enum  TSL2591SensorChannel { TSL2591_SENSOR_CHANNEL_VISIBLE, TSL2591_SENSOR_CHANNEL_INFRARED, TSL2591_SENSOR_CHANNEL_FULL_SPECTRUM }
 Enum listing sensor channels. More...
 

Enumeration Type Documentation

◆ TSL2591ComponentGain

Enum listing all gain settings for the TSL2591 component.

Enum constants are used by the component to allow auto gain, not directly to registers Higher values are better for low light situations, but can increase noise.

Enumerator
TSL2591_CGAIN_LOW 
TSL2591_CGAIN_MED 
TSL2591_CGAIN_HIGH 
TSL2591_CGAIN_MAX 
TSL2591_CGAIN_AUTO 

Definition at line 31 of file tsl2591.h.

◆ TSL2591Gain

Enum listing all gain settings for the TSL2591.

Specific values of the enum constants are register values taken from the TSL2591 datasheet. Higher values are better for low light situations, but can increase noise.

Enumerator
TSL2591_GAIN_LOW 
TSL2591_GAIN_MED 
TSL2591_GAIN_HIGH 
TSL2591_GAIN_MAX 

Definition at line 44 of file tsl2591.h.

◆ TSL2591IntegrationTime

Enum listing all conversion/integration time settings for the TSL2591.

Specific values of the enum constants are register values taken from the TSL2591 datasheet. Longer times mean more accurate results, but will take more energy/more time.

Enumerator
TSL2591_INTEGRATION_TIME_100MS 
TSL2591_INTEGRATION_TIME_200MS 
TSL2591_INTEGRATION_TIME_300MS 
TSL2591_INTEGRATION_TIME_400MS 
TSL2591_INTEGRATION_TIME_500MS 
TSL2591_INTEGRATION_TIME_600MS 

Definition at line 17 of file tsl2591.h.

◆ TSL2591SensorChannel

Enum listing sensor channels.

They identify the type of light to report.

Enumerator
TSL2591_SENSOR_CHANNEL_VISIBLE 
TSL2591_SENSOR_CHANNEL_INFRARED 
TSL2591_SENSOR_CHANNEL_FULL_SPECTRUM 

Definition at line 55 of file tsl2591.h.