ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::tx20::Tx20Component Class Reference

This class implements support for the Tx20 Wind sensor. More...

#include <tx20.h>

Inheritance diagram for esphome::tx20::Tx20Component:
esphome::Component

Public Member Functions

std::string get_wind_cardinal_direction () const
 Get the textual representation of the wind direction ('N', 'SSE', ..). More...
 
void set_pin (InternalGPIOPin *pin)
 
void set_wind_speed_sensor (sensor::Sensor *wind_speed_sensor)
 
void set_wind_direction_degrees_sensor (sensor::Sensor *wind_direction_degrees_sensor)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void loop () override
 
- Public Member Functions inherited from esphome::Component
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...
 

Protected Member Functions

void decode_and_publish_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
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()> &&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()> &&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

std::string wind_cardinal_direction_
 
InternalGPIOPinpin_
 
sensor::Sensorwind_speed_sensor_ {nullptr}
 
sensor::Sensorwind_direction_degrees_sensor_ {nullptr}
 
Tx20ComponentStore store_
 
- 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}
 

Detailed Description

This class implements support for the Tx20 Wind sensor.

Definition at line 25 of file tx20.h.

Member Function Documentation

◆ decode_and_publish_()

void esphome::tx20::Tx20Component::decode_and_publish_ ( )
protected

Definition at line 44 of file tx20.cpp.

◆ dump_config()

void esphome::tx20::Tx20Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 25 of file tx20.cpp.

◆ get_setup_priority()

float esphome::tx20::Tx20Component::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 40 of file tx20.cpp.

◆ get_wind_cardinal_direction()

std::string esphome::tx20::Tx20Component::get_wind_cardinal_direction ( ) const

Get the textual representation of the wind direction ('N', 'SSE', ..).

Definition at line 42 of file tx20.cpp.

◆ loop()

void esphome::tx20::Tx20Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 33 of file tx20.cpp.

◆ set_pin()

void esphome::tx20::Tx20Component::set_pin ( InternalGPIOPin pin)
inline

Definition at line 30 of file tx20.h.

◆ set_wind_direction_degrees_sensor()

void esphome::tx20::Tx20Component::set_wind_direction_degrees_sensor ( sensor::Sensor wind_direction_degrees_sensor)
inline

Definition at line 32 of file tx20.h.

◆ set_wind_speed_sensor()

void esphome::tx20::Tx20Component::set_wind_speed_sensor ( sensor::Sensor wind_speed_sensor)
inline

Definition at line 31 of file tx20.h.

◆ setup()

void esphome::tx20::Tx20Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file tx20.cpp.

Field Documentation

◆ pin_

InternalGPIOPin* esphome::tx20::Tx20Component::pin_
protected

Definition at line 45 of file tx20.h.

◆ store_

Tx20ComponentStore esphome::tx20::Tx20Component::store_
protected

Definition at line 48 of file tx20.h.

◆ wind_cardinal_direction_

std::string esphome::tx20::Tx20Component::wind_cardinal_direction_
protected

Definition at line 44 of file tx20.h.

◆ wind_direction_degrees_sensor_

sensor::Sensor* esphome::tx20::Tx20Component::wind_direction_degrees_sensor_ {nullptr}
protected

Definition at line 47 of file tx20.h.

◆ wind_speed_sensor_

sensor::Sensor* esphome::tx20::Tx20Component::wind_speed_sensor_ {nullptr}
protected

Definition at line 46 of file tx20.h.


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