tsl2591.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/component.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/i2c/i2c.h"

#include <cinttypes>

namespace esphome {
namespace tsl2591 {

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 TSL2591ComponentGain {
  TSL2591_CGAIN_LOW,   // 1x
  TSL2591_CGAIN_MED,   // 25x
  TSL2591_CGAIN_HIGH,  // 400x
  TSL2591_CGAIN_MAX,   // 9500x
  TSL2591_CGAIN_AUTO
};

enum TSL2591Gain {
  TSL2591_GAIN_LOW = 0b00 << 4,   // 1x
  TSL2591_GAIN_MED = 0b01 << 4,   // 25x
  TSL2591_GAIN_HIGH = 0b10 << 4,  // 400x
  TSL2591_GAIN_MAX = 0b11 << 4,   // 9500x
};

enum TSL2591SensorChannel {
  TSL2591_SENSOR_CHANNEL_VISIBLE,
  TSL2591_SENSOR_CHANNEL_INFRARED,
  TSL2591_SENSOR_CHANNEL_FULL_SPECTRUM,
};

class TSL2591Component : public PollingComponent, public i2c::I2CDevice {
 public:
  void set_integration_time_and_gain(TSL2591IntegrationTime integration_time, TSL2591Gain gain);

  void set_power_save_mode(bool enable);

  void set_name(const char *name);

  void set_device_and_glass_attenuation_factors(float device_factor, float glass_attenuation_factor);

  float get_calculated_lux(uint16_t full_spectrum, uint16_t infrared);

  uint32_t get_combined_illuminance();

  uint16_t get_illuminance(TSL2591SensorChannel channel);

  uint16_t get_illuminance(TSL2591SensorChannel channel, uint32_t combined_illuminance);

  bool is_adc_valid();

  void enable();
  void disable();

  void automatic_gain_update(uint16_t full_spectrum);

  float get_actual_gain();

  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these. They're for ESPHome integration use.)
  void set_full_spectrum_sensor(sensor::Sensor *full_spectrum_sensor);
  void set_actual_gain_sensor(sensor::Sensor *actual_gain_sensor);
  void set_infrared_sensor(sensor::Sensor *infrared_sensor);
  void set_visible_sensor(sensor::Sensor *visible_sensor);
  void set_calculated_lux_sensor(sensor::Sensor *calculated_lux_sensor);
  void set_integration_time(TSL2591IntegrationTime integration_time);
  void set_gain(TSL2591ComponentGain gain);
  void setup() override;
  void dump_config() override;
  void update() override;
  float get_setup_priority() const override;

 protected:
  const char *name_;
  sensor::Sensor *full_spectrum_sensor_{nullptr};
  sensor::Sensor *infrared_sensor_{nullptr};
  sensor::Sensor *visible_sensor_{nullptr};
  sensor::Sensor *calculated_lux_sensor_{nullptr};
  sensor::Sensor *actual_gain_sensor_{nullptr};
  TSL2591IntegrationTime integration_time_;
  TSL2591ComponentGain component_gain_;
  TSL2591Gain gain_;
  bool power_save_mode_enabled_;
  float device_factor_;
  float glass_attenuation_factor_;
  uint64_t interval_start_;
  uint64_t interval_timeout_;
  void disable_if_power_saving_();
  void process_update_();
  void interval_function_for_update_();
};

}  // namespace tsl2591
}  // namespace esphome