ESPHome  2022.6.3
Data Structures | Enumerations | Functions
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  LockLockTrigger
 
class  LockPublishAction
 
class  LockTraits
 
class  LockUnlockTrigger
 
class  OpenAction
 
class  UnlockAction
 

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

const char * lock_state_to_string (LockState state)
 

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 26 of file lock.h.

Function Documentation

◆ lock_state_to_string()

const char * esphome::lock::lock_state_to_string ( LockState  state)

Definition at line 9 of file lock.cpp.