homeassistant.components.switch_as_x.valve.ValveSwitch Class Reference

Inheritance diagram for homeassistant.components.switch_as_x.valve.ValveSwitch:

Collaboration diagram for homeassistant.components.switch_as_x.valve.ValveSwitch:

Public Member Functions
None	async_close_valve (self, **Any kwargs)
None	async_open_valve (self, **Any kwargs)
None	async_state_changed_listener (self, Event[EventStateChangedData]|None event=None)
Public Member Functions inherited from homeassistant.components.switch_as_x.entity.BaseInvertableEntity
None	__init__ (self, HomeAssistant hass, str config_entry_title, str domain, bool invert, str switch_entity_id, str unique_id)
dict[str, Any]	async_generate_entity_options (self)
Public Member Functions inherited from homeassistant.components.switch_as_x.entity.BaseEntity
None	__init__ (self, HomeAssistant hass, str config_entry_title, str domain, str switch_entity_id, str unique_id)
None	async_added_to_hass (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_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)
Public Member Functions inherited from homeassistant.components.valve.ValveEntity
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)

Private Attributes
	_attr_is_closed

Static Private Attributes
bool	_attr_reports_position = False
	_attr_supported_features = ValveEntityFeature.OPEN | ValveEntityFeature.CLOSE

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
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

Detailed Description

Represents a Switch as a Valve.

Definition at line 54 of file valve.py.

Member Function Documentation

async_close_valve()

None homeassistant.components.switch_as_x.valve.ValveSwitch.async_close_valve	(		self,
		**Any	kwargs
	)

Close valve.

Definition at line 70 of file valve.py.

async_open_valve()

None homeassistant.components.switch_as_x.valve.ValveSwitch.async_open_valve	(		self,
		**Any	kwargs
	)

Open the valve.

Definition at line 60 of file valve.py.

async_state_changed_listener()

None homeassistant.components.switch_as_x.valve.ValveSwitch.async_state_changed_listener	(		self,
		Event[EventStateChangedData] | None	event = None
	)

Handle child updates.

Reimplemented from homeassistant.components.switch_as_x.entity.BaseEntity.

Definition at line 81 of file valve.py.

Member Data Documentation

_attr_is_closed

homeassistant.components.switch_as_x.valve.ValveSwitch._attr_is_closed

private

Definition at line 93 of file valve.py.

_attr_reports_position

bool homeassistant.components.switch_as_x.valve.ValveSwitch._attr_reports_position = False

staticprivate

Definition at line 58 of file valve.py.

_attr_supported_features

homeassistant.components.switch_as_x.valve.ValveSwitch._attr_supported_features = ValveEntityFeature.OPEN | ValveEntityFeature.CLOSE

staticprivate

Definition at line 57 of file valve.py.

---

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

• core/homeassistant/components/switch_as_x/valve.py