homeassistant.components.script.UnavailableScriptEntity Class Reference

Inheritance diagram for homeassistant.components.script.UnavailableScriptEntity:

Collaboration diagram for homeassistant.components.script.UnavailableScriptEntity:

Public Member Functions
None	__init__ (self, str key, ConfigType|None raw_config, str validation_error, ValidationStatus validation_status)
None	async_added_to_hass (self)
None	async_will_remove_from_hass (self)
set[str]	referenced_areas (self)
str|None	referenced_blueprint (self)
set[str]	referenced_devices (self)
set[str]	referenced_entities (self)
set[str]	referenced_floors (self)
set[str]	referenced_labels (self)
Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None	async_toggle (self, **Any kwargs)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
bool|None	is_on (self)
Literal["on", "off"]|None	state (self)
None	toggle (self, **Any kwargs)
None	turn_off (self, **Any kwargs)
None	turn_on (self, **Any kwargs)
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_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (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)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (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 Attributes
	raw_config
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Private Attributes
	_attr_name
	_attr_unique_id
	_validation_error
	_validation_status

Static Private Attributes
bool	_attr_available = False
bool	_attr_should_poll = False

Additional Inherited Members
Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

A non-functional script entity with its state set to unavailable.

This class is instantiated when an script fails to validate.

Definition at line 461 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.script.UnavailableScriptEntity.__init__	(		self,
		str	key,
		ConfigType | None	raw_config,
		str	validation_error,
		ValidationStatus	validation_status
	)

Initialize a script entity.

Definition at line 470 of file __init__.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.script.UnavailableScriptEntity.async_added_to_hass

(

self

)

Create a repair issue to notify the user the automation has errors.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 514 of file __init__.py.

async_will_remove_from_hass()

None homeassistant.components.script.UnavailableScriptEntity.async_will_remove_from_hass

(

self

)

Run when entity will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 532 of file __init__.py.

referenced_areas()

set[str] homeassistant.components.script.UnavailableScriptEntity.referenced_areas

(

self

)

Return a set of referenced areas.

Reimplemented from homeassistant.components.script.BaseScriptEntity.

Definition at line 495 of file __init__.py.

referenced_blueprint()

str | None homeassistant.components.script.UnavailableScriptEntity.referenced_blueprint

(

self

)

Return referenced blueprint or None.

Reimplemented from homeassistant.components.script.BaseScriptEntity.

Definition at line 500 of file __init__.py.

referenced_devices()

set[str] homeassistant.components.script.UnavailableScriptEntity.referenced_devices

(

self

)

Return a set of referenced devices.

Reimplemented from homeassistant.components.script.BaseScriptEntity.

Definition at line 505 of file __init__.py.

referenced_entities()

set[str] homeassistant.components.script.UnavailableScriptEntity.referenced_entities

(

self

)

Return a set of referenced entities.

Reimplemented from homeassistant.components.script.BaseScriptEntity.

Definition at line 510 of file __init__.py.

referenced_floors()

set[str] homeassistant.components.script.UnavailableScriptEntity.referenced_floors

(

self

)

Return a set of referenced floors.

Reimplemented from homeassistant.components.script.BaseScriptEntity.

Definition at line 490 of file __init__.py.

referenced_labels()

set[str] homeassistant.components.script.UnavailableScriptEntity.referenced_labels

(

self

)

Return a set of referenced labels.

Reimplemented from homeassistant.components.script.BaseScriptEntity.

Definition at line 485 of file __init__.py.

Member Data Documentation

_attr_available

bool homeassistant.components.script.UnavailableScriptEntity._attr_available = False

staticprivate

Definition at line 468 of file __init__.py.

_attr_name

homeassistant.components.script.UnavailableScriptEntity._attr_name

private

Definition at line 478 of file __init__.py.

_attr_should_poll

bool homeassistant.components.script.UnavailableScriptEntity._attr_should_poll = False

staticprivate

A non-functional script entity with its state set to unavailable.

This class is instantiated when an script fails to validate.

Definition at line 467 of file __init__.py.

_attr_unique_id

homeassistant.components.script.UnavailableScriptEntity._attr_unique_id

private

Definition at line 479 of file __init__.py.

_validation_error

homeassistant.components.script.UnavailableScriptEntity._validation_error

private

Definition at line 481 of file __init__.py.

_validation_status

homeassistant.components.script.UnavailableScriptEntity._validation_status

private

Definition at line 482 of file __init__.py.

raw_config

homeassistant.components.script.UnavailableScriptEntity.raw_config

Definition at line 480 of file __init__.py.

---

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

• core/homeassistant/components/script/__init__.py