ESPHome  2024.11.3
Public Member Functions | Protected Attributes
esphome::sun::SunTrigger Class Reference

#include <sun.h>

Inheritance diagram for esphome::sun::SunTrigger:
esphome::Trigger<> esphome::PollingComponent esphome::Parented< Sun > esphome::Component

Public Member Functions

 SunTrigger ()
 
void set_sunrise (bool sunrise)
 
void set_elevation (double elevation)
 
void update () override
 
- Public Member Functions inherited from esphome::Trigger<>
void trigger (Ts... x)
 Inform the parent automation that the event has triggered. More...
 
void set_automation_parent (Automation< Ts... > *automation_parent)
 
void stop_action ()
 Stop any action connected to this trigger. More...
 
bool is_action_running ()
 Returns true if any action connected to this trigger is running. 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 setup ()
 Where the component's initialization should happen. More...
 
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
virtual float get_setup_priority () const
 priority of setup(). 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::Parented< Sun >
 Parented ()
 
 Parented (Sun *parent)
 
Sun * get_parent () const
 Get the parent of this object. More...
 
void set_parent (Sun *parent)
 Set the parent of this object. More...
 

Protected Attributes

bool sunrise_
 
double last_elevation_ {NAN}
 
double elevation_
 
- Protected Attributes inherited from esphome::Trigger<>
Automation< Ts... > * automation_parent_
 
- 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::Parented< Sun >
Sun * parent_
 

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

Detailed Description

Definition at line 82 of file sun.h.

Constructor & Destructor Documentation

◆ SunTrigger()

esphome::sun::SunTrigger::SunTrigger ( )
inline

Definition at line 84 of file sun.h.

Member Function Documentation

◆ set_elevation()

void esphome::sun::SunTrigger::set_elevation ( double  elevation)
inline

Definition at line 87 of file sun.h.

◆ set_sunrise()

void esphome::sun::SunTrigger::set_sunrise ( bool  sunrise)
inline

Definition at line 86 of file sun.h.

◆ update()

void esphome::sun::SunTrigger::update ( )
inlineoverridevirtual

Implements esphome::PollingComponent.

Definition at line 89 of file sun.h.

Field Documentation

◆ elevation_

double esphome::sun::SunTrigger::elevation_
protected

Definition at line 110 of file sun.h.

◆ last_elevation_

double esphome::sun::SunTrigger::last_elevation_ {NAN}
protected

Definition at line 109 of file sun.h.

◆ sunrise_

bool esphome::sun::SunTrigger::sunrise_
protected

Definition at line 108 of file sun.h.


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