#include <veml7700.h>

Inheritance diagram for esphome::veml7700::VEML7700Component:

Data Structures
struct	Readings

Public Member Functions
float	get_setup_priority () const override

void	setup () override

void	dump_config () override

void	update () override

void	loop () override

void	set_gain (Gain gain)

void	set_integration_time (IntegrationTime time)

void	set_enable_automatic_mode (bool enable)

void	set_enable_lux_compensation (bool enable)

void	set_glass_attenuation_factor (float factor)

void	set_ambient_light_sensor (sensor::Sensor *sensor)

void	set_ambient_light_counts_sensor (sensor::Sensor *sensor)

void	set_white_sensor (sensor::Sensor *sensor)

void	set_white_counts_sensor (sensor::Sensor *sensor)

void	set_infrared_sensor (sensor::Sensor *sensor)

void	set_actual_gain_sensor (sensor::Sensor *sensor)

void	set_actual_integration_time_sensor (sensor::Sensor *sensor)

Public Member Functions inherited from esphome::PollingComponent
	PollingComponent ()

	PollingComponent (uint32_t update_interval)
	Initialize this polling component with the given update interval in ms. More...

virtual void	set_update_interval (uint32_t update_interval)
	Manually set the update interval in ms for this polling object. More...

void	call_setup () override

virtual uint32_t	get_update_interval () const
	Get the update interval in ms of this sensor. More...

void	start_poller ()

void	stop_poller ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

void	mark_failed (const char *message)

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Public Member Functions inherited from esphome::i2c::I2CDevice
	I2CDevice ()=default
	we use the C++ default constructor More...

void	set_i2c_address (uint8_t address)
	We store the address of the device on the bus. More...

void	set_i2c_bus (I2CBus *bus)
	we store the pointer to the I2CBus to use More...

I2CRegister	reg (uint8_t a_register)
	calls the I2CRegister constructor More...

I2CRegister16	reg16 (uint16_t a_register)
	calls the I2CRegister16 constructor More...

ErrorCode	read (uint8_t *data, size_t len)
	reads an array of bytes from the device using an I2CBus More...

ErrorCode	read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
	reads an array of bytes from a specific register in the I²C device More...

ErrorCode	read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
	reads an array of bytes from a specific register in the I²C device More...

ErrorCode	write (const uint8_t *data, size_t len, bool stop=true)
	writes an array of bytes to a device using an I2CBus More...

ErrorCode	write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
	writes an array of bytes to a specific register in the I²C device More...

ErrorCode	write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
	write an array of bytes to a specific register in the I²C device More...

bool	read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
	Compat APIs All methods below have been added for compatibility reasons. More...

bool	read_bytes_raw (uint8_t *data, uint8_t len)

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes (uint8_t a_register)

template<size_t N>
optional< std::array< uint8_t, N > >	read_bytes_raw ()

bool	read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)

bool	read_byte (uint8_t a_register, uint8_t *data, bool stop=true)

optional< uint8_t >	read_byte (uint8_t a_register)

bool	read_byte_16 (uint8_t a_register, uint16_t *data)

bool	write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)

bool	write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)

template<size_t N>
bool	write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)

bool	write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)

bool	write_byte (uint8_t a_register, uint8_t data, bool stop=true)

bool	write_byte_16 (uint8_t a_register, uint16_t data)

Protected Types
enum	State : uint8_t { State::NOT_INITIALIZED, State::INITIAL_SETUP_COMPLETED, State::IDLE, State::COLLECTING_DATA, State::COLLECTING_DATA_AUTO, State::DATA_COLLECTED, State::ADJUSTMENT_NEEDED, State::ADJUSTMENT_IN_PROGRESS, State::READY_TO_APPLY_ADJUSTMENTS, State::READY_TO_PUBLISH_PART_1, State::READY_TO_PUBLISH_PART_2, State::READY_TO_PUBLISH_PART_3 }

Protected Member Functions
ErrorCode	configure_ ()

ErrorCode	reconfigure_time_and_gain_ (IntegrationTime time, Gain gain, bool shutdown)

ErrorCode	read_sensor_output_ (Readings &data)

bool	are_adjustments_required_ (Readings &data)

void	apply_lux_calculation_ (Readings &data)

void	apply_lux_compensation_ (Readings &data)

void	apply_glass_attenuation_ (Readings &data)

void	publish_data_part_1_ (Readings &data)

void	publish_data_part_2_ (Readings &data)

void	publish_data_part_3_ (Readings &data)

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes
enum esphome::veml7700::VEML7700Component::State	NOT_INITIALIZED

struct esphome::veml7700::VEML7700Component::Readings	readings_

bool	automatic_mode_enabled_ {true}

bool	lux_compensation_enabled_ {true}

float	glass_attenuation_factor_ {1.0}

IntegrationTime	integration_time_ {INTEGRATION_TIME_100MS}

Gain	gain_ {X_1}

sensor::Sensor *	ambient_light_sensor_ {nullptr}

sensor::Sensor *	ambient_light_counts_sensor_ {nullptr}

sensor::Sensor *	white_sensor_ {nullptr}

sensor::Sensor *	white_counts_sensor_ {nullptr}

sensor::Sensor *	fake_infrared_sensor_ {nullptr}

sensor::Sensor *	actual_gain_sensor_ {nullptr}

sensor::Sensor *	actual_integration_time_sensor_ {nullptr}

Protected Attributes inherited from esphome::PollingComponent
uint32_t	update_interval_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

std::string	error_message_ {}

Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t	address_ {0x00}
	store the address of the device on the bus More...

I2CBus *	bus_ {nullptr}
	pointer to I2CBus instance More...

Detailed Description

Definition at line 100 of file veml7700.h.

Member Enumeration Documentation

◆ State

enum esphome::veml7700::VEML7700Component::State : uint8_t

strongprotected

Enumerator
NOT_INITIALIZED
INITIAL_SETUP_COMPLETED
IDLE
COLLECTING_DATA
COLLECTING_DATA_AUTO
DATA_COLLECTED
ADJUSTMENT_NEEDED
ADJUSTMENT_IN_PROGRESS
READY_TO_APPLY_ADJUSTMENTS
READY_TO_PUBLISH_PART_1
READY_TO_PUBLISH_PART_2
READY_TO_PUBLISH_PART_3

Definition at line 133 of file veml7700.h.

Member Function Documentation

◆ apply_glass_attenuation_()

void esphome::veml7700::VEML7700Component::apply_glass_attenuation_ ( Readings & data )

protected

Definition at line 399 of file veml7700.cpp.

◆ apply_lux_calculation_()

void esphome::veml7700::VEML7700Component::apply_lux_calculation_ ( Readings & data )

protected

Definition at line 352 of file veml7700.cpp.

◆ apply_lux_compensation_()

void esphome::veml7700::VEML7700Component::apply_lux_compensation_ ( Readings & data )

protected

Definition at line 370 of file veml7700.cpp.

◆ are_adjustments_required_()

bool esphome::veml7700::VEML7700Component::are_adjustments_required_ ( Readings & data )

protected

Definition at line 305 of file veml7700.cpp.

◆ configure_()

ErrorCode esphome::veml7700::VEML7700Component::configure_ ( )

protected

Definition at line 219 of file veml7700.cpp.

◆ dump_config()

void esphome::veml7700::VEML7700Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 92 of file veml7700.cpp.

◆ get_setup_priority()

float esphome::veml7700::VEML7700Component::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 105 of file veml7700.h.

◆ loop()

void esphome::veml7700::VEML7700Component::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 134 of file veml7700.cpp.

◆ publish_data_part_1_()

void esphome::veml7700::VEML7700Component::publish_data_part_1_ ( Readings & data )

protected

Definition at line 407 of file veml7700.cpp.

◆ publish_data_part_2_()

void esphome::veml7700::VEML7700Component::publish_data_part_2_ ( Readings & data )

protected

Definition at line 416 of file veml7700.cpp.

◆ publish_data_part_3_()

void esphome::veml7700::VEML7700Component::publish_data_part_3_ ( Readings & data )

protected

Definition at line 428 of file veml7700.cpp.

◆ read_sensor_output_()

ErrorCode esphome::veml7700::VEML7700Component::read_sensor_output_ ( Readings & data )

protected

Definition at line 279 of file veml7700.cpp.

◆ reconfigure_time_and_gain_()

ErrorCode esphome::veml7700::VEML7700Component::reconfigure_time_and_gain_	(	IntegrationTime	time,
		Gain	gain,
		bool	shutdown
	)

protected

Definition at line 258 of file veml7700.cpp.

◆ set_actual_gain_sensor()

void esphome::veml7700::VEML7700Component::set_actual_gain_sensor ( sensor::Sensor * sensor )

inline

Definition at line 125 of file veml7700.h.

◆ set_actual_integration_time_sensor()

void esphome::veml7700::VEML7700Component::set_actual_integration_time_sensor ( sensor::Sensor * sensor )

inline

Definition at line 126 of file veml7700.h.

◆ set_ambient_light_counts_sensor()

void esphome::veml7700::VEML7700Component::set_ambient_light_counts_sensor ( sensor::Sensor * sensor )

inline

Definition at line 121 of file veml7700.h.

◆ set_ambient_light_sensor()

void esphome::veml7700::VEML7700Component::set_ambient_light_sensor ( sensor::Sensor * sensor )

inline

Definition at line 120 of file veml7700.h.

◆ set_enable_automatic_mode()

void esphome::veml7700::VEML7700Component::set_enable_automatic_mode ( bool enable )

inline

Definition at line 116 of file veml7700.h.

◆ set_enable_lux_compensation()

void esphome::veml7700::VEML7700Component::set_enable_lux_compensation ( bool enable )

inline

Definition at line 117 of file veml7700.h.

◆ set_gain()

void esphome::veml7700::VEML7700Component::set_gain ( Gain gain )

inline

Definition at line 114 of file veml7700.h.

◆ set_glass_attenuation_factor()

void esphome::veml7700::VEML7700Component::set_glass_attenuation_factor ( float factor )

inline

Definition at line 118 of file veml7700.h.

◆ set_infrared_sensor()

void esphome::veml7700::VEML7700Component::set_infrared_sensor ( sensor::Sensor * sensor )

inline

Definition at line 124 of file veml7700.h.

◆ set_integration_time()

void esphome::veml7700::VEML7700Component::set_integration_time ( IntegrationTime time )

inline

Definition at line 115 of file veml7700.h.

◆ set_white_counts_sensor()

void esphome::veml7700::VEML7700Component::set_white_counts_sensor ( sensor::Sensor * sensor )

inline

Definition at line 123 of file veml7700.h.

◆ set_white_sensor()

void esphome::veml7700::VEML7700Component::set_white_sensor ( sensor::Sensor * sensor )

inline

Definition at line 122 of file veml7700.h.

◆ setup()

void esphome::veml7700::VEML7700Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 80 of file veml7700.cpp.

◆ update()

void esphome::veml7700::VEML7700Component::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 116 of file veml7700.cpp.

Field Documentation

◆ actual_gain_sensor_

sensor::Sensor* esphome::veml7700::VEML7700Component::actual_gain_sensor_ {nullptr}

protected

Definition at line 197 of file veml7700.h.

◆ actual_integration_time_sensor_

sensor::Sensor* esphome::veml7700::VEML7700Component::actual_integration_time_sensor_ {nullptr}

protected

Definition at line 198 of file veml7700.h.

◆ ambient_light_counts_sensor_

sensor::Sensor* esphome::veml7700::VEML7700Component::ambient_light_counts_sensor_ {nullptr}

protected

Definition at line 193 of file veml7700.h.

◆ ambient_light_sensor_

sensor::Sensor* esphome::veml7700::VEML7700Component::ambient_light_sensor_ {nullptr}

protected

Definition at line 192 of file veml7700.h.

◆ automatic_mode_enabled_

bool esphome::veml7700::VEML7700Component::automatic_mode_enabled_ {true}

protected

Definition at line 183 of file veml7700.h.

◆ fake_infrared_sensor_

sensor::Sensor* esphome::veml7700::VEML7700Component::fake_infrared_sensor_ {nullptr}

protected

Definition at line 196 of file veml7700.h.

◆ gain_

Gain esphome::veml7700::VEML7700Component::gain_ {X_1}

protected

Definition at line 187 of file veml7700.h.

◆ glass_attenuation_factor_

float esphome::veml7700::VEML7700Component::glass_attenuation_factor_ {1.0}

protected

Definition at line 185 of file veml7700.h.

◆ integration_time_

IntegrationTime esphome::veml7700::VEML7700Component::integration_time_ {INTEGRATION_TIME_100MS}

protected

Definition at line 186 of file veml7700.h.

◆ lux_compensation_enabled_

bool esphome::veml7700::VEML7700Component::lux_compensation_enabled_ {true}

protected

Definition at line 184 of file veml7700.h.

◆ NOT_INITIALIZED

enum esphome::veml7700::VEML7700Component::State esphome::veml7700::VEML7700Component::NOT_INITIALIZED

protected

◆ readings_

struct esphome::veml7700::VEML7700Component::Readings esphome::veml7700::VEML7700Component::readings_

protected

◆ white_counts_sensor_

sensor::Sensor* esphome::veml7700::VEML7700Component::white_counts_sensor_ {nullptr}

protected

Definition at line 195 of file veml7700.h.

◆ white_sensor_

sensor::Sensor* esphome::veml7700::VEML7700Component::white_sensor_ {nullptr}

protected

Definition at line 194 of file veml7700.h.

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

/opt/build/esphome/esphome/components/veml7700/veml7700.h
/opt/build/esphome/esphome/components/veml7700/veml7700.cpp

Data Structures

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ State

Member Function Documentation

◆ apply_glass_attenuation_()

◆ apply_lux_calculation_()

◆ apply_lux_compensation_()

◆ are_adjustments_required_()

◆ configure_()

◆ dump_config()

◆ get_setup_priority()

◆ loop()

◆ publish_data_part_1_()

◆ publish_data_part_2_()

◆ publish_data_part_3_()

◆ read_sensor_output_()

◆ reconfigure_time_and_gain_()

◆ set_actual_gain_sensor()

◆ set_actual_integration_time_sensor()

◆ set_ambient_light_counts_sensor()

◆ set_ambient_light_sensor()

◆ set_enable_automatic_mode()

◆ set_enable_lux_compensation()

◆ set_gain()

◆ set_glass_attenuation_factor()

◆ set_infrared_sensor()

◆ set_integration_time()

◆ set_white_counts_sensor()

◆ set_white_sensor()

◆ setup()

◆ update()

Field Documentation

◆ actual_gain_sensor_

◆ actual_integration_time_sensor_

◆ ambient_light_counts_sensor_

◆ ambient_light_sensor_

◆ automatic_mode_enabled_

◆ fake_infrared_sensor_

◆ gain_

◆ glass_attenuation_factor_

◆ integration_time_

◆ lux_compensation_enabled_

◆ NOT_INITIALIZED

◆ readings_

◆ white_counts_sensor_

◆ white_sensor_