Inheritance diagram for homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity:

Collaboration diagram for homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity:

Public Member Functions
None	__init__ (self, HomematicipHAP hap, device, str\|None post=None, int\|None channel=None, bool\|None is_multi_channel=False)

None	async_added_to_hass (self)

None	async_remove_from_registries (self)

None	async_will_remove_from_hass (self)

bool	available (self)

DeviceInfo\|None	device_info (self)

dict[str, Any]	extra_state_attributes (self)

FunctionalChannel	get_current_channel (self)

str\|None	icon (self)

str	name (self)

str	unique_id (self)

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_internal_added_to_hass (self)

None	async_internal_will_remove_from_hass (self)

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_write_ha_state (self)

str\|None	attribution (self)

dict[str, Any]\|None	capability_attributes (self)

str\|None	device_class (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)

StateType	state (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	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 Attributes
	functional_channel

	hmip_device_removed

Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry

	entity_id

	hass

	parallel_updates

	platform

	registry_entry

Private Member Functions
None	_async_device_changed (self, args, *kwargs)

None	_async_device_removed (self, args, *kwargs)

Private Attributes
	_channel

	_device

	_hap

	_is_multi_channel

	_post

Static Private Attributes
bool	_attr_should_poll = False

Additional Inherited Members
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool

	EntityPlatform

	HomeAssistant

	None

	StateInfo

	StateType

	str

Detailed Description

Representation of the HomematicIP generic entity.

Definition at line 75 of file entity.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.__init__	(		self,
		HomematicipHAP	hap,
			device,
		str \| None	post = `None`,
		int \| None	channel = `None`,
		bool \| None	is_multi_channel = `False`
	)

Initialize the generic entity.

Definition at line 80 of file entity.py.

Member Function Documentation

◆ _async_device_changed()

None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._async_device_changed	(		self,
		*	args,
		**	kwargs
	)

private

Handle device state changes.

Definition at line 125 of file entity.py.

◆ _async_device_removed()

None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._async_device_removed	(		self,
		*	args,
		**	kwargs
	)

private

Handle hmip device removal.

Definition at line 176 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.async_added_to_hass ( self )

Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 118 of file entity.py.

◆ async_remove_from_registries()

None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.async_remove_from_registries ( self )

Remove entity/device from registry.

Definition at line 152 of file entity.py.

◆ async_will_remove_from_hass()

None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.async_will_remove_from_hass ( self )

Run when hmip device will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 138 of file entity.py.

◆ available()

bool homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.available ( self )

Return if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.homematicip_cloud.weather.HomematicipHomeWeather, homeassistant.components.homematicip_cloud.switch.HomematicipGroupSwitch, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipSecurityZoneSensorGroup, and homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor.

Definition at line 211 of file entity.py.

◆ device_info()

DeviceInfo | None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.device_info ( self )

Return device specific attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup, and homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor.

Definition at line 100 of file entity.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.extra_state_attributes ( self )

Return the state attributes of the generic entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 236 of file entity.py.

◆ get_current_channel()

FunctionalChannel homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.get_current_channel ( self )

Return the FunctionalChannel for device.

Definition at line 256 of file entity.py.

◆ icon()

str | None homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.icon ( self )

Return the icon.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.homematicip_cloud.sensor.HomematicipHeatingThermostat, homeassistant.components.homematicip_cloud.sensor.HomematicipFloorTerminalBlockMechanicChannelValve, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipStormSensor, and homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor.

Definition at line 227 of file entity.py.

◆ name()

str homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.name ( self )

Return the name of the generic entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.homematicip_cloud.weather.HomematicipHomeWeather, homeassistant.components.homematicip_cloud.weather.HomematicipWeatherSensor, and homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor.

Definition at line 185 of file entity.py.

◆ unique_id()

str homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.unique_id ( self )

Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight.

Definition at line 216 of file entity.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._attr_should_poll = False

staticprivate

Definition at line 78 of file entity.py.

◆ _channel

homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._channel

private

Definition at line 93 of file entity.py.

◆ _device

homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._device

private

Definition at line 91 of file entity.py.

◆ _hap

homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._hap

private

Definition at line 89 of file entity.py.

◆ _is_multi_channel

homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._is_multi_channel

private

Definition at line 94 of file entity.py.

◆ _post

homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity._post

private

Definition at line 92 of file entity.py.

◆ functional_channel

homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.functional_channel

Definition at line 95 of file entity.py.

◆ hmip_device_removed

homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity.hmip_device_removed

Definition at line 97 of file entity.py.

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

core/homeassistant/components/homematicip_cloud/entity.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _async_device_changed()

◆ _async_device_removed()

◆ async_added_to_hass()

◆ async_remove_from_registries()

◆ async_will_remove_from_hass()

◆ available()

◆ device_info()

◆ extra_state_attributes()

◆ get_current_channel()

◆ icon()

◆ name()

◆ unique_id()

Member Data Documentation

◆ _attr_should_poll

◆ _channel

◆ _device

◆ _hap

◆ _is_multi_channel

◆ _post

◆ functional_channel

◆ hmip_device_removed

◆ init()