ESPHome  2021.9.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::sht4x::SHT4XComponent Class Reference

#include <sht4x.h>

Inheritance diagram for esphome::sht4x::SHT4XComponent:
esphome::PollingComponent esphome::i2c::I2CDevice esphome::Component

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...
 
- 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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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
 
 I2CDevice (I2CComponent *parent, uint8_t address)
 
void set_i2c_address (uint8_t address)
 Manually set the i2c address of this device. More...
 
void set_i2c_multiplexer (I2CMultiplexer *multiplexer, uint8_t channel)
 Manually set the i2c multiplexer of this device. More...
 
void set_i2c_parent (I2CComponent *parent)
 Manually set the parent i2c bus for this device. More...
 
I2CRegister reg (uint8_t a_register)
 
void raw_begin_transmission ()
 Begin a write transmission. More...
 
bool raw_end_transmission (bool send_stop=true)
 End a write transmission, return true if successful. More...
 
void raw_write (const uint8_t *data, uint8_t len)
 Write len amount of bytes from data. begin_transmission_ must be called before this. More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len, uint32_t conversion=0)
 Read len amount of bytes from a register into data. 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, uint32_t conversion=0)
 Read len amount of 16-bit words (MSB first) from a register into data. More...
 
bool read_byte (uint8_t a_register, uint8_t *data, uint32_t conversion=0)
 Read a single byte from a register into the data variable. Return true if successful. More...
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data, uint32_t conversion=0)
 Read a single 16-bit words (MSB first) from a register into the data variable. Return true if successful. More...
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len)
 Write len amount of 8-bit bytes to the specified register. More...
 
bool write_bytes_raw (const uint8_t *data, uint8_t len)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 Write a vector of data to a register. More...
 
bool write_bytes_raw (const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
template<size_t N>
bool write_bytes_raw (const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 Write len amount of 16-bit words (MSB first) to the specified register. More...
 
bool write_byte (uint8_t a_register, uint8_t data)
 Write a single byte of data into the specified register. Return true if successful. More...
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 Write a single 16-bit word of data into the specified register. Return true if successful. More...
 

Protected Member Functions

void start_heater_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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_timeout (uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
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::i2c::I2CDevice
void check_multiplexer_ ()
 

Protected Attributes

SHT4XPRECISION precision_
 
SHT4XHEATERPOWER heater_power_
 
SHT4XHEATERTIME heater_time_
 
float duty_cycle_
 
uint8_t heater_command_
 
sensor::Sensortemp_sensor_ {nullptr}
 
sensor::Sensorhumidity_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::i2c::I2CDevice
uint8_t address_ {0x00}
 
I2CComponentparent_ {nullptr}
 
I2CMultiplexermultiplexer_ {nullptr}
 
uint8_t channel_
 

Detailed Description

Definition at line 16 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 18 of file sht4x.h.

◆ set_heater_duty_value()

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

Definition at line 26 of file sht4x.h.

◆ set_heater_power_value()

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

Definition at line 24 of file sht4x.h.

◆ set_heater_time_value()

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

Definition at line 25 of file sht4x.h.

◆ set_humidity_sensor()

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

Definition at line 29 of file sht4x.h.

◆ set_precision_value()

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

Definition at line 23 of file sht4x.h.

◆ set_temp_sensor()

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

Definition at line 28 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 35 of file sht4x.h.

◆ heater_command_

uint8_t esphome::sht4x::SHT4XComponent::heater_command_
protected

Definition at line 38 of file sht4x.h.

◆ heater_power_

SHT4XHEATERPOWER esphome::sht4x::SHT4XComponent::heater_power_
protected

Definition at line 33 of file sht4x.h.

◆ heater_time_

SHT4XHEATERTIME esphome::sht4x::SHT4XComponent::heater_time_
protected

Definition at line 34 of file sht4x.h.

◆ humidity_sensor_

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

Definition at line 41 of file sht4x.h.

◆ precision_

SHT4XPRECISION esphome::sht4x::SHT4XComponent::precision_
protected

Definition at line 32 of file sht4x.h.

◆ temp_sensor_

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

Definition at line 40 of file sht4x.h.


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