#include <tcs34725.h>

Inheritance diagram for esphome::tcs34725::TCS34725Component:

Public Member Functions
void	set_integration_time (TCS34725IntegrationTime integration_time)

void	set_gain (TCS34725Gain gain)

void	set_glass_attenuation_factor (float ga)

void	set_clear_sensor (sensor::Sensor *clear_sensor)

void	set_red_sensor (sensor::Sensor *red_sensor)

void	set_green_sensor (sensor::Sensor *green_sensor)

void	set_blue_sensor (sensor::Sensor *blue_sensor)

void	set_illuminance_sensor (sensor::Sensor *illuminance_sensor)

void	set_color_temperature_sensor (sensor::Sensor *color_temperature_sensor)

void	setup () override

float	get_setup_priority () const override

void	update () override

void	dump_config () override

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
virtual void	loop ()
	This method will be called repeatedly. More...

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 Member Functions
i2c::ErrorCode	read_data_register_ (uint8_t a_register, uint16_t &data)

i2c::ErrorCode	write_config_register_ (uint8_t a_register, uint8_t 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
sensor::Sensor *	clear_sensor_ {nullptr}

sensor::Sensor *	red_sensor_ {nullptr}

sensor::Sensor *	green_sensor_ {nullptr}

sensor::Sensor *	blue_sensor_ {nullptr}

sensor::Sensor *	illuminance_sensor_ {nullptr}

sensor::Sensor *	color_temperature_sensor_ {nullptr}

float	integration_time_ {2.4}

float	gain_ {1.0}

float	glass_attenuation_ {1.0}

float	illuminance_

float	color_temperature_

bool	integration_time_auto_ {true}

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 39 of file tcs34725.h.

Member Function Documentation

◆ dump_config()

void esphome::tcs34725::TCS34725Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 45 of file tcs34725.cpp.

◆ get_setup_priority()

float esphome::tcs34725::TCS34725Component::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 60 of file tcs34725.cpp.

◆ read_data_register_()

i2c::ErrorCode esphome::tcs34725::TCS34725Component::read_data_register_	(	uint8_t	a_register,
		uint16_t &	data
	)

inlineprotected

Definition at line 60 of file tcs34725.h.

◆ set_blue_sensor()

void esphome::tcs34725::TCS34725Component::set_blue_sensor ( sensor::Sensor * blue_sensor )

inline

Definition at line 48 of file tcs34725.h.

◆ set_clear_sensor()

void esphome::tcs34725::TCS34725Component::set_clear_sensor ( sensor::Sensor * clear_sensor )

inline

Definition at line 45 of file tcs34725.h.

◆ set_color_temperature_sensor()

void esphome::tcs34725::TCS34725Component::set_color_temperature_sensor ( sensor::Sensor * color_temperature_sensor )

inline

Definition at line 50 of file tcs34725.h.

◆ set_gain()

void esphome::tcs34725::TCS34725Component::set_gain ( TCS34725Gain gain )

Definition at line 323 of file tcs34725.cpp.

◆ set_glass_attenuation_factor()

void esphome::tcs34725::TCS34725Component::set_glass_attenuation_factor ( float ga )

Definition at line 344 of file tcs34725.cpp.

◆ set_green_sensor()

void esphome::tcs34725::TCS34725Component::set_green_sensor ( sensor::Sensor * green_sensor )

inline

Definition at line 47 of file tcs34725.h.

◆ set_illuminance_sensor()

void esphome::tcs34725::TCS34725Component::set_illuminance_sensor ( sensor::Sensor * illuminance_sensor )

inline

Definition at line 49 of file tcs34725.h.

◆ set_integration_time()

void esphome::tcs34725::TCS34725Component::set_integration_time ( TCS34725IntegrationTime integration_time )

Definition at line 307 of file tcs34725.cpp.

◆ set_red_sensor()

void esphome::tcs34725::TCS34725Component::set_red_sensor ( sensor::Sensor * red_sensor )

inline

Definition at line 46 of file tcs34725.h.

◆ setup()

void esphome::tcs34725::TCS34725Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file tcs34725.cpp.

◆ update()

void esphome::tcs34725::TCS34725Component::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 185 of file tcs34725.cpp.

◆ write_config_register_()

i2c::ErrorCode esphome::tcs34725::TCS34725Component::write_config_register_	(	uint8_t	a_register,
		uint8_t	data
	)

inlineprotected

Definition at line 67 of file tcs34725.h.

Field Documentation

◆ blue_sensor_

sensor::Sensor* esphome::tcs34725::TCS34725Component::blue_sensor_ {nullptr}

protected

Definition at line 73 of file tcs34725.h.

◆ clear_sensor_

sensor::Sensor* esphome::tcs34725::TCS34725Component::clear_sensor_ {nullptr}

protected

Definition at line 70 of file tcs34725.h.

◆ color_temperature_

float esphome::tcs34725::TCS34725Component::color_temperature_

protected

Definition at line 80 of file tcs34725.h.

◆ color_temperature_sensor_

sensor::Sensor* esphome::tcs34725::TCS34725Component::color_temperature_sensor_ {nullptr}

protected

Definition at line 75 of file tcs34725.h.

◆ gain_

float esphome::tcs34725::TCS34725Component::gain_ {1.0}

protected

Definition at line 77 of file tcs34725.h.

◆ glass_attenuation_

float esphome::tcs34725::TCS34725Component::glass_attenuation_ {1.0}

protected

Definition at line 78 of file tcs34725.h.

◆ green_sensor_

sensor::Sensor* esphome::tcs34725::TCS34725Component::green_sensor_ {nullptr}

protected

Definition at line 72 of file tcs34725.h.

◆ illuminance_

float esphome::tcs34725::TCS34725Component::illuminance_

protected

Definition at line 79 of file tcs34725.h.

◆ illuminance_sensor_

sensor::Sensor* esphome::tcs34725::TCS34725Component::illuminance_sensor_ {nullptr}

protected

Definition at line 74 of file tcs34725.h.

◆ integration_time_

float esphome::tcs34725::TCS34725Component::integration_time_ {2.4}

protected

Definition at line 76 of file tcs34725.h.

◆ integration_time_auto_

bool esphome::tcs34725::TCS34725Component::integration_time_auto_ {true}

protected

Definition at line 81 of file tcs34725.h.

◆ red_sensor_

sensor::Sensor* esphome::tcs34725::TCS34725Component::red_sensor_ {nullptr}

protected

Definition at line 71 of file tcs34725.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ read_data_register_()

◆ set_blue_sensor()

◆ set_clear_sensor()

◆ set_color_temperature_sensor()

◆ set_gain()

◆ set_glass_attenuation_factor()

◆ set_green_sensor()

◆ set_illuminance_sensor()

◆ set_integration_time()

◆ set_red_sensor()

◆ setup()

◆ update()

◆ write_config_register_()

Field Documentation

◆ blue_sensor_

◆ clear_sensor_

◆ color_temperature_

◆ color_temperature_sensor_

◆ gain_

◆ glass_attenuation_

◆ green_sensor_

◆ illuminance_

◆ illuminance_sensor_

◆ integration_time_

◆ integration_time_auto_

◆ red_sensor_