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

Public Member Functions

None async_close_cover (self, **Any kwargs)
 
None async_close_cover_tilt (self, **Any kwargs)
 
None async_open_cover (self, **Any kwargs)
 
None async_open_cover_tilt (self, **Any kwargs)
 
None async_set_cover_position (self, **Any kwargs)
 
None async_set_cover_tilt_position (self, **Any kwargs)
 
None async_stop_cover (self, **Any kwargs)
 
None async_toggle_tilt (self, **Any kwargs)
 
None tilt_payload_received (self, Any _payload)
 
- 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)
 
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)
 
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.cover.CoverEntity
None async_stop_cover_tilt (self, **Any kwargs)
 
None async_toggle (self, **Any kwargs)
 
None close_cover (self, **Any kwargs)
 
None close_cover_tilt (self, **Any kwargs)
 
int|None current_cover_position (self)
 
int|None current_cover_tilt_position (self)
 
CoverDeviceClass|None device_class (self)
 
bool|None is_closed (self)
 
bool|None is_closing (self)
 
bool|None is_opening (self)
 
None open_cover (self, **Any kwargs)
 
None open_cover_tilt (self, **Any kwargs)
 
None set_cover_position (self, **Any kwargs)
 
None set_cover_tilt_position (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
None stop_cover (self, **Any kwargs)
 
None stop_cover_tilt (self, **Any kwargs)
 
CoverEntityFeature supported_features (self)
 
None toggle (self, **Any kwargs)
 
None toggle_tilt (self, **Any kwargs)
 

Static Public Member Functions

VolSchemaType config_schema ()
 

Public Attributes

 current_cover_position
 
- 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
 
- Public Attributes inherited from homeassistant.components.cover.CoverEntity
 current_cover_position
 
 current_cover_tilt_position
 

Static Public Attributes

 None
 
 str
 
- 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.cover.CoverEntity
 None
 

Private Member Functions

None _position_message_received (self, ReceiveMessage msg)
 
None _prepare_subscribe_topics (self)
 
None _setup_from_config (self, ConfigType config)
 
None _state_message_received (self, ReceiveMessage msg)
 
None _subscribe_topics (self)
 
None _tilt_message_received (self, ReceiveMessage msg)
 
None _update_state (self, str|None state)
 

Private Attributes

 _attr_assumed_state
 
 _attr_current_cover_position
 
 _attr_current_cover_tilt_position
 
 _attr_device_class
 
 _attr_is_closed
 
 _attr_is_closing
 
 _attr_is_opening
 
 _attr_supported_features
 
 _get_position_template
 
 _optimistic
 
 _pos_range
 
 _set_position_template
 
 _set_tilt_template
 
 _tilt_closed_percentage
 
 _tilt_open_percentage
 
 _tilt_optimistic
 
 _tilt_range
 
 _tilt_status_template
 
 _value_template
 

Static Private Attributes

 _default_name = DEFAULT_NAME
 

Detailed Description

Representation of a cover that can be controlled using MQTT.

Definition at line 237 of file cover.py.

Member Function Documentation

◆ _position_message_received()

None homeassistant.components.mqtt.cover.MqttCover._position_message_received (   self,
ReceiveMessage  msg 
)
private
Handle new MQTT position messages.

Definition at line 420 of file cover.py.

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.cover.MqttCover._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 463 of file cover.py.

◆ _setup_from_config()

None homeassistant.components.mqtt.cover.MqttCover._setup_from_config (   self,
ConfigType  config 
)
private
Set up cover from config.

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

Definition at line 256 of file cover.py.

◆ _state_message_received()

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

Definition at line 376 of file cover.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.cover.MqttCover._subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 487 of file cover.py.

◆ _tilt_message_received()

None homeassistant.components.mqtt.cover.MqttCover._tilt_message_received (   self,
ReceiveMessage  msg 
)
private
Handle tilt updates.

Definition at line 365 of file cover.py.

◆ _update_state()

None homeassistant.components.mqtt.cover.MqttCover._update_state (   self,
str | None  state 
)
private
Update the cover state.

Definition at line 354 of file cover.py.

◆ async_close_cover()

None homeassistant.components.mqtt.cover.MqttCover.async_close_cover (   self,
**Any  kwargs 
)
Move the cover down.

This method is a coroutine.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 506 of file cover.py.

◆ async_close_cover_tilt()

None homeassistant.components.mqtt.cover.MqttCover.async_close_cover_tilt (   self,
**Any  kwargs 
)
Tilt the cover closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 549 of file cover.py.

◆ async_open_cover()

None homeassistant.components.mqtt.cover.MqttCover.async_open_cover (   self,
**Any  kwargs 
)
Move the cover up.

This method is a coroutine.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 491 of file cover.py.

◆ async_open_cover_tilt()

None homeassistant.components.mqtt.cover.MqttCover.async_open_cover_tilt (   self,
**Any  kwargs 
)
Tilt the cover open.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 530 of file cover.py.

◆ async_set_cover_position()

None homeassistant.components.mqtt.cover.MqttCover.async_set_cover_position (   self,
**Any  kwargs 
)
Move the cover to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 595 of file cover.py.

◆ async_set_cover_tilt_position()

None homeassistant.components.mqtt.cover.MqttCover.async_set_cover_tilt_position (   self,
**Any  kwargs 
)
Move the cover tilt to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 570 of file cover.py.

◆ async_stop_cover()

None homeassistant.components.mqtt.cover.MqttCover.async_stop_cover (   self,
**Any  kwargs 
)
Stop the device.

This method is a coroutine.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 521 of file cover.py.

◆ async_toggle_tilt()

None homeassistant.components.mqtt.cover.MqttCover.async_toggle_tilt (   self,
**Any  kwargs 
)
Toggle the entity.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 624 of file cover.py.

◆ config_schema()

VolSchemaType homeassistant.components.mqtt.cover.MqttCover.config_schema ( )
static
Return the config schema.

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

Definition at line 252 of file cover.py.

◆ tilt_payload_received()

None homeassistant.components.mqtt.cover.MqttCover.tilt_payload_received (   self,
Any  _payload 
)
Set the tilt value.

Definition at line 635 of file cover.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.mqtt.cover.MqttCover._attr_assumed_state
private

Definition at line 296 of file cover.py.

◆ _attr_current_cover_position

homeassistant.components.mqtt.cover.MqttCover._attr_current_cover_position
private

Definition at line 389 of file cover.py.

◆ _attr_current_cover_tilt_position

homeassistant.components.mqtt.cover.MqttCover._attr_current_cover_tilt_position
private

Definition at line 546 of file cover.py.

◆ _attr_device_class

homeassistant.components.mqtt.cover.MqttCover._attr_device_class
private

Definition at line 334 of file cover.py.

◆ _attr_is_closed

homeassistant.components.mqtt.cover.MqttCover._attr_is_closed
private

Definition at line 358 of file cover.py.

◆ _attr_is_closing

homeassistant.components.mqtt.cover.MqttCover._attr_is_closing
private

Definition at line 362 of file cover.py.

◆ _attr_is_opening

homeassistant.components.mqtt.cover.MqttCover._attr_is_opening
private

Definition at line 361 of file cover.py.

◆ _attr_supported_features

homeassistant.components.mqtt.cover.MqttCover._attr_supported_features
private

Definition at line 351 of file cover.py.

◆ _default_name

homeassistant.components.mqtt.cover.MqttCover._default_name = DEFAULT_NAME
staticprivate

Definition at line 242 of file cover.py.

◆ _get_position_template

homeassistant.components.mqtt.cover.MqttCover._get_position_template
private

Definition at line 318 of file cover.py.

◆ _optimistic

homeassistant.components.mqtt.cover.MqttCover._optimistic
private

Definition at line 291 of file cover.py.

◆ _pos_range

homeassistant.components.mqtt.cover.MqttCover._pos_range
private

Definition at line 258 of file cover.py.

◆ _set_position_template

homeassistant.components.mqtt.cover.MqttCover._set_position_template
private

Definition at line 314 of file cover.py.

◆ _set_tilt_template

homeassistant.components.mqtt.cover.MqttCover._set_tilt_template
private

Definition at line 324 of file cover.py.

◆ _tilt_closed_percentage

homeassistant.components.mqtt.cover.MqttCover._tilt_closed_percentage
private

Definition at line 260 of file cover.py.

◆ _tilt_open_percentage

homeassistant.components.mqtt.cover.MqttCover._tilt_open_percentage
private

Definition at line 263 of file cover.py.

◆ _tilt_optimistic

homeassistant.components.mqtt.cover.MqttCover._tilt_optimistic
private

Definition at line 298 of file cover.py.

◆ _tilt_range

homeassistant.components.mqtt.cover.MqttCover._tilt_range
private

Definition at line 259 of file cover.py.

◆ _tilt_status_template

homeassistant.components.mqtt.cover.MqttCover._tilt_status_template
private

Definition at line 328 of file cover.py.

◆ _value_template

homeassistant.components.mqtt.cover.MqttCover._value_template
private

Definition at line 310 of file cover.py.

◆ current_cover_position

homeassistant.components.mqtt.cover.MqttCover.current_cover_position

Definition at line 458 of file cover.py.

◆ None

homeassistant.components.mqtt.cover.MqttCover.None
static

Definition at line 240 of file cover.py.

◆ str

homeassistant.components.mqtt.cover.MqttCover.str
static

Definition at line 243 of file cover.py.


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