ESPHome  2024.11.0
Public Member Functions
esphome::statsd::StatsdComponent Class Reference

#include <statsd.h>

Inheritance diagram for esphome::statsd::StatsdComponent:
esphome::PollingComponent esphome::Component

Public Member Functions

 ~StatsdComponent ()
 
void setup () override
 
void dump_config () override
 
void update () override
 
float get_setup_priority () const override
 
void configure (const char *host, uint16_t port, const char *prefix)
 
void register_sensor (const char *name, esphome::sensor::Sensor *sensor)
 
void register_binary_sensor (const char *name, esphome::binary_sensor::BinarySensor *binary_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...
 

Additional Inherited Members

- 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 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}
 

Detailed Description

Definition at line 46 of file statsd.h.

Constructor & Destructor Documentation

◆ ~StatsdComponent()

esphome::statsd::StatsdComponent::~StatsdComponent ( )

Definition at line 31 of file statsd.cpp.

Member Function Documentation

◆ configure()

void esphome::statsd::StatsdComponent::configure ( const char *  host,
uint16_t  port,
const char *  prefix 
)
inline

Definition at line 55 of file statsd.h.

◆ dump_config()

void esphome::statsd::StatsdComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 40 of file statsd.cpp.

◆ get_setup_priority()

float esphome::statsd::StatsdComponent::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 55 of file statsd.cpp.

◆ register_binary_sensor()

void esphome::statsd::StatsdComponent::register_binary_sensor ( const char *  name,
esphome::binary_sensor::BinarySensor binary_sensor 
)

Definition at line 68 of file statsd.cpp.

◆ register_sensor()

void esphome::statsd::StatsdComponent::register_sensor ( const char *  name,
esphome::sensor::Sensor sensor 
)

Definition at line 58 of file statsd.cpp.

◆ setup()

void esphome::statsd::StatsdComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file statsd.cpp.

◆ update()

void esphome::statsd::StatsdComponent::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 77 of file statsd.cpp.


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