esphome::lock Namespace Reference

Data Structures
class	Lock
	Base class for all locks. More...
class	LockAction
class	LockCall
	This class is used to encode all control actions on a lock device. More...
class	LockCondition
class	LockStateTrigger
class	LockTraits
class	OpenAction
class	UnlockAction

Typedefs
using	LockLockTrigger = LockStateTrigger<LockState::LOCK_STATE_LOCKED>
using	LockUnlockTrigger = LockStateTrigger<LockState::LOCK_STATE_UNLOCKED>

Enumerations
enum	LockState : uint8_t {   LOCK_STATE_NONE = 0 , LOCK_STATE_LOCKED = 1 , LOCK_STATE_UNLOCKED = 2 , LOCK_STATE_JAMMED = 3 ,   LOCK_STATE_LOCKING = 4 , LOCK_STATE_UNLOCKING = 5 }
	Enum for all states a lock can be in. More...

Functions
	PROGMEM_STRING_TABLE (LockStateStrings, "UNKNOWN", "LOCKED", "UNLOCKED", "JAMMED", "LOCKING", "UNLOCKING")
const LogString *	lock_state_to_string (LockState state)

Typedef Documentation

LockLockTrigger

using esphome::lock::LockLockTrigger = LockStateTrigger<LockState::LOCK_STATE_LOCKED>

Definition at line 63 of file automation.h.

LockUnlockTrigger

using esphome::lock::LockUnlockTrigger = LockStateTrigger<LockState::LOCK_STATE_UNLOCKED>

Definition at line 64 of file automation.h.

Enumeration Type Documentation

LockState

enum esphome::lock::LockState : uint8_t

Enum for all states a lock can be in.

Enumerator
LOCK_STATE_NONE
LOCK_STATE_LOCKED
LOCK_STATE_UNLOCKED
LOCK_STATE_JAMMED
LOCK_STATE_LOCKING
LOCK_STATE_UNLOCKING

Definition at line 23 of file lock.h.

Function Documentation

lock_state_to_string()

const LogString * esphome::lock::lock_state_to_string

(

LockState

state

)

Definition at line 15 of file lock.cpp.

PROGMEM_STRING_TABLE()

esphome::lock::PROGMEM_STRING_TABLE	(	LockStateStrings	,
		"UNKNOWN"	,
		"LOCKED"	,
		"UNLOCKED"	,
		"JAMMED"	,
		"LOCKING"	,
		"UNLOCKING"	)