homeassistant.components.hydrawise.entity.HydrawiseEntity Class Reference

Inheritance diagram for homeassistant.components.hydrawise.entity.HydrawiseEntity:

Collaboration diagram for homeassistant.components.hydrawise.entity.HydrawiseEntity:

Public Member Functions
None	__init__ (self, HydrawiseDataUpdateCoordinator coordinator, EntityDescription description, Controller controller, *int|None zone_id=None, int|None sensor_id=None)
bool	available (self)
Sensor	sensor (self)
Zone	zone (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)

Public Attributes
	controller
	entity_description
	sensor_id
	zone_id
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method

Private Member Functions
None	_handle_coordinator_update (self)
None	_update_attrs (self)

Private Attributes
	_attr_device_info
	_attr_unique_id
	_device_id

Static Private Attributes
string	_attr_attribution = "Data provided by hydrawise.com"
bool	_attr_has_entity_name = True

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.hydrawise.coordinator.HydrawiseData
	default_factory

Detailed Description

Entity class for Hydrawise devices.

Definition at line 16 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.hydrawise.entity.HydrawiseEntity.__init__	(		self,
		HydrawiseDataUpdateCoordinator	coordinator,
		EntityDescription	description,
		Controller	controller,
		*int | None	zone_id = None,
		int | None	sensor_id = None
	)

Initialize the Hydrawise entity.

Definition at line 22 of file entity.py.

Member Function Documentation

_handle_coordinator_update()

None homeassistant.components.hydrawise.entity.HydrawiseEntity._handle_coordinator_update (   self )

private

Get the latest data and updates the state.

Definition at line 68 of file entity.py.

_update_attrs()

None homeassistant.components.hydrawise.entity.HydrawiseEntity._update_attrs (   self )

private

Update state attributes.

Reimplemented in homeassistant.components.hydrawise.valve.HydrawiseValve, homeassistant.components.hydrawise.sensor.HydrawiseSensor, and homeassistant.components.hydrawise.binary_sensor.HydrawiseBinarySensor.

Definition at line 63 of file entity.py.

available()

bool homeassistant.components.hydrawise.entity.HydrawiseEntity.available

(

self

)

Set the entity availability.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Reimplemented in homeassistant.components.hydrawise.binary_sensor.HydrawiseBinarySensor.

Definition at line 75 of file entity.py.

sensor()

Sensor homeassistant.components.hydrawise.entity.HydrawiseEntity.sensor

(

self

)

Return the entity sensor.

Definition at line 58 of file entity.py.

zone()

Zone homeassistant.components.hydrawise.entity.HydrawiseEntity.zone

(

self

)

Return the entity zone.

Definition at line 52 of file entity.py.

Member Data Documentation

_attr_attribution

string homeassistant.components.hydrawise.entity.HydrawiseEntity._attr_attribution = "Data provided by hydrawise.com"

staticprivate

Definition at line 19 of file entity.py.

_attr_device_info

homeassistant.components.hydrawise.entity.HydrawiseEntity._attr_device_info

private

Definition at line 39 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.hydrawise.entity.HydrawiseEntity._attr_has_entity_name = True

staticprivate

Definition at line 20 of file entity.py.

_attr_unique_id

homeassistant.components.hydrawise.entity.HydrawiseEntity._attr_unique_id

private

Definition at line 38 of file entity.py.

_device_id

homeassistant.components.hydrawise.entity.HydrawiseEntity._device_id

private

Definition at line 37 of file entity.py.

controller

homeassistant.components.hydrawise.entity.HydrawiseEntity.controller

Definition at line 34 of file entity.py.

entity_description

homeassistant.components.hydrawise.entity.HydrawiseEntity.entity_description

Definition at line 33 of file entity.py.

sensor_id

homeassistant.components.hydrawise.entity.HydrawiseEntity.sensor_id

Definition at line 36 of file entity.py.

zone_id

homeassistant.components.hydrawise.entity.HydrawiseEntity.zone_id

Definition at line 35 of file entity.py.

---

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

• core/homeassistant/components/hydrawise/entity.py