ESPHome  2024.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::smt100::SMT100Component Class Reference

#include <smt100.h>

Inheritance diagram for esphome::smt100::SMT100Component:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

 SMT100Component ()=default
 
void dump_config () override
 
void loop () override
 
void update () override
 
float get_setup_priority () const override
 
void set_counts_sensor (sensor::Sensor *counts_sensor)
 
void set_dielectric_constant_sensor (sensor::Sensor *dielectric_constant_sensor)
 
void set_temperature_sensor (sensor::Sensor *temperature_sensor)
 
void set_moisture_sensor (sensor::Sensor *moisture_sensor)
 
void set_voltage_sensor (sensor::Sensor *voltage_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 setup ()
 Where the component's initialization should happen. 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::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
 

Protected Member Functions

int readline_ (int readch, char *buffer, int len)
 
- 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::Sensorcounts_sensor_ {nullptr}
 
sensor::Sensordielectric_constant_sensor_ {nullptr}
 
sensor::Sensormoisture_sensor_ {nullptr}
 
sensor::Sensortemperature_sensor_ {nullptr}
 
sensor::Sensorvoltage_sensor_ {nullptr}
 
uint32_t last_transmission_ {0}
 
- 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::uart::UARTDevice
UARTComponentparent_ {nullptr}
 

Detailed Description

Definition at line 10 of file smt100.h.

Constructor & Destructor Documentation

◆ SMT100Component()

esphome::smt100::SMT100Component::SMT100Component ( )
default

Member Function Documentation

◆ dump_config()

void esphome::smt100::SMT100Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 49 of file smt100.cpp.

◆ get_setup_priority()

float esphome::smt100::SMT100Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file smt100.cpp.

◆ loop()

void esphome::smt100::SMT100Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 14 of file smt100.cpp.

◆ readline_()

int esphome::smt100::SMT100Component::readline_ ( int  readch,
char *  buffer,
int  len 
)
protected

Definition at line 60 of file smt100.cpp.

◆ set_counts_sensor()

void esphome::smt100::SMT100Component::set_counts_sensor ( sensor::Sensor counts_sensor)
inline

Definition at line 22 of file smt100.h.

◆ set_dielectric_constant_sensor()

void esphome::smt100::SMT100Component::set_dielectric_constant_sensor ( sensor::Sensor dielectric_constant_sensor)
inline

Definition at line 23 of file smt100.h.

◆ set_moisture_sensor()

void esphome::smt100::SMT100Component::set_moisture_sensor ( sensor::Sensor moisture_sensor)
inline

Definition at line 27 of file smt100.h.

◆ set_temperature_sensor()

void esphome::smt100::SMT100Component::set_temperature_sensor ( sensor::Sensor temperature_sensor)
inline

Definition at line 26 of file smt100.h.

◆ set_voltage_sensor()

void esphome::smt100::SMT100Component::set_voltage_sensor ( sensor::Sensor voltage_sensor)
inline

Definition at line 28 of file smt100.h.

◆ update()

void esphome::smt100::SMT100Component::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 9 of file smt100.cpp.

Field Documentation

◆ counts_sensor_

sensor::Sensor* esphome::smt100::SMT100Component::counts_sensor_ {nullptr}
protected

Definition at line 33 of file smt100.h.

◆ dielectric_constant_sensor_

sensor::Sensor* esphome::smt100::SMT100Component::dielectric_constant_sensor_ {nullptr}
protected

Definition at line 34 of file smt100.h.

◆ last_transmission_

uint32_t esphome::smt100::SMT100Component::last_transmission_ {0}
protected

Definition at line 39 of file smt100.h.

◆ moisture_sensor_

sensor::Sensor* esphome::smt100::SMT100Component::moisture_sensor_ {nullptr}
protected

Definition at line 35 of file smt100.h.

◆ temperature_sensor_

sensor::Sensor* esphome::smt100::SMT100Component::temperature_sensor_ {nullptr}
protected

Definition at line 36 of file smt100.h.

◆ voltage_sensor_

sensor::Sensor* esphome::smt100::SMT100Component::voltage_sensor_ {nullptr}
protected

Definition at line 37 of file smt100.h.


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