#include <as7341.h>

Inheritance diagram for esphome::as7341::AS7341Component:

Public Member Functions
void	setup () override

void	dump_config () override

float	get_setup_priority () const override

void	update () override

void	set_f1_sensor (sensor::Sensor *f1_sensor)

void	set_f2_sensor (sensor::Sensor *f2_sensor)

void	set_f3_sensor (sensor::Sensor *f3_sensor)

void	set_f4_sensor (sensor::Sensor *f4_sensor)

void	set_f5_sensor (sensor::Sensor *f5_sensor)

void	set_f6_sensor (sensor::Sensor *f6_sensor)

void	set_f7_sensor (sensor::Sensor *f7_sensor)

void	set_f8_sensor (sensor::Sensor *f8_sensor)

void	set_clear_sensor (sensor::Sensor *clear_sensor)

void	set_nir_sensor (sensor::Sensor *nir_sensor)

void	set_gain (AS7341Gain gain)

void	set_atime (uint8_t atime)

void	set_astep (uint16_t astep)

AS7341Gain	get_gain ()

uint8_t	get_atime ()

uint16_t	get_astep ()

bool	setup_gain (AS7341Gain gain)

bool	setup_atime (uint8_t atime)

bool	setup_astep (uint16_t astep)

uint16_t	read_channel (AS7341AdcChannel channel)

bool	read_channels (uint16_t *data)

void	set_smux_low_channels (bool enable)

bool	set_smux_command (AS7341SmuxCommand command)

void	configure_smux_low_channels ()

void	configure_smux_high_channels ()

bool	enable_smux ()

bool	wait_for_data ()

bool	is_data_ready ()

bool	enable_power (bool enable)

bool	enable_spectral_measurement (bool enable)

bool	read_register_bit (uint8_t address, uint8_t bit_position)

bool	write_register_bit (uint8_t address, bool value, uint8_t bit_position)

bool	set_register_bit (uint8_t address, uint8_t bit_position)

bool	clear_register_bit (uint8_t address, uint8_t bit_position)

uint16_t	swap_bytes (uint16_t data)

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 Attributes
sensor::Sensor *	f1_ {nullptr}

sensor::Sensor *	f2_ {nullptr}

sensor::Sensor *	f3_ {nullptr}

sensor::Sensor *	f4_ {nullptr}

sensor::Sensor *	f5_ {nullptr}

sensor::Sensor *	f6_ {nullptr}

sensor::Sensor *	f7_ {nullptr}

sensor::Sensor *	f8_ {nullptr}

sensor::Sensor *	clear_ {nullptr}

sensor::Sensor *	nir_ {nullptr}

uint16_t	astep_

AS7341Gain	gain_

uint8_t	atime_

uint16_t	channel_readings_ [12]

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...

Additional Inherited Members
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...

Detailed Description

Definition at line 77 of file as7341.h.

Member Function Documentation

◆ clear_register_bit()

bool esphome::as7341::AS7341Component::clear_register_bit	(	uint8_t	address,
		uint8_t	bit_position
	)

Definition at line 261 of file as7341.cpp.

◆ configure_smux_high_channels()

void esphome::as7341::AS7341Component::configure_smux_high_channels ( )

Definition at line 177 of file as7341.cpp.

◆ configure_smux_low_channels()

void esphome::as7341::AS7341Component::configure_smux_low_channels ( )

Definition at line 153 of file as7341.cpp.

◆ dump_config()

void esphome::as7341::AS7341Component::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file as7341.cpp.

◆ enable_power()

bool esphome::as7341::AS7341Component::enable_power ( bool enable )

Definition at line 233 of file as7341.cpp.

◆ enable_smux()

bool esphome::as7341::AS7341Component::enable_smux ( )

Definition at line 201 of file as7341.cpp.

◆ enable_spectral_measurement()

bool esphome::as7341::AS7341Component::enable_spectral_measurement ( bool enable )

Definition at line 235 of file as7341.cpp.

◆ get_astep()

uint16_t esphome::as7341::AS7341Component::get_astep ( )

Definition at line 109 of file as7341.cpp.

◆ get_atime()

uint8_t esphome::as7341::AS7341Component::get_atime ( )

Definition at line 103 of file as7341.cpp.

◆ get_gain()

AS7341Gain esphome::as7341::AS7341Component::get_gain ( )

Definition at line 97 of file as7341.cpp.

◆ get_setup_priority()

float esphome::as7341::AS7341Component::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 60 of file as7341.cpp.

◆ is_data_ready()

bool esphome::as7341::AS7341Component::is_data_ready ( )

Definition at line 231 of file as7341.cpp.

◆ read_channel()

uint16_t esphome::as7341::AS7341Component::read_channel ( AS7341AdcChannel channel )

◆ read_channels()

bool esphome::as7341::AS7341Component::read_channels ( uint16_t * data )

Definition at line 121 of file as7341.cpp.

◆ read_register_bit()

bool esphome::as7341::AS7341Component::read_register_bit	(	uint8_t	address,
		uint8_t	bit_position
	)

Definition at line 239 of file as7341.cpp.

◆ set_astep()

void esphome::as7341::AS7341Component::set_astep ( uint16_t astep )

inline

Definition at line 97 of file as7341.h.

◆ set_atime()

void esphome::as7341::AS7341Component::set_atime ( uint8_t atime )

inline

Definition at line 96 of file as7341.h.

◆ set_clear_sensor()

void esphome::as7341::AS7341Component::set_clear_sensor ( sensor::Sensor * clear_sensor )

inline

Definition at line 92 of file as7341.h.

◆ set_f1_sensor()

void esphome::as7341::AS7341Component::set_f1_sensor ( sensor::Sensor * f1_sensor )

inline

Definition at line 84 of file as7341.h.

◆ set_f2_sensor()

void esphome::as7341::AS7341Component::set_f2_sensor ( sensor::Sensor * f2_sensor )

inline

Definition at line 85 of file as7341.h.

◆ set_f3_sensor()

void esphome::as7341::AS7341Component::set_f3_sensor ( sensor::Sensor * f3_sensor )

inline

Definition at line 86 of file as7341.h.

◆ set_f4_sensor()

void esphome::as7341::AS7341Component::set_f4_sensor ( sensor::Sensor * f4_sensor )

inline

Definition at line 87 of file as7341.h.

◆ set_f5_sensor()

void esphome::as7341::AS7341Component::set_f5_sensor ( sensor::Sensor * f5_sensor )

inline

Definition at line 88 of file as7341.h.

◆ set_f6_sensor()

void esphome::as7341::AS7341Component::set_f6_sensor ( sensor::Sensor * f6_sensor )

inline

Definition at line 89 of file as7341.h.

◆ set_f7_sensor()

void esphome::as7341::AS7341Component::set_f7_sensor ( sensor::Sensor * f7_sensor )

inline

Definition at line 90 of file as7341.h.

◆ set_f8_sensor()

void esphome::as7341::AS7341Component::set_f8_sensor ( sensor::Sensor * f8_sensor )

inline

Definition at line 91 of file as7341.h.

◆ set_gain()

void esphome::as7341::AS7341Component::set_gain ( AS7341Gain gain )

inline

Definition at line 95 of file as7341.h.

◆ set_nir_sensor()

void esphome::as7341::AS7341Component::set_nir_sensor ( sensor::Sensor * nir_sensor )

inline

Definition at line 93 of file as7341.h.

◆ set_register_bit()

bool esphome::as7341::AS7341Component::set_register_bit	(	uint8_t	address,
		uint8_t	bit_position
	)

Definition at line 254 of file as7341.cpp.

◆ set_smux_command()

bool esphome::as7341::AS7341Component::set_smux_command ( AS7341SmuxCommand command )

Definition at line 148 of file as7341.cpp.

◆ set_smux_low_channels()

void esphome::as7341::AS7341Component::set_smux_low_channels ( bool enable )

Definition at line 135 of file as7341.cpp.

◆ setup()

void esphome::as7341::AS7341Component::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file as7341.cpp.

◆ setup_astep()

bool esphome::as7341::AS7341Component::setup_astep ( uint16_t astep )

Definition at line 119 of file as7341.cpp.

◆ setup_atime()

bool esphome::as7341::AS7341Component::setup_atime ( uint8_t atime )

Definition at line 117 of file as7341.cpp.

◆ setup_gain()

bool esphome::as7341::AS7341Component::setup_gain ( AS7341Gain gain )

Definition at line 115 of file as7341.cpp.

◆ swap_bytes()

uint16_t esphome::as7341::AS7341Component::swap_bytes ( uint16_t data )

Definition at line 268 of file as7341.cpp.

◆ update()

void esphome::as7341::AS7341Component::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 62 of file as7341.cpp.

◆ wait_for_data()

bool esphome::as7341::AS7341Component::wait_for_data ( )

Definition at line 218 of file as7341.cpp.

◆ write_register_bit()

bool esphome::as7341::AS7341Component::write_register_bit	(	uint8_t	address,
		bool	value,
		uint8_t	bit_position
	)

Definition at line 246 of file as7341.cpp.

Field Documentation

◆ astep_

uint16_t esphome::as7341::AS7341Component::astep_

protected

Definition at line 137 of file as7341.h.

◆ atime_

uint8_t esphome::as7341::AS7341Component::atime_

protected

Definition at line 139 of file as7341.h.

◆ channel_readings_

uint16_t esphome::as7341::AS7341Component::channel_readings_[12]

protected

Definition at line 140 of file as7341.h.

◆ clear_

sensor::Sensor* esphome::as7341::AS7341Component::clear_ {nullptr}

protected

Definition at line 134 of file as7341.h.

◆ f1_

sensor::Sensor* esphome::as7341::AS7341Component::f1_ {nullptr}

protected

Definition at line 126 of file as7341.h.

◆ f2_

sensor::Sensor* esphome::as7341::AS7341Component::f2_ {nullptr}

protected

Definition at line 127 of file as7341.h.

◆ f3_

sensor::Sensor* esphome::as7341::AS7341Component::f3_ {nullptr}

protected

Definition at line 128 of file as7341.h.

◆ f4_

sensor::Sensor* esphome::as7341::AS7341Component::f4_ {nullptr}

protected

Definition at line 129 of file as7341.h.

◆ f5_

sensor::Sensor* esphome::as7341::AS7341Component::f5_ {nullptr}

protected

Definition at line 130 of file as7341.h.

◆ f6_

sensor::Sensor* esphome::as7341::AS7341Component::f6_ {nullptr}

protected

Definition at line 131 of file as7341.h.

◆ f7_

sensor::Sensor* esphome::as7341::AS7341Component::f7_ {nullptr}

protected

Definition at line 132 of file as7341.h.

◆ f8_

sensor::Sensor* esphome::as7341::AS7341Component::f8_ {nullptr}

protected

Definition at line 133 of file as7341.h.

◆ gain_

AS7341Gain esphome::as7341::AS7341Component::gain_

protected

Definition at line 138 of file as7341.h.

◆ nir_

sensor::Sensor* esphome::as7341::AS7341Component::nir_ {nullptr}

protected

Definition at line 135 of file as7341.h.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clear_register_bit()

◆ configure_smux_high_channels()

◆ configure_smux_low_channels()

◆ dump_config()

◆ enable_power()

◆ enable_smux()

◆ enable_spectral_measurement()

◆ get_astep()

◆ get_atime()

◆ get_gain()

◆ get_setup_priority()

◆ is_data_ready()

◆ read_channel()

◆ read_channels()

◆ read_register_bit()

◆ set_astep()

◆ set_atime()

◆ set_clear_sensor()

◆ set_f1_sensor()

◆ set_f2_sensor()

◆ set_f3_sensor()

◆ set_f4_sensor()

◆ set_f5_sensor()

◆ set_f6_sensor()

◆ set_f7_sensor()

◆ set_f8_sensor()

◆ set_gain()

◆ set_nir_sensor()

◆ set_register_bit()

◆ set_smux_command()

◆ set_smux_low_channels()

◆ setup()

◆ setup_astep()

◆ setup_atime()

◆ setup_gain()

◆ swap_bytes()

◆ update()

◆ wait_for_data()

◆ write_register_bit()

Field Documentation

◆ astep_

◆ atime_

◆ channel_readings_

◆ clear_

◆ f1_

◆ f2_

◆ f3_

◆ f4_

◆ f5_

◆ f6_

◆ f7_

◆ f8_

◆ gain_

◆ nir_