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

Public Member Functions

None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
dict[str, Any]|None extra_state_attributes (self)
 
- 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)
 
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)
 
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)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (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)
 
- Public Member Functions inherited from homeassistant.components.siren.SirenEntity
list[int|str]|dict[int, str]|None available_tones (self)
 
dict[str, Any]|None capability_attributes (self)
 
SirenEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
bool|None is_on (self)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Static Public Member Functions

VolSchemaType config_schema ()
 

Private Member Functions

None _async_publish (self, str topic, str template, Any value, dict[str, Any]|None variables=None)
 
None _prepare_subscribe_topics (self)
 
None _setup_from_config (self, ConfigType config)
 
None _state_message_received (self, ReceiveMessage msg)
 
None _subscribe_topics (self)
 
None _update (self, SirenTurnOnServiceParameters data)
 

Private Attributes

 _attr_assumed_state
 
 _attr_available_tones
 
 _attr_is_on
 
 _attr_supported_features
 
 _command_templates
 
 _extra_attributes
 
 _optimistic
 
 _state_off
 
 _state_on
 
 _value_template
 

Static Private Attributes

 _attributes_extra_blocked = MQTT_SIREN_ATTRIBUTES_BLOCKED
 
 _default_name = DEFAULT_NAME
 
 _entity_id_format = 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
 
- Static Public Attributes inherited from homeassistant.components.siren.SirenEntity
 SirenEntityFeature
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Detailed Description

Representation of a siren that can be controlled using MQTT.

Definition at line 130 of file siren.py.

Member Function Documentation

◆ _async_publish()

None homeassistant.components.mqtt.siren.MqttSiren._async_publish (   self,
str  topic,
str  template,
Any  value,
dict[str, Any] | None   variables = None 
)
private
Publish MQTT payload with optional command template.

Definition at line 291 of file siren.py.

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.siren.MqttSiren._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 264 of file siren.py.

◆ _setup_from_config()

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

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

Definition at line 151 of file siren.py.

◆ _state_message_received()

None homeassistant.components.mqtt.siren.MqttSiren._state_message_received (   self,
ReceiveMessage  msg 
)
private
Handle new MQTT state messages.

Definition at line 203 of file siren.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.siren.MqttSiren._subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 275 of file siren.py.

◆ _update()

None homeassistant.components.mqtt.siren.MqttSiren._update (   self,
SirenTurnOnServiceParameters  data 
)
private
Update the extra siren state attributes.

Definition at line 343 of file siren.py.

◆ async_turn_off()

None homeassistant.components.mqtt.siren.MqttSiren.async_turn_off (   self,
**Any  kwargs 
)
Turn the siren off.

This method is a coroutine.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 327 of file siren.py.

◆ async_turn_on()

None homeassistant.components.mqtt.siren.MqttSiren.async_turn_on (   self,
**Any  kwargs 
)
Turn the siren on.

This method is a coroutine.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 309 of file siren.py.

◆ config_schema()

VolSchemaType homeassistant.components.mqtt.siren.MqttSiren.config_schema ( )
static
Return the config schema.

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

Definition at line 147 of file siren.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.components.mqtt.siren.MqttSiren.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 280 of file siren.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.mqtt.siren.MqttSiren._attr_assumed_state
private

Definition at line 178 of file siren.py.

◆ _attr_available_tones

homeassistant.components.mqtt.siren.MqttSiren._attr_available_tones
private

Definition at line 169 of file siren.py.

◆ _attr_is_on

homeassistant.components.mqtt.siren.MqttSiren._attr_is_on
private

Definition at line 179 of file siren.py.

◆ _attr_supported_features

homeassistant.components.mqtt.siren.MqttSiren._attr_supported_features
private

Definition at line 176 of file siren.py.

◆ _attributes_extra_blocked

homeassistant.components.mqtt.siren.MqttSiren._attributes_extra_blocked = MQTT_SIREN_ATTRIBUTES_BLOCKED
staticprivate

Definition at line 135 of file siren.py.

◆ _command_templates

homeassistant.components.mqtt.siren.MqttSiren._command_templates
private

Definition at line 185 of file siren.py.

◆ _default_name

homeassistant.components.mqtt.siren.MqttSiren._default_name = DEFAULT_NAME
staticprivate

Definition at line 133 of file siren.py.

◆ _entity_id_format

homeassistant.components.mqtt.siren.MqttSiren._entity_id_format = ENTITY_ID_FORMAT
staticprivate

Definition at line 134 of file siren.py.

◆ _extra_attributes

homeassistant.components.mqtt.siren.MqttSiren._extra_attributes
private

Definition at line 160 of file siren.py.

◆ _optimistic

homeassistant.components.mqtt.siren.MqttSiren._optimistic
private

Definition at line 177 of file siren.py.

◆ _state_off

homeassistant.components.mqtt.siren.MqttSiren._state_off
private

Definition at line 158 of file siren.py.

◆ _state_on

homeassistant.components.mqtt.siren.MqttSiren._state_on
private

Definition at line 155 of file siren.py.

◆ _value_template

homeassistant.components.mqtt.siren.MqttSiren._value_template
private

Definition at line 197 of file siren.py.


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