ESPHome  1.15.2
Data Structures | Enumerations | Functions | Variables
esphome::cover Namespace Reference

Data Structures

class  CloseAction
 
class  ControlAction
 
class  Cover
 Base class for all cover devices. More...
 
class  CoverCall
 
class  CoverIsClosedCondition
 
class  CoverIsOpenCondition
 
class  CoverPublishAction
 
struct  CoverRestoreState
 Struct used to store the restored state of a cover. More...
 
class  CoverTraits
 
class  OpenAction
 
class  StopAction
 

Enumerations

enum  CoverOperation : uint8_t { COVER_OPERATION_IDLE = 0, COVER_OPERATION_OPENING, COVER_OPERATION_CLOSING }
 Enum encoding the current operation of a cover. More...
 

Functions

const char * cover_command_to_str (float pos)
 
const char * cover_operation_to_str (CoverOperation op)
 
struct esphome::cover::CoverRestoreState __attribute__ ((packed))
 

Variables

const float COVER_OPEN = 1.0f
 
const float COVER_CLOSED = 0.0f
 
enum esphome::cover::CoverOperation __attribute__
 

Enumeration Type Documentation

◆ CoverOperation

Enum encoding the current operation of a cover.

Enumerator
COVER_OPERATION_IDLE 

The cover is currently idle (not moving)

COVER_OPERATION_OPENING 

The cover is currently opening.

COVER_OPERATION_CLOSING 

The cover is currently closing.

Definition at line 75 of file cover.h.

Function Documentation

◆ __attribute__()

struct esphome::cover::CoverRestoreState esphome::cover::__attribute__ ( (packed)  )

◆ cover_command_to_str()

const char* esphome::cover::cover_command_to_str ( float  pos)

Definition at line 12 of file cover.cpp.

◆ cover_operation_to_str()

const char * esphome::cover::cover_operation_to_str ( CoverOperation  op)

Definition at line 21 of file cover.cpp.

Variable Documentation

◆ __attribute__

enum esphome::cover::CoverOperation esphome::cover::__attribute__

◆ COVER_CLOSED

const float esphome::cover::COVER_CLOSED = 0.0f

Definition at line 10 of file cover.cpp.

◆ COVER_OPEN

const float esphome::cover::COVER_OPEN = 1.0f

Definition at line 9 of file cover.cpp.