ESPHome  2024.10.2
Data Structures | Namespaces | Enumerations | Functions | Variables
valve.h File Reference

Go to the source code of this file.

Data Structures

class  esphome::valve::ValveCall
 
struct  esphome::valve::ValveRestoreState
 Struct used to store the restored state of a valve. More...
 
class  esphome::valve::Valve
 Base class for all valve devices. More...
 

Namespaces

 esphome
 Implementation of SPI Controller mode.
 
 esphome::valve
 

Enumerations

enum  esphome::valve::ValveOperation : uint8_t { esphome::valve::VALVE_OPERATION_IDLE = 0, esphome::valve::VALVE_OPERATION_OPENING, esphome::valve::VALVE_OPERATION_CLOSING }
 Enum encoding the current operation of a valve. More...
 

Functions

struct esphome::valve::ValveRestoreState esphome::valve::__attribute__ ((packed))
 
ValveCall to_call (Valve *valve)
 Convert this struct to a valve call that can be performed. More...
 
void apply (Valve *valve)
 Apply these settings to the valve. More...
 
const char * esphome::valve::valve_operation_to_str (ValveOperation op)
 

Variables

float position
 
enum esphome::valve::ValveOperation esphome::valve::__attribute__
 

Function Documentation

◆ apply()

void __attribute__::apply ( Valve *  valve)

Apply these settings to the valve.

◆ to_call()

ValveCall __attribute__::to_call ( Valve *  valve)

Convert this struct to a valve call that can be performed.

Variable Documentation

◆ position

float position

Definition at line 14 of file valve.h.