Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.alarm_control_panel.MqttAlarm Class Reference
Inheritance diagram for homeassistant.components.mqtt.alarm_control_panel.MqttAlarm:
[legend]
Collaboration diagram for homeassistant.components.mqtt.alarm_control_panel.MqttAlarm:
[legend]

Public Member Functions

None async_alarm_arm_away (self, str|None code=None)
 
None async_alarm_arm_custom_bypass (self, str|None code=None)
 
None async_alarm_arm_home (self, str|None code=None)
 
None async_alarm_arm_night (self, str|None code=None)
 
None async_alarm_arm_vacation (self, str|None code=None)
 
None async_alarm_disarm (self, str|None code=None)
 
None async_alarm_trigger (self, str|None code=None)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntity
None __init__ (self, HomeAssistant hass, ConfigType config, ConfigEntry config_entry, DiscoveryInfoType|None discovery_data)
 
bool add_subscription (self, str state_topic_config_key, Callable[[ReceiveMessage], None] msg_callback, set[str]|None tracked_attributes, bool disable_encoding=False)
 
None async_added_to_hass (self)
 
None async_publish (self, str topic, PublishPayloadType payload, int qos=0, bool retain=False, str|None encoding=DEFAULT_ENCODING)
 
None async_publish_with_config (self, str topic, PublishPayloadType payload)
 
None async_will_remove_from_hass (self)
 
None discovery_update (self, MQTTDiscoveryPayload discovery_payload)
 
None mqtt_async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttAttributesMixin
None __init__ (self, ConfigType config)
 
None attributes_discovery_update (self, DiscoveryInfoType config)
 
None attributes_prepare_discovery_update (self, DiscoveryInfoType config)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttAvailabilityMixin
None __init__ (self, ConfigType config)
 
None async_mqtt_connection_state_changed (self, bool state)
 
None availability_discovery_update (self, DiscoveryInfoType config)
 
None availability_prepare_discovery_update (self, DiscoveryInfoType config)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin
None __init__ (self, HomeAssistant hass, DiscoveryInfoType|None discovery_data, Callable[[MQTTDiscoveryPayload], Coroutine[Any, Any, None]]|None discovery_update=None)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None async_removed_from_registry (self)
 
- Public Member Functions inherited from homeassistant.components.mqtt.entity.MqttEntityDeviceInfo
None __init__ (self, dict[str, Any]|None specifications, ConfigEntry config_entry)
 
DeviceInfo|None device_info (self)
 
None device_info_discovery_update (self, DiscoveryInfoType config)
 

Static Public Member Functions

vol.Schema config_schema ()
 

Private Member Functions

None _prepare_subscribe_topics (self)
 
None _publish (self, str|None code, str action)
 
None _setup_from_config (self, ConfigType config)
 
None _state_message_received (self, ReceiveMessage msg)
 
None _subscribe_topics (self)
 
bool _validate_code (self, str|None code, str state)
 

Private Attributes

 _attr_alarm_state
 
 _attr_code_arm_required
 
 _attr_code_format
 
 _command_template
 
 _value_template
 

Static Private Attributes

 _attributes_extra_blocked = MQTT_ALARM_ATTRIBUTES_BLOCKED
 
 _default_name = DEFAULT_NAME
 
 _entity_id_format = alarm.ENTITY_ID_FORMAT
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.mqtt.entity.MqttEntity
 hass
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.mqtt.entity.MqttAttributesMixin
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a MQTT alarm status.

Definition at line 132 of file alarm_control_panel.py.

Member Function Documentation

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 196 of file alarm_control_panel.py.

◆ _publish()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._publish (   self,
str | None  code,
str  action 
)
private
Publish via mqtt.

Definition at line 283 of file alarm_control_panel.py.

◆ _setup_from_config()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._setup_from_config (   self,
ConfigType  config 
)
private
(Re)Setup the entity.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 144 of file alarm_control_panel.py.

◆ _state_message_received()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._state_message_received (   self,
ReceiveMessage  msg 
)
private
Run when new MQTT message has been received.

Definition at line 165 of file alarm_control_panel.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._subscribe_topics (   self)
private
(Re)Subscribe to topics.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 202 of file alarm_control_panel.py.

◆ _validate_code()

bool homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._validate_code (   self,
str | None  code,
str  state 
)
private
Validate given code.

Definition at line 289 of file alarm_control_panel.py.

◆ async_alarm_arm_away()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.async_alarm_arm_away (   self,
str | None   code = None 
)
Send arm away command.

This method is a coroutine.

Definition at line 228 of file alarm_control_panel.py.

◆ async_alarm_arm_custom_bypass()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.async_alarm_arm_custom_bypass (   self,
str | None   code = None 
)
Send arm custom bypass command.

This method is a coroutine.

Definition at line 261 of file alarm_control_panel.py.

◆ async_alarm_arm_home()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.async_alarm_arm_home (   self,
str | None   code = None 
)
Send arm home command.

This method is a coroutine.

Definition at line 217 of file alarm_control_panel.py.

◆ async_alarm_arm_night()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.async_alarm_arm_night (   self,
str | None   code = None 
)
Send arm night command.

This method is a coroutine.

Definition at line 239 of file alarm_control_panel.py.

◆ async_alarm_arm_vacation()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.async_alarm_arm_vacation (   self,
str | None   code = None 
)
Send arm vacation command.

This method is a coroutine.

Definition at line 250 of file alarm_control_panel.py.

◆ async_alarm_disarm()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.async_alarm_disarm (   self,
str | None   code = None 
)
Send disarm command.

This method is a coroutine.

Definition at line 206 of file alarm_control_panel.py.

◆ async_alarm_trigger()

None homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.async_alarm_trigger (   self,
str | None   code = None 
)
Send trigger command.

This method is a coroutine.

Definition at line 272 of file alarm_control_panel.py.

◆ config_schema()

vol.Schema homeassistant.components.mqtt.alarm_control_panel.MqttAlarm.config_schema ( )
static
Return the config schema.

Reimplemented from homeassistant.components.mqtt.entity.MqttEntity.

Definition at line 140 of file alarm_control_panel.py.

Member Data Documentation

◆ _attr_alarm_state

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._attr_alarm_state
private

Definition at line 176 of file alarm_control_panel.py.

◆ _attr_code_arm_required

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._attr_code_arm_required
private

Definition at line 163 of file alarm_control_panel.py.

◆ _attr_code_format

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._attr_code_format
private

Definition at line 158 of file alarm_control_panel.py.

◆ _attributes_extra_blocked

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._attributes_extra_blocked = MQTT_ALARM_ATTRIBUTES_BLOCKED
staticprivate

Definition at line 137 of file alarm_control_panel.py.

◆ _command_template

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._command_template
private

Definition at line 150 of file alarm_control_panel.py.

◆ _default_name

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._default_name = DEFAULT_NAME
staticprivate

Definition at line 135 of file alarm_control_panel.py.

◆ _entity_id_format

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._entity_id_format = alarm.ENTITY_ID_FORMAT
staticprivate

Definition at line 136 of file alarm_control_panel.py.

◆ _value_template

homeassistant.components.mqtt.alarm_control_panel.MqttAlarm._value_template
private

Definition at line 146 of file alarm_control_panel.py.


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