homeassistant.components.rainmachine.entity.RainMachineEntity Class Reference

Inheritance diagram for homeassistant.components.rainmachine.entity.RainMachineEntity:

Collaboration diagram for homeassistant.components.rainmachine.entity.RainMachineEntity:

Public Member Functions
None	__init__ (self, RainMachineConfigEntry entry, RainMachineData data, RainMachineEntityDescription description)
None	async_added_to_hass (self)
DeviceInfo	device_info (self)
None	update_from_latest_data (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
bool	available (self)
Public Member Functions inherited from homeassistant.components.rainmachine.coordinator.RainMachineDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, *RainMachineConfigEntry entry, str name, str api_category, timedelta update_interval, Callable[[], Coroutine[Any, Any, dict]] update_method)
None	async_initialize (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
	entity_description
Public Attributes inherited from homeassistant.components.rainmachine.coordinator.RainMachineDataUpdateCoordinator
	config_entry
	last_update_success
	signal_reboot_completed
	signal_reboot_requested
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)

Private Attributes
	_attr_extra_state_attributes
	_attr_unique_id
	_data
	_entry
	_version_coordinator

Static Private Attributes
bool	_attr_has_entity_name = True

Detailed Description

Define a generic RainMachine entity.

Definition at line 26 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.rainmachine.entity.RainMachineEntity.__init__	(		self,
		RainMachineConfigEntry	entry,
		RainMachineData	data,
		RainMachineEntityDescription	description
	)

Initialize.

Definition at line 31 of file entity.py.

Member Function Documentation

_handle_coordinator_update()

None homeassistant.components.rainmachine.entity.RainMachineEntity._handle_coordinator_update (   self )

private

Respond to a DataUpdateCoordinator update.

Definition at line 67 of file entity.py.

async_added_to_hass()

None homeassistant.components.rainmachine.entity.RainMachineEntity.async_added_to_hass

(

self

)

When entity is added to hass.

Reimplemented in homeassistant.components.rainmachine.sensor.TimeRemainingSensor.

Definition at line 72 of file entity.py.

device_info()

DeviceInfo homeassistant.components.rainmachine.entity.RainMachineEntity.device_info

(

self

)

Return device information about this controller.

Definition at line 48 of file entity.py.

update_from_latest_data()

None homeassistant.components.rainmachine.entity.RainMachineEntity.update_from_latest_data

(

self

)

Update the state.

Reimplemented in homeassistant.components.rainmachine.update.RainMachineUpdateEntity, homeassistant.components.rainmachine.switch.RainMachineZone, homeassistant.components.rainmachine.switch.RainMachineRestrictionSwitch, homeassistant.components.rainmachine.switch.RainMachineProgram, homeassistant.components.rainmachine.switch.RainMachineEnabledSwitch, homeassistant.components.rainmachine.sensor.ProvisionSettingsSensor, homeassistant.components.rainmachine.sensor.TimeRemainingSensor, homeassistant.components.rainmachine.select.FreezeProtectionTemperatureSelect, homeassistant.components.rainmachine.binary_sensor.ProvisionSettingsBinarySensor, and homeassistant.components.rainmachine.binary_sensor.CurrentRestrictionsBinarySensor.

Definition at line 83 of file entity.py.

Member Data Documentation

_attr_extra_state_attributes

homeassistant.components.rainmachine.entity.RainMachineEntity._attr_extra_state_attributes

private

Initialize.

Definition at line 40 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.rainmachine.entity.RainMachineEntity._attr_has_entity_name = True

staticprivate

Definition at line 29 of file entity.py.

_attr_unique_id

homeassistant.components.rainmachine.entity.RainMachineEntity._attr_unique_id

private

Definition at line 41 of file entity.py.

_data

homeassistant.components.rainmachine.entity.RainMachineEntity._data

private

Definition at line 43 of file entity.py.

_entry

homeassistant.components.rainmachine.entity.RainMachineEntity._entry

private

Definition at line 42 of file entity.py.

_version_coordinator

homeassistant.components.rainmachine.entity.RainMachineEntity._version_coordinator

private

Definition at line 44 of file entity.py.

entity_description

homeassistant.components.rainmachine.entity.RainMachineEntity.entity_description

Definition at line 45 of file entity.py.

---

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

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