homeassistant.components.ads.valve.AdsValve Class Reference

Inheritance diagram for homeassistant.components.ads.valve.AdsValve:

Collaboration diagram for homeassistant.components.ads.valve.AdsValve:

Public Member Functions
None	__init__ (self, AdsHub ads_hub, str ads_var, str name, ValveDeviceClass|None device_class)
None	async_added_to_hass (self)
None	close_valve (self, **kwargs)
None	open_valve (self, **kwargs)
Public Member Functions inherited from homeassistant.components.ads.entity.AdsEntity
None	__init__ (self, AdsHub ads_hub, str name, str ads_var)
None	async_initialize_device (self, str ads_var, type plctype, str state_key=STATE_KEY_STATE, int|None factor=None)
bool	available (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)
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_device_class
	_attr_is_closed
	_attr_reports_position

Static Private Attributes
	_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

Representation of an ADS valve entity.

Definition at line 54 of file valve.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.ads.valve.AdsValve.__init__	(		self,
		AdsHub	ads_hub,
		str	ads_var,
		str	name,
		ValveDeviceClass | None	device_class
	)

Initialize AdsValve entity.

Definition at line 59 of file valve.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.ads.valve.AdsValve.async_added_to_hass

(

self

)

Register device notification.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 72 of file valve.py.

close_valve()

None homeassistant.components.ads.valve.AdsValve.close_valve	(		self,
		**	kwargs
	)

Close the valve.

Definition at line 81 of file valve.py.

open_valve()

None homeassistant.components.ads.valve.AdsValve.open_valve	(		self,
		**	kwargs
	)

Open the valve.

Definition at line 76 of file valve.py.

Member Data Documentation

_attr_device_class

homeassistant.components.ads.valve.AdsValve._attr_device_class

private

Definition at line 68 of file valve.py.

_attr_is_closed

homeassistant.components.ads.valve.AdsValve._attr_is_closed

private

Definition at line 70 of file valve.py.

_attr_reports_position

homeassistant.components.ads.valve.AdsValve._attr_reports_position

private

Definition at line 69 of file valve.py.

_attr_supported_features

homeassistant.components.ads.valve.AdsValve._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/ads/valve.py