#include <sht4x.h>

Inheritance diagram for esphome::sht4x::SHT4XComponent:

Public Member Functions
float	get_setup_priority () const override

void	setup () override

void	dump_config () override

void	update () override

void	set_precision_value (SHT4XPRECISION precision)

void	set_heater_power_value (SHT4XHEATERPOWER heater_power)

void	set_heater_time_value (SHT4XHEATERTIME heater_time)

void	set_heater_duty_value (float duty_cycle)

void	set_temp_sensor (sensor::Sensor *temp_sensor)

void	set_humidity_sensor (sensor::Sensor *humidity_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
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...

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::sensirion_common::SensirionI2CDevice
bool	read_data (uint16_t *data, uint8_t len)
	Read data words from i2c device. More...

bool	read_data (uint16_t &data)
	Read 1 data word from i2c device. More...

bool	get_register (uint16_t command, uint16_t *data, uint8_t len, uint8_t delay=0)
	get data words from i2c register. More...

bool	get_register (uint16_t i2c_register, uint16_t &data, uint8_t delay=0)
	Read 1 data word from 16 bit i2c register. More...

bool	get_8bit_register (uint8_t i2c_register, uint16_t *data, uint8_t len, uint8_t delay=0)
	get data words from i2c register. More...

bool	get_8bit_register (uint8_t i2c_register, uint16_t &data, uint8_t delay=0)
	Read 1 data word from 8 bit i2c register. More...

template<class T >
bool	write_command (T i2c_register)
	Write a command to the i2c device. More...

template<class T >
bool	write_command (T i2c_register, uint16_t data)
	Write a command and one data word to the i2c device . More...

template<class T >
bool	write_command (T i2c_register, const std::vector< uint16_t > &data)
	Write a command with arguments as words. More...

template<class T >
bool	write_command (T i2c_register, const uint16_t *data, uint8_t len)
	Write a command with arguments as words. 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
void	start_heater_ ()

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 Member Functions inherited from esphome::sensirion_common::SensirionI2CDevice
bool	write_command_ (uint16_t command, CommandLen command_len, const uint16_t *data, uint8_t data_len)
	Write a command with arguments as words. More...

bool	get_register_ (uint16_t reg, CommandLen command_len, uint16_t *data, uint8_t len, uint8_t delay)
	get data words from i2c register. More...

uint8_t	sht_crc_ (uint16_t data)
	8-bit CRC checksum that is transmitted after each data word for read and write operation More...

uint8_t	sht_crc_ (uint8_t data1, uint8_t data2)
	8-bit CRC checksum that is transmitted after each data word for read and write operation More...

Protected Attributes
SHT4XPRECISION	precision_

SHT4XHEATERPOWER	heater_power_

SHT4XHEATERTIME	heater_time_

float	duty_cycle_

uint8_t	heater_command_

sensor::Sensor *	temp_sensor_ {nullptr}

sensor::Sensor *	humidity_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}

Protected Attributes inherited from esphome::sensirion_common::SensirionI2CDevice
uint8_t	crc_polynomial_ {0x31u}

i2c::ErrorCode	last_error_
	last error code from i2c operation More...

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
Public Types inherited from esphome::sensirion_common::SensirionI2CDevice
enum	CommandLen : uint8_t { ADDR_8_BIT = 1, ADDR_16_BIT = 2 }

Detailed Description

Definition at line 18 of file sht4x.h.

Member Function Documentation

◆ dump_config()

void esphome::sht4x::SHT4XComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 50 of file sht4x.cpp.

◆ get_setup_priority()

float esphome::sht4x::SHT4XComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 20 of file sht4x.h.

◆ set_heater_duty_value()

void esphome::sht4x::SHT4XComponent::set_heater_duty_value ( float duty_cycle )

inline

Definition at line 28 of file sht4x.h.

◆ set_heater_power_value()

void esphome::sht4x::SHT4XComponent::set_heater_power_value ( SHT4XHEATERPOWER heater_power )

inline

Definition at line 26 of file sht4x.h.

◆ set_heater_time_value()

void esphome::sht4x::SHT4XComponent::set_heater_time_value ( SHT4XHEATERTIME heater_time )

inline

Definition at line 27 of file sht4x.h.

◆ set_humidity_sensor()

void esphome::sht4x::SHT4XComponent::set_humidity_sensor ( sensor::Sensor * humidity_sensor )

inline

Definition at line 31 of file sht4x.h.

◆ set_precision_value()

void esphome::sht4x::SHT4XComponent::set_precision_value ( SHT4XPRECISION precision )

inline

Definition at line 25 of file sht4x.h.

◆ set_temp_sensor()

void esphome::sht4x::SHT4XComponent::set_temp_sensor ( sensor::Sensor * temp_sensor )

inline

Definition at line 30 of file sht4x.h.

◆ setup()

void esphome::sht4x::SHT4XComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file sht4x.cpp.

◆ start_heater_()

void esphome::sht4x::SHT4XComponent::start_heater_ ( )

protected

Definition at line 11 of file sht4x.cpp.

◆ update()

void esphome::sht4x::SHT4XComponent::update ( )

overridevirtual

Implements esphome::PollingComponent.

Definition at line 52 of file sht4x.cpp.

Field Documentation

◆ duty_cycle_

float esphome::sht4x::SHT4XComponent::duty_cycle_

protected

Definition at line 37 of file sht4x.h.

◆ heater_command_

uint8_t esphome::sht4x::SHT4XComponent::heater_command_

protected

Definition at line 40 of file sht4x.h.

◆ heater_power_

SHT4XHEATERPOWER esphome::sht4x::SHT4XComponent::heater_power_

protected

Definition at line 35 of file sht4x.h.

◆ heater_time_

SHT4XHEATERTIME esphome::sht4x::SHT4XComponent::heater_time_

protected

Definition at line 36 of file sht4x.h.

◆ humidity_sensor_

sensor::Sensor* esphome::sht4x::SHT4XComponent::humidity_sensor_ {nullptr}

protected

Definition at line 43 of file sht4x.h.

◆ precision_

SHT4XPRECISION esphome::sht4x::SHT4XComponent::precision_

protected

Definition at line 34 of file sht4x.h.

◆ temp_sensor_

sensor::Sensor* esphome::sht4x::SHT4XComponent::temp_sensor_ {nullptr}

protected

Definition at line 42 of file sht4x.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ set_heater_duty_value()

◆ set_heater_power_value()

◆ set_heater_time_value()

◆ set_humidity_sensor()

◆ set_precision_value()

◆ set_temp_sensor()

◆ setup()

◆ start_heater_()

◆ update()

Field Documentation

◆ duty_cycle_

◆ heater_command_

◆ heater_power_

◆ heater_time_

◆ humidity_sensor_

◆ precision_

◆ temp_sensor_