esphome::api::LockInfo Struct Reference

Static description of a lock entity. More...

#include <lock.hpp>

Inheritance diagram for esphome::api::LockInfo:

Collaboration diagram for esphome::api::LockInfo:

Public Attributes
bool	assumed_state = false
bool	supports_open = false
bool	requires_code = false
std::string	code_format
Public Attributes inherited from esphome::api::EntityInfo
std::uint32_t	key = 0
	Stable per-entity identifier used to correlate state and command messages.
std::string	object_id
std::string	name
std::string	icon
bool	disabled_by_default = false
EntityCategory	entity_category = EntityCategory::None
std::uint32_t	device_id = 0
	Sub-device id (0 = the root device) when the device exposes sub-devices.

Detailed Description

Static description of a lock entity.

Member Data Documentation

assumed_state

bool esphome::api::LockInfo::assumed_state = false

code_format

std::string esphome::api::LockInfo::code_format

requires_code

bool esphome::api::LockInfo::requires_code = false

supports_open

bool esphome::api::LockInfo::supports_open = false

---

The documentation for this struct was generated from the following file:

• include/esphome/api/model/entities/lock.hpp