homeassistant.components.wilight.cover.WiLightCover Class Reference

Inheritance diagram for homeassistant.components.wilight.cover.WiLightCover:

Collaboration diagram for homeassistant.components.wilight.cover.WiLightCover:

Public Member Functions
None	async_close_cover (self, **Any kwargs)
None	async_open_cover (self, **Any kwargs)
None	async_set_cover_position (self, **Any kwargs)
None	async_stop_cover (self, **Any kwargs)
int|None	current_cover_position (self)
bool|None	is_closed (self)
bool|None	is_closing (self)
bool|None	is_opening (self)
Public Member Functions inherited from homeassistant.components.wilight.entity.WiLightDevice
None	__init__ (self, PyWiLightDevice api_device, str index, str item_name)
None	async_added_to_hass (self)
None	async_update (self)
bool	available (self)
None	handle_event_callback (self, dict[str, Any] states)
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.cover.CoverEntity
None	async_close_cover_tilt (self, **Any kwargs)
None	async_open_cover_tilt (self, **Any kwargs)
None	async_set_cover_tilt_position (self, **Any kwargs)
None	async_stop_cover_tilt (self, **Any kwargs)
None	async_toggle (self, **Any kwargs)
None	async_toggle_tilt (self, **Any kwargs)
None	close_cover (self, **Any kwargs)
None	close_cover_tilt (self, **Any kwargs)
int|None	current_cover_tilt_position (self)
CoverDeviceClass|None	device_class (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 Private Attributes
	_attr_name = None

Additional Inherited Members
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 inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.cover.CoverEntity
	None

Detailed Description

Representation of a WiLights cover.

Definition at line 59 of file cover.py.

Member Function Documentation

async_close_cover()

None homeassistant.components.wilight.cover.WiLightCover.async_close_cover	(		self,
		**Any	kwargs
	)

Close cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 102 of file cover.py.

async_open_cover()

None homeassistant.components.wilight.cover.WiLightCover.async_open_cover	(		self,
		**Any	kwargs
	)

Open the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 98 of file cover.py.

async_set_cover_position()

None homeassistant.components.wilight.cover.WiLightCover.async_set_cover_position	(		self,
		**Any	kwargs
	)

Move the cover to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 106 of file cover.py.

async_stop_cover()

None homeassistant.components.wilight.cover.WiLightCover.async_stop_cover	(		self,
		**Any	kwargs
	)

Stop the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 111 of file cover.py.

current_cover_position()

int | None homeassistant.components.wilight.cover.WiLightCover.current_cover_position

(

self

)

Return current position of cover.

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

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 65 of file cover.py.

is_closed()

bool | None homeassistant.components.wilight.cover.WiLightCover.is_closed

(

self

)

Return if the cover is closed or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 89 of file cover.py.

is_closing()

bool | None homeassistant.components.wilight.cover.WiLightCover.is_closing

(

self

)

Return if the cover is closing or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 82 of file cover.py.

is_opening()

bool | None homeassistant.components.wilight.cover.WiLightCover.is_opening

(

self

)

Return if the cover is opening or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 75 of file cover.py.

Member Data Documentation

_attr_name

homeassistant.components.wilight.cover.WiLightCover._attr_name = None

staticprivate

Definition at line 62 of file cover.py.

---

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

• core/homeassistant/components/wilight/cover.py