Inheritance diagram for homeassistant.components.valve.ValveEntity:

Collaboration diagram for homeassistant.components.valve.ValveEntity:

Public Member Functions
None	async_close_valve (self)

None	async_handle_close_valve (self)

None	async_handle_open_valve (self)

None	async_open_valve (self)

None	async_set_valve_position (self, int position)

None	async_stop_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)

Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)

str	__repr__ (self)

None	add_to_platform_abort (self)

None	add_to_platform_finish (self)

None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore\|None parallel_updates)

bool	assumed_state (self)

None	async_added_to_hass (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_removed_from_registry (self)

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_will_remove_from_hass (self)

None	async_write_ha_state (self)

str\|None	attribution (self)

bool	available (self)

dict[str, Any]\|None	capability_attributes (self)

DeviceInfo\|None	device_info (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, str]	translation_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)

Static Public Attributes
	None

	ValveEntityFeature

Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Static Private Attributes
	__is_last_toggle_direction_open

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Detailed Description

Base class for valve entities.

Definition at line 130 of file __init__.py.

Member Function Documentation

◆ async_close_valve()

None homeassistant.components.valve.ValveEntity.async_close_valve ( self )

Close valve.

Reimplemented in homeassistant.components.yolink.valve.YoLinkValveEntity, homeassistant.components.mqtt.valve.MqttValve, homeassistant.components.matter.valve.MatterValve, homeassistant.components.hydrawise.valve.HydrawiseValve, and homeassistant.components.guardian.valve.ValveControllerValve.

Definition at line 238 of file __init__.py.

◆ async_handle_close_valve()

None homeassistant.components.valve.ValveEntity.async_handle_close_valve ( self )

Close the valve.

Definition at line 243 of file __init__.py.

◆ async_handle_open_valve()

None homeassistant.components.valve.ValveEntity.async_handle_open_valve ( self )

Open the valve.

Definition at line 227 of file __init__.py.

◆ async_open_valve()

None homeassistant.components.valve.ValveEntity.async_open_valve ( self )

Open the valve.

Reimplemented in homeassistant.components.yolink.valve.YoLinkValveEntity, homeassistant.components.mqtt.valve.MqttValve, homeassistant.components.matter.valve.MatterValve, and homeassistant.components.guardian.valve.ValveControllerValve.

Definition at line 222 of file __init__.py.

◆ async_set_valve_position()

None homeassistant.components.valve.ValveEntity.async_set_valve_position	(		self,
		int	position
	)

Move the valve to a specific position.

Reimplemented in homeassistant.components.mqtt.valve.MqttValve, and homeassistant.components.matter.valve.MatterValve.

Definition at line 266 of file __init__.py.

◆ async_stop_valve()

None homeassistant.components.valve.ValveEntity.async_stop_valve ( self )

Stop the valve.

Reimplemented in homeassistant.components.mqtt.valve.MqttValve, and homeassistant.components.guardian.valve.ValveControllerValve.

Definition at line 274 of file __init__.py.

◆ async_toggle()

None homeassistant.components.valve.ValveEntity.async_toggle ( self )

Toggle the entity.

Definition at line 250 of file __init__.py.

◆ close_valve()

None homeassistant.components.valve.ValveEntity.close_valve ( self )

Close valve.

Definition at line 234 of file __init__.py.

◆ current_valve_position()

int | None homeassistant.components.valve.ValveEntity.current_valve_position ( self )

Return current position of valve.

None is unknown, 0 is closed, 100 is fully open.

Reimplemented in homeassistant.components.esphome.valve.EsphomeValve.

Definition at line 154 of file __init__.py.

◆ device_class()

ValveDeviceClass | None homeassistant.components.valve.ValveEntity.device_class ( self )

Return the class of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 162 of file __init__.py.

◆ is_closed()

bool | None homeassistant.components.valve.ValveEntity.is_closed ( self )

Return if the valve is closed or not.

Reimplemented in homeassistant.components.guardian.valve.ValveControllerValve, and homeassistant.components.esphome.valve.EsphomeValve.

Definition at line 214 of file __init__.py.

◆ is_closing()

bool | None homeassistant.components.valve.ValveEntity.is_closing ( self )

Return if the valve is closing or not.

Reimplemented in homeassistant.components.shelly.valve.BlockShellyValve, homeassistant.components.guardian.valve.ValveControllerValve, and homeassistant.components.esphome.valve.EsphomeValve.

Definition at line 209 of file __init__.py.

◆ is_opening()

bool | None homeassistant.components.valve.ValveEntity.is_opening ( self )

Return if the valve is opening or not.

Reimplemented in homeassistant.components.shelly.valve.BlockShellyValve, homeassistant.components.guardian.valve.ValveControllerValve, and homeassistant.components.esphome.valve.EsphomeValve.

Definition at line 204 of file __init__.py.

◆ open_valve()

None homeassistant.components.valve.ValveEntity.open_valve ( self )

Open the valve.

Definition at line 218 of file __init__.py.

◆ reports_position()

bool homeassistant.components.valve.ValveEntity.reports_position ( self )

Return True if entity reports position, False otherwise.

Definition at line 145 of file __init__.py.

◆ set_valve_position()

None homeassistant.components.valve.ValveEntity.set_valve_position	(		self,
		int	position
	)

Move the valve to a specific position.

Definition at line 262 of file __init__.py.

◆ state()

str | None homeassistant.components.valve.ValveEntity.state ( self )

Return the state of the valve.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 172 of file __init__.py.

◆ state_attributes()

dict[str, Any] | None homeassistant.components.valve.ValveEntity.state_attributes ( self )

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 192 of file __init__.py.

◆ stop_valve()

None homeassistant.components.valve.ValveEntity.stop_valve ( self )

Stop the valve.

Definition at line 270 of file __init__.py.

◆ supported_features()

ValveEntityFeature homeassistant.components.valve.ValveEntity.supported_features ( self )

Flag supported features.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 199 of file __init__.py.

Member Data Documentation

◆ __is_last_toggle_direction_open

homeassistant.components.valve.ValveEntity.__is_last_toggle_direction_open

staticprivate

Definition at line 142 of file __init__.py.

◆ None

homeassistant.components.valve.ValveEntity.None

static

Definition at line 134 of file __init__.py.

◆ ValveEntityFeature

homeassistant.components.valve.ValveEntity.ValveEntityFeature

static

Definition at line 140 of file __init__.py.

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

core/homeassistant/components/valve/__init__.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Static Public Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ async_close_valve()

◆ async_handle_close_valve()

◆ async_handle_open_valve()

◆ async_open_valve()

◆ async_set_valve_position()

◆ async_stop_valve()

◆ async_toggle()

◆ close_valve()

◆ current_valve_position()

◆ device_class()

◆ is_closed()

◆ is_closing()

◆ is_opening()

◆ open_valve()

◆ reports_position()

◆ set_valve_position()

◆ state()

◆ state_attributes()

◆ stop_valve()

◆ supported_features()

Member Data Documentation

◆ __is_last_toggle_direction_open

◆ None

◆ ValveEntityFeature