ESPHome
2024.8.3
|
#include <template_valve.h>
Public Member Functions | |
TemplateValve () | |
void | set_state_lambda (std::function< optional< float >()> &&f) |
Trigger * | get_open_trigger () const |
Trigger * | get_close_trigger () const |
Trigger * | get_stop_trigger () const |
Trigger * | get_toggle_trigger () const |
Trigger< float > * | get_position_trigger () const |
void | set_optimistic (bool optimistic) |
void | set_assumed_state (bool assumed_state) |
void | set_has_stop (bool has_stop) |
void | set_has_position (bool has_position) |
void | set_has_toggle (bool has_toggle) |
void | set_restore_mode (TemplateValveRestoreMode restore_mode) |
void | setup () override |
void | loop () override |
void | dump_config () override |
float | get_setup_priority () const override |
![]() | |
Valve () | |
ValveCall | make_call () |
Construct a new valve call used to control the valve. More... | |
void | add_on_state_callback (std::function< void()> &&f) |
void | publish_state (bool save=true) |
Publish the current state of the valve. More... | |
bool | is_fully_open () const |
Helper method to check if the valve is fully open. Equivalent to comparing .position against 1.0. More... | |
bool | is_fully_closed () const |
Helper method to check if the valve is fully closed. Equivalent to comparing .position against 0.0. More... | |
![]() | |
const StringRef & | get_name () const |
void | set_name (const char *name) |
bool | has_own_name () const |
std::string | get_object_id () const |
void | set_object_id (const char *object_id) |
uint32_t | get_object_id_hash () |
bool | is_internal () const |
void | set_internal (bool internal) |
bool | is_disabled_by_default () const |
void | set_disabled_by_default (bool disabled_by_default) |
EntityCategory | get_entity_category () const |
void | set_entity_category (EntityCategory entity_category) |
std::string | get_icon () const |
void | set_icon (const char *icon) |
![]() | |
std::string | get_device_class () |
Get the device class, using the manual override if set. More... | |
void | set_device_class (const char *device_class) |
Manually set the device class. 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... | |
Protected Member Functions | |
void | control (const valve::ValveCall &call) override |
valve::ValveTraits | get_traits () override |
void | stop_prev_trigger_ () |
![]() | |
optional< ValveRestoreState > | restore_state_ () |
![]() | |
virtual uint32_t | hash_base () |
The hash_base() function has been deprecated. More... | |
void | calc_object_id_ () |
![]() | |
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(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... | |
Additional Inherited Members | |
![]() | |
ValveOperation | current_operation {VALVE_OPERATION_IDLE} |
The current operation of the valve (idle, opening, closing). More... | |
float | position |
The position of the valve from 0.0 (fully closed) to 1.0 (fully open). More... | |
Definition at line 16 of file template_valve.h.
esphome::template_::TemplateValve::TemplateValve | ( | ) |
Definition at line 11 of file template_valve.cpp.
|
overrideprotectedvirtual |
Implements esphome::valve::Valve.
Definition at line 73 of file template_valve.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 67 of file template_valve.cpp.
Trigger * esphome::template_::TemplateValve::get_close_trigger | ( | ) | const |
Definition at line 63 of file template_valve.cpp.
Trigger * esphome::template_::TemplateValve::get_open_trigger | ( | ) | const |
Definition at line 62 of file template_valve.cpp.
Trigger< float > * esphome::template_::TemplateValve::get_position_trigger | ( | ) | const |
Definition at line 117 of file template_valve.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 60 of file template_valve.cpp.
Trigger * esphome::template_::TemplateValve::get_stop_trigger | ( | ) | const |
Definition at line 64 of file template_valve.cpp.
Trigger * esphome::template_::TemplateValve::get_toggle_trigger | ( | ) | const |
Definition at line 65 of file template_valve.cpp.
|
overrideprotectedvirtual |
Implements esphome::valve::Valve.
Definition at line 108 of file template_valve.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 39 of file template_valve.cpp.
void esphome::template_::TemplateValve::set_assumed_state | ( | bool | assumed_state | ) |
Definition at line 58 of file template_valve.cpp.
void esphome::template_::TemplateValve::set_has_position | ( | bool | has_position | ) |
Definition at line 121 of file template_valve.cpp.
void esphome::template_::TemplateValve::set_has_stop | ( | bool | has_stop | ) |
Definition at line 119 of file template_valve.cpp.
void esphome::template_::TemplateValve::set_has_toggle | ( | bool | has_toggle | ) |
Definition at line 120 of file template_valve.cpp.
void esphome::template_::TemplateValve::set_optimistic | ( | bool | optimistic | ) |
Definition at line 57 of file template_valve.cpp.
|
inline |
Definition at line 31 of file template_valve.h.
void esphome::template_::TemplateValve::set_state_lambda | ( | std::function< optional< float >()> && | f | ) |
Definition at line 59 of file template_valve.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 18 of file template_valve.cpp.
|
protected |
Definition at line 123 of file template_valve.cpp.
|
protected |
Definition at line 46 of file template_valve.h.
|
protected |
Definition at line 49 of file template_valve.h.
|
protected |
Definition at line 56 of file template_valve.h.
|
protected |
Definition at line 50 of file template_valve.h.
|
protected |
Definition at line 51 of file template_valve.h.
|
protected |
Definition at line 48 of file template_valve.h.
|
protected |
Definition at line 47 of file template_valve.h.
|
protected |
Definition at line 55 of file template_valve.h.
|
protected |
Definition at line 54 of file template_valve.h.
|
protected |
Definition at line 44 of file template_valve.h.
Definition at line 45 of file template_valve.h.
|
protected |
Definition at line 52 of file template_valve.h.
|
protected |
Definition at line 53 of file template_valve.h.