#include <htu31d.h>

Inheritance diagram for esphome::htu31d::HTU31DComponent:

Public Member Functions
void	setup () override
	Resets the sensor and ensures that the devices serial number can be read over I2C. More...

void	update () override
	Setup (reset) the sensor and check connection. More...

void	dump_config () override
	Update the sensor values (temperature+humidity). More...

void	set_temperature (sensor::Sensor *temperature)
	Dumps the configuration values. More...

void	set_humidity (sensor::Sensor *humidity)

void	set_heater_state (bool desired)
	Sets the heater state on or off. More...

bool	is_heater_enabled ()
	Checks the diagnostics register to determine if the heater is currently enabled. More...

float	get_setup_priority () const override
	Sets the startup priority for this component. More...

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::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
bool	reset_ ()
	Sends a 'reset' request to the HTU31D, followed by a 15ms delay. More...

uint32_t	read_serial_num_ ()
	Reads the serial number from the device and checks the CRC. More...

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 *	temperature_ {nullptr}

sensor::Sensor *	humidity_ {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::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 11 of file htu31d.h.

Member Function Documentation

◆ dump_config()

void esphome::htu31d::HTU31DComponent::dump_config ( )

overridevirtual

Update the sensor values (temperature+humidity).

Logs the current compoenent config.

Reimplemented from esphome::Component.

Definition at line 160 of file htu31d.cpp.

◆ get_setup_priority()

float esphome::htu31d::HTU31DComponent::get_setup_priority ( ) const

overridevirtual

Sets the startup priority for this component.

Returns: The startup priority

Reimplemented from esphome::Component.

Definition at line 269 of file htu31d.cpp.

◆ is_heater_enabled()

bool esphome::htu31d::HTU31DComponent::is_heater_enabled ( )

Checks the diagnostics register to determine if the heater is currently enabled.

Returns: True if the heater is currently enabled, False otherwise

Definition at line 220 of file htu31d.cpp.

◆ read_serial_num_()

uint32_t esphome::htu31d::HTU31DComponent::read_serial_num_ ( )

protected

Reads the serial number from the device and checks the CRC.

Returns: the 24bit serial number from the device

Definition at line 190 of file htu31d.cpp.

◆ reset_()

bool esphome::htu31d::HTU31DComponent::reset_ ( )

protected

Sends a 'reset' request to the HTU31D, followed by a 15ms delay.

Returns: True if was able to write the command successfully

Definition at line 176 of file htu31d.cpp.

◆ set_heater_state()

void esphome::htu31d::HTU31DComponent::set_heater_state ( bool desired )

Sets the heater state on or off.

Parameters

desired True for on, and False for off.

Definition at line 240 of file htu31d.cpp.

◆ set_humidity()

void esphome::htu31d::HTU31DComponent::set_humidity ( sensor::Sensor * humidity )

inline

Definition at line 18 of file htu31d.h.

◆ set_temperature()

void esphome::htu31d::HTU31DComponent::set_temperature ( sensor::Sensor * temperature )

inline

Dumps the configuration values.

Definition at line 17 of file htu31d.h.

◆ setup()

void esphome::htu31d::HTU31DComponent::setup ( )

overridevirtual

Resets the sensor and ensures that the devices serial number can be read over I2C.

Reimplemented from esphome::Component.

Definition at line 77 of file htu31d.cpp.

◆ update()

void esphome::htu31d::HTU31DComponent::update ( )

overridevirtual

Setup (reset) the sensor and check connection.

Called once every update interval (user configured, defaults to 60s) and sets the current temperature and humidity.

Implements esphome::PollingComponent.

Definition at line 95 of file htu31d.cpp.

Field Documentation

◆ humidity_

sensor::Sensor* esphome::htu31d::HTU31DComponent::humidity_ {nullptr}

protected

Definition at line 30 of file htu31d.h.

◆ temperature_

sensor::Sensor* esphome::htu31d::HTU31DComponent::temperature_ {nullptr}

protected

Definition at line 29 of file htu31d.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ is_heater_enabled()

◆ read_serial_num_()

◆ reset_()

◆ set_heater_state()

◆ set_humidity()

◆ set_temperature()

◆ setup()

◆ update()

Field Documentation

◆ humidity_

◆ temperature_