esphome::cover Namespace Reference

Data Structures
class	Cover
	Base class for all cover devices. More...
class	CoverCall
class	CoverPositionTrigger
struct	CoverRestoreState
	Struct used to store the restored state of a cover. More...
class	CoverTraits
class	CoverTrigger

Typedefs
using	CoverOpenedTrigger = CoverPositionTrigger<true>
using	CoverClosedTrigger = CoverPositionTrigger<false>

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
	ESPHOME_LOG_TAG (TAG, "cover")
const LogString *	cover_command_to_str (float pos)
	PROGMEM_STRING_TABLE (CoverOperationStrings, "IDLE", "OPENING", "CLOSING", "UNKNOWN")
const LogString *	cover_operation_to_str (CoverOperation op)
struct esphome::cover::CoverRestoreState	__attribute__ ((packed))

Variables
enum esphome::cover::CoverOperation	__attribute__

Typedef Documentation

CoverClosedTrigger

using esphome::cover::CoverClosedTrigger = CoverPositionTrigger<false>

Definition at line 27 of file automation.h.

CoverOpenedTrigger

using esphome::cover::CoverOpenedTrigger = CoverPositionTrigger<true>

Definition at line 26 of file automation.h.

Enumeration Type Documentation

CoverOperation

enum esphome::cover::CoverOperation : uint8_t

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 84 of file cover.h.

Function Documentation

__attribute__()

struct esphome::cover::CoverRestoreState esphome::cover::__attribute__

(

(packed)

)

cover_command_to_str()

const LogString * esphome::cover::cover_command_to_str

(

float

pos

)

Definition at line 13 of file cover.cpp.

cover_operation_to_str()

const LogString * esphome::cover::cover_operation_to_str

(

CoverOperation

op

)

Definition at line 25 of file cover.cpp.

ESPHOME_LOG_TAG()

esphome::cover::ESPHOME_LOG_TAG	(	TAG	,
		"cover"	)

PROGMEM_STRING_TABLE()

esphome::cover::PROGMEM_STRING_TABLE	(	CoverOperationStrings	,
		"IDLE"	,
		"OPENING"	,
		"CLOSING"	,
		"UNKNOWN"	)

Variable Documentation

__attribute__

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