Base class for all valve devices. More...
#include <valve.h>
Inheritance diagram for esphome::valve::Valve:
Public Member Functions | |
| 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... | |
| virtual ValveTraits | get_traits ()=0 |
| 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... | |
 Public Member Functions inherited from esphome::EntityBase | |
| 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) |
| Public Member Functions inherited from esphome::EntityBase_DeviceClass | |
| 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... | |
Data Fields | |
| 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... | |
Protected Member Functions | |
| virtual void | control (const ValveCall &call)=0 |
| optional< ValveRestoreState > | restore_state_ () |
| Protected Member Functions inherited from esphome::EntityBase | |
| virtual uint32_t | hash_base () |
| The hash_base() function has been deprecated. More... | |
| void | calc_object_id_ () |
Protected Attributes | |
| friend | ValveCall |
| CallbackManager< void()> | state_callback_ {} |
| ESPPreferenceObject | rtc_ |
| Protected Attributes inherited from esphome::EntityBase | |
| StringRef | name_ |
| const char * | object_id_c_str_ {nullptr} |
| const char * | icon_c_str_ {nullptr} |
| uint32_t | object_id_hash_ |
| bool | has_own_name_ {false} |
| bool | internal_ {false} |
| bool | disabled_by_default_ {false} |
| EntityCategory | entity_category_ {ENTITY_CATEGORY_NONE} |
| Protected Attributes inherited from esphome::EntityBase_DeviceClass | |
| const char * | device_class_ {nullptr} |
| Device class override. More... | |
Detailed Description
Base class for all valve devices.
Valves currently have three properties:
- position - The current position of the valve from 0.0 (fully closed) to 1.0 (fully open). For valves with only binary OPEN/CLOSED position this will always be either 0.0 or 1.0
- current_operation - The operation the valve is currently performing, this can be one of IDLE, OPENING and CLOSING.
For users: All valve operations must be performed over the .make_call() interface. To command a valve, use .make_call() to create a call object, set all properties you wish to set, and activate the command with .perform(). For reading out the current values of the valve, use the public .position, etc. properties (these are read-only for users)
For integrations: Integrations must implement two methods: control() and get_traits(). Control will be called with the arguments supplied by the user and should be used to control all values of the valve. Also implement get_traits() to return what operations the valve supports.
Constructor & Destructor Documentation
◆ Valve()
Member Function Documentation
◆ add_on_state_callback()
| void esphome::valve::Valve::add_on_state_callback | ( | std::function< void()> && | f | ) |
◆ control()
|
protectedpure virtual |
Implemented in esphome::template_::TemplateValve.
◆ get_traits()
|
pure virtual |
Implemented in esphome::template_::TemplateValve.
◆ is_fully_closed()
| bool esphome::valve::Valve::is_fully_closed | ( | ) | const |
◆ is_fully_open()
| bool esphome::valve::Valve::is_fully_open | ( | ) | const |
◆ make_call()
| ValveCall esphome::valve::Valve::make_call | ( | ) |
◆ publish_state()
| void esphome::valve::Valve::publish_state | ( | bool | save = true | ) |
◆ restore_state_()
|
protected |
Field Documentation
◆ current_operation
| ValveOperation esphome::valve::Valve::current_operation {VALVE_OPERATION_IDLE} |
◆ position
| float esphome::valve::Valve::position |
◆ rtc_
|
protected |
◆ state_callback_
|
protected |
◆ ValveCall
The documentation for this class was generated from the following files:
