homeassistant.components.overkiz.entity.OverkizEntity Class Reference

Inheritance diagram for homeassistant.components.overkiz.entity.OverkizEntity:

Collaboration diagram for homeassistant.components.overkiz.entity.OverkizEntity:

Public Member Functions
None	__init__ (self, str device_url, OverkizDataUpdateCoordinator coordinator)
Device	device (self)
DeviceInfo	generate_device_info (self)
bool	is_sub_device (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.overkiz.coordinator.OverkizDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *str name, OverkizClient client, list[Device] devices, Place|None places, timedelta|None update_interval=None, str config_entry_id)
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
	base_device_url
	device_url
	executor
	index_device_url
Public Attributes inherited from homeassistant.components.overkiz.coordinator.OverkizDataUpdateCoordinator
	areas
	client
	config_entry_id
	data
	devices
	executions
	is_stateless
	update_interval
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

Static Public Attributes
	None

Private Attributes
	_attr_assumed_state
	_attr_available
	_attr_device_info
	_attr_name
	_attr_unique_id

Static Private Attributes
bool	_attr_has_entity_name = True

Detailed Description

Representation of an Overkiz device entity.

Definition at line 19 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.overkiz.entity.OverkizEntity.__init__	(		self,
		str	device_url,
		OverkizDataUpdateCoordinator	coordinator
	)

Initialize the device.

Reimplemented in homeassistant.components.overkiz.water_heater.domestic_hot_water_production.DomesticHotWaterProduction, homeassistant.components.overkiz.sensor.OverkizHomeKitSetupCodeSensor, homeassistant.components.overkiz.light.OverkizLight, homeassistant.components.overkiz.cover.vertical_cover.LowSpeedCover, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.climate.valve_heating_temperature_interface.ValveHeatingTemperatureInterface, homeassistant.components.overkiz.climate.somfy_thermostat.SomfyThermostat, homeassistant.components.overkiz.climate.somfy_heating_temperature_interface.SomfyHeatingTemperatureInterface, homeassistant.components.overkiz.climate.hitachi_air_to_air_heat_pump_ovp.HitachiAirToAirHeatPumpOVP, homeassistant.components.overkiz.climate.hitachi_air_to_air_heat_pump_hlrrwifi.HitachiAirToAirHeatPumpHLRRWIFI, homeassistant.components.overkiz.climate.atlantic_pass_apc_zone_control_zone.AtlanticPassAPCZoneControlZone, homeassistant.components.overkiz.climate.atlantic_pass_apc_zone_control.AtlanticPassAPCZoneControl, homeassistant.components.overkiz.climate.atlantic_pass_apc_heating_zone.AtlanticPassAPCHeatingZone, homeassistant.components.overkiz.climate.atlantic_heat_recovery_ventilation.AtlanticHeatRecoveryVentilation, homeassistant.components.overkiz.climate.atlantic_electrical_towel_dryer.AtlanticElectricalTowelDryer, and homeassistant.components.overkiz.climate.atlantic_electrical_heater_with_adjustable_temperature_setpoint.AtlanticElectricalHeaterWithAdjustableTemperatureSetpoint.

Definition at line 25 of file entity.py.

Member Function Documentation

device()

Device homeassistant.components.overkiz.entity.OverkizEntity.device

(

self

)

Return Overkiz device linked to this entity.

Definition at line 53 of file entity.py.

generate_device_info()

DeviceInfo homeassistant.components.overkiz.entity.OverkizEntity.generate_device_info

(

self

)

Return device registry information for this entity.

Definition at line 57 of file entity.py.

is_sub_device()

bool homeassistant.components.overkiz.entity.OverkizEntity.is_sub_device

(

self

)

Return True if device is a sub device.

Definition at line 48 of file entity.py.

Member Data Documentation

_attr_assumed_state

homeassistant.components.overkiz.entity.OverkizEntity._attr_assumed_state

private

Definition at line 37 of file entity.py.

_attr_available

homeassistant.components.overkiz.entity.OverkizEntity._attr_available

private

Definition at line 38 of file entity.py.

_attr_device_info

homeassistant.components.overkiz.entity.OverkizEntity._attr_device_info

private

Definition at line 45 of file entity.py.

_attr_has_entity_name

bool homeassistant.components.overkiz.entity.OverkizEntity._attr_has_entity_name = True

staticprivate

Definition at line 22 of file entity.py.

_attr_name

homeassistant.components.overkiz.entity.OverkizEntity._attr_name

private

Definition at line 43 of file entity.py.

_attr_unique_id

homeassistant.components.overkiz.entity.OverkizEntity._attr_unique_id

private

Definition at line 39 of file entity.py.

base_device_url

homeassistant.components.overkiz.entity.OverkizEntity.base_device_url

Definition at line 32 of file entity.py.

device_url

homeassistant.components.overkiz.entity.OverkizEntity.device_url

Definition at line 30 of file entity.py.

executor

homeassistant.components.overkiz.entity.OverkizEntity.executor

Definition at line 35 of file entity.py.

index_device_url

homeassistant.components.overkiz.entity.OverkizEntity.index_device_url

Definition at line 34 of file entity.py.

None

homeassistant.components.overkiz.entity.OverkizEntity.None

static

Definition at line 23 of file entity.py.

---

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

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