Home Assistant Unofficial Reference 2024.12.1
Classes | Functions | Variables
homeassistant.components.mqtt.lock Namespace Reference

Classes

class  MqttLock
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_CODE_FORMAT = "code_format"
 
string CONF_PAYLOAD_LOCK = "payload_lock"
 
string CONF_PAYLOAD_OPEN = "payload_open"
 
string CONF_PAYLOAD_UNLOCK = "payload_unlock"
 
string CONF_STATE_JAMMED = "state_jammed"
 
string CONF_STATE_LOCKED = "state_locked"
 
string CONF_STATE_LOCKING = "state_locking"
 
string CONF_STATE_UNLOCKED = "state_unlocked"
 
string CONF_STATE_UNLOCKING = "state_unlocking"
 
string DEFAULT_NAME = "MQTT Lock"
 
string DEFAULT_PAYLOAD_LOCK = "LOCK"
 
string DEFAULT_PAYLOAD_OPEN = "OPEN"
 
string DEFAULT_PAYLOAD_RESET = "None"
 
string DEFAULT_PAYLOAD_UNLOCK = "UNLOCK"
 
string DEFAULT_STATE_JAMMED = "JAMMED"
 
string DEFAULT_STATE_LOCKED = "LOCKED"
 
string DEFAULT_STATE_LOCKING = "LOCKING"
 
string DEFAULT_STATE_OPEN = "OPEN"
 
string DEFAULT_STATE_OPENING = "OPENING"
 
string DEFAULT_STATE_UNLOCKED = "UNLOCKED"
 
string DEFAULT_STATE_UNLOCKING = "UNLOCKING"
 
 DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)
 
 MQTT_LOCK_ATTRIBUTES_BLOCKED
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA_MODERN
 
list STATE_CONFIG_KEYS
 

Detailed Description

Support for MQTT locks.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.mqtt.lock.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
) 
Set up MQTT lock through YAML and through MQTT discovery.

Definition at line 116 of file lock.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.mqtt.lock._LOGGER = logging.getLogger(__name__)
private

Definition at line 46 of file lock.py.

◆ CONF_CODE_FORMAT

string homeassistant.components.mqtt.lock.CONF_CODE_FORMAT = "code_format"

Definition at line 50 of file lock.py.

◆ CONF_PAYLOAD_LOCK

string homeassistant.components.mqtt.lock.CONF_PAYLOAD_LOCK = "payload_lock"

Definition at line 52 of file lock.py.

◆ CONF_PAYLOAD_OPEN

string homeassistant.components.mqtt.lock.CONF_PAYLOAD_OPEN = "payload_open"

Definition at line 54 of file lock.py.

◆ CONF_PAYLOAD_UNLOCK

string homeassistant.components.mqtt.lock.CONF_PAYLOAD_UNLOCK = "payload_unlock"

Definition at line 53 of file lock.py.

◆ CONF_STATE_JAMMED

string homeassistant.components.mqtt.lock.CONF_STATE_JAMMED = "state_jammed"

Definition at line 61 of file lock.py.

◆ CONF_STATE_LOCKED

string homeassistant.components.mqtt.lock.CONF_STATE_LOCKED = "state_locked"

Definition at line 56 of file lock.py.

◆ CONF_STATE_LOCKING

string homeassistant.components.mqtt.lock.CONF_STATE_LOCKING = "state_locking"

Definition at line 57 of file lock.py.

◆ CONF_STATE_UNLOCKED

string homeassistant.components.mqtt.lock.CONF_STATE_UNLOCKED = "state_unlocked"

Definition at line 59 of file lock.py.

◆ CONF_STATE_UNLOCKING

string homeassistant.components.mqtt.lock.CONF_STATE_UNLOCKING = "state_unlocking"

Definition at line 60 of file lock.py.

◆ DEFAULT_NAME

string homeassistant.components.mqtt.lock.DEFAULT_NAME = "MQTT Lock"

Definition at line 63 of file lock.py.

◆ DEFAULT_PAYLOAD_LOCK

string homeassistant.components.mqtt.lock.DEFAULT_PAYLOAD_LOCK = "LOCK"

Definition at line 64 of file lock.py.

◆ DEFAULT_PAYLOAD_OPEN

string homeassistant.components.mqtt.lock.DEFAULT_PAYLOAD_OPEN = "OPEN"

Definition at line 66 of file lock.py.

◆ DEFAULT_PAYLOAD_RESET

string homeassistant.components.mqtt.lock.DEFAULT_PAYLOAD_RESET = "None"

Definition at line 67 of file lock.py.

◆ DEFAULT_PAYLOAD_UNLOCK

string homeassistant.components.mqtt.lock.DEFAULT_PAYLOAD_UNLOCK = "UNLOCK"

Definition at line 65 of file lock.py.

◆ DEFAULT_STATE_JAMMED

string homeassistant.components.mqtt.lock.DEFAULT_STATE_JAMMED = "JAMMED"

Definition at line 74 of file lock.py.

◆ DEFAULT_STATE_LOCKED

string homeassistant.components.mqtt.lock.DEFAULT_STATE_LOCKED = "LOCKED"

Definition at line 68 of file lock.py.

◆ DEFAULT_STATE_LOCKING

string homeassistant.components.mqtt.lock.DEFAULT_STATE_LOCKING = "LOCKING"

Definition at line 69 of file lock.py.

◆ DEFAULT_STATE_OPEN

string homeassistant.components.mqtt.lock.DEFAULT_STATE_OPEN = "OPEN"

Definition at line 70 of file lock.py.

◆ DEFAULT_STATE_OPENING

string homeassistant.components.mqtt.lock.DEFAULT_STATE_OPENING = "OPENING"

Definition at line 71 of file lock.py.

◆ DEFAULT_STATE_UNLOCKED

string homeassistant.components.mqtt.lock.DEFAULT_STATE_UNLOCKED = "UNLOCKED"

Definition at line 72 of file lock.py.

◆ DEFAULT_STATE_UNLOCKING

string homeassistant.components.mqtt.lock.DEFAULT_STATE_UNLOCKING = "UNLOCKING"

Definition at line 73 of file lock.py.

◆ DISCOVERY_SCHEMA

homeassistant.components.mqtt.lock.DISCOVERY_SCHEMA = PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA)

Definition at line 103 of file lock.py.

◆ MQTT_LOCK_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.lock.MQTT_LOCK_ATTRIBUTES_BLOCKED
Initial value:
1 = frozenset(
2  {
3  lock.ATTR_CHANGED_BY,
4  lock.ATTR_CODE_FORMAT,
5  }
6 )

Definition at line 76 of file lock.py.

◆ PARALLEL_UPDATES

int homeassistant.components.mqtt.lock.PARALLEL_UPDATES = 0

Definition at line 48 of file lock.py.

◆ PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.lock.PLATFORM_SCHEMA_MODERN
Initial value:
1 = MQTT_RW_SCHEMA.extend(
2  {
3  vol.Optional(CONF_CODE_FORMAT): cv.is_regex,
4  vol.Optional(CONF_COMMAND_TEMPLATE): cv.template,
5  vol.Optional(CONF_NAME): vol.Any(cv.string, None),
6  vol.Optional(CONF_PAYLOAD_LOCK, default=DEFAULT_PAYLOAD_LOCK): cv.string,
7  vol.Optional(CONF_PAYLOAD_UNLOCK, default=DEFAULT_PAYLOAD_UNLOCK): cv.string,
8  vol.Optional(CONF_PAYLOAD_OPEN): cv.string,
9  vol.Optional(CONF_PAYLOAD_RESET, default=DEFAULT_PAYLOAD_RESET): cv.string,
10  vol.Optional(CONF_STATE_JAMMED, default=DEFAULT_STATE_JAMMED): cv.string,
11  vol.Optional(CONF_STATE_LOCKED, default=DEFAULT_STATE_LOCKED): cv.string,
12  vol.Optional(CONF_STATE_LOCKING, default=DEFAULT_STATE_LOCKING): cv.string,
13  vol.Optional(CONF_STATE_OPEN, default=DEFAULT_STATE_OPEN): cv.string,
14  vol.Optional(CONF_STATE_OPENING, default=DEFAULT_STATE_OPENING): cv.string,
15  vol.Optional(CONF_STATE_UNLOCKED, default=DEFAULT_STATE_UNLOCKED): cv.string,
16  vol.Optional(CONF_STATE_UNLOCKING, default=DEFAULT_STATE_UNLOCKING): cv.string,
17  vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
18  }
19 ).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 83 of file lock.py.

◆ STATE_CONFIG_KEYS

list homeassistant.components.mqtt.lock.STATE_CONFIG_KEYS
Initial value:
1 = [
2  CONF_STATE_JAMMED,
3  CONF_STATE_LOCKED,
4  CONF_STATE_LOCKING,
5  CONF_STATE_OPEN,
6  CONF_STATE_OPENING,
7  CONF_STATE_UNLOCKED,
8  CONF_STATE_UNLOCKING,
9 ]

Definition at line 105 of file lock.py.