homeassistant.components.input_boolean.InputBoolean Class Reference

Inheritance diagram for homeassistant.components.input_boolean.InputBoolean:

Collaboration diagram for homeassistant.components.input_boolean.InputBoolean:

Public Member Functions
None	__init__ (self, ConfigType config)
None	async_added_to_hass (self)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
None	async_update_config (self, ConfigType config)
dict[str, bool]	extra_state_attributes (self)
Self	from_storage (cls, ConfigType config)
Self	from_yaml (cls, ConfigType config)
str|None	icon (self)
str|None	name (self)
Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None	async_toggle (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_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)
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)
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)
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 Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None	async_get_last_extra_data (self)
State|None	async_get_last_state (self)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
ExtraStoredData|None	extra_restore_state_data (self)

Private Attributes
	_attr_is_on
	_attr_unique_id
	_config

Static Private Attributes
bool	_attr_should_poll = False
	_unrecorded_attributes = frozenset({ATTR_EDITABLE})

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.ToggleEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of a boolean input.

Definition at line 150 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.input_boolean.InputBoolean.__init__	(		self,
		ConfigType	config
	)

Initialize a boolean input.

Definition at line 158 of file __init__.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.input_boolean.InputBoolean.async_added_to_hass

(

self

)

Call when entity about to be added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 194 of file __init__.py.

async_turn_off()

None homeassistant.components.input_boolean.InputBoolean.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the entity off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 209 of file __init__.py.

async_turn_on()

None homeassistant.components.input_boolean.InputBoolean.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the entity on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 204 of file __init__.py.

async_update_config()

None homeassistant.components.input_boolean.InputBoolean.async_update_config	(		self,
		ConfigType	config
	)

Handle when the config is updated.

Definition at line 214 of file __init__.py.

extra_state_attributes()

dict[str, bool] homeassistant.components.input_boolean.InputBoolean.extra_state_attributes

(

self

)

Return the state attributes of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 190 of file __init__.py.

from_storage()

Self homeassistant.components.input_boolean.InputBoolean.from_storage	(		cls,
		ConfigType	config
	)

Return entity instance initialized from storage.

Definition at line 165 of file __init__.py.

from_yaml()

Self homeassistant.components.input_boolean.InputBoolean.from_yaml	(		cls,
		ConfigType	config
	)

Return entity instance initialized from yaml.

Definition at line 172 of file __init__.py.

icon()

str | None homeassistant.components.input_boolean.InputBoolean.icon

(

self

)

Return the icon to be used for this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 185 of file __init__.py.

name()

str | None homeassistant.components.input_boolean.InputBoolean.name

(

self

)

Return name of the boolean input.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 180 of file __init__.py.

Member Data Documentation

_attr_is_on

homeassistant.components.input_boolean.InputBoolean._attr_is_on

private

Definition at line 161 of file __init__.py.

_attr_should_poll

bool homeassistant.components.input_boolean.InputBoolean._attr_should_poll = False

staticprivate

Definition at line 155 of file __init__.py.

_attr_unique_id

homeassistant.components.input_boolean.InputBoolean._attr_unique_id

private

Definition at line 162 of file __init__.py.

_config

homeassistant.components.input_boolean.InputBoolean._config

private

Definition at line 160 of file __init__.py.

_unrecorded_attributes

homeassistant.components.input_boolean.InputBoolean._unrecorded_attributes = frozenset({ATTR_EDITABLE})

staticprivate

Definition at line 153 of file __init__.py.

---

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

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