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

Public Member Functions

None async_close_valve (self)
 
None async_open_valve (self)
 
None async_set_valve_position (self, int position)
 
None async_stop_valve (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)
 
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.valve.ValveEntity
None async_handle_close_valve (self)
 
None async_handle_open_valve (self)
 
None async_toggle (self)
 
None close_valve (self)
 
int|None current_valve_position (self)
 
ValveDeviceClass|None device_class (self)
 
bool|None is_closed (self)
 
bool|None is_closing (self)
 
bool|None is_opening (self)
 
None open_valve (self)
 
bool reports_position (self)
 
None set_valve_position (self, int position)
 
str|None state (self)
 
dict[str, Any]|None state_attributes (self)
 
None stop_valve (self)
 
ValveEntityFeature supported_features (self)
 

Static Public Member Functions

VolSchemaType config_schema ()
 

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.valve.ValveEntity
 None
 
 ValveEntityFeature
 

Private Member Functions

None _prepare_subscribe_topics (self)
 
None _process_binary_valve_update (self, ReceiveMessage msg, str state_payload)
 
None _process_position_valve_update (self, ReceiveMessage msg, str position_payload, str state_payload)
 
None _setup_from_config (self, ConfigType config)
 
None _state_message_received (self, ReceiveMessage msg)
 
None _subscribe_topics (self)
 
None _update_state (self, str|None state)
 

Private Attributes

 _attr_assumed_state
 
 _attr_current_valve_position
 
 _attr_device_class
 
 _attr_is_closed
 
 _attr_is_closing
 
 _attr_is_opening
 
 _attr_reports_position
 
 _attr_supported_features
 
 _command_template
 
 _optimistic
 
 _range
 
 _value_template
 

Static Private Attributes

 _default_name = DEFAULT_NAME
 

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
 

Detailed Description

Representation of a valve that can be controlled using MQTT.

Definition at line 153 of file valve.py.

Member Function Documentation

◆ _prepare_subscribe_topics()

None homeassistant.components.mqtt.valve.MqttValve._prepare_subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 337 of file valve.py.

◆ _process_binary_valve_update()

None homeassistant.components.mqtt.valve.MqttValve._process_binary_valve_update (   self,
ReceiveMessage  msg,
str   state_payload 
)
private
Process an update for a valve that does not report the position.

Definition at line 228 of file valve.py.

◆ _process_position_valve_update()

None homeassistant.components.mqtt.valve.MqttValve._process_position_valve_update (   self,
ReceiveMessage  msg,
str  position_payload,
str   state_payload 
)
private
Process an update for a valve that reports the position.

Definition at line 254 of file valve.py.

◆ _setup_from_config()

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

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

Definition at line 169 of file valve.py.

◆ _state_message_received()

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

Definition at line 298 of file valve.py.

◆ _subscribe_topics()

None homeassistant.components.mqtt.valve.MqttValve._subscribe_topics (   self)
private
(Re)Subscribe to topics.

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

Definition at line 350 of file valve.py.

◆ _update_state()

None homeassistant.components.mqtt.valve.MqttValve._update_state (   self,
str | None  state 
)
private
Update the valve state properties.

Definition at line 216 of file valve.py.

◆ async_close_valve()

None homeassistant.components.mqtt.valve.MqttValve.async_close_valve (   self)
Move the valve down.

This method is a coroutine.

Reimplemented from homeassistant.components.valve.ValveEntity.

Definition at line 368 of file valve.py.

◆ async_open_valve()

None homeassistant.components.mqtt.valve.MqttValve.async_open_valve (   self)
Move the valve up.

This method is a coroutine.

Reimplemented from homeassistant.components.valve.ValveEntity.

Definition at line 354 of file valve.py.

◆ async_set_valve_position()

None homeassistant.components.mqtt.valve.MqttValve.async_set_valve_position (   self,
int  position 
)
Move the valve to a specific position.

Reimplemented from homeassistant.components.valve.ValveEntity.

Definition at line 390 of file valve.py.

◆ async_stop_valve()

None homeassistant.components.mqtt.valve.MqttValve.async_stop_valve (   self)
Stop valve positioning.

This method is a coroutine.

Reimplemented from homeassistant.components.valve.ValveEntity.

Definition at line 382 of file valve.py.

◆ config_schema()

VolSchemaType homeassistant.components.mqtt.valve.MqttValve.config_schema ( )
static
Return the config schema.

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

Definition at line 165 of file valve.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.mqtt.valve.MqttValve._attr_assumed_state
private

Definition at line 178 of file valve.py.

◆ _attr_current_valve_position

homeassistant.components.mqtt.valve.MqttValve._attr_current_valve_position
private

Definition at line 265 of file valve.py.

◆ _attr_device_class

homeassistant.components.mqtt.valve.MqttValve._attr_device_class
private

Definition at line 199 of file valve.py.

◆ _attr_is_closed

homeassistant.components.mqtt.valve.MqttValve._attr_is_closed
private

Definition at line 223 of file valve.py.

◆ _attr_is_closing

homeassistant.components.mqtt.valve.MqttValve._attr_is_closing
private

Definition at line 219 of file valve.py.

◆ _attr_is_opening

homeassistant.components.mqtt.valve.MqttValve._attr_is_opening
private

Definition at line 218 of file valve.py.

◆ _attr_reports_position

homeassistant.components.mqtt.valve.MqttValve._attr_reports_position
private

Definition at line 171 of file valve.py.

◆ _attr_supported_features

homeassistant.components.mqtt.valve.MqttValve._attr_supported_features
private

Definition at line 213 of file valve.py.

◆ _command_template

homeassistant.components.mqtt.valve.MqttValve._command_template
private

Definition at line 189 of file valve.py.

◆ _default_name

homeassistant.components.mqtt.valve.MqttValve._default_name = DEFAULT_NAME
staticprivate

Definition at line 158 of file valve.py.

◆ _optimistic

homeassistant.components.mqtt.valve.MqttValve._optimistic
private

Definition at line 177 of file valve.py.

◆ _range

homeassistant.components.mqtt.valve.MqttValve._range
private

Definition at line 172 of file valve.py.

◆ _value_template

homeassistant.components.mqtt.valve.MqttValve._value_template
private

Definition at line 185 of file valve.py.

◆ None

homeassistant.components.mqtt.valve.MqttValve.None
static

Definition at line 156 of file valve.py.

◆ str

homeassistant.components.mqtt.valve.MqttValve.str
static

Definition at line 159 of file valve.py.


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