homeassistant.components.zone.Zone Class Reference

Inheritance diagram for homeassistant.components.zone.Zone:

Collaboration diagram for homeassistant.components.zone.Zone:

Public Member Functions
None	__init__ (self, ConfigType config)
None	async_added_to_hass (self)
None	async_update_config (self, ConfigType config)
Self	from_storage (cls, ConfigType config)
Self	from_yaml (cls, ConfigType config)
int	state (self)

Public Attributes
	editable
	entity_id

Private Member Functions
None	_generate_attrs (self)
None	_person_state_change_listener (self, Event[EventStateChangedData] evt)
None	_set_attrs_from_config (self)
bool	_state_is_in_zone (self, State|None state)

Private Attributes
	_attr_extra_state_attributes
	_attr_icon
	_attr_name
	_attr_unique_id
	_case_folded_name
	_config
	_persons_in_zone

Static Private Attributes
bool	_attr_should_poll = False

Detailed Description

Representation of a Zone.

Definition at line 337 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.zone.Zone.__init__	(		self,
		ConfigType	config
	)

Initialize the zone.

Definition at line 343 of file __init__.py.

Member Function Documentation

_generate_attrs()

None homeassistant.components.zone.Zone._generate_attrs (   self )

private

Generate new attrs based on config.

Definition at line 425 of file __init__.py.

_person_state_change_listener()

None homeassistant.components.zone.Zone._person_state_change_listener (   self, Event[EventStateChangedData]  evt  )

private

Definition at line 392 of file __init__.py.

_set_attrs_from_config()

None homeassistant.components.zone.Zone._set_attrs_from_config (   self )

private

Set the attributes from the config.

Definition at line 352 of file __init__.py.

_state_is_in_zone()

bool homeassistant.components.zone.Zone._state_is_in_zone (   self, State | None  state  )

private

Return if given state is in zone.

Definition at line 437 of file __init__.py.

async_added_to_hass()

None homeassistant.components.zone.Zone.async_added_to_hass

(

self

)

Run when entity about to be added to hass.

Definition at line 405 of file __init__.py.

async_update_config()

None homeassistant.components.zone.Zone.async_update_config	(		self,
		ConfigType	config
	)

Handle when the config is updated.

Definition at line 382 of file __init__.py.

from_storage()

Self homeassistant.components.zone.Zone.from_storage	(		cls,
		ConfigType	config
	)

Return entity instance initialized from storage.

Definition at line 362 of file __init__.py.

from_yaml()

Self homeassistant.components.zone.Zone.from_yaml	(		cls,
		ConfigType	config
	)

Return entity instance initialized from yaml.

Definition at line 370 of file __init__.py.

state()

int homeassistant.components.zone.Zone.state

(

self

)

Return the state property really does nothing for a zone.

Definition at line 378 of file __init__.py.

Member Data Documentation

_attr_extra_state_attributes

homeassistant.components.zone.Zone._attr_extra_state_attributes

private

Definition at line 427 of file __init__.py.

_attr_icon

homeassistant.components.zone.Zone._attr_icon

private

Definition at line 359 of file __init__.py.

_attr_name

homeassistant.components.zone.Zone._attr_name

private

Definition at line 356 of file __init__.py.

_attr_should_poll

bool homeassistant.components.zone.Zone._attr_should_poll = False

staticprivate

Definition at line 341 of file __init__.py.

_attr_unique_id

homeassistant.components.zone.Zone._attr_unique_id

private

Definition at line 358 of file __init__.py.

_case_folded_name

homeassistant.components.zone.Zone._case_folded_name

private

Definition at line 357 of file __init__.py.

_config

homeassistant.components.zone.Zone._config

private

Definition at line 345 of file __init__.py.

_persons_in_zone

homeassistant.components.zone.Zone._persons_in_zone

private

Definition at line 409 of file __init__.py.

editable

homeassistant.components.zone.Zone.editable

Definition at line 346 of file __init__.py.

entity_id

homeassistant.components.zone.Zone.entity_id

Definition at line 449 of file __init__.py.

---

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

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