homeassistant.helpers.entity.Entity Class Reference

Inherits metaclass, homeassistant.helpers.entity.ABCCachedProperties, cached_properties, and CACHED_PROPERTIES_WITH_ATTR_.

Inherited by homeassistant.components.abode.entity.AbodeEntity, homeassistant.components.adguard.entity.AdGuardHomeEntity, homeassistant.components.ads.entity.AdsEntity, homeassistant.components.air_quality.AirQualityEntity, homeassistant.components.airtouch5.entity.Airtouch5Entity, homeassistant.components.alarm_control_panel.AlarmControlPanelEntity, homeassistant.components.alarmdecoder.entity.AlarmDecoderEntity, homeassistant.components.alert.entity.AlertEntity, homeassistant.components.ambient_station.entity.AmbientWeatherEntity, homeassistant.components.androidtv.entity.AndroidTVEntity, homeassistant.components.androidtv_remote.entity.AndroidTVRemoteBaseEntity, homeassistant.components.anova.entity.AnovaEntity, homeassistant.components.apple_tv.entity.AppleTVEntity, homeassistant.components.apsystems.entity.ApSystemsEntity, homeassistant.components.august.entity.AugustEntity, homeassistant.components.axis.entity.AxisEntity, homeassistant.components.baf.entity.BAFEntity, homeassistant.components.balboa.entity.BalboaEntity, homeassistant.components.bang_olufsen.entity.BangOlufsenEntity, homeassistant.components.binary_sensor.BinarySensorEntity, homeassistant.components.blue_current.entity.BlueCurrentEntity, homeassistant.components.bond.entity.BondEntity, homeassistant.components.bosch_shc.entity.SHCBaseEntity, homeassistant.components.broadlink.entity.BroadlinkEntity, homeassistant.components.calendar.CalendarEntity, homeassistant.components.cambridge_audio.entity.CambridgeAudioEntity, homeassistant.components.camera.Camera, homeassistant.components.chacon_dio.entity.ChaconDioEntity, homeassistant.components.climate.ClimateEntity, homeassistant.components.cover.CoverEntity, homeassistant.components.crownstone.entity.CrownstoneEntity, homeassistant.components.date.DateEntity, homeassistant.components.datetime.DateTimeEntity, homeassistant.components.device_tracker.config_entry.BaseTrackerEntity, homeassistant.components.devolo_home_control.entity.DevoloDeviceEntity, homeassistant.components.devolo_home_network.entity.DevoloEntity, homeassistant.components.directv.entity.DIRECTVEntity, homeassistant.components.dlink.entity.DLinkEntity, homeassistant.components.dominos.DominosOrder, homeassistant.components.doorbird.entity.DoorBirdEntity, homeassistant.components.duotecno.entity.DuotecnoEntity, homeassistant.components.ecobee.entity.EcobeeBaseEntity, homeassistant.components.econet.entity.EcoNetEntity, homeassistant.components.ecovacs.entity.EcovacsEntity, homeassistant.components.ecovacs.entity.EcovacsLegacyEntity, homeassistant.components.ecowitt.entity.EcowittEntity, homeassistant.components.efergy.entity.EfergyEntity, homeassistant.components.elkm1.entity.ElkEntity, homeassistant.components.enocean.entity.EnOceanEntity, homeassistant.components.envisalink.entity.EnvisalinkEntity, homeassistant.components.eq3btsmart.entity.Eq3Entity, homeassistant.components.esphome.entity.EsphomeAssistEntity, homeassistant.components.esphome.entity.EsphomeEntity, homeassistant.components.evohome.entity.EvoDevice, homeassistant.components.ezviz.entity.EzvizBaseEntity, homeassistant.components.ezviz.entity.EzvizEntity, homeassistant.components.fibaro.entity.FibaroEntity, homeassistant.components.flo.entity.FloEntity, homeassistant.components.flux_led.entity.FluxBaseEntity, homeassistant.components.freebox.entity.FreeboxHomeEntity, homeassistant.components.fully_kiosk.entity.FullyKioskEntity, homeassistant.components.geniushub.entity.GeniusEntity, homeassistant.components.geo_location.GeolocationEvent, homeassistant.components.google_mail.entity.GoogleMailEntity, homeassistant.components.group.entity.Group, homeassistant.components.group.entity.GroupEntity, homeassistant.components.harmony.entity.HarmonyEntity, homeassistant.components.hdmi_cec.entity.CecEntity, homeassistant.components.hive.entity.HiveEntity, homeassistant.components.hlk_sw16.entity.SW16Entity, homeassistant.components.home_connect.entity.HomeConnectEntity, homeassistant.components.homekit_controller.entity.HomeKitEntity, homeassistant.components.homematic.entity.HMDevice, homeassistant.components.homematic.entity.HMHub, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homeworks.entity.HomeworksEntity, homeassistant.components.huawei_lte.entity.HuaweiLteBaseEntity, homeassistant.components.hue.v2.entity.HueBaseEntity, homeassistant.components.iaqualink.entity.AqualinkEntity, homeassistant.components.ibeacon.entity.IBeaconEntity, homeassistant.components.ihc.entity.IHCEntity, homeassistant.components.image.ImageEntity, homeassistant.components.image_processing.ImageProcessingEntity, homeassistant.components.insteon.entity.InsteonEntity, homeassistant.components.ipma.entity.IPMADevice, homeassistant.components.isy994.entity.ISYAuxControlEntity, homeassistant.components.isy994.entity.ISYEntity, homeassistant.components.jewish_calendar.entity.JewishCalendarEntity, homeassistant.components.kaleidescape.entity.KaleidescapeEntity, homeassistant.components.knx.entity._KnxEntityBase, homeassistant.components.lawn_mower.LawnMowerEntity, homeassistant.components.lcn.entity.LcnEntity, homeassistant.components.linkplay.entity.LinkPlayBaseEntity, homeassistant.components.lock.LockEntity, homeassistant.components.lupusec.entity.LupusecDevice, homeassistant.components.lutron.entity.LutronBaseEntity, homeassistant.components.lutron_caseta.entity.LutronCasetaEntity, homeassistant.components.matter.entity.MatterEntity, homeassistant.components.media_player.MediaPlayerEntity, homeassistant.components.microsoft_face.MicrosoftFaceGroupEntity, homeassistant.components.modbus.entity.BasePlatform, homeassistant.components.motionblinds_ble.entity.MotionblindsBLEEntity, homeassistant.components.motionmount.entity.MotionMountEntity, homeassistant.components.mqtt.entity.MqttAttributesMixin, homeassistant.components.mqtt.entity.MqttAvailabilityMixin, homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin, homeassistant.components.mqtt.entity.MqttEntityDeviceInfo, homeassistant.components.music_assistant.entity.MusicAssistantEntity, homeassistant.components.mysensors.entity.MySensorNodeEntity, homeassistant.components.neato.entity.NeatoEntity, homeassistant.components.netatmo.entity.NetatmoBaseEntity, homeassistant.components.netgear.entity.NetgearRouterEntity, homeassistant.components.nissan_leaf.entity.LeafEntity, homeassistant.components.number.NumberEntity, homeassistant.components.oncue.entity.OncueEntity, homeassistant.components.onewire.entity.OneWireEntity, homeassistant.components.onvif.entity.ONVIFBaseEntity, homeassistant.components.opentherm_gw.entity.OpenThermEntity, homeassistant.components.plant.Plant, homeassistant.components.point.entity.MinutPointEntity, homeassistant.components.private_ble_device.entity.BasePrivateDeviceEntity, homeassistant.components.qwikswitch.entity.QSEntity, homeassistant.components.rachio.entity.RachioDevice, homeassistant.components.raincloud.entity.RainCloudEntity, homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity, homeassistant.components.renault.entity.RenaultEntity, homeassistant.components.rest.entity.RestEntity, homeassistant.components.rflink.entity.RflinkDevice, homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin, homeassistant.components.risco.entity.RiscoLocalZoneEntity, homeassistant.components.roborock.entity.RoborockEntity, homeassistant.components.roomba.entity.IRobotEntity, homeassistant.components.russound_rio.entity.RussoundBaseEntity, homeassistant.components.samsungtv.entity.SamsungTVEntity, homeassistant.components.select.SelectEntity, homeassistant.components.sensor.SensorEntity, homeassistant.components.shelly.entity.ShellyBlockAttributeEntity, homeassistant.components.shelly.entity.ShellyRpcAttributeEntity, homeassistant.components.slack.entity.SlackEntity, homeassistant.components.sleepiq.entity.SleepIQEntity, homeassistant.components.smartthings.entity.SmartThingsEntity, homeassistant.components.soma.entity.SomaEntity, homeassistant.components.sonos.entity.SonosEntity, homeassistant.components.starline.entity.StarlineEntity, homeassistant.components.starlink.entity.StarlinkEntity, homeassistant.components.steamist.entity.SteamistEntity, homeassistant.components.sun.entity.Sun, homeassistant.components.switch_as_x.entity.BaseEntity, homeassistant.components.tado.entity.TadoDeviceEntity, homeassistant.components.tado.entity.TadoHomeEntity, homeassistant.components.tado.entity.TadoZoneEntity, homeassistant.components.tag.TagEntity, homeassistant.components.tami4.entity.Tami4EdgeBaseEntity, homeassistant.components.tasmota.entity.TasmotaEntity, homeassistant.components.tcp.entity.TcpEntity, homeassistant.components.tellduslive.entity.TelldusLiveEntity, homeassistant.components.tellstick.entity.TellstickDevice, homeassistant.components.template.template_entity.TemplateEntity, homeassistant.components.text.TextEntity, homeassistant.components.time.TimeEntity, homeassistant.components.todo.TodoListEntity, homeassistant.components.tractive.entity.TractiveEntity, homeassistant.components.tuya.entity.TuyaEntity, homeassistant.components.twentemilieu.entity.TwenteMilieuEntity, homeassistant.components.unifi.entity.UnifiEntity, homeassistant.components.unifiprotect.entity.BaseProtectEntity, homeassistant.components.upb.entity.UpbEntity, homeassistant.components.vacuum.StateVacuumEntity, homeassistant.components.valve.ValveEntity, homeassistant.components.velbus.entity.VelbusEntity, homeassistant.components.velux.entity.VeluxEntity, homeassistant.components.vesync.entity.VeSyncBaseEntity, homeassistant.components.vicare.entity.ViCareEntity, homeassistant.components.water_heater.WaterHeaterEntity, homeassistant.components.weather.WeatherEntity, homeassistant.components.weatherkit.entity.WeatherKitEntity, homeassistant.components.wiffi.entity.WiffiEntity, homeassistant.components.wilight.entity.WiLightDevice, homeassistant.components.wirelesstag.entity.WirelessTagBaseSensor, homeassistant.components.wiz.entity.WizEntity, homeassistant.components.wmspro.entity.WebControlProGenericEntity, homeassistant.components.xiaomi_aqara.entity.XiaomiDevice, homeassistant.components.xiaomi_miio.entity.XiaomiGatewayDevice, homeassistant.components.xiaomi_miio.entity.XiaomiMiioEntity, homeassistant.components.xs1.entity.XS1DeviceEntity, homeassistant.components.yale.entity.YaleEntity, homeassistant.components.yale_smart_alarm.entity.YaleAlarmEntity, homeassistant.components.yalexs_ble.entity.YALEXSBLEEntity, homeassistant.components.yeelight.entity.YeelightEntity, homeassistant.components.zha.entity.ZHAEntity, homeassistant.components.zwave_js.entity.ZWaveBaseEntity, homeassistant.components.zwave_me.entity.ZWaveMeEntity, homeassistant.helpers.collection.CollectionEntity, homeassistant.helpers.entity.ToggleEntity, homeassistant.helpers.restore_state.RestoreEntity, and homeassistant.helpers.trigger_template_entity.TriggerBaseEntity.

Collaboration diagram for homeassistant.helpers.entity.Entity:

Public Member Functions
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_added_to_hass (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_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (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)
Mapping[str, Any]|None	extra_state_attributes (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)
str|None	icon (self)
str|UndefinedType|None	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	unique_id (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
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Static Public Attributes
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Private Member Functions
tuple[str, dict[str, Any], Mapping[str, Any]|None, str|None, int|None]	__async_calculate_state (self)
None	__async_remove_impl (self, bool force_remove)
CalculatedState	_async_calculate_state (self)
None	_async_device_registry_updated (self, Event[EventDeviceRegistryUpdatedData] event)
None	_async_process_registry_update_or_remove (self, Event[er.EventEntityRegistryUpdatedData] event)
None	_async_registry_updated (self, Event[er.EventEntityRegistryUpdatedData] event)
None	_async_slow_update_warning (self)
None	_async_subscribe_device_updates (self)
None	_async_unsubscribe_device_updates (self)
None	_async_verify_state_writable (self)
None	_async_write_ha_state (self)
None	_async_write_ha_state_from_call_soon_threadsafe (self)
None	_call_on_remove_callbacks (self)
bool	_default_to_device_class_name (self)
str|None	_device_class_name (self)
str|None	_device_class_name_helper (self, dict[str, str] component_translations)
str|None	_friendly_name_internal (self)
str|UndefinedType|None	_name_internal (self, str|None device_class_name, dict[str, str] platform_translations)
str|None	_name_translation_key (self)
str|None	_object_id_device_class_name (self)
None	_report_deprecated_supported_features_values (self, IntFlag replacement)
str	_stringify_state (self, bool available)
str	_substitute_name_placeholders (self, str name)
str	_suggest_report_issue (self)
_T	_T (self, Coroutine[Any, Any, _T] coro)
str|None	_unit_of_measurement_translation_key (self)

Private Attributes
	__capabilities_updated_at
	__capabilities_updated_at_reported
	__combined_unrecorded_attributes
	__remove_future
	_async_update_ha_state_reported
	_context
	_context_set
	_deprecated_supported_features_reported
	_disabled_reported
	_job_types
	_name_translation_placeholders_reported
	_no_platform_reported
	_on_remove
	_removed_from_registry
	_slow_reported
	_state_info
	_unsub_device_updates
	_update_staged
	_verified_state_writable

Static Private Attributes
bool	_async_update_ha_state_reported = False
bool	_deprecated_supported_features_reported = False
bool	_disabled_reported = False
bool	_name_translation_placeholders_reported = False
bool	_no_platform_reported = False
	_platform_state = EntityPlatformState.NOT_ADDED
bool	_slow_reported = False
bool	_update_staged = False
bool	_verified_state_writable = False

Detailed Description

An abstract class for Home Assistant entities.

Definition at line 431 of file entity.py.

Member Function Documentation

__async_calculate_state()

tuple[str, dict[str, Any], Mapping[str, Any] | None, str | None, int | None] homeassistant.helpers.entity.Entity.__async_calculate_state (   self )

private

Calculate state string and attribute mapping.

Returns a tuple:
state - the stringified state
attr - the attribute dictionary
capability_attr - a mapping with capability attributes
original_device_class - the device class which may be overridden
supported_features - the supported features

This method is called when writing the state to avoid the overhead of creating
a dataclass object.

Definition at line 1064 of file entity.py.

__async_remove_impl()

None homeassistant.helpers.entity.Entity.__async_remove_impl (   self, bool  force_remove  )

private

Remove entity from Home Assistant.

Definition at line 1411 of file entity.py.

__init_subclass__()

None homeassistant.helpers.entity.Entity.__init_subclass__	(		cls,
		**Any	kwargs
	)

Initialize an Entity subclass.

Reimplemented in homeassistant.components.number.NumberEntity, and homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 550 of file entity.py.

__repr__()

str homeassistant.helpers.entity.Entity.__repr__

(

self

)

Return the representation.

If the entity is not added to a platform it's not safe to call _stringify_state.

Definition at line 1613 of file entity.py.

_async_calculate_state()

CalculatedState homeassistant.helpers.entity.Entity._async_calculate_state (   self )

private

Calculate state string and attribute mapping.

Definition at line 1059 of file entity.py.

_async_device_registry_updated()

None homeassistant.helpers.entity.Entity._async_device_registry_updated (   self, Event[EventDeviceRegistryUpdatedData]   event  )

private

Handle device registry update.

Definition at line 1573 of file entity.py.

_async_process_registry_update_or_remove()

None homeassistant.helpers.entity.Entity._async_process_registry_update_or_remove (   self, Event[er.EventEntityRegistryUpdatedData]   event  )

private

Handle entity registry update or remove.

Definition at line 1520 of file entity.py.

_async_registry_updated()

None homeassistant.helpers.entity.Entity._async_registry_updated (   self, Event[er.EventEntityRegistryUpdatedData]   event  )

private

Handle entity registry update.

Definition at line 1508 of file entity.py.

_async_slow_update_warning()

None homeassistant.helpers.entity.Entity._async_slow_update_warning (   self )

private

Log a warning if update is taking too long.

Definition at line 1286 of file entity.py.

_async_subscribe_device_updates()

None homeassistant.helpers.entity.Entity._async_subscribe_device_updates (   self )

private

Subscribe to device registry updates.

Definition at line 1589 of file entity.py.

_async_unsubscribe_device_updates()

None homeassistant.helpers.entity.Entity._async_unsubscribe_device_updates (   self )

private

Unsubscribe from device registry updates.

Definition at line 1565 of file entity.py.

_async_verify_state_writable()

None homeassistant.helpers.entity.Entity._async_verify_state_writable (   self )

private

Verify the entity is in a writable state.

Definition at line 981 of file entity.py.

_async_write_ha_state()

None homeassistant.helpers.entity.Entity._async_write_ha_state (   self )

private

Write the state to the state machine.

Reimplemented in homeassistant.components.todo.TodoListEntity.

Definition at line 1124 of file entity.py.

_async_write_ha_state_from_call_soon_threadsafe()

None homeassistant.helpers.entity.Entity._async_write_ha_state_from_call_soon_threadsafe (   self )

private

Write the state to the state machine from the event loop thread.

Definition at line 1010 of file entity.py.

_call_on_remove_callbacks()

None homeassistant.helpers.entity.Entity._call_on_remove_callbacks (   self )

private

Call callbacks registered by async_on_remove.

Definition at line 1362 of file entity.py.

_default_to_device_class_name()

bool homeassistant.helpers.entity.Entity._default_to_device_class_name (   self )

private

Return True if an unnamed entity should be named by its device class.

Reimplemented in homeassistant.components.update.UpdateEntity, homeassistant.components.sensor.SensorEntity, homeassistant.components.number.NumberEntity, homeassistant.components.event.EventEntity, and homeassistant.components.button.ButtonEntity.

Definition at line 635 of file entity.py.

_device_class_name()

str | None homeassistant.helpers.entity.Entity._device_class_name (   self )

private

Return a translated name of the entity based on its device class.

Definition at line 631 of file entity.py.

_device_class_name_helper()

str | None homeassistant.helpers.entity.Entity._device_class_name_helper (   self, dict[str, str]  component_translations  )

private

Return a translated name of the entity based on its device class.

Definition at line 609 of file entity.py.

_friendly_name_internal()

str | None homeassistant.helpers.entity.Entity._friendly_name_internal (   self )

private

Return the friendly name.

If has_entity_name is False, this returns self.name
If has_entity_name is True, this returns device.name + self.name

Definition at line 1040 of file entity.py.

_name_internal()

str | UndefinedType | None homeassistant.helpers.entity.Entity._name_internal (   self, str | None  device_class_name, dict[str, str]  platform_translations  )

private

Return the name of the entity.

Definition at line 689 of file entity.py.

_name_translation_key()

str | None homeassistant.helpers.entity.Entity._name_translation_key (   self )

private

Return translation key for entity name.

Definition at line 640 of file entity.py.

_object_id_device_class_name()

str | None homeassistant.helpers.entity.Entity._object_id_device_class_name (   self )

private

Return a translated name of the entity based on its device class.

Definition at line 624 of file entity.py.

_report_deprecated_supported_features_values()

None homeassistant.helpers.entity.Entity._report_deprecated_supported_features_values (   self, IntFlag   replacement  )

private

Report deprecated supported features values.

Definition at line 1643 of file entity.py.

_stringify_state()

str homeassistant.helpers.entity.Entity._stringify_state (   self, bool  available  )

private

Convert state to string.

Definition at line 1025 of file entity.py.

_substitute_name_placeholders()

str homeassistant.helpers.entity.Entity._substitute_name_placeholders (   self, str  name  )

private

Substitute placeholders in entity name.

Definition at line 666 of file entity.py.

_suggest_report_issue()

str homeassistant.helpers.entity.Entity._suggest_report_issue (   self )

private

Suggest to report an issue.

Definition at line 1633 of file entity.py.

_T()

_T homeassistant.helpers.entity.Entity._T (   self, Coroutine[Any, Any, _T]  coro  )

private

Process request batched.

Definition at line 1622 of file entity.py.

_unit_of_measurement_translation_key()

str | None homeassistant.helpers.entity.Entity._unit_of_measurement_translation_key (   self )

private

Return translation key for unit of measurement.

Definition at line 651 of file entity.py.

add_to_platform_abort()

None homeassistant.helpers.entity.Entity.add_to_platform_abort

(

self

)

Abort adding an entity to a platform.

Reimplemented in homeassistant.components.tasmota.entity.TasmotaDiscoveryUpdate, homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin, and homeassistant.components.energy.sensor.EnergyCostSensor.

Definition at line 1370 of file entity.py.

add_to_platform_finish()

None homeassistant.helpers.entity.Entity.add_to_platform_finish

(

self

)

Finish adding an entity to a platform.

Reimplemented in homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin.

Definition at line 1380 of file entity.py.

add_to_platform_start()

None homeassistant.helpers.entity.Entity.add_to_platform_start	(		self,
		HomeAssistant	hass,
		EntityPlatform	platform,
		asyncio.Semaphore | None	parallel_updates
	)

Start adding an entity to a platform.

Reimplemented in homeassistant.components.sensor.SensorEntity, homeassistant.components.fan.FanEntity, homeassistant.components.device_tracker.config_entry.ScannerEntity, homeassistant.components.climate.ClimateEntity, and homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 1344 of file entity.py.

assumed_state()

bool homeassistant.helpers.entity.Entity.assumed_state

(

self

)

Return True if unable to access real state of the entity.

Reimplemented in homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.tellstick.cover.TellstickCover, homeassistant.components.tellduslive.entity.TelldusLiveEntity, homeassistant.components.switchbot.switch.SwitchBotSwitch, homeassistant.components.snooz.fan.SnoozFan, homeassistant.components.rflink.entity.RflinkDevice, homeassistant.components.remote_rpi_gpio.switch.RemoteRPiGPIOSwitch, homeassistant.components.raspyrfm.switch.RaspyRFMSwitch, homeassistant.components.pilight.entity.PilightBaseDevice, homeassistant.components.oralb.sensor.OralBBluetoothSensorEntity, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.leaone.sensor.LeaoneBluetoothSensorEntity, homeassistant.components.iaqualink.entity.AqualinkEntity, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.huawei_lte.binary_sensor.HuaweiLteSmsStorageFullBinarySensor, homeassistant.components.huawei_lte.binary_sensor.HuaweiLteBaseWifiStatusBinarySensor, homeassistant.components.huawei_lte.binary_sensor.HuaweiLteMobileConnectionBinarySensor, homeassistant.components.group.entity.Group, homeassistant.components.command_line.switch.CommandSwitch, and homeassistant.components.balboa.entity.BalboaEntity.

Definition at line 843 of file entity.py.

async_added_to_hass()

None homeassistant.helpers.entity.Entity.async_added_to_hass

(

self

)

Run when entity about to be added to hass.

To be extended by integrations.

Reimplemented in homeassistant.components.zwave_me.entity.ZWaveMeEntity, homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate, homeassistant.components.zwave_js.sensor.ZWaveStatisticsSensor, homeassistant.components.zwave_js.sensor.ZWaveControllerStatusSensor, homeassistant.components.zwave_js.sensor.ZWaveNodeStatusSensor, homeassistant.components.zwave_js.event.ZwaveEventEntity, homeassistant.components.zwave_js.entity.ZWaveBaseEntity, homeassistant.components.zhong_hong.climate.ZhongHongClimate, homeassistant.components.zha.entity.ZHAEntity, homeassistant.components.zerproc.light.ZerprocLight, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.yeelight.binary_sensor.YeelightNightlightModeSensor, homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.yalexs_ble.entity.YALEXSBLEEntity, homeassistant.components.yale.sensor.YaleOperatorSensor, homeassistant.components.yale.lock.YaleLock, homeassistant.components.yale.entity.YaleEntity, homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.xiaomi_ble.event.XiaomiEventEntity, homeassistant.components.xiaomi_aqara.entity.XiaomiDevice, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiCube, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiButton, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiVibration, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiSmokeSensor, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiWaterLeakSensor, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiDoorSensor, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiMotionSensor, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiNatgasSensor, homeassistant.components.wyoming.switch.WyomingSatelliteMuteSwitch, homeassistant.components.wyoming.select.WyomingSatelliteNoiseSuppressionLevelSelect, homeassistant.components.wyoming.number.WyomingSatelliteVolumeMultiplierNumber, homeassistant.components.wyoming.number.WyomingSatelliteAutoGainNumber, homeassistant.components.wyoming.binary_sensor.WyomingSatelliteAssistInProgress, homeassistant.components.workday.binary_sensor.IsWorkdaySensor, homeassistant.components.wled.update.WLEDUpdateEntity, homeassistant.components.wirelesstag.sensor.WirelessTagSensor, homeassistant.components.wirelesstag.binary_sensor.WirelessTagBinarySensor, homeassistant.components.wilight.entity.WiLightDevice, homeassistant.components.wiffi.entity.WiffiEntity, homeassistant.components.whirlpool.sensor.WasherDryerTimeClass, homeassistant.components.whirlpool.sensor.WasherDryerClass, homeassistant.components.whirlpool.climate.AirConEntity, homeassistant.components.websocket_api.sensor.APICount, homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity, homeassistant.components.weatherflow.sensor.WeatherFlowSensorEntity, homeassistant.components.weather.CoordinatorWeatherEntity, homeassistant.components.waze_travel_time.sensor.WazeTravelTime, homeassistant.components.waterfurnace.sensor.WaterFurnaceSensor, homeassistant.components.w800rf32.binary_sensor.W800rf32BinarySensor, homeassistant.components.voip.switch.VoIPCallAllowedSwitch, homeassistant.components.voip.binary_sensor.VoIPCallInProgress, homeassistant.components.vizio.media_player.VizioDevice, homeassistant.components.verisure.camera.VerisureSmartcam, homeassistant.components.verisure.alarm_control_panel.VerisureAlarm, homeassistant.components.velux.entity.VeluxEntity, homeassistant.components.velbus.entity.VelbusEntity, homeassistant.components.utility_meter.sensor.UtilityMeterSensor, homeassistant.components.utility_meter.select.TariffSelect, homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent, homeassistant.components.upnp.sensor.UpnpSensor, homeassistant.components.upnp.binary_sensor.UpnpStatusBinarySensor, homeassistant.components.upb.entity.UpbEntity, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.unifiprotect.switch.ProtectPrivacyModeSwitch, homeassistant.components.unifiprotect.entity.BaseProtectEntity, homeassistant.components.unifi.switch.UnifiSwitchEntity, homeassistant.components.unifi.sensor.UnifiSensorEntity, homeassistant.components.unifi.entity.UnifiEntity, homeassistant.components.unifi.device_tracker.UnifiScannerEntity, homeassistant.components.twinkly.light.TwinklyLight, homeassistant.components.twentemilieu.calendar.TwenteMilieuCalendar, homeassistant.components.tuya.entity.TuyaEntity, homeassistant.components.tuya.climate.TuyaClimateEntity, homeassistant.components.trend.binary_sensor.SensorTrend, homeassistant.components.tractive.entity.TractiveEntity, homeassistant.components.tractive.device_tracker.TractiveDeviceTracker, homeassistant.components.traccar.device_tracker.TraccarEntity, homeassistant.components.tplink_omada.switch.OmadaDevicePortSwitchEntity, homeassistant.components.tplink_omada.binary_sensor.OmadaGatewayPortBinarySensor, homeassistant.components.todoist.todo.TodoistTodoListEntity, homeassistant.components.tod.binary_sensor.TodSensor, homeassistant.components.timer.Timer, homeassistant.components.time_date.sensor.TimeDateSensor, homeassistant.components.threshold.binary_sensor.ThresholdSensor, homeassistant.components.tesla_fleet.sensor.TeslaFleetVehicleSensorEntity, homeassistant.components.tesla_fleet.device_tracker.TeslaFleetDeviceTrackerEntity, homeassistant.components.template.weather.TriggerWeatherEntity, homeassistant.components.template.template_entity.TemplateEntity, homeassistant.components.template.switch.SwitchTemplate, homeassistant.components.template.sensor.TriggerSensorEntity, homeassistant.components.template.binary_sensor.TriggerBinarySensorEntity, homeassistant.components.template.binary_sensor.BinarySensorTemplate, homeassistant.components.template.alarm_control_panel.AlarmControlPanelTemplate, homeassistant.components.tellstick.entity.TellstickDevice, homeassistant.components.tellduslive.entity.TelldusLiveEntity, homeassistant.components.technove.binary_sensor.TechnoVEBinarySensorEntity, homeassistant.components.tasmota.sensor.TasmotaSensor, homeassistant.components.tasmota.fan.TasmotaFan, homeassistant.components.tasmota.entity.TasmotaDiscoveryUpdate, homeassistant.components.tasmota.entity.TasmotaAvailability, homeassistant.components.tasmota.entity.TasmotaOnOffEntity, homeassistant.components.tasmota.entity.TasmotaEntity, homeassistant.components.tasmota.cover.TasmotaCover, homeassistant.components.tasmota.binary_sensor.TasmotaBinarySensor, homeassistant.components.tag.TagEntity, homeassistant.components.tado.water_heater.TadoWaterHeater, homeassistant.components.tado.sensor.TadoZoneSensor, homeassistant.components.tado.sensor.TadoHomeSensor, homeassistant.components.tado.climate.TadoClimate, homeassistant.components.tado.binary_sensor.TadoZoneBinarySensor, homeassistant.components.tado.binary_sensor.TadoDeviceBinarySensor, homeassistant.components.systemmonitor.sensor.SystemMonitorSensor, homeassistant.components.systemmonitor.binary_sensor.SystemMonitorSensor, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.syncthing.sensor.FolderSensor, homeassistant.components.switchbot.switch.SwitchBotSwitch, homeassistant.components.switchbot.cover.SwitchBotBlindTiltEntity, homeassistant.components.switchbot.cover.SwitchBotCurtainEntity, homeassistant.components.switch_as_x.entity.BaseEntity, homeassistant.components.switch.light.LightSwitch, homeassistant.components.sun.sensor.SunSensor, homeassistant.components.statistics.sensor.StatisticsSensor, homeassistant.components.starline.entity.StarlineEntity, homeassistant.components.sql.sensor.SQLSensor, homeassistant.components.spotify.media_player.SpotifyMediaPlayer, homeassistant.components.spc.binary_sensor.SpcBinarySensor, homeassistant.components.spc.alarm_control_panel.SpcAlarm, homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer, homeassistant.components.sonos.switch.SonosAlarmEntity, homeassistant.components.sonos.sensor.SonosFavoritesEntity, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.sonos.entity.SonosEntity, homeassistant.components.songpal.media_player.SongpalEntity, homeassistant.components.somfy_mylink.cover.SomfyShade, homeassistant.components.snooz.fan.SnoozFan, homeassistant.components.snmp.sensor.SnmpSensor, homeassistant.components.snapcast.media_player.SnapcastClientDevice, homeassistant.components.snapcast.media_player.SnapcastGroupDevice, homeassistant.components.smlight.switch.SmSwitch, homeassistant.components.smlight.binary_sensor.SmInternetSensorEntity, homeassistant.components.smartthings.entity.SmartThingsEntity, homeassistant.components.smart_meter_texas.sensor.SmartMeterTexasSensor, homeassistant.components.sma.sensor.SMAsensor, homeassistant.components.slimproto.media_player.SlimProtoPlayer, homeassistant.components.sisyphus.media_player.SisyphusPlayer, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.sia.entity.SIABaseEntity, homeassistant.components.shopping_list.todo.ShoppingTodoListEntity, homeassistant.components.shelly.update.RpcSleepingUpdateEntity, homeassistant.components.shelly.update.RpcUpdateEntity, homeassistant.components.shelly.switch.BlockSleepingMotionSwitch, homeassistant.components.shelly.sensor.RpcSleepingSensor, homeassistant.components.shelly.sensor.BlockSleepingSensor, homeassistant.components.shelly.number.BlockSleepingNumber, homeassistant.components.shelly.event.ShellyRpcEvent, homeassistant.components.shelly.event.ShellyBlockEvent, homeassistant.components.shelly.climate.BlockSleepingClimate, homeassistant.components.shelly.binary_sensor.RpcSleepingBinarySensor, homeassistant.components.shelly.binary_sensor.BlockSleepingBinarySensor, homeassistant.components.serial.sensor.SerialSensor, homeassistant.components.script.ScriptEntity, homeassistant.components.script.UnavailableScriptEntity, homeassistant.components.screenlogic.climate.ScreenLogicClimate, homeassistant.components.scrape.sensor.ScrapeSensor, homeassistant.components.schedule.Schedule, homeassistant.components.satel_integra.switch.SatelIntegraSwitch, homeassistant.components.satel_integra.binary_sensor.SatelIntegraBinarySensor, homeassistant.components.satel_integra.alarm_control_panel.SatelIntegraAlarmPanel, homeassistant.components.samsungtv.media_player.SamsungTVDevice, homeassistant.components.samsungtv.entity.SamsungTVEntity, homeassistant.components.russound_rio.entity.RussoundBaseEntity, homeassistant.components.roon.media_player.RoonDevice, homeassistant.components.roon.event.RoonEventEntity, homeassistant.components.roomba.entity.IRobotEntity, homeassistant.components.roborock.entity.RoborockCoordinatedEntityV1, homeassistant.components.risco.sensor.RiscoSensor, homeassistant.components.risco.entity.RiscoLocalZoneEntity, homeassistant.components.risco.binary_sensor.RiscoSystemBinarySensor, homeassistant.components.risco.alarm_control_panel.RiscoLocalAlarm, homeassistant.components.rfxtrx.switch.RfxtrxSwitch, homeassistant.components.rfxtrx.sensor.RfxtrxSensor, homeassistant.components.rfxtrx.light.RfxtrxLight, homeassistant.components.rfxtrx.entity.RfxtrxEntity, homeassistant.components.rfxtrx.cover.RfxtrxCover, homeassistant.components.rfxtrx.binary_sensor.RfxtrxBinarySensor, homeassistant.components.rflink.sensor.RflinkSensor, homeassistant.components.rflink.light.DimmableRflinkLight, homeassistant.components.rflink.entity.SwitchableRflinkDevice, homeassistant.components.rflink.entity.RflinkDevice, homeassistant.components.rflink.cover.RflinkCover, homeassistant.components.rflink.binary_sensor.RflinkBinarySensor, homeassistant.components.rest.switch.RestSwitch, homeassistant.components.rest.entity.RestEntity, homeassistant.components.repetier.sensor.RepetierSensor, homeassistant.components.reolink.update.ReolinkUpdateBaseEntity, homeassistant.components.reolink.binary_sensor.ReolinkPushBinarySensorEntity, homeassistant.components.remote_rpi_gpio.binary_sensor.RemoteRPiGPIOBinarySensor, homeassistant.components.rainmachine.sensor.TimeRemainingSensor, homeassistant.components.raincloud.entity.RainCloudEntity, homeassistant.components.rainbird.calendar.RainBirdCalendarEntity, homeassistant.components.rachio.switch.RachioSchedule, homeassistant.components.rachio.switch.RachioZone, homeassistant.components.rachio.switch.RachioRainDelay, homeassistant.components.rachio.switch.RachioStandbySwitch, homeassistant.components.rachio.binary_sensor.RachioRainSensor, homeassistant.components.rachio.binary_sensor.RachioControllerOnlineBinarySensor, homeassistant.components.qwikswitch.entity.QSEntity, homeassistant.components.qld_bushfire.geo_location.QldBushfireLocationEvent, homeassistant.components.pvpc_hourly_pricing.sensor.ElecPriceSensor, homeassistant.components.pushbullet.sensor.PushBulletNotificationSensor, homeassistant.components.push.camera.PushCamera, homeassistant.components.ps4.media_player.PS4Device, homeassistant.components.proximity.sensor.ProximityTrackedEntitySensor, homeassistant.components.private_ble_device.entity.BasePrivateDeviceEntity, homeassistant.components.point.entity.MinutPointEntity, homeassistant.components.point.binary_sensor.MinutPointBinarySensor, homeassistant.components.point.alarm_control_panel.MinutPointAlarmControl, homeassistant.components.plum_lightpad.light.GlowRing, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.plex.sensor.PlexLibrarySectionSensor, homeassistant.components.plex.sensor.PlexSensor, homeassistant.components.plex.media_player.PlexMediaPlayer, homeassistant.components.plant.Plant, homeassistant.components.pilight.entity.PilightBaseDevice, homeassistant.components.philips_js.remote.PhilipsTVRemote, homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer, homeassistant.components.person.Person, homeassistant.components.owntracks.device_tracker.OwnTracksEntity, homeassistant.components.ourgroceries.todo.OurGroceriesTodoListEntity, homeassistant.components.otp.sensor.TOTPSensor, homeassistant.components.openweathermap.sensor.AbstractOpenWeatherMapSensor, homeassistant.components.opentherm_gw.entity.OpenThermStatusEntity, homeassistant.components.opentherm_gw.climate.OpenThermClimate, homeassistant.components.openai_conversation.conversation.OpenAIConversationEntity, homeassistant.components.onvif.sensor.ONVIFSensor, homeassistant.components.onvif.binary_sensor.ONVIFBinarySensor, homeassistant.components.onkyo.media_player.OnkyoMediaPlayer, homeassistant.components.ollama.conversation.OllamaConversationEntity, homeassistant.components.nws.weather.NWSWeather, homeassistant.components.numato.binary_sensor.NumatoGpioBinarySensor, homeassistant.components.nuheat.climate.NuHeatThermostat, homeassistant.components.nsw_rural_fire_service_feed.geo_location.NswRuralFireServiceLocationEvent, homeassistant.components.nobo_hub.sensor.NoboTemperatureSensor, homeassistant.components.nobo_hub.select.NoboProfileSelector, homeassistant.components.nobo_hub.select.NoboGlobalSelector, homeassistant.components.nobo_hub.climate.NoboZone, homeassistant.components.nissan_leaf.entity.LeafEntity, homeassistant.components.nice_go.event.NiceGOEventEntity, homeassistant.components.nextbus.sensor.NextBusDepartureSensor, homeassistant.components.netgear.switch.NetgearRouterSwitchEntity, homeassistant.components.netgear.sensor.NetgearRouterSensorEntity, homeassistant.components.netatmo.sensor.NetatmoPublicSensor, homeassistant.components.netatmo.select.NetatmoScheduleSelect, homeassistant.components.netatmo.light.NetatmoCameraLight, homeassistant.components.netatmo.entity.NetatmoRoomEntity, homeassistant.components.netatmo.entity.NetatmoBaseEntity, homeassistant.components.netatmo.climate.NetatmoThermostat, homeassistant.components.netatmo.camera.NetatmoCamera, homeassistant.components.nest.sensor.SensorBase, homeassistant.components.nest.event.NestTraitEventEntity, homeassistant.components.nest.climate.ThermostatEntity, homeassistant.components.nest.camera.NestCameraBaseEntity, homeassistant.components.ness_alarm.binary_sensor.NessZoneBinarySensor, homeassistant.components.ness_alarm.alarm_control_panel.NessAlarmPanel, homeassistant.components.nanoleaf.event.NanoleafGestureEvent, homeassistant.components.mysensors.entity.MySensorsChildEntity, homeassistant.components.mysensors.entity.MySensorNodeEntity, homeassistant.components.music_assistant.media_player.MusicAssistantPlayer, homeassistant.components.music_assistant.entity.MusicAssistantEntity, homeassistant.components.mqtt_room.sensor.MQTTRoomSensor, homeassistant.components.mqtt.entity.MqttEntity, homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin, homeassistant.components.mqtt.entity.MqttAvailabilityMixin, homeassistant.components.mqtt.entity.MqttAttributesMixin, homeassistant.components.motionmount.entity.MotionMountEntity, homeassistant.components.motionblinds_ble.sensor.BatterySensor, homeassistant.components.motionblinds_ble.sensor.MotionblindsBLESensorEntity, homeassistant.components.motionblinds_ble.select.SpeedSelect, homeassistant.components.motionblinds_ble.cover.MotionblindsBLECoverEntity, homeassistant.components.motionblinds_ble.button.MotionblindsBLEButtonEntity, homeassistant.components.mold_indicator.sensor.MoldIndicator, homeassistant.components.modem_callerid.sensor.ModemCalleridSensor, homeassistant.components.modbus.sensor.SlaveSensor, homeassistant.components.modbus.sensor.ModbusRegisterSensor, homeassistant.components.modbus.entity.BaseSwitch, homeassistant.components.modbus.cover.ModbusCover, homeassistant.components.modbus.climate.ModbusThermostat, homeassistant.components.modbus.binary_sensor.SlaveSensor, homeassistant.components.modbus.binary_sensor.ModbusBinarySensor, homeassistant.components.mobile_app.entity.MobileAppEntity, homeassistant.components.mobile_app.device_tracker.MobileAppEntity, homeassistant.components.min_max.sensor.MinMaxSensor, homeassistant.components.mediaroom.media_player.MediaroomDevice, homeassistant.components.matter.update.MatterUpdate, homeassistant.components.matter.entity.MatterEntity, homeassistant.components.manual_mqtt.alarm_control_panel.ManualMQTTAlarm, homeassistant.components.manual.alarm_control_panel.ManualAlarm, homeassistant.components.lutron_caseta.entity.LutronCasetaEntity, homeassistant.components.lutron_caseta.binary_sensor.LutronOccupancySensor, homeassistant.components.lutron.event.LutronEventEntity, homeassistant.components.lutron.entity.LutronBaseEntity, homeassistant.components.lookin.media_player.LookinMedia, homeassistant.components.lookin.climate.ConditionerEntity, homeassistant.components.livisi.switch.LivisiSwitch, homeassistant.components.livisi.climate.LivisiClimate, homeassistant.components.livisi.binary_sensor.LivisiWindowDoorSensor, homeassistant.components.livisi.binary_sensor.LivisiBinarySensor, homeassistant.components.litejet.switch.LiteJetSwitch, homeassistant.components.litejet.scene.LiteJetScene, homeassistant.components.litejet.light.LiteJetLight, homeassistant.components.limitlessled.light.LimitlessLEDGroup, homeassistant.components.lifx.sensor.LIFXRssiSensor, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.lg_soundbar.media_player.LGDevice, homeassistant.components.lg_netcast.media_player.LgTVDevice, homeassistant.components.led_ble.light.LEDBLEEntity, homeassistant.components.lcn.switch.LcnKeyLockSwitch, homeassistant.components.lcn.switch.LcnRegulatorLockSwitch, homeassistant.components.lcn.switch.LcnRelaySwitch, homeassistant.components.lcn.switch.LcnOutputSwitch, homeassistant.components.lcn.sensor.LcnLedLogicSensor, homeassistant.components.lcn.sensor.LcnVariableSensor, homeassistant.components.lcn.light.LcnRelayLight, homeassistant.components.lcn.light.LcnOutputLight, homeassistant.components.lcn.entity.LcnEntity, homeassistant.components.lcn.cover.LcnRelayCover, homeassistant.components.lcn.cover.LcnOutputsCover, homeassistant.components.lcn.climate.LcnClimate, homeassistant.components.lcn.binary_sensor.LcnLockKeysSensor, homeassistant.components.lcn.binary_sensor.LcnBinarySensor, homeassistant.components.lcn.binary_sensor.LcnRegulatorLockSensor, homeassistant.components.launch_library.sensor.LaunchLibrarySensor, homeassistant.components.kulersky.light.KulerskyLight, homeassistant.components.kraken.sensor.KrakenSensor, homeassistant.components.kostal_plenticore.switch.PlenticoreDataSwitch, homeassistant.components.kostal_plenticore.sensor.PlenticoreDataSensor, homeassistant.components.kostal_plenticore.select.PlenticoreDataSelect, homeassistant.components.kostal_plenticore.number.PlenticoreDataNumber, homeassistant.components.konnected.switch.KonnectedSwitch, homeassistant.components.konnected.sensor.KonnectedSensor, homeassistant.components.konnected.binary_sensor.KonnectedBinarySensor, homeassistant.components.knx.time.KNXTimeEntity, homeassistant.components.knx.text.KNXText, homeassistant.components.knx.switch._KnxSwitch, homeassistant.components.knx.sensor.KNXSystemSensor, homeassistant.components.knx.select.KNXSelect, homeassistant.components.knx.number.KNXNumber, homeassistant.components.knx.entity._KnxEntityBase, homeassistant.components.knx.datetime.KNXDateTimeEntity, homeassistant.components.knx.date.KNXDateEntity, homeassistant.components.knx.climate.KNXClimate, homeassistant.components.knx.binary_sensor.KNXBinarySensor, homeassistant.components.knocki.event.KnockiTrigger, homeassistant.components.kitchen_sink.weather.DemoWeather, homeassistant.components.kitchen_sink.image.DemoImage, homeassistant.components.kef.media_player.KefMediaPlayer, homeassistant.components.keenetic_ndms2.binary_sensor.RouterOnlineBinarySensor, homeassistant.components.keba.sensor.KebaSensor, homeassistant.components.keba.lock.KebaLock, homeassistant.components.keba.binary_sensor.KebaBinarySensor, homeassistant.components.kaleidescape.entity.KaleidescapeEntity, homeassistant.components.kaiterra.sensor.KaiterraSensor, homeassistant.components.kaiterra.air_quality.KaiterraAirQuality, homeassistant.components.jewish_calendar.binary_sensor.JewishCalendarBinarySensor, homeassistant.components.izone.climate.ZoneDevice, homeassistant.components.izone.climate.ControllerDevice, homeassistant.components.isy994.switch.ISYEnableSwitchEntity, homeassistant.components.isy994.sensor.ISYAuxSensorEntity, homeassistant.components.isy994.select.ISYBacklightSelectEntity, homeassistant.components.isy994.number.ISYBacklightNumberEntity, homeassistant.components.isy994.number.ISYVariableNumberEntity, homeassistant.components.isy994.light.ISYLightEntity, homeassistant.components.isy994.entity.ISYAuxControlEntity, homeassistant.components.isy994.entity.ISYEntity, homeassistant.components.isy994.button.ISYNodeButtonEntity, homeassistant.components.isy994.binary_sensor.ISYBinarySensorHeartbeat, homeassistant.components.isy994.binary_sensor.ISYInsteonBinarySensorEntity, homeassistant.components.ista_ecotrend.sensor.IstaSensor, homeassistant.components.iron_os.update.IronOSUpdate, homeassistant.components.iperf3.sensor.Iperf3Sensor, homeassistant.components.ios.sensor.IOSSensor, homeassistant.components.intesishome.climate.IntesisAC, homeassistant.components.integration.sensor.IntegrationSensor, homeassistant.components.insteon.entity.InsteonEntity, homeassistant.components.insteon.climate.InsteonClimateEntity, homeassistant.components.input_text.InputText, homeassistant.components.input_select.InputSelect, homeassistant.components.input_number.InputNumber, homeassistant.components.input_datetime.InputDatetime, homeassistant.components.input_boolean.InputBoolean, homeassistant.components.ihc.entity.IHCEntity, homeassistant.components.ign_sismologia.geo_location.IgnSismologiaLocationEvent, homeassistant.components.idasen_desk.sensor.IdasenDeskSensor, homeassistant.components.icloud.sensor.IcloudDeviceBatterySensor, homeassistant.components.ibeacon.entity.IBeaconEntity, homeassistant.components.iaqualink.entity.AqualinkEntity, homeassistant.components.hyperion.switch.HyperionComponentSwitch, homeassistant.components.hyperion.sensor.HyperionSensor, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hyperion.camera.HyperionCamera, homeassistant.components.husqvarna_automower.binary_sensor.AutomowerBinarySensorEntity, homeassistant.components.hunterdouglas_powerview.sensor.PowerViewSensor, homeassistant.components.hunterdouglas_powerview.number.PowerViewNumber, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.hue.v2.group.GroupedHueLight, homeassistant.components.hue.v2.entity.HueBaseEntity, homeassistant.components.hue.scene.HueSceneEntityBase, homeassistant.components.huawei_lte.switch.HuaweiLteBaseSwitch, homeassistant.components.huawei_lte.sensor.HuaweiLteSensor, homeassistant.components.huawei_lte.select.HuaweiLteSelectEntity, homeassistant.components.huawei_lte.entity.HuaweiLteBaseEntity, homeassistant.components.huawei_lte.binary_sensor.HuaweiLteBaseBinarySensor, homeassistant.components.homeworks.light.HomeworksLight, homeassistant.components.homeworks.binary_sensor.HomeworksBinarySensor, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity, homeassistant.components.homematic.entity.HMDevice, homeassistant.components.homekit_controller.event.HomeKitEventEntity, homeassistant.components.homekit_controller.entity.HomeKitEntity, homeassistant.components.home_connect.switch.HomeConnectPowerSwitch, homeassistant.components.home_connect.entity.HomeConnectEntity, homeassistant.components.home_connect.binary_sensor.HomeConnectDoorBinarySensor, homeassistant.components.holiday.calendar.HolidayCalendarEntity, homeassistant.components.hlk_sw16.entity.SW16Entity, homeassistant.components.hive.entity.HiveEntity, homeassistant.components.history_stats.sensor.HistoryStatsSensorBase, homeassistant.components.here_travel_time.sensor.HERETravelTimeSensor, homeassistant.components.heos.media_player.HeosMediaPlayer, homeassistant.components.hdmi_cec.entity.CecEntity, homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedSensor, homeassistant.components.harmony.select.HarmonyActivitySelect, homeassistant.components.harmony.remote.HarmonyRemote, homeassistant.components.habitica.sensor.HabitipyTaskSensor, homeassistant.components.group.media_player.MediaPlayerGroup, homeassistant.components.group.event.EventGroup, homeassistant.components.group.entity.Group, homeassistant.components.group.entity.GroupEntity, homeassistant.components.greeneye_monitor.sensor.GEMSensor, homeassistant.components.gpslogger.device_tracker.GPSLoggerEntity, homeassistant.components.govee_ble.event.GoveeBluetoothEventEntity, homeassistant.components.google_travel_time.sensor.GoogleTravelTimeSensor, homeassistant.components.google_generative_ai_conversation.conversation.GoogleGenerativeAIConversationEntity, homeassistant.components.google.calendar.GoogleCalendarEntity, homeassistant.components.goodwe.sensor.InverterSensor, homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor, homeassistant.components.geonetnz_quakes.sensor.GeonetnzQuakesSensor, homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent, homeassistant.components.geofency.device_tracker.GeofencyEntity, homeassistant.components.geo_json_events.geo_location.GeoJsonLocationEvent, homeassistant.components.geniushub.entity.GeniusEntity, homeassistant.components.generic_thermostat.climate.GenericThermostat, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.gdacs.sensor.GdacsSensor, homeassistant.components.gdacs.geo_location.GdacsEvent, homeassistant.components.fully_kiosk.switch.FullySwitchEntity, homeassistant.components.fritzbox_callmonitor.sensor.FritzBoxCallSensor, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.fritz.image.FritzGuestWifiQRImage, homeassistant.components.freedompro.switch.Device, homeassistant.components.freedompro.sensor.Device, homeassistant.components.freedompro.lock.Device, homeassistant.components.freedompro.light.Device, homeassistant.components.freedompro.fan.FreedomproFan, homeassistant.components.freedompro.cover.Device, homeassistant.components.freedompro.climate.Device, homeassistant.components.freedompro.binary_sensor.Device, homeassistant.components.freebox.sensor.FreeboxSensor, homeassistant.components.freebox.entity.FreeboxHomeEntity, homeassistant.components.freebox.binary_sensor.FreeboxRaidDegradedSensor, homeassistant.components.foscam.camera.HassFoscamCamera, homeassistant.components.forked_daapd.media_player.ForkedDaapdMaster, homeassistant.components.forked_daapd.media_player.ForkedDaapdZone, homeassistant.components.folder_watcher.event.FolderWatcherEventEntity, homeassistant.components.flux_led.number.FluxConfigNumber, homeassistant.components.flux.switch.FluxSwitch, homeassistant.components.flo.switch.FloSwitch, homeassistant.components.flo.entity.FloEntity, homeassistant.components.fitbit.sensor.FitbitBatteryLevelSensor, homeassistant.components.fitbit.sensor.FitbitBatterySensor, homeassistant.components.fitbit.sensor.FitbitSensor, homeassistant.components.firmata.switch.FirmataSwitch, homeassistant.components.firmata.sensor.FirmataSensor, homeassistant.components.firmata.light.FirmataLight, homeassistant.components.firmata.binary_sensor.FirmataBinarySensor, homeassistant.components.fireservicerota.switch.ResponseSwitch, homeassistant.components.fireservicerota.sensor.IncidentsSensor, homeassistant.components.filter.sensor.SensorFilter, homeassistant.components.fibaro.event.FibaroEventEntity, homeassistant.components.fibaro.entity.FibaroEntity, homeassistant.components.fibaro.climate.FibaroThermostat, homeassistant.components.feedreader.event.FeedReaderEvent, homeassistant.components.ezviz.siren.EzvizSirenEntity, homeassistant.components.ezviz.number.EzvizNumber, homeassistant.components.ezviz.alarm_control_panel.EzvizAlarm, homeassistant.components.evohome.entity.EvoDevice, homeassistant.components.eufylife_ble.sensor.EufyLifeHeartRateSensorEntity, homeassistant.components.eufylife_ble.sensor.EufyLifeWeightSensorEntity, homeassistant.components.eufylife_ble.sensor.EufyLifeSensorEntity, homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity, homeassistant.components.esphome.select.EsphomeAssistSatelliteWakeWordSelect, homeassistant.components.esphome.entity.EsphomeAssistEntity, homeassistant.components.esphome.entity.EsphomeEntity, homeassistant.components.esphome.binary_sensor.EsphomeAssistInProgressBinarySensor, homeassistant.components.esphome.assist_satellite.EsphomeAssistSatellite, homeassistant.components.escea.climate.ControllerEntity, homeassistant.components.eq3btsmart.entity.Eq3Entity, homeassistant.components.envisalink.switch.EnvisalinkSwitch, homeassistant.components.envisalink.sensor.EnvisalinkSensor, homeassistant.components.envisalink.binary_sensor.EnvisalinkBinarySensor, homeassistant.components.envisalink.alarm_control_panel.EnvisalinkAlarm, homeassistant.components.enocean.sensor.EnOceanSensor, homeassistant.components.enocean.entity.EnOceanEntity, homeassistant.components.energy.sensor.EnergyCostSensor, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.elkm1.entity.ElkEntity, homeassistant.components.elkm1.alarm_control_panel.ElkArea, homeassistant.components.egardia.alarm_control_panel.EgardiaAlarm, homeassistant.components.edl21.sensor.EDL21Entity, homeassistant.components.ecowitt.entity.EcowittEntity, homeassistant.components.ecovacs.vacuum.EcovacsVacuum, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, homeassistant.components.ecovacs.switch.EcovacsSwitchEntity, homeassistant.components.ecovacs.sensor.EcovacsLegacyLifespanSensor, homeassistant.components.ecovacs.sensor.EcovacsErrorSensor, homeassistant.components.ecovacs.sensor.EcovacsLifespanSensor, homeassistant.components.ecovacs.sensor.EcovacsSensor, homeassistant.components.ecovacs.select.EcovacsSelectEntity, homeassistant.components.ecovacs.number.EcovacsNumberEntity, homeassistant.components.ecovacs.lawn_mower.EcovacsMower, homeassistant.components.ecovacs.image.EcovacsMap, homeassistant.components.ecovacs.event.EcovacsLastJobEventEntity, homeassistant.components.ecovacs.entity.EcovacsEntity, homeassistant.components.ecovacs.binary_sensor.EcovacsBinarySensor, homeassistant.components.econet.entity.EcoNetEntity, homeassistant.components.dynalite.entity.DynaliteBase, homeassistant.components.duotecno.entity.DuotecnoEntity, homeassistant.components.dsmr_reader.sensor.DSMRSensor, homeassistant.components.doorbird.event.DoorBirdEventEntity, homeassistant.components.doorbird.camera.DoorBirdCamera, homeassistant.components.devolo_home_control.entity.DevoloDeviceEntity, homeassistant.components.device_tracker.legacy.Device, homeassistant.components.derivative.sensor.DerivativeSensor, homeassistant.components.denonavr.media_player.DenonDevice, homeassistant.components.demo.weather.DemoWeather, homeassistant.components.demo.sensor.DemoSumSensor, homeassistant.components.demo.event.DemoEvent, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.counter.Counter, homeassistant.components.compensation.sensor.CompensationSensor, homeassistant.components.command_line.switch.CommandSwitch, homeassistant.components.command_line.sensor.CommandSensor, homeassistant.components.command_line.cover.CommandCover, homeassistant.components.command_line.binary_sensor.CommandBinarySensor, homeassistant.components.comfoconnect.sensor.ComfoConnectSensor, homeassistant.components.comfoconnect.fan.ComfoConnectFan, homeassistant.components.comelit.cover.ComelitCoverEntity, homeassistant.components.cloud.tts.CloudTTSEntity, homeassistant.components.cloud.stt.CloudProviderEntity, homeassistant.components.cloud.binary_sensor.CloudRemoteBinary, homeassistant.components.chacon_dio.entity.ChaconDioEntity, homeassistant.components.cast.media_player.CastMediaPlayerEntity, homeassistant.components.cambridge_audio.entity.CambridgeAudioEntity, homeassistant.components.caldav.calendar.WebDavCalendarEntity, homeassistant.components.buienradar.sensor.BrSensor, homeassistant.components.bthome.event.BTHomeEventEntity, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.broadlink.switch.BroadlinkSwitch, homeassistant.components.broadlink.remote.BroadlinkRemote, homeassistant.components.broadlink.entity.BroadlinkEntity, homeassistant.components.bosch_shc.entity.SHCEntity, homeassistant.components.bosch_shc.entity.SHCBaseEntity, homeassistant.components.bond.entity.BondEntity, homeassistant.components.bluesound.media_player.BluesoundPlayer, homeassistant.components.blue_current.entity.BlueCurrentEntity, homeassistant.components.bayesian.binary_sensor.BayesianBinarySensor, homeassistant.components.bang_olufsen.media_player.BangOlufsenMediaPlayer, homeassistant.components.balboa.entity.BalboaEntity, homeassistant.components.baf.entity.BAFEntity, homeassistant.components.axis.light.AxisLight, homeassistant.components.axis.entity.AxisEventEntity, homeassistant.components.axis.entity.AxisEntity, homeassistant.components.axis.camera.AxisCamera, homeassistant.components.automation.AutomationEntity, homeassistant.components.automation.UnavailableAutomationEntity, homeassistant.components.august.sensor.AugustOperatorSensor, homeassistant.components.august.lock.AugustLock, homeassistant.components.august.entity.AugustEntity, homeassistant.components.assist_pipeline.select.VadSensitivitySelect, homeassistant.components.assist_pipeline.select.AssistPipelineSelect, homeassistant.components.arcam_fmj.media_player.ArcamFmj, homeassistant.components.aqualogic.switch.AquaLogicSwitch, homeassistant.components.aqualogic.sensor.AquaLogicSensor, homeassistant.components.apple_tv.entity.AppleTVEntity, homeassistant.components.anthropic.conversation.AnthropicConversationEntity, homeassistant.components.anthemav.media_player.AnthemAVR, homeassistant.components.androidtv_remote.remote.AndroidTVRemoteEntity, homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity, homeassistant.components.androidtv_remote.entity.AndroidTVRemoteBaseEntity, homeassistant.components.androidtv.media_player.ADBDevice, homeassistant.components.amcrest.sensor.AmcrestSensor, homeassistant.components.amcrest.camera.AmcrestCam, homeassistant.components.amcrest.binary_sensor.AmcrestBinarySensor, homeassistant.components.ambient_station.entity.AmbientWeatherEntity, homeassistant.components.alarmdecoder.sensor.AlarmDecoderSensor, homeassistant.components.alarmdecoder.binary_sensor.AlarmDecoderBinarySensor, homeassistant.components.alarmdecoder.alarm_control_panel.AlarmDecoderAlarmPanel, homeassistant.components.airtouch5.entity.Airtouch5Entity, homeassistant.components.airtouch5.cover.Airtouch5ZoneOpenPercentage, homeassistant.components.airtouch5.climate.Airtouch5Zone, homeassistant.components.airtouch5.climate.Airtouch5AC, homeassistant.components.aftership.sensor.AfterShipSensor, homeassistant.components.ads.valve.AdsValve, homeassistant.components.ads.switch.AdsSwitch, homeassistant.components.ads.sensor.AdsSensor, homeassistant.components.ads.select.AdsSelect, homeassistant.components.ads.light.AdsLight, homeassistant.components.ads.cover.AdsCover, homeassistant.components.ads.binary_sensor.AdsBinarySensor, homeassistant.components.acaia.sensor.AcaiaRestoreSensor, homeassistant.components.abode.switch.AbodeAutomationSwitch, homeassistant.components.abode.entity.AbodeDevice, homeassistant.components.abode.entity.AbodeEntity, and homeassistant.components.abode.camera.AbodeCamera.

Definition at line 1443 of file entity.py.

async_device_update()

None homeassistant.helpers.entity.Entity.async_device_update	(		self,
		bool	warning = True
	)

Process 'update' or 'async_update' from entity.

This method is a coroutine.

Definition at line 1294 of file entity.py.

async_internal_added_to_hass()

None homeassistant.helpers.entity.Entity.async_internal_added_to_hass

(

self

)

Run when entity about to be added to hass.

Not to be extended by integrations.

Reimplemented in homeassistant.helpers.restore_state.RestoreEntity, homeassistant.components.weather.WeatherEntity, homeassistant.components.wake_word.WakeWordDetectionEntity, homeassistant.components.update.UpdateEntity, homeassistant.components.tts.TextToSpeechEntity, homeassistant.components.stt.SpeechToTextEntity, homeassistant.components.sensor.SensorEntity, homeassistant.components.scene.Scene, homeassistant.components.number.NumberEntity, homeassistant.components.notify.NotifyEntity, homeassistant.components.lock.LockEntity, homeassistant.components.event.EventEntity, homeassistant.components.device_tracker.config_entry.ScannerEntity, homeassistant.components.conversation.entity.ConversationEntity, homeassistant.components.camera.Camera, homeassistant.components.button.ButtonEntity, homeassistant.components.binary_sensor.BinarySensorEntity, and homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 1462 of file entity.py.

async_internal_will_remove_from_hass()

None homeassistant.helpers.entity.Entity.async_internal_will_remove_from_hass

(

self

)

Run when entity will be removed from hass.

Not to be extended by integrations.

Reimplemented in homeassistant.helpers.restore_state.RestoreEntity.

Definition at line 1497 of file entity.py.

async_on_remove()

None homeassistant.helpers.entity.Entity.async_on_remove	(		self,
		CALLBACK_TYPE	func
	)

Add a function to call when entity is removed or not added.

Definition at line 1331 of file entity.py.

async_registry_entry_updated()

None homeassistant.helpers.entity.Entity.async_registry_entry_updated

(

self

)

Run when the entity registry entry has been updated.

To be extended by integrations.

Reimplemented in homeassistant.components.weather.WeatherEntity, homeassistant.components.sensor.SensorEntity, homeassistant.components.number.NumberEntity, homeassistant.components.lock.LockEntity, and homeassistant.components.alarm_control_panel.AlarmControlPanelEntity.

Definition at line 1456 of file entity.py.

async_remove()

None homeassistant.helpers.entity.Entity.async_remove	(		self,
		*bool	force_remove = False
	)

Remove entity from Home Assistant.

If the entity has a non disabled entry in the entity registry,
the entity's state will be set to unavailable, in the same way
as when the entity registry is loaded.

If the entity doesn't have a non disabled entry in the entity registry,
or if force_remove=True, its state will be removed.

Definition at line 1387 of file entity.py.

async_removed_from_registry()

None homeassistant.helpers.entity.Entity.async_removed_from_registry

(

self

)

Run when entity has been removed from entity registry.

To be extended by integrations.

Reimplemented in homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin.

Definition at line 1337 of file entity.py.

async_schedule_update_ha_state()

None homeassistant.helpers.entity.Entity.async_schedule_update_ha_state	(		self,
		bool	force_refresh = False
	)

Schedule an update ha state change task.

This method must be run in the event loop.
Scheduling the update avoids executor deadlocks.

Entity state and attributes are read when the update ha state change
task is executed.
If state is changed more than once before the ha state change task has
been executed, the intermediate state transitions will be missed.

Definition at line 1265 of file entity.py.

async_set_context()

None homeassistant.helpers.entity.Entity.async_set_context	(		self,
		Context	context
	)

Set the context the entity currently operates under.

Definition at line 937 of file entity.py.

async_update_ha_state()

None homeassistant.helpers.entity.Entity.async_update_ha_state	(		self,
		bool	force_refresh = False
	)

Update Home Assistant with current state of entity.

If force_refresh == True will update entity before setting state.

This method must be run in the event loop.

Definition at line 942 of file entity.py.

async_will_remove_from_hass()

None homeassistant.helpers.entity.Entity.async_will_remove_from_hass

(

self

)

Run when entity will be removed from hass.

To be extended by integrations.

Reimplemented in homeassistant.components.zwave_js.update.ZWaveNodeFirmwareUpdate, homeassistant.components.zha.entity.ZHAEntity, homeassistant.components.zerproc.light.ZerprocLight, homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.yale.binary_sensor.YaleDoorbellBinarySensor, homeassistant.components.whirlpool.sensor.WasherDryerTimeClass, homeassistant.components.whirlpool.sensor.WasherDryerClass, homeassistant.components.whirlpool.climate.AirConEntity, homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity, homeassistant.components.voip.binary_sensor.VoIPCallInProgress, homeassistant.components.utility_meter.sensor.UtilityMeterSensor, homeassistant.components.unifi.sensor.UnifiSensorEntity, homeassistant.components.unifi.device_tracker.UnifiScannerEntity, homeassistant.components.traccar.device_tracker.TraccarEntity, homeassistant.components.time_date.sensor.TimeDateSensor, homeassistant.components.tasmota.entity.TasmotaDiscoveryUpdate, homeassistant.components.tasmota.entity.TasmotaEntity, homeassistant.components.tag.TagEntity, homeassistant.components.systemmonitor.sensor.SystemMonitorSensor, homeassistant.components.systemmonitor.binary_sensor.SystemMonitorSensor, homeassistant.components.starline.entity.StarlineEntity, homeassistant.components.squeezebox.media_player.SqueezeBoxMediaPlayerEntity, homeassistant.components.sonos.entity.SonosEntity, homeassistant.components.songpal.media_player.SongpalEntity, homeassistant.components.snapcast.media_player.SnapcastClientDevice, homeassistant.components.snapcast.media_player.SnapcastGroupDevice, homeassistant.components.smartthings.entity.SmartThingsEntity, homeassistant.components.sma.sensor.SMAsensor, homeassistant.components.sia.entity.SIABaseEntity, homeassistant.components.script.ScriptEntity, homeassistant.components.script.UnavailableScriptEntity, homeassistant.components.samsungtv.media_player.SamsungTVDevice, homeassistant.components.russound_rio.entity.RussoundBaseEntity, homeassistant.components.roon.event.RoonEventEntity, homeassistant.components.roborock.entity.RoborockCoordinatedEntityV1, homeassistant.components.rfxtrx.siren.RfxtrxOffDelayMixin, homeassistant.components.reolink.update.ReolinkUpdateBaseEntity, homeassistant.components.ps4.media_player.PS4Device, homeassistant.components.point.entity.MinutPointEntity, homeassistant.components.point.binary_sensor.MinutPointBinarySensor, homeassistant.components.point.alarm_control_panel.MinutPointAlarmControl, homeassistant.components.openai_conversation.conversation.OpenAIConversationEntity, homeassistant.components.onkyo.media_player.OnkyoMediaPlayer, homeassistant.components.ollama.conversation.OllamaConversationEntity, homeassistant.components.nsw_rural_fire_service_feed.geo_location.NswRuralFireServiceLocationEvent, homeassistant.components.nobo_hub.sensor.NoboTemperatureSensor, homeassistant.components.nobo_hub.select.NoboProfileSelector, homeassistant.components.nobo_hub.select.NoboGlobalSelector, homeassistant.components.nobo_hub.climate.NoboZone, homeassistant.components.netatmo.entity.NetatmoBaseEntity, homeassistant.components.nest.camera.NestWebRTCEntity, homeassistant.components.nest.camera.NestRTSPEntity, homeassistant.components.mysensors.entity.MySensorsChildEntity, homeassistant.components.mqtt.entity.MqttEntity, homeassistant.components.mqtt.entity.MqttDiscoveryUpdateMixin, homeassistant.components.mqtt.entity.MqttAvailabilityMixin, homeassistant.components.mqtt.entity.MqttAttributesMixin, homeassistant.components.motionmount.entity.MotionMountEntity, homeassistant.components.mobile_app.device_tracker.MobileAppEntity, homeassistant.components.matter.update.MatterUpdate, homeassistant.components.litejet.switch.LiteJetSwitch, homeassistant.components.litejet.scene.LiteJetScene, homeassistant.components.litejet.light.LiteJetLight, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.lcn.switch.LcnKeyLockSwitch, homeassistant.components.lcn.switch.LcnRegulatorLockSwitch, homeassistant.components.lcn.switch.LcnRelaySwitch, homeassistant.components.lcn.switch.LcnOutputSwitch, homeassistant.components.lcn.sensor.LcnLedLogicSensor, homeassistant.components.lcn.sensor.LcnVariableSensor, homeassistant.components.lcn.light.LcnRelayLight, homeassistant.components.lcn.light.LcnOutputLight, homeassistant.components.lcn.entity.LcnEntity, homeassistant.components.lcn.cover.LcnRelayCover, homeassistant.components.lcn.cover.LcnOutputsCover, homeassistant.components.lcn.climate.LcnClimate, homeassistant.components.lcn.binary_sensor.LcnLockKeysSensor, homeassistant.components.lcn.binary_sensor.LcnBinarySensor, homeassistant.components.lcn.binary_sensor.LcnRegulatorLockSensor, homeassistant.components.kostal_plenticore.switch.PlenticoreDataSwitch, homeassistant.components.kostal_plenticore.sensor.PlenticoreDataSensor, homeassistant.components.kostal_plenticore.select.PlenticoreDataSelect, homeassistant.components.kostal_plenticore.number.PlenticoreDataNumber, homeassistant.components.knx.entity._KnxEntityBase, homeassistant.components.knx.climate.KNXClimate, homeassistant.components.kef.media_player.KefMediaPlayer, homeassistant.components.jewish_calendar.binary_sensor.JewishCalendarBinarySensor, homeassistant.components.intesishome.climate.IntesisAC, homeassistant.components.insteon.entity.InsteonEntity, homeassistant.components.icloud.sensor.IcloudDeviceBatterySensor, homeassistant.components.hyperion.switch.HyperionComponentSwitch, homeassistant.components.hyperion.sensor.HyperionSensor, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hyperion.camera.HyperionCamera, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.huawei_lte.switch.HuaweiLteBaseSwitch, homeassistant.components.huawei_lte.sensor.HuaweiLteSensor, homeassistant.components.huawei_lte.select.HuaweiLteSelectEntity, homeassistant.components.huawei_lte.entity.HuaweiLteBaseEntity, homeassistant.components.huawei_lte.binary_sensor.HuaweiLteBaseBinarySensor, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homekit_controller.entity.HomeKitEntity, homeassistant.components.home_connect.binary_sensor.HomeConnectDoorBinarySensor, homeassistant.components.heos.media_player.HeosMediaPlayer, homeassistant.components.group.entity.Group, homeassistant.components.greeneye_monitor.sensor.GEMSensor, homeassistant.components.gpslogger.device_tracker.GPSLoggerEntity, homeassistant.components.google_generative_ai_conversation.conversation.GoogleGenerativeAIConversationEntity, homeassistant.components.goodwe.sensor.InverterSensor, homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor, homeassistant.components.geonetnz_quakes.sensor.GeonetnzQuakesSensor, homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent, homeassistant.components.geofency.device_tracker.GeofencyEntity, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.gdacs.sensor.GdacsSensor, homeassistant.components.gdacs.geo_location.GdacsEvent, homeassistant.components.fully_kiosk.switch.FullySwitchEntity, homeassistant.components.fritzbox_callmonitor.sensor.FritzBoxCallSensor, homeassistant.components.freebox.entity.FreeboxHomeEntity, homeassistant.components.flux.switch.FluxSwitch, homeassistant.components.esphome.media_player.EsphomeMediaPlayer, homeassistant.components.esphome.binary_sensor.EsphomeAssistInProgressBinarySensor, homeassistant.components.esphome.assist_satellite.EsphomeAssistSatellite, homeassistant.components.eq3btsmart.entity.Eq3Entity, homeassistant.components.energy.sensor.EnergyCostSensor, homeassistant.components.edl21.sensor.EDL21Entity, homeassistant.components.ecovacs.entity.EcovacsLegacyEntity, homeassistant.components.dynalite.entity.DynaliteBase, homeassistant.components.doorbird.camera.DoorBirdCamera, homeassistant.components.devolo_home_control.entity.DevoloDeviceEntity, homeassistant.components.denonavr.media_player.DenonDevice, homeassistant.components.cast.media_player.CastMediaPlayerEntity, homeassistant.components.cambridge_audio.entity.CambridgeAudioEntity, homeassistant.components.calendar.CalendarEntity, homeassistant.components.bosch_shc.entity.SHCEntity, homeassistant.components.bosch_shc.entity.SHCBaseEntity, homeassistant.components.bond.entity.BondEntity, homeassistant.components.bluesound.media_player.BluesoundPlayer, homeassistant.components.baf.entity.BAFEntity, homeassistant.components.automation.AutomationEntity, homeassistant.components.automation.UnavailableAutomationEntity, homeassistant.components.august.binary_sensor.AugustDoorbellBinarySensor, homeassistant.components.androidtv_remote.remote.AndroidTVRemoteEntity, homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity, homeassistant.components.androidtv_remote.entity.AndroidTVRemoteBaseEntity, homeassistant.components.amcrest.camera.AmcrestCam, homeassistant.components.airtouch5.entity.Airtouch5Entity, homeassistant.components.airtouch5.cover.Airtouch5ZoneOpenPercentage, homeassistant.components.airtouch5.climate.Airtouch5Zone, homeassistant.components.airtouch5.climate.Airtouch5AC, homeassistant.components.abode.entity.AbodeDevice, and homeassistant.components.abode.entity.AbodeEntity.

Definition at line 1449 of file entity.py.

async_write_ha_state()

None homeassistant.helpers.entity.Entity.async_write_ha_state

(

self

)

Write the state to the state machine.

Reimplemented in homeassistant.components.radarr.calendar.RadarrCalendarEntity, homeassistant.components.fritzbox.climate.FritzboxThermostat, homeassistant.components.camera.Camera, and homeassistant.components.calendar.CalendarEntity.

Definition at line 1017 of file entity.py.

attribution()

str | None homeassistant.helpers.entity.Entity.attribution

(

self

)

Return the attribution.

Reimplemented in homeassistant.components.template.weather.WeatherTemplate, homeassistant.components.here_travel_time.sensor.HERETravelTimeSensor, and homeassistant.components.ecobee.weather.EcobeeWeather.

Definition at line 890 of file entity.py.

available()

bool homeassistant.helpers.entity.Entity.available

(

self

)

Return True if entity is available.

Reimplemented in homeassistant.helpers.trigger_template_entity.TriggerBaseEntity, homeassistant.components.zwave_js.fan.ValueMappingZwaveFan, homeassistant.components.zwave_js.entity.ZWaveBaseEntity, homeassistant.components.zha.entity.ZHAEntity, homeassistant.components.youtube.sensor.YouTubeSensor, homeassistant.components.youless.sensor.YoulessBaseSensor, homeassistant.components.yolink.sensor.YoLinkSensorEntity, homeassistant.components.yolink.binary_sensor.YoLinkBinarySensorEntity, homeassistant.components.yeelight.entity.YeelightEntity, homeassistant.components.yardian.switch.YardianSwitch, homeassistant.components.yale_smart_alarm.alarm_control_panel.YaleAlarmDevice, homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch, homeassistant.components.xiaomi_miio.switch.XiaomiGenericCoordinatedSwitch, homeassistant.components.xiaomi_miio.sensor.XiaomiGatewayIlluminanceSensor, homeassistant.components.xiaomi_miio.sensor.XiaomiAirQualityMonitor, homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsAbstractLight, homeassistant.components.xiaomi_miio.entity.XiaomiGatewayDevice, homeassistant.components.xiaomi_miio.air_quality.AirMonitorCGDN1, homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1, homeassistant.components.xiaomi_ble.sensor.XiaomiBluetoothSensorEntity, homeassistant.components.xiaomi_ble.binary_sensor.XiaomiBluetoothSensorEntity, homeassistant.components.xiaomi_aqara.entity.XiaomiDevice, homeassistant.components.wmspro.entity.WebControlProGenericEntity, homeassistant.components.wled.update.WLEDUpdateEntity, homeassistant.components.wled.switch.WLEDReverseSwitch, homeassistant.components.wled.select.WLEDPaletteSelect, homeassistant.components.wled.select.WLEDPlaylistSelect, homeassistant.components.wled.select.WLEDPresetSelect, homeassistant.components.wled.number.WLEDNumber, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.wled.light.WLEDMainLight, homeassistant.components.wiz.number.WizSpeedNumber, homeassistant.components.wirelesstag.entity.WirelessTagBaseSensor, homeassistant.components.wilight.entity.WiLightDevice, homeassistant.components.wiffi.sensor.StringEntity, homeassistant.components.wiffi.sensor.NumberEntity, homeassistant.components.wiffi.binary_sensor.BoolEntity, homeassistant.components.whirlpool.sensor.WasherDryerTimeClass, homeassistant.components.whirlpool.sensor.WasherDryerClass, homeassistant.components.whirlpool.climate.AirConEntity, homeassistant.components.wemo.light.WemoLight, homeassistant.components.wallbox.switch.WallboxSwitch, homeassistant.components.volkszaehler.sensor.VolkszaehlerSensor, homeassistant.components.vilfo.sensor.VilfoRouterSensor, homeassistant.components.vicare.sensor.ViCareSensor, homeassistant.components.vicare.number.ViCareNumber, homeassistant.components.vicare.binary_sensor.ViCareBinarySensor, homeassistant.components.vesync.entity.VeSyncBaseEntity, homeassistant.components.versasense.switch.VActuator, homeassistant.components.versasense.sensor.VSensor, homeassistant.components.verisure.switch.VerisureSmartplug, homeassistant.components.verisure.sensor.VerisureHygrometer, homeassistant.components.verisure.sensor.VerisureThermometer, homeassistant.components.verisure.lock.VerisureDoorlock, homeassistant.components.verisure.binary_sensor.VerisureEthernetStatus, homeassistant.components.verisure.binary_sensor.VerisureDoorWindowSensor, homeassistant.components.upb.entity.UpbEntity, homeassistant.components.twitch.sensor.TwitchSensor, homeassistant.components.tuya.scene.TuyaSceneEntity, homeassistant.components.tuya.entity.TuyaEntity, homeassistant.components.triggercmd.switch.TRIGGERcmdSwitch, homeassistant.components.tplink_omada.switch.OmadaDevicePortSwitchEntity, homeassistant.components.tolo.sensor.ToloSensorEntity, homeassistant.components.tolo.button.ToloLampNextColorButton, homeassistant.components.tibber.sensor.TibberSensorRT, homeassistant.components.tfiac.climate.TfiacClimate, homeassistant.components.tessie.sensor.TessieVehicleSensorEntity, homeassistant.components.tellduslive.entity.TelldusLiveEntity, homeassistant.components.tedee.lock.TedeeLockEntity, homeassistant.components.tasmota.entity.TasmotaAvailability, homeassistant.components.tado.climate.TadoClimate, homeassistant.components.systemmonitor.sensor.SystemMonitorSensor, homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer, homeassistant.components.synology_dsm.update.SynoDSMUpdateEntity, homeassistant.components.synology_dsm.switch.SynoDSMSurveillanceHomeModeToggle, homeassistant.components.synology_dsm.sensor.SynoDSMUtilSensor, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.synology_dsm.binary_sensor.SynoDSMSecurityBinarySensor, homeassistant.components.syncthing.sensor.FolderSensor, homeassistant.components.switchmate.switch.SwitchmateEntity, homeassistant.components.surepetcare.lock.SurePetcareLock, homeassistant.components.surepetcare.binary_sensor.Hub, homeassistant.components.supervisord.sensor.SupervisorProcessSensor, homeassistant.components.subaru.sensor.SubaruSensor, homeassistant.components.subaru.device_tracker.SubaruDeviceTracker, homeassistant.components.starlink.time.StarlinkTimeEntity, homeassistant.components.starline.switch.StarlineSwitch, homeassistant.components.starline.lock.StarlineLock, homeassistant.components.starline.entity.StarlineEntity, homeassistant.components.starline.button.StarlineButton, homeassistant.components.squeezebox.media_player.SqueezeBoxMediaPlayerEntity, homeassistant.components.sony_projector.switch.SonyProjector, homeassistant.components.sonos.switch.SonosAlarmEntity, homeassistant.components.sonos.sensor.SonosBatteryEntity, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.sonos.entity.SonosEntity, homeassistant.components.sonos.binary_sensor.SonosPowerEntity, homeassistant.components.soma.entity.SomaEntity, homeassistant.components.smappee.switch.SmappeeActuator, homeassistant.components.slimproto.media_player.SlimProtoPlayer, homeassistant.components.slide.cover.SlideCover, homeassistant.components.sisyphus.media_player.SisyphusPlayer, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.shelly.entity.ShellyRpcAttributeEntity, homeassistant.components.shelly.entity.ShellyBlockAttributeEntity, homeassistant.components.shelly.climate.BlockSleepingClimate, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.seventeentrack.sensor.SeventeenTrackPackageSensor, homeassistant.components.seventeentrack.sensor.SeventeenTrackSummarySensor, homeassistant.components.sesame.lock.SesameDevice, homeassistant.components.senz.climate.SENZClimate, homeassistant.components.sensoterra.sensor.SensoterraEntity, homeassistant.components.sensibo.climate.SensiboClimate, homeassistant.components.scrape.sensor.ScrapeSensor, homeassistant.components.samsungtv.entity.SamsungTVEntity, homeassistant.components.roborock.image.RoborockMap, homeassistant.components.rmvtransport.sensor.RMVDepartureSensor, homeassistant.components.ring.event.RingEvent, homeassistant.components.ring.binary_sensor.RingBinarySensor, homeassistant.components.rflink.entity.RflinkDevice, homeassistant.components.rest.sensor.RestSensor, homeassistant.components.rest.entity.RestEntity, homeassistant.components.rest.binary_sensor.RestBinarySensor, homeassistant.components.reolink.update.ReolinkUpdateBaseEntity, homeassistant.components.reolink.sensor.ReolinkHddSensorEntity, homeassistant.components.rainforest_eagle.sensor.EagleSensor, homeassistant.components.pvpc_hourly_pricing.sensor.ElecPriceSensor, homeassistant.components.pulseaudio_loopback.switch.PALoopbackSwitch, homeassistant.components.prusalink.sensor.PrusaLinkSensorEntity, homeassistant.components.prusalink.camera.PrusaLinkJobPreviewEntity, homeassistant.components.prusalink.button.PrusaLinkButtonEntity, homeassistant.components.proxmoxve.binary_sensor.ProxmoxBinarySensor, homeassistant.components.proximity.sensor.ProximityTrackedEntitySensor, homeassistant.components.powerwall.sensor.PowerWallEnergyDirectionSensor, homeassistant.components.powerwall.binary_sensor.PowerWallChargingStatusSensor, homeassistant.components.point.entity.MinutPointEntity, homeassistant.components.ping.sensor.PingSensor, homeassistant.components.philips_js.switch.PhilipsTVAmbilightHueSwitch, homeassistant.components.philips_js.switch.PhilipsTVScreenSwitch, homeassistant.components.philips_js.light.PhilipsTVLightEntity, homeassistant.components.permobil.sensor.PermobilSensor, homeassistant.components.permobil.binary_sensor.PermobilbinarySensor, homeassistant.components.panasonic_viera.remote.PanasonicVieraRemoteEntity, homeassistant.components.panasonic_viera.media_player.PanasonicVieraTVEntity, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater, homeassistant.components.oralb.sensor.OralBBluetoothSensorEntity, homeassistant.components.opple.light.OppleLight, homeassistant.components.openweathermap.sensor.AbstractOpenWeatherMapSensor, homeassistant.components.opentherm_gw.entity.OpenThermEntity, homeassistant.components.opengarage.binary_sensor.OpenGarageBinarySensor, homeassistant.components.onvif.entity.ONVIFBaseEntity, homeassistant.components.oncue.entity.OncueEntity, homeassistant.components.octoprint.sensor.OctoPrintTemperatureSensor, homeassistant.components.octoprint.sensor.OctoPrintStatusSensor, homeassistant.components.octoprint.button.OctoprintSystemButton, homeassistant.components.octoprint.button.OctoprintPrinterButton, homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase, homeassistant.components.nuki.binary_sensor.NukiDoorsensorEntity, homeassistant.components.nuheat.climate.NuHeatThermostat, homeassistant.components.nissan_leaf.button.LeafChargingButton, homeassistant.components.nissan_leaf.binary_sensor.LeafChargingSensor, homeassistant.components.nissan_leaf.binary_sensor.LeafPluggedInSensor, homeassistant.components.nibe_heatpump.water_heater.WaterHeater, homeassistant.components.nibe_heatpump.climate.NibeClimateEntity, homeassistant.components.nibe_heatpump.button.NibeAlarmResetButton, homeassistant.components.netio.switch.NetioSwitch, homeassistant.components.netdata.sensor.NetdataAlarms, homeassistant.components.netdata.sensor.NetdataSensor, homeassistant.components.netatmo.sensor.NetatmoWeatherSensor, homeassistant.components.netatmo.light.NetatmoCameraLight, homeassistant.components.netatmo.climate.NetatmoThermostat, homeassistant.components.nest.sensor.SensorBase, homeassistant.components.nest.climate.ThermostatEntity, homeassistant.components.nest.camera.NestRTSPEntity, homeassistant.components.neato.camera.NeatoCleaningMap, homeassistant.components.nam.sensor.NAMSensor, homeassistant.components.nad.media_player.NAD, homeassistant.components.myuplink.binary_sensor.MyUplinkDevicePointBinarySensor, homeassistant.components.mysensors.entity.MySensorsChildEntity, homeassistant.components.music_assistant.entity.MusicAssistantEntity, homeassistant.components.mqtt.entity.MqttAvailabilityMixin, homeassistant.components.motionmount.entity.MotionMountEntity, homeassistant.components.motioneye.camera.MotionEyeMjpegCamera, homeassistant.components.motion_blinds.cover.MotionBaseDevice, homeassistant.components.minecraft_server.binary_sensor.MinecraftServerBinarySensorEntity, homeassistant.components.mill.sensor.MillSensor, homeassistant.components.mill.climate.MillHeater, homeassistant.components.mediaroom.media_player.MediaroomDevice, homeassistant.components.meater.sensor.MeaterProbeTemperature, homeassistant.components.mealie.todo.MealieShoppingListTodoListEntity, homeassistant.components.leaone.sensor.LeaoneBluetoothSensorEntity, homeassistant.components.ld2410_ble.sensor.LD2410BLESensor, homeassistant.components.ld2410_ble.binary_sensor.LD2410BLEBinarySensor, homeassistant.components.laundrify.binary_sensor.LaundrifyPowerPlug, homeassistant.components.launch_library.sensor.LaunchLibrarySensor, homeassistant.components.lastfm.sensor.LastFmSensor, homeassistant.components.lametric.switch.LaMetricSwitchEntity, homeassistant.components.lacrosse_view.sensor.LaCrosseViewSensor, homeassistant.components.kwb.sensor.KWBSensor, homeassistant.components.kraken.sensor.KrakenSensor, homeassistant.components.kostal_plenticore.switch.PlenticoreDataSwitch, homeassistant.components.kostal_plenticore.sensor.PlenticoreDataSensor, homeassistant.components.kostal_plenticore.select.PlenticoreDataSelect, homeassistant.components.kostal_plenticore.number.PlenticoreDataNumber, homeassistant.components.konnected.switch.KonnectedSwitch, homeassistant.components.knx.sensor.KNXSystemSensor, homeassistant.components.knx.entity._KnxEntityBase, homeassistant.components.kaleidescape.media_player.KaleidescapeMediaPlayer, homeassistant.components.kaiterra.sensor.KaiterraSensor, homeassistant.components.kaiterra.air_quality.KaiterraAirQuality, homeassistant.components.izone.climate.ZoneDevice, homeassistant.components.isy994.switch.ISYEnableSwitchEntity, homeassistant.components.isy994.sensor.ISYAuxSensorEntity, homeassistant.components.isy994.entity.ISYAuxControlEntity, homeassistant.components.isy994.entity.ISYNodeEntity, homeassistant.components.isy994.button.ISYNodeButtonEntity, homeassistant.components.iron_os.update.IronOSUpdate, homeassistant.components.intesishome.climate.IntesisAC, homeassistant.components.idasen_desk.sensor.IdasenDeskSensor, homeassistant.components.idasen_desk.cover.IdasenDeskCover, homeassistant.components.iaqualink.entity.AqualinkEntity, homeassistant.components.hyperion.switch.HyperionComponentSwitch, homeassistant.components.hyperion.sensor.HyperionSensor, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hyperion.camera.HyperionCamera, homeassistant.components.hydrawise.binary_sensor.HydrawiseBinarySensor, homeassistant.components.hvv_departures.binary_sensor.HvvDepartureBinarySensor, homeassistant.components.husqvarna_automower.switch.StayOutZoneSwitchEntity, homeassistant.components.husqvarna_automower.button.AutomowerButtonEntity, homeassistant.components.huisbaasje.sensor.EnergyFlipSensor, homeassistant.components.hue.v2.entity.HueBaseEntity, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.huawei_lte.entity.HuaweiLteBaseEntity, homeassistant.components.homewizard.switch.HomeWizardSwitchEntity, homeassistant.components.homewizard.sensor.HomeWizardExternalSensorEntity, homeassistant.components.homewizard.sensor.HomeWizardSensorEntity, homeassistant.components.homewizard.number.HWEnergyNumberEntity, homeassistant.components.homematicip_cloud.weather.HomematicipHomeWeather, homeassistant.components.homematicip_cloud.switch.HomematicipGroupSwitch, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipSecurityZoneSensorGroup, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor, homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity, homeassistant.components.homematic.entity.HMDevice, homeassistant.components.homekit_controller.sensor.RSSISensor, homeassistant.components.homekit_controller.entity.HomeKitEntity, homeassistant.components.home_connect.sensor.HomeConnectSensor, homeassistant.components.home_connect.binary_sensor.HomeConnectBinarySensor, homeassistant.components.hlk_sw16.entity.SW16Entity, homeassistant.components.heos.media_player.HeosMediaPlayer, homeassistant.components.harmony.entity.HarmonyEntity, homeassistant.components.habitica.button.HabiticaButton, homeassistant.components.gtfs.sensor.GTFSDepartureSensor, homeassistant.components.govee_ble.sensor.GoveeBluetoothSensorEntity, homeassistant.components.govee_ble.binary_sensor.GoveeBluetoothBinarySensorEntity, homeassistant.components.google_wifi.sensor.GoogleWifiSensor, homeassistant.components.goodwe.sensor.InverterSensor, homeassistant.components.glances.sensor.GlancesSensor, homeassistant.components.github.sensor.GitHubSensorEntity, homeassistant.components.gios.sensor.GiosSensor, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.gardena_bluetooth.sensor.GardenaBluetoothRemainSensor, homeassistant.components.garages_amsterdam.sensor.GaragesAmsterdamSensor, homeassistant.components.garadget.cover.GaradgetCover, homeassistant.components.fujitsu_fglair.climate.FGLairDevice, homeassistant.components.fritz.switch.FritzBoxProfileSwitch, homeassistant.components.fritz.switch.FritzBoxBaseSwitch, homeassistant.components.fritz.switch.FritzBoxBaseCoordinatorSwitch, homeassistant.components.forked_daapd.media_player.ForkedDaapdMaster, homeassistant.components.forked_daapd.media_player.ForkedDaapdZone, homeassistant.components.flux_led.number.FluxMusicNumber, homeassistant.components.flo.entity.FloEntity, homeassistant.components.fireservicerota.switch.ResponseSwitch, homeassistant.components.ezviz.camera.EzvizCamera, homeassistant.components.eufylife_ble.sensor.EufyLifeHeartRateSensorEntity, homeassistant.components.eufylife_ble.sensor.EufyLifeWeightSensorEntity, homeassistant.components.eufylife_ble.sensor.EufyLifeSensorEntity, homeassistant.components.esphome.update.ESPHomeDashboardUpdateEntity, homeassistant.components.esphome.select.EsphomeAssistSatelliteWakeWordSelect, homeassistant.components.esphome.binary_sensor.EsphomeBinarySensor, homeassistant.components.eq3btsmart.number.Eq3NumberEntity, homeassistant.components.eq3btsmart.entity.Eq3Entity, homeassistant.components.epion.sensor.EpionSensor, homeassistant.components.elv.switch.SmartPlugSwitch, homeassistant.components.elkm1.entity.ElkEntity, homeassistant.components.electrasmart.climate.ElectraClimateEntity, homeassistant.components.ecowitt.entity.EcowittEntity, homeassistant.components.ecovacs.entity.EcovacsLegacyEntity, homeassistant.components.econet.entity.EcoNetEntity, homeassistant.components.ecobee.sensor.EcobeeSensor, homeassistant.components.ecobee.humidifier.EcobeeHumidifier, homeassistant.components.ecobee.entity.EcobeeBaseEntity, homeassistant.components.ecobee.climate.Thermostat, homeassistant.components.ecobee.binary_sensor.EcobeeBinarySensor, homeassistant.components.eafm.sensor.Measurement, homeassistant.components.dynalite.entity.DynaliteBase, homeassistant.components.dwd_weather_warnings.sensor.DwdWeatherWarningsSensor, homeassistant.components.duotecno.entity.DuotecnoEntity, homeassistant.components.dunehd.media_player.DuneHDPlayerEntity, homeassistant.components.dsmr.sensor.DSMREntity, homeassistant.components.dremel_3d_printer.sensor.Dremel3DPrinterSensor, homeassistant.components.dlink.switch.SmartPlugSwitch, homeassistant.components.dexcom.sensor.DexcomGlucoseTrendSensor, homeassistant.components.devialet.media_player.DevialetMediaPlayerEntity, homeassistant.components.demo.light.DemoLight, homeassistant.components.comelit.sensor.ComelitVedoSensorEntity, homeassistant.components.comelit.alarm_control_panel.ComelitAlarmEntity, homeassistant.components.cloud.binary_sensor.CloudRemoteBinary, homeassistant.components.ccm15.climate.CCM15Climate, homeassistant.components.camera.Camera, homeassistant.components.bthome.sensor.BTHomeBluetoothSensorEntity, homeassistant.components.bthome.binary_sensor.BTHomeBluetoothBinarySensorEntity, homeassistant.components.broadlink.entity.BroadlinkEntity, homeassistant.components.bosch_shc.entity.SHCDomainEntity, homeassistant.components.bosch_shc.entity.SHCEntity, homeassistant.components.blue_current.entity.BlueCurrentEntity, homeassistant.components.awair.sensor.AwairSensor, homeassistant.components.aranet.sensor.Aranet4BluetoothSensorEntity, homeassistant.components.aprilaire.sensor.BaseAprilaireSensor, homeassistant.components.anova.entity.AnovaEntity, homeassistant.components.android_ip_webcam.binary_sensor.IPWebcamBinarySensor, homeassistant.components.amcrest.switch.AmcrestSwitch, homeassistant.components.amcrest.sensor.AmcrestSensor, homeassistant.components.amcrest.camera.AmcrestCam, homeassistant.components.amcrest.binary_sensor.AmcrestBinarySensor, homeassistant.components.airzone_cloud.sensor.AirzoneSensor, homeassistant.components.airzone_cloud.binary_sensor.AirzoneBinarySensor, homeassistant.components.airvisual.sensor.AirVisualGeographySensor, homeassistant.components.airthings_ble.sensor.AirthingsSensor, homeassistant.components.airthings.sensor.AirthingsHeaterEnergySensor, homeassistant.components.ads.entity.AdsEntity, and homeassistant.components.ads.cover.AdsCover.

Definition at line 838 of file entity.py.

capability_attributes()

dict[str, Any] | None homeassistant.helpers.entity.Entity.capability_attributes

(

self

)

Return the capability attributes.

Attributes that explain the capabilities of an entity.

Implemented by component base class. Convention for attribute names
is lowercase snake_case.

Reimplemented in homeassistant.components.water_heater.WaterHeaterEntity, homeassistant.components.vacuum.StateVacuumEntity, homeassistant.components.text.TextEntity, homeassistant.components.siren.SirenEntity, homeassistant.components.sensor.SensorEntity, homeassistant.components.select.SelectEntity, homeassistant.components.number.NumberEntity, homeassistant.components.media_player.MediaPlayerEntity, homeassistant.components.light.LightEntity, homeassistant.components.input_datetime.InputDatetime, homeassistant.components.humidifier.HumidifierEntity, homeassistant.components.fan.FanEntity, homeassistant.components.event.EventEntity, homeassistant.components.climate.ClimateEntity, and homeassistant.components.automation.BaseAutomationEntity.

Definition at line 755 of file entity.py.

device_class()

str | None homeassistant.helpers.entity.Entity.device_class

(

self

)

Return the class of this device, from component DEVICE_CLASSES.

Reimplemented in homeassistant.components.yandex_transport.sensor.DiscoverYandexTransport, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiBinarySensor, homeassistant.components.wirelesstag.binary_sensor.WirelessTagBinarySensor, homeassistant.components.w800rf32.binary_sensor.W800rf32BinarySensor, homeassistant.components.valve.ValveEntity, homeassistant.components.utility_meter.sensor.UtilityMeterSensor, homeassistant.components.update.UpdateEntity, homeassistant.components.totalconnect.binary_sensor.TotalConnectZoneBinarySensor, homeassistant.components.time.TimeEntity, homeassistant.components.switch.SwitchEntity, homeassistant.components.sensor.SensorEntity, homeassistant.components.satel_integra.binary_sensor.SatelIntegraBinarySensor, homeassistant.components.remote_rpi_gpio.binary_sensor.RemoteRPiGPIOBinarySensor, homeassistant.components.qwikswitch.binary_sensor.QSBinarySensor, homeassistant.components.oasa_telematics.sensor.OASATelematicsSensor, homeassistant.components.nx584.binary_sensor.NX584ZoneSensor, homeassistant.components.number.NumberEntity, homeassistant.components.nice_go.cover.NiceGOCoverEntity, homeassistant.components.ness_alarm.binary_sensor.NessZoneBinarySensor, homeassistant.components.mfi.sensor.MfiSensor, homeassistant.components.media_player.MediaPlayerEntity, homeassistant.components.lupusec.binary_sensor.LupusecBinarySensor, homeassistant.components.image_processing.ImageProcessingEntity, homeassistant.components.hunterdouglas_powerview.sensor.PowerViewSensor, homeassistant.components.humidifier.HumidifierEntity, homeassistant.components.huawei_lte.sensor.HuaweiLteSensor, homeassistant.components.homewizard.sensor.HomeWizardExternalSensorEntity, homeassistant.components.homematic.binary_sensor.HMBinarySensor, homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor, homeassistant.components.group.binary_sensor.BinarySensorGroup, homeassistant.components.geniushub.switch.GeniusSwitch, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.event.EventEntity, homeassistant.components.envisalink.binary_sensor.EnvisalinkBinarySensor, homeassistant.components.egardia.binary_sensor.EgardiaBinarySensor, homeassistant.components.ebusd.sensor.EbusdSensor, homeassistant.components.digital_ocean.binary_sensor.DigitalOceanBinarySensor, homeassistant.components.datetime.DateTimeEntity, homeassistant.components.date.DateEntity, homeassistant.components.cover.CoverEntity, homeassistant.components.control4.media_player.Control4Room, homeassistant.components.concord232.binary_sensor.Concord232ZoneSensor, homeassistant.components.button.ButtonEntity, and homeassistant.components.abode.binary_sensor.AbodeBinarySensor.

Definition at line 806 of file entity.py.

device_info()

DeviceInfo | None homeassistant.helpers.entity.Entity.device_info

(

self

)

Return device specific attributes.

Implemented by platform classes.

Reimplemented in homeassistant.components.zwave_me.entity.ZWaveMeEntity, homeassistant.components.zha.entity.ZHAEntity, homeassistant.components.zha.device_tracker.ZHADeviceScannerEntity, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.entity.XiaomiGatewayDevice, homeassistant.components.xiaomi_miio.entity.XiaomiMiioEntity, homeassistant.components.xiaomi_aqara.entity.XiaomiDevice, homeassistant.components.xbox.remote.XboxRemote, homeassistant.components.xbox.media_player.XboxMediaPlayer, homeassistant.components.wemo.light.WemoLight, homeassistant.components.vesync.entity.VeSyncBaseEntity, homeassistant.components.verisure.switch.VerisureSmartplug, homeassistant.components.verisure.sensor.VerisureHygrometer, homeassistant.components.verisure.sensor.VerisureThermometer, homeassistant.components.verisure.lock.VerisureDoorlock, homeassistant.components.verisure.camera.VerisureSmartcam, homeassistant.components.verisure.binary_sensor.VerisureEthernetStatus, homeassistant.components.verisure.binary_sensor.VerisureDoorWindowSensor, homeassistant.components.verisure.alarm_control_panel.VerisureAlarm, homeassistant.components.upb.entity.UpbAttachedEntity, homeassistant.components.twinkly.light.TwinklyLight, homeassistant.components.tuya.scene.TuyaSceneEntity, homeassistant.components.tuya.entity.TuyaEntity, homeassistant.components.tibber.sensor.TibberSensor, homeassistant.components.tellduslive.entity.TelldusLiveEntity, homeassistant.components.synology_dsm.switch.SynoDSMSurveillanceHomeModeToggle, homeassistant.components.synology_dsm.camera.SynoDSMCamera, homeassistant.components.syncthru.sensor.SyncThruSensor, homeassistant.components.syncthru.binary_sensor.SyncThruBinarySensor, homeassistant.components.sonos.entity.SonosEntity, homeassistant.components.songpal.media_player.SongpalEntity, homeassistant.components.soma.entity.SomaEntity, homeassistant.components.roon.media_player.RoonDevice, homeassistant.components.plex.sensor.PlexLibrarySectionSensor, homeassistant.components.plex.sensor.PlexSensor, homeassistant.components.plex.media_player.PlexMediaPlayer, homeassistant.components.panasonic_viera.remote.PanasonicVieraRemoteEntity, homeassistant.components.owntracks.device_tracker.OwnTracksEntity, homeassistant.components.overkiz.sensor.OverkizHomeKitSetupCodeSensor, homeassistant.components.onvif.entity.ONVIFBaseEntity, homeassistant.components.nuheat.climate.NuHeatThermostat, homeassistant.components.neato.vacuum.NeatoConnectedVacuum, homeassistant.components.mysensors.entity.MySensorNodeEntity, homeassistant.components.mqtt.entity.MqttEntityDeviceInfo, homeassistant.components.mobile_app.entity.MobileAppEntity, homeassistant.components.mobile_app.device_tracker.MobileAppEntity, homeassistant.components.meteoclimatic.weather.MeteoclimaticWeather, homeassistant.components.meteoclimatic.sensor.MeteoclimaticSensor, homeassistant.components.meteo_france.weather.MeteoFranceWeather, homeassistant.components.lcn.entity.LcnEntity, homeassistant.components.iotawatt.sensor.IotaWattSensor, homeassistant.components.ios.sensor.IOSSensor, homeassistant.components.insteon.entity.InsteonEntity, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.huawei_lte.entity.HuaweiLteBaseEntityWithDevice, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor, homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity, homeassistant.components.homekit_controller.entity.HomeKitEntity, homeassistant.components.fritzbox.button.FritzBoxTemplate, homeassistant.components.fritz.switch.FritzBoxBaseCoordinatorSwitch, homeassistant.components.flo.entity.FloEntity, homeassistant.components.elkm1.entity.ElkAttachedEntity, homeassistant.components.elkm1.entity.ElkEntity, homeassistant.components.ecovacs.entity.EcovacsEntity, homeassistant.components.econet.entity.EcoNetEntity, homeassistant.components.ecobee.weather.EcobeeWeather, homeassistant.components.ecobee.sensor.EcobeeSensor, homeassistant.components.ecobee.humidifier.EcobeeHumidifier, homeassistant.components.ecobee.climate.Thermostat, homeassistant.components.ecobee.binary_sensor.EcobeeBinarySensor, homeassistant.components.eafm.sensor.Measurement, homeassistant.components.dynalite.entity.DynaliteBase, homeassistant.components.device_tracker.config_entry.ScannerEntity, homeassistant.components.crownstone.entity.CrownstoneEntity, homeassistant.components.broadlink.entity.BroadlinkEntity, homeassistant.components.bond.entity.BondEntity, homeassistant.components.awair.sensor.AwairSensor, homeassistant.components.adguard.entity.AdGuardHomeEntity, and homeassistant.components.abode.entity.AbodeDevice.

Definition at line 798 of file entity.py.

enabled()

bool homeassistant.helpers.entity.Entity.enabled

(

self

)

Return if the entity is enabled in the entity registry.

If an entity is not part of the registry, it cannot be disabled
and will therefore always be enabled.

Definition at line 928 of file entity.py.

entity_category()

EntityCategory | None homeassistant.helpers.entity.Entity.entity_category

(

self

)

Return the category of the entity, if any.

Reimplemented in homeassistant.components.update.UpdateEntity, and homeassistant.components.fritzbox.sensor.FritzBoxSensor.

Definition at line 895 of file entity.py.

entity_picture()

str | None homeassistant.helpers.entity.Entity.entity_picture

(

self

)

Return the entity picture to use in the frontend, if any.

Reimplemented in homeassistant.helpers.trigger_template_entity.TriggerBaseEntity, homeassistant.components.youtube.sensor.YouTubeSensor, homeassistant.components.update.UpdateEntity, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.twitch.sensor.TwitchSensor, homeassistant.components.template.image.StateImageEntity, homeassistant.components.ps4.media_player.PS4Device, homeassistant.components.mqtt.update.MqttUpdate, homeassistant.components.monarch_money.sensor.MonarchMoneySensor, homeassistant.components.media_player.MediaPlayerEntity, homeassistant.components.matter.update.MatterUpdate, homeassistant.components.lastfm.sensor.LastFmSensor, homeassistant.components.image.ImageEntity, homeassistant.components.hassio.update.SupervisorCoreUpdateEntity, homeassistant.components.hassio.update.SupervisorSupervisorUpdateEntity, homeassistant.components.hassio.update.SupervisorOSUpdateEntity, homeassistant.components.hassio.update.SupervisorAddonUpdateEntity, homeassistant.components.habitica.sensor.HabitipySensor, homeassistant.components.habitica.button.HabiticaButton, homeassistant.components.habitica.binary_sensor.HabiticaBinarySensorEntity, homeassistant.components.device_tracker.legacy.Device, and homeassistant.components.camera.Camera.

Definition at line 833 of file entity.py.

entity_registry_enabled_default()

bool homeassistant.helpers.entity.Entity.entity_registry_enabled_default

(

self

)

Return if the entity should be enabled when first added.

This only applies when fist added to the entity registry.

Reimplemented in homeassistant.components.monoprice.media_player.MonopriceZone, and homeassistant.components.device_tracker.config_entry.ScannerEntity.

Definition at line 866 of file entity.py.

entity_registry_visible_default()

bool homeassistant.helpers.entity.Entity.entity_registry_visible_default

(

self

)

Return if the entity should be visible when first added.

This only applies when fist added to the entity registry.

Definition at line 878 of file entity.py.

extra_state_attributes()

Mapping[str, Any] | None homeassistant.helpers.entity.Entity.extra_state_attributes

(

self

)

Return entity specific state attributes.

Implemented by platform classes. Convention for attribute names
is lowercase snake_case.

Reimplemented in homeassistant.helpers.trigger_template_entity.TriggerBaseEntity, homeassistant.components.zwave_js.sensor.ZWaveConfigParameterSensor, homeassistant.components.zwave_js.sensor.ZWaveListSensor, homeassistant.components.zwave_js.sensor.ZWaveMeterSensor, homeassistant.components.zwave_js.number.ZWaveConfigParameterNumberEntity, homeassistant.components.zwave_js.fan.ZwaveThermostatFan, homeassistant.components.zwave_js.climate.ZWaveClimate, homeassistant.components.zha.sensor.Sensor, homeassistant.components.zha.light.Light, homeassistant.components.zha.cover.ZhaCover, homeassistant.components.zha.climate.Thermostat, homeassistant.components.zestimate.sensor.ZestimateDataSensor, homeassistant.components.zamg.sensor.ZamgSensor, homeassistant.components.zabbix.sensor.ZabbixTriggerCountSensor, homeassistant.components.youtube.sensor.YouTubeSensor, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.yandex_transport.sensor.DiscoverYandexTransport, homeassistant.components.yale.sensor.YaleOperatorSensor, homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch, homeassistant.components.xiaomi_miio.sensor.XiaomiAirQualityMonitor, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsAbstractLight, homeassistant.components.xiaomi_miio.fan.XiaomiGenericDevice, homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1, homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch, homeassistant.components.xiaomi_aqara.lock.XiaomiAqaraLock, homeassistant.components.xiaomi_aqara.entity.XiaomiDevice, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiCube, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiButton, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiVibration, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiSmokeSensor, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiDoorSensor, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiMotionSensor, homeassistant.components.xiaomi_aqara.binary_sensor.XiaomiNatgasSensor, homeassistant.components.wsdot.sensor.WashingtonStateTravelTimeSensor, homeassistant.components.worldtidesinfo.sensor.WorldTidesInfoSensor, homeassistant.components.wolflink.sensor.WolfLinkSensor, homeassistant.components.wled.switch.WLEDSyncReceiveSwitch, homeassistant.components.wled.switch.WLEDSyncSendSwitch, homeassistant.components.wled.switch.WLEDNightlightSwitch, homeassistant.components.wirelesstag.entity.WirelessTagBaseSensor, homeassistant.components.wilight.switch.WiLightValvePauseSwitch, homeassistant.components.wilight.switch.WiLightValveSwitch, homeassistant.components.whois.sensor.WhoisSensorEntity, homeassistant.components.wemo.switch.WemoSwitch, homeassistant.components.wemo.fan.WemoHumidifier, homeassistant.components.waze_travel_time.sensor.WazeTravelTime, homeassistant.components.watttime.sensor.RealtimeEmissionsSensor, homeassistant.components.vultr.switch.VultrSwitch, homeassistant.components.vultr.binary_sensor.VultrBinarySensor, homeassistant.components.vicare.climate.ViCareClimate, homeassistant.components.viaggiatreno.sensor.ViaggiaTrenoSensor, homeassistant.components.vesync.fan.VeSyncFanHA, homeassistant.components.version.sensor.VersionSensorEntity, homeassistant.components.verisure.lock.VerisureDoorlock, homeassistant.components.verisure.binary_sensor.VerisureDoorWindowSensor, homeassistant.components.vera.scene.VeraScene, homeassistant.components.vera.lock.VeraLock, homeassistant.components.venstar.climate.VenstarThermostat, homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor, homeassistant.components.vallox.fan.ValloxFanEntity, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.utility_meter.sensor.UtilityMeterSensor, homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent, homeassistant.components.upb.entity.UpbEntity, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.unifi.device_tracker.UnifiScannerEntity, homeassistant.components.uk_transport.sensor.UkTransportLiveTrainTimeSensor, homeassistant.components.uk_transport.sensor.UkTransportLiveBusTimeSensor, homeassistant.components.twitch.sensor.TwitchSensor, homeassistant.components.trend.binary_sensor.SensorTrend, homeassistant.components.travisci.sensor.TravisCISensor, homeassistant.components.transport_nsw.sensor.TransportNSWSensor, homeassistant.components.transmission.sensor.TransmissionSensor, homeassistant.components.trafikverket_train.sensor.TrainSensor, homeassistant.components.trafikverket_camera.camera.TVCamera, homeassistant.components.tradfri.cover.TradfriCover, homeassistant.components.toon.climate.ToonThermostatDevice, homeassistant.components.todoist.calendar.TodoistProjectEntity, homeassistant.components.tod.binary_sensor.TodSensor, homeassistant.components.tmb.sensor.TMBSensor, homeassistant.components.timer.Timer, homeassistant.components.threshold.binary_sensor.ThresholdSensor, homeassistant.components.tessie.device_tracker.TessieDeviceTrackerLocationEntity, homeassistant.components.tensorflow.image_processing.TensorFlowImageProcessor, homeassistant.components.tellduslive.entity.TelldusLiveEntity, homeassistant.components.tank_utility.sensor.TankUtilitySensor, homeassistant.components.tag.TagEntity, homeassistant.components.tado.climate.TadoClimate, homeassistant.components.synology_dsm.binary_sensor.SynoDSMSecurityBinarySensor, homeassistant.components.syncthru.sensor.SyncThruOutputTraySensor, homeassistant.components.syncthru.sensor.SyncThruInputTraySensor, homeassistant.components.syncthru.sensor.SyncThruDrumSensor, homeassistant.components.syncthru.sensor.SyncThruTonerSensor, homeassistant.components.syncthru.sensor.SyncThruMainSensor, homeassistant.components.syncthing.sensor.FolderSensor, homeassistant.components.switchbot.switch.SwitchBotSwitch, homeassistant.components.swiss_hydrological_data.sensor.SwissHydrologicalDataSensor, homeassistant.components.supervisord.sensor.SupervisorProcessSensor, homeassistant.components.sun.entity.Sun, homeassistant.components.suez_water.sensor.SuezWaterSensor, homeassistant.components.subaru.device_tracker.SubaruDeviceTracker, homeassistant.components.stiebel_eltron.climate.StiebelEltron, homeassistant.components.steam_online.sensor.SteamSensor, homeassistant.components.starlink.device_tracker.StarlinkDeviceTrackerEntity, homeassistant.components.starline.switch.StarlineSwitch, homeassistant.components.starline.sensor.StarlineSensor, homeassistant.components.starline.lock.StarlineLock, homeassistant.components.starline.device_tracker.StarlineDeviceTracker, homeassistant.components.squeezebox.media_player.SqueezeBoxMediaPlayerEntity, homeassistant.components.sql.sensor.SQLSensor, homeassistant.components.speedtestdotnet.sensor.SpeedtestSensor, homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer, homeassistant.components.sony_projector.switch.SonyProjector, homeassistant.components.sonos.switch.SonosAlarmEntity, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.sonos.binary_sensor.SonosPowerEntity, homeassistant.components.sonarr.sensor.SonarrSensor, homeassistant.components.solaredge_local.sensor.SolarEdgeSensor, homeassistant.components.solaredge.sensor.SolarEdgePowerFlowSensor, homeassistant.components.solaredge.sensor.SolarEdgeEnergyDetailsSensor, homeassistant.components.solaredge.sensor.SolarEdgeInventorySensor, homeassistant.components.solaredge.sensor.SolarEdgeDetailsSensor, homeassistant.components.snapcast.media_player.SnapcastClientDevice, homeassistant.components.smhi.weather.SmhiWeather, homeassistant.components.smarttub.sensor.SmartTubSecondaryFiltrationCycle, homeassistant.components.smarttub.sensor.SmartTubPrimaryFiltrationCycle, homeassistant.components.smarttub.binary_sensor.SmartTubError, homeassistant.components.smarttub.binary_sensor.SmartTubReminder, homeassistant.components.smartthings.sensor.SmartThingsPowerConsumptionSensor, homeassistant.components.smartthings.scene.SmartThingsScene, homeassistant.components.smartthings.climate.SmartThingsAirConditioner, homeassistant.components.smart_meter_texas.sensor.SmartMeterTexasSensor, homeassistant.components.skybeacon.sensor.SkybeaconTemp, homeassistant.components.skybeacon.sensor.SkybeaconHumid, homeassistant.components.simulated.sensor.SimulatedSensor, homeassistant.components.sighthound.image_processing.SighthoundEntity, homeassistant.components.sigfox.sensor.SigfoxDevice, homeassistant.components.shelly.entity.ShellyBlockAttributeEntity, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.seventeentrack.sensor.SeventeenTrackPackageSensor, homeassistant.components.seventeentrack.sensor.SeventeenTrackSummarySensor, homeassistant.components.sesame.lock.SesameDevice, homeassistant.components.serial.sensor.SerialSensor, homeassistant.components.sensibo.switch.SensiboDeviceSwitch, homeassistant.components.sensibo.sensor.SensiboDeviceSensor, homeassistant.components.script.ScriptEntity, homeassistant.components.roomba.roomba.RoombaVacuum, homeassistant.components.roomba.entity.IRobotVacuum, homeassistant.components.roomba.braava.BraavaJet, homeassistant.components.rmvtransport.sensor.RMVDepartureSensor, homeassistant.components.risco.sensor.RiscoSensor, homeassistant.components.risco.binary_sensor.RiscoLocalBinarySensor, homeassistant.components.ring.camera.RingCam, homeassistant.components.ring.binary_sensor.RingBinarySensor, homeassistant.components.ridwell.sensor.RidwellSensor, homeassistant.components.rfxtrx.entity.RfxtrxEntity, homeassistant.components.rest.sensor.RestSensor, homeassistant.components.repetier.sensor.RepetierSensor, homeassistant.components.rejseplanen.sensor.RejseplanenTransportSensor, homeassistant.components.reddit.sensor.RedditSensor, homeassistant.components.rainforest_raven.sensor.RAVEnSensor, homeassistant.components.raincloud.switch.RainCloudSwitch, homeassistant.components.raincloud.entity.RainCloudEntity, homeassistant.components.rainbird.switch.RainBirdSwitch, homeassistant.components.rachio.switch.RachioSchedule, homeassistant.components.rachio.switch.RachioZone, homeassistant.components.qvr_pro.camera.QVRProCamera, homeassistant.components.qnap.sensor.QNAPDriveSensor, homeassistant.components.qld_bushfire.geo_location.QldBushfireLocationEvent, homeassistant.components.pvpc_hourly_pricing.sensor.ElecPriceSensor, homeassistant.components.push.camera.PushCamera, homeassistant.components.proliphix.climate.ProliphixThermostat, homeassistant.components.private_ble_device.device_tracker.BasePrivateDeviceTracker, homeassistant.components.point.entity.MinutPointEntity, homeassistant.components.plugwise.binary_sensor.PlugwiseBinarySensorEntity, homeassistant.components.plex.sensor.PlexSensor, homeassistant.components.plex.media_player.PlexMediaPlayer, homeassistant.components.plant.Plant, homeassistant.components.pi_hole.binary_sensor.PiHoleBinarySensor, homeassistant.components.pencom.switch.PencomRelay, homeassistant.components.peco.sensor.PecoSensor, homeassistant.components.owntracks.device_tracker.OwnTracksEntity, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.openuv.sensor.OpenUvSensor, homeassistant.components.openhardwaremonitor.sensor.OpenHardwareMonitorDevice, homeassistant.components.openalpr_cloud.image_processing.ImageProcessingAlprEntity, homeassistant.components.onewire.entity.OneWireEntity, homeassistant.components.ohmconnect.sensor.OhmconnectSensor, homeassistant.components.oasa_telematics.sensor.OASATelematicsSensor, homeassistant.components.nx584.binary_sensor.NX584ZoneSensor, homeassistant.components.nsw_rural_fire_service_feed.geo_location.NswRuralFireServiceLocationEvent, homeassistant.components.nsw_fuel_station.sensor.StationPriceSensor, homeassistant.components.norway_air.air_quality.AirSensor, homeassistant.components.noaa_tides.sensor.NOAATidesAndCurrentsSensor, homeassistant.components.nmbs.sensor.NMBSSensor, homeassistant.components.nmbs.sensor.NMBSLiveBoard, homeassistant.components.nissan_leaf.switch.LeafClimateSwitch, homeassistant.components.nissan_leaf.entity.LeafEntity, homeassistant.components.nina.binary_sensor.NINAMessage, homeassistant.components.nilu.air_quality.NiluSensor, homeassistant.components.nexia.climate.NexiaZone, homeassistant.components.nederlandse_spoorwegen.sensor.NSDepartureSensor, homeassistant.components.neato.vacuum.NeatoConnectedVacuum, homeassistant.components.neato.camera.NeatoCleaningMap, homeassistant.components.mysensors.entity.MySensorsChildEntity, homeassistant.components.mysensors.entity.MySensorNodeEntity, homeassistant.components.mvglive.sensor.MVGLiveSensor, homeassistant.components.music_assistant.media_player.MusicAssistantPlayer, homeassistant.components.mqtt_room.sensor.MQTTRoomSensor, homeassistant.components.mqtt.siren.MqttSiren, homeassistant.components.motioneye.sensor.MotionEyeActionSensor, homeassistant.components.motion_blinds.sensor.MotionTDBUBatterySensor, homeassistant.components.motion_blinds.sensor.MotionBatterySensor, homeassistant.components.motion_blinds.cover.MotionTDBUDevice, homeassistant.components.mold_indicator.sensor.MoldIndicator, homeassistant.components.mobile_app.device_tracker.MobileAppEntity, homeassistant.components.min_max.sensor.MinMaxSensor, homeassistant.components.microsoft_face.MicrosoftFaceGroupEntity, homeassistant.components.metoffice.sensor.MetOfficeCurrentSensor, homeassistant.components.melcloud.water_heater.AtwWaterHeater, homeassistant.components.melcloud.climate.AtwDeviceZoneClimate, homeassistant.components.melcloud.climate.AtaDeviceClimate, homeassistant.components.maxcube.climate.MaxCubeClimate, homeassistant.components.manual_mqtt.alarm_control_panel.ManualMQTTAlarm, homeassistant.components.manual.alarm_control_panel.ManualAlarm, homeassistant.components.lutron_caseta.entity.LutronCasetaEntity, homeassistant.components.lutron_caseta.binary_sensor.LutronOccupancySensor, homeassistant.components.lutron.switch.LutronLed, homeassistant.components.lutron.switch.LutronSwitch, homeassistant.components.lutron.light.LutronLight, homeassistant.components.lutron.cover.LutronCover, homeassistant.components.lutron.binary_sensor.LutronOccupancySensor, homeassistant.components.london_underground.sensor.LondonTubeSensor, homeassistant.components.london_air.sensor.AirSensor, homeassistant.components.local_file.camera.LocalFile, homeassistant.components.litterrobot.vacuum.LitterRobotCleaner, homeassistant.components.litejet.switch.LiteJetSwitch, homeassistant.components.litejet.scene.LiteJetScene, homeassistant.components.linux_battery.sensor.LinuxBatterySensor, homeassistant.components.lidarr.sensor.LidarrSensor, homeassistant.components.launch_library.sensor.LaunchLibrarySensor, homeassistant.components.lastfm.sensor.LastFmSensor, homeassistant.components.lacrosse.sensor.LaCrosseSensor, homeassistant.components.knx.sensor.KNXSensor, homeassistant.components.knx.climate.KNXClimate, homeassistant.components.knx.binary_sensor.KNXBinarySensor, homeassistant.components.kiwi.lock.KiwiLock, homeassistant.components.kef.media_player.KefMediaPlayer, homeassistant.components.keba.sensor.KebaSensor, homeassistant.components.keba.binary_sensor.KebaBinarySensor, homeassistant.components.kaiterra.air_quality.KaiterraAirQuality, homeassistant.components.jewish_calendar.sensor.JewishCalendarSensor, homeassistant.components.izone.climate.ZoneDevice, homeassistant.components.izone.climate.ControllerDevice, homeassistant.components.isy994.number.ISYVariableNumberEntity, homeassistant.components.isy994.light.ISYLightEntity, homeassistant.components.isy994.entity.ISYProgramEntity, homeassistant.components.isy994.entity.ISYNodeEntity, homeassistant.components.isy994.binary_sensor.ISYBinarySensorHeartbeat, homeassistant.components.iss.sensor.IssSensor, homeassistant.components.irish_rail_transport.sensor.IrishRailTransportSensor, homeassistant.components.ipp.sensor.IPPSensor, homeassistant.components.iperf3.sensor.Iperf3Sensor, homeassistant.components.iotawatt.sensor.IotaWattSensor, homeassistant.components.ios.sensor.IOSSensor, homeassistant.components.intesishome.climate.IntesisAC, homeassistant.components.integration.sensor.IntegrationSensor, homeassistant.components.insteon.entity.InsteonEntity, homeassistant.components.insteon.climate.InsteonClimateEntity, homeassistant.components.input_text.InputText, homeassistant.components.input_select.InputSelect, homeassistant.components.input_number.InputNumber, homeassistant.components.input_datetime.InputDatetime, homeassistant.components.input_button.InputButton, homeassistant.components.input_boolean.InputBoolean, homeassistant.components.incomfort.water_heater.IncomfortWaterHeater, homeassistant.components.incomfort.sensor.IncomfortSensor, homeassistant.components.incomfort.climate.InComfortClimate, homeassistant.components.incomfort.binary_sensor.IncomfortBinarySensor, homeassistant.components.ihc.entity.IHCEntity, homeassistant.components.ign_sismologia.geo_location.IgnSismologiaLocationEvent, homeassistant.components.icloud.sensor.IcloudDeviceBatterySensor, homeassistant.components.ibeacon.entity.IBeaconEntity, homeassistant.components.hvv_departures.binary_sensor.HvvDepartureBinarySensor, homeassistant.components.husqvarna_automower.sensor.AutomowerSensorEntity, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.hue.v2.sensor.HueZigbeeConnectivitySensor, homeassistant.components.hue.v2.sensor.HueBatterySensor, homeassistant.components.hue.v2.sensor.HueLightLevelSensor, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v2.group.GroupedHueLight, homeassistant.components.hue.v1.sensor.HueLightLevel, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.hue.v1.binary_sensor.HuePresence, homeassistant.components.hue.scene.HueSmartSceneEntity, homeassistant.components.hue.scene.HueSceneEntity, homeassistant.components.huawei_lte.switch.HuaweiLteWifiGuestNetworkSwitch, homeassistant.components.huawei_lte.device_tracker.HuaweiLteScannerEntity, homeassistant.components.huawei_lte.binary_sensor.HuaweiLteMobileConnectionBinarySensor, homeassistant.components.hp_ilo.sensor.HpIloSensor, homeassistant.components.honeywell.climate.HoneywellUSThermostat, homeassistant.components.homematicip_cloud.switch.HomematicipGroupSwitch, homeassistant.components.homematicip_cloud.sensor.HomematicipPassageDetectorDeltaCounter, homeassistant.components.homematicip_cloud.sensor.HmipEsiSensorEntity, homeassistant.components.homematicip_cloud.sensor.HomematicipWindspeedSensor, homeassistant.components.homematicip_cloud.sensor.HomematicipIlluminanceSensor, homeassistant.components.homematicip_cloud.sensor.HomematicipTemperatureSensor, homeassistant.components.homematicip_cloud.lock.HomematicipDoorLockDrive, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homematicip_cloud.climate.HomematicipHeatingGroup, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipSecuritySensorGroup, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipSecurityZoneSensorGroup, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipSunshineSensor, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipShutterContact, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipBaseActionSensor, homeassistant.components.homematic.entity.HMHub, homeassistant.components.homematic.entity.HMDevice, homeassistant.components.homekit_controller.switch.HomeKitValve, homeassistant.components.homekit_controller.switch.HomeKitSwitch, homeassistant.components.homekit_controller.lock.HomeKitLock, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homekit_controller.cover.HomeKitGarageDoorCover, homeassistant.components.homekit_controller.alarm_control_panel.HomeKitAlarmControlPanelEntity, homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor, homeassistant.components.here_travel_time.sensor.DestinationSensor, homeassistant.components.here_travel_time.sensor.OriginSensor, homeassistant.components.heos.media_player.HeosMediaPlayer, homeassistant.components.hdmi_cec.entity.CecEntity, homeassistant.components.hddtemp.sensor.HddTempSensor, homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedSensor, homeassistant.components.harmony.remote.HarmonyRemote, homeassistant.components.habitica.sensor.HabitipyTaskSensor, homeassistant.components.habitica.sensor.HabitipySensor, homeassistant.components.habitica.calendar.HabiticaDailiesCalendarEntity, homeassistant.components.guardian.switch.ValveControllerSwitch, homeassistant.components.gtfs.sensor.GTFSDepartureSensor, homeassistant.components.group.sensor.SensorGroup, homeassistant.components.group.media_player.MediaPlayerGroup, homeassistant.components.group.entity.Group, homeassistant.components.greeneye_monitor.sensor.PulseCounter, homeassistant.components.greeneye_monitor.sensor.CurrentSensor, homeassistant.components.gpsd.sensor.GpsdSensor, homeassistant.components.google_travel_time.sensor.GoogleTravelTimeSensor, homeassistant.components.google.calendar.GoogleCalendarEntity, homeassistant.components.gogogate2.sensor.DoorSensorEntity, homeassistant.components.gitter.sensor.GitterSensor, homeassistant.components.github.sensor.GitHubSensorEntity, homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor, homeassistant.components.geonetnz_quakes.sensor.GeonetnzQuakesSensor, homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent, homeassistant.components.geo_rss_events.sensor.GeoRssServiceSensor, homeassistant.components.geo_json_events.geo_location.GeoJsonLocationEvent, homeassistant.components.geniushub.sensor.GeniusIssue, homeassistant.components.geniushub.entity.GeniusZone, homeassistant.components.geniushub.entity.GeniusDevice, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.gdacs.sensor.GdacsSensor, homeassistant.components.gdacs.geo_location.GdacsEvent, homeassistant.components.garadget.cover.GaradgetCover, homeassistant.components.fritzbox_callmonitor.sensor.FritzBoxCallSensor, homeassistant.components.fritzbox.climate.FritzboxThermostat, homeassistant.components.fritz.switch.FritzBoxDeflectionSwitch, homeassistant.components.fritz.switch.FritzBoxBaseSwitch, homeassistant.components.freebox.sensor.FreeboxCallSensor, homeassistant.components.flo.binary_sensor.FloPendingAlertsBinarySensor, homeassistant.components.flick_electric.sensor.FlickPricingSensor, homeassistant.components.flexit.climate.Flexit, homeassistant.components.fixer.sensor.ExchangeRateSensor, homeassistant.components.fitbit.sensor.FitbitBatterySensor, homeassistant.components.fireservicerota.switch.ResponseSwitch, homeassistant.components.fireservicerota.sensor.IncidentsSensor, homeassistant.components.fireservicerota.binary_sensor.ResponseBinarySensor, homeassistant.components.fints.sensor.FinTsHoldingsAccount, homeassistant.components.fido.sensor.FidoSensor, homeassistant.components.fibaro.entity.FibaroEntity, homeassistant.components.fibaro.binary_sensor.FibaroBinarySensor, homeassistant.components.fail2ban.sensor.BanSensor, homeassistant.components.faa_delays.binary_sensor.FAABinarySensor, homeassistant.components.evohome.entity.EvoDevice, homeassistant.components.epson.media_player.EpsonProjectorMediaPlayer, homeassistant.components.envisalink.sensor.EnvisalinkSensor, homeassistant.components.envisalink.binary_sensor.EnvisalinkBinarySensor, homeassistant.components.environment_canada.sensor.ECAlertSensor, homeassistant.components.entur_public_transport.sensor.EnturPublicTransportSensor, homeassistant.components.elkm1.sensor.ElkZone, homeassistant.components.elkm1.sensor.ElkSetting, homeassistant.components.elkm1.sensor.ElkPanel, homeassistant.components.elkm1.sensor.ElkKeypad, homeassistant.components.elkm1.entity.ElkEntity, homeassistant.components.elkm1.alarm_control_panel.ElkArea, homeassistant.components.ecovacs.vacuum.EcovacsVacuum, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, homeassistant.components.ecobee.climate.Thermostat, homeassistant.components.ebusd.sensor.EbusdSensor, homeassistant.components.dwd_weather_warnings.sensor.DwdWeatherWarningsSensor, homeassistant.components.dublin_bus_transport.sensor.DublinPublicTransportSensor, homeassistant.components.dovado.sensor.DovadoSensor, homeassistant.components.doods.image_processing.Doods, homeassistant.components.dlink.switch.SmartPlugSwitch, homeassistant.components.discogs.sensor.DiscogsSensor, homeassistant.components.directv.media_player.DIRECTVMediaPlayer, homeassistant.components.digital_ocean.switch.DigitalOceanSwitch, homeassistant.components.digital_ocean.binary_sensor.DigitalOceanBinarySensor, homeassistant.components.device_tracker.legacy.Device, homeassistant.components.denonavr.media_player.DenonDevice, homeassistant.components.demo.vacuum.StateDemoVacuum, homeassistant.components.demo.remote.DemoRemote, homeassistant.components.deconz.sensor.DeconzSensor, homeassistant.components.deconz.climate.DeconzThermostat, homeassistant.components.deconz.binary_sensor.DeconzBinarySensor, homeassistant.components.cups.sensor.MarkerSensor, homeassistant.components.cups.sensor.IPPSensor, homeassistant.components.cups.sensor.CupsSensor, homeassistant.components.counter.Counter, homeassistant.components.compensation.sensor.CompensationSensor, homeassistant.components.command_line.sensor.CommandSensor, homeassistant.components.coinbase.sensor.AccountSensor, homeassistant.components.ccm15.climate.CCM15Climate, homeassistant.components.canary.sensor.CanarySensor, homeassistant.components.canary.alarm_control_panel.CanaryAlarm, homeassistant.components.brunt.cover.BruntDevice, homeassistant.components.bosch_shc.sensor.SHCSensor, homeassistant.components.bluesound.media_player.BluesoundPlayer, homeassistant.components.blink.camera.BlinkCamera, homeassistant.components.bayesian.binary_sensor.BayesianBinarySensor, homeassistant.components.bang_olufsen.media_player.BangOlufsenMediaPlayer, homeassistant.components.azure_devops.sensor.AzureDevOpsBuildSensor, homeassistant.components.awair.sensor.AwairSensor, homeassistant.components.automation.AutomationEntity, homeassistant.components.august.sensor.AugustOperatorSensor, homeassistant.components.amcrest.camera.AmcrestCam, homeassistant.components.amberelectric.sensor.AmberForecastSensor, homeassistant.components.amberelectric.sensor.AmberPriceSensor, homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor, homeassistant.components.airnow.sensor.AirNowSensor, homeassistant.components.aftership.sensor.AfterShipSensor, homeassistant.components.accuweather.sensor.AccuWeatherForecastSensor, homeassistant.components.accuweather.sensor.AccuWeatherSensor, homeassistant.components.abode.entity.AbodeDevice, and homeassistant.components.abode.alarm_control_panel.AbodeAlarm.

Definition at line 787 of file entity.py.

force_update()

bool homeassistant.helpers.entity.Entity.force_update

(

self

)

Return True if state updates should be forced.

If True, a state change will be triggered anytime the state property is
updated, not just when the value changes.

Reimplemented in homeassistant.components.mqtt.device_tracker.MqttDeviceTracker, and homeassistant.components.device_tracker.config_entry.TrackerEntity.

Definition at line 848 of file entity.py.

get_hassjob_type()

HassJobType homeassistant.helpers.entity.Entity.get_hassjob_type	(		self,
		str	function_name
	)

Get the job type function for the given name.

This is used for entity service calls to avoid
figuring out the job type each time.

Definition at line 557 of file entity.py.

get_initial_entity_options()

er.EntityOptionsType | None homeassistant.helpers.entity.Entity.get_initial_entity_options

(

self

)

Return initial entity options.

These will be stored in the entity registry the first time the entity is seen,
and then never updated.

Implemented by component base class, should not be extended by integrations.

Note: Not a property to avoid calculating unless needed.

Reimplemented in homeassistant.components.sensor.SensorEntity.

Definition at line 765 of file entity.py.

has_entity_name()

bool homeassistant.helpers.entity.Entity.has_entity_name

(

self

)

Return if the name of the entity is describing only the entity itself.

Definition at line 601 of file entity.py.

icon()

str | None homeassistant.helpers.entity.Entity.icon

(

self

)

Return the icon to use in the frontend, if any.

Reimplemented in homeassistant.helpers.trigger_template_entity.TriggerBaseEntity, homeassistant.components.xiaomi_miio.switch.XiaomiPlugGenericSwitch, homeassistant.components.xiaomi_miio.air_quality.AirMonitorCGDN1, homeassistant.components.xiaomi_miio.air_quality.AirMonitorB1, homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch, homeassistant.components.wemo.switch.WemoSwitch, homeassistant.components.wemo.fan.WemoHumidifier, homeassistant.components.vultr.switch.VultrSwitch, homeassistant.components.vultr.binary_sensor.VultrBinarySensor, homeassistant.components.vicare.fan.ViCareFan, homeassistant.components.viaggiatreno.sensor.ViaggiaTrenoSensor, homeassistant.components.transport_nsw.sensor.TransportNSWSensor, homeassistant.components.torque.sensor.TorqueSensor, homeassistant.components.timer.Timer, homeassistant.components.time_date.sensor.TimeDateSensor, homeassistant.components.swiss_hydrological_data.sensor.SwissHydrologicalDataSensor, homeassistant.components.starline.sensor.StarlineSensor, homeassistant.components.simplefin.sensor.SimpleFinSensor, homeassistant.components.satel_integra.binary_sensor.SatelIntegraBinarySensor, homeassistant.components.rmvtransport.sensor.RMVDepartureSensor, homeassistant.components.reddit.sensor.RedditSensor, homeassistant.components.raincloud.sensor.RainCloudSensor, homeassistant.components.raincloud.entity.RainCloudEntity, homeassistant.components.raincloud.binary_sensor.RainCloudBinarySensor, homeassistant.components.rachio.switch.RachioSchedule, homeassistant.components.obihai.sensor.ObihaiServiceSensors, homeassistant.components.nsw_rural_fire_service_feed.geo_location.NswRuralFireServiceLocationEvent, homeassistant.components.nmbs.sensor.NMBSSensor, homeassistant.components.nmbs.sensor.NMBSLiveBoard, homeassistant.components.nissan_leaf.sensor.LeafBatterySensor, homeassistant.components.netdata.sensor.NetdataAlarms, homeassistant.components.netdata.sensor.NetdataSensor, homeassistant.components.mvglive.sensor.MVGLiveSensor, homeassistant.components.metoffice.sensor.MetOfficeCurrentSensor, homeassistant.components.london_air.sensor.AirSensor, homeassistant.components.litterrobot.sensor.LitterRobotSensorEntity, homeassistant.components.litterrobot.select.LitterRobotSelectEntity, homeassistant.components.lacrosse.sensor.LaCrosseBattery, homeassistant.components.kraken.sensor.KrakenSensor, homeassistant.components.juicenet.sensor.JuiceNetSensorDevice, homeassistant.components.itunes.media_player.AirPlayDevice, homeassistant.components.isy994.switch.ISYSwitchEntity, homeassistant.components.ios.sensor.IOSSensor, homeassistant.components.intesishome.climate.IntesisAC, homeassistant.components.input_text.InputText, homeassistant.components.input_number.InputNumber, homeassistant.components.input_datetime.InputDatetime, homeassistant.components.input_button.InputButton, homeassistant.components.input_boolean.InputBoolean, homeassistant.components.icloud.sensor.IcloudDeviceBatterySensor, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hydrawise.sensor.HydrawiseSensor, homeassistant.components.huum.climate.HuumDevice, homeassistant.components.huawei_lte.sensor.HuaweiLteSensor, homeassistant.components.homematicip_cloud.sensor.HomematicipHeatingThermostat, homeassistant.components.homematicip_cloud.sensor.HomematicipFloorTerminalBlockMechanicChannelValve, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipStormSensor, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor, homeassistant.components.homematic.entity.HMHub, homeassistant.components.homekit_controller.sensor.HomeKitBatterySensor, homeassistant.components.gtfs.sensor.GTFSDepartureSensor, homeassistant.components.group.sensor.SensorGroup, homeassistant.components.gitlab_ci.sensor.GitLabSensor, homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor, homeassistant.components.geonetnz_quakes.sensor.GeonetnzQuakesSensor, homeassistant.components.geo_rss_events.sensor.GeoRssServiceSensor, homeassistant.components.geniushub.sensor.GeniusBattery, homeassistant.components.geniushub.climate.GeniusClimateZone, homeassistant.components.gdacs.geo_location.GdacsEvent, homeassistant.components.fritz.switch.FritzBoxBaseSwitch, homeassistant.components.fitbit.sensor.FitbitBatterySensor, homeassistant.components.fireservicerota.switch.ResponseSwitch, homeassistant.components.fireservicerota.sensor.IncidentsSensor, homeassistant.components.envisalink.sensor.EnvisalinkSensor, homeassistant.components.entur_public_transport.sensor.EnturPublicTransportSensor, homeassistant.components.elkm1.sensor.ElkZone, homeassistant.components.ebusd.sensor.EbusdSensor, homeassistant.components.device_tracker.legacy.Device, homeassistant.components.counter.Counter, homeassistant.components.atag.sensor.AtagSensor, homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor, homeassistant.components.advantage_air.sensor.AdvantageAirZoneSignal, homeassistant.components.advantage_air.sensor.AdvantageAirZoneVent, and homeassistant.components.advantage_air.sensor.AdvantageAirTimeTo.

Definition at line 824 of file entity.py.

name()

str | UndefinedType | None homeassistant.helpers.entity.Entity.name

(

self

)

Return the name of the entity.

Reimplemented in homeassistant.helpers.trigger_template_entity.TriggerBaseEntity, homeassistant.components.zhong_hong.climate.ZhongHongClimate, homeassistant.components.zha.number.ZhaNumber, homeassistant.components.zha.entity.ZHAEntity, homeassistant.components.zestimate.sensor.ZestimateDataSensor, homeassistant.components.zabbix.sensor.ZabbixTriggerCountSensor, homeassistant.components.yi.camera.YiCamera, homeassistant.components.yardian.switch.YardianSwitch, homeassistant.components.yandex_transport.sensor.DiscoverYandexTransport, homeassistant.components.yamaha.media_player.YamahaDeviceZone, homeassistant.components.xs1.switch.XS1SwitchEntity, homeassistant.components.xs1.sensor.XS1Sensor, homeassistant.components.xs1.climate.XS1ThermostatEntity, homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.entity.XiaomiGatewayDevice, homeassistant.components.xiaomi_miio.entity.XiaomiMiioEntity, homeassistant.components.xiaomi_aqara.entity.XiaomiDevice, homeassistant.components.xiaomi.camera.XiaomiCamera, homeassistant.components.xeoma.camera.XeomaCamera, homeassistant.components.xbox.remote.XboxRemote, homeassistant.components.xbox.media_player.XboxMediaPlayer, homeassistant.components.x10.light.X10Light, homeassistant.components.wsdot.sensor.WashingtonStateTransportSensor, homeassistant.components.worxlandroid.sensor.WorxLandroidSensor, homeassistant.components.worldtidesinfo.sensor.WorldTidesInfoSensor, homeassistant.components.wirelesstag.entity.WirelessTagBaseSensor, homeassistant.components.wemo.light.WemoLight, homeassistant.components.w800rf32.binary_sensor.W800rf32BinarySensor, homeassistant.components.vultr.switch.VultrSwitch, homeassistant.components.vultr.sensor.VultrSensor, homeassistant.components.vultr.binary_sensor.VultrBinarySensor, homeassistant.components.vivotek.camera.VivotekCam, homeassistant.components.viaggiatreno.sensor.ViaggiaTrenoSensor, homeassistant.components.versasense.switch.VActuator, homeassistant.components.versasense.sensor.VSensor, homeassistant.components.velux.scene.VeluxScene, homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor, homeassistant.components.uk_transport.sensor.UkTransportSensor, homeassistant.components.transport_nsw.sensor.TransportNSWSensor, homeassistant.components.touchline.climate.Touchline, homeassistant.components.torque.sensor.TorqueSensor, homeassistant.components.todoist.calendar.TodoistProjectEntity, homeassistant.components.tmb.sensor.TMBSensor, homeassistant.components.timer.Timer, homeassistant.components.tfiac.climate.TfiacClimate, homeassistant.components.tensorflow.image_processing.TensorFlowImageProcessor, homeassistant.components.tcp.entity.TcpEntity, homeassistant.components.tasmota.entity.TasmotaEntity, homeassistant.components.tapsaff.binary_sensor.TapsAffSensor, homeassistant.components.tank_utility.sensor.TankUtilitySensor, homeassistant.components.switchmate.switch.SwitchmateEntity, homeassistant.components.swiss_hydrological_data.sensor.SwissHydrologicalDataSensor, homeassistant.components.supervisord.sensor.SupervisorProcessSensor, homeassistant.components.stiebel_eltron.climate.StiebelEltron, homeassistant.components.starlingbank.sensor.StarlingBalanceSensor, homeassistant.components.sony_projector.switch.SonyProjector, homeassistant.components.sonos.switch.SonosAlarmEntity, homeassistant.components.snapcast.media_player.SnapcastClientDevice, homeassistant.components.snapcast.media_player.SnapcastGroupDevice, homeassistant.components.smarttub.switch.SmartTubPump, homeassistant.components.smappee.switch.SmappeeActuator, homeassistant.components.smappee.sensor.SmappeeSensor, homeassistant.components.sma.sensor.SMAsensor, homeassistant.components.skybeacon.sensor.SkybeaconTemp, homeassistant.components.skybeacon.sensor.SkybeaconHumid, homeassistant.components.sisyphus.media_player.SisyphusPlayer, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.simulated.sensor.SimulatedSensor, homeassistant.components.sighthound.image_processing.SighthoundEntity, homeassistant.components.sigfox.sensor.SigfoxDevice, homeassistant.components.seven_segments.image_processing.ImageProcessingSsocr, homeassistant.components.sesame.lock.SesameDevice, homeassistant.components.serial_pm.sensor.ParticulateMatterSensor, homeassistant.components.serial.sensor.SerialSensor, homeassistant.components.scsgate.switch.SCSGateSwitch, homeassistant.components.scsgate.cover.SCSGateCover, homeassistant.components.schluter.climate.SchluterThermostat, homeassistant.components.satel_integra.switch.SatelIntegraSwitch, homeassistant.components.satel_integra.binary_sensor.SatelIntegraBinarySensor, homeassistant.components.rpi_camera.camera.RaspberryCamera, homeassistant.components.rmvtransport.sensor.RMVDepartureSensor, homeassistant.components.ripple.sensor.RippleSensor, homeassistant.components.rflink.entity.RflinkDevice, homeassistant.components.remote_rpi_gpio.switch.RemoteRPiGPIOSwitch, homeassistant.components.remote_rpi_gpio.binary_sensor.RemoteRPiGPIOBinarySensor, homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity, homeassistant.components.rejseplanen.sensor.RejseplanenTransportSensor, homeassistant.components.reddit.sensor.RedditSensor, homeassistant.components.recswitch.switch.RecSwitchSwitch, homeassistant.components.raspyrfm.switch.RaspyRFMSwitch, homeassistant.components.raincloud.entity.RainCloudEntity, homeassistant.components.qwikswitch.entity.QSEntity, homeassistant.components.qvr_pro.camera.QVRProCamera, homeassistant.components.qrcode.image_processing.QrEntity, homeassistant.components.push.camera.PushCamera, homeassistant.components.pulseaudio_loopback.switch.PALoopbackSwitch, homeassistant.components.proxy.camera.ProxyCamera, homeassistant.components.proliphix.climate.ProliphixThermostat, homeassistant.components.pocketcasts.sensor.PocketCastsSensor, homeassistant.components.plant.Plant, homeassistant.components.pioneer.media_player.PioneerDevice, homeassistant.components.pilight.sensor.PilightSensor, homeassistant.components.pilight.entity.PilightBaseDevice, homeassistant.components.pilight.binary_sensor.PilightTriggerSensor, homeassistant.components.pilight.binary_sensor.PilightBinarySensor, homeassistant.components.pi_hole.switch.PiHoleSwitch, homeassistant.components.pencom.switch.PencomRelay, homeassistant.components.panasonic_viera.remote.PanasonicVieraRemoteEntity, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.orvibo.switch.S20Switch, homeassistant.components.opple.light.OppleLight, homeassistant.components.opensensemap.air_quality.OpenSenseMapQuality, homeassistant.components.openhardwaremonitor.sensor.OpenHardwareMonitorDevice, homeassistant.components.openerz.sensor.OpenERZSensor, homeassistant.components.openalpr_cloud.image_processing.OpenAlprCloudEntity, homeassistant.components.ohmconnect.sensor.OhmconnectSensor, homeassistant.components.oem.climate.ThermostatDevice, homeassistant.components.oasa_telematics.sensor.OASATelematicsSensor, homeassistant.components.nx584.binary_sensor.NX584ZoneSensor, homeassistant.components.nsw_fuel_station.sensor.StationPriceSensor, homeassistant.components.norway_air.air_quality.AirSensor, homeassistant.components.noaa_tides.sensor.NOAATidesAndCurrentsSensor, homeassistant.components.nmbs.sensor.NMBSSensor, homeassistant.components.nmbs.sensor.NMBSLiveBoard, homeassistant.components.nissan_leaf.switch.LeafClimateSwitch, homeassistant.components.nissan_leaf.sensor.LeafRangeSensor, homeassistant.components.nissan_leaf.sensor.LeafBatterySensor, homeassistant.components.nissan_leaf.button.LeafChargingButton, homeassistant.components.nissan_leaf.binary_sensor.LeafChargingSensor, homeassistant.components.nissan_leaf.binary_sensor.LeafPluggedInSensor, homeassistant.components.nilu.air_quality.NiluSensor, homeassistant.components.neurio_energy.sensor.NeurioEnergy, homeassistant.components.netio.switch.NetioSwitch, homeassistant.components.netdata.sensor.NetdataAlarms, homeassistant.components.netdata.sensor.NetdataSensor, homeassistant.components.ness_alarm.binary_sensor.NessZoneBinarySensor, homeassistant.components.nederlandse_spoorwegen.sensor.NSDepartureSensor, homeassistant.components.mystrom.binary_sensor.MyStromBinarySensor, homeassistant.components.mysensors.sensor.MyBatterySensor, homeassistant.components.mysensors.entity.MySensorsChildEntity, homeassistant.components.mvglive.sensor.MVGLiveSensor, homeassistant.components.mqtt_room.sensor.MQTTRoomSensor, homeassistant.components.mobile_app.device_tracker.MobileAppEntity, homeassistant.components.microsoft_face_identify.image_processing.MicrosoftFaceIdentifyEntity, homeassistant.components.microsoft_face_detect.image_processing.MicrosoftFaceDetectEntity, homeassistant.components.microsoft_face.MicrosoftFaceGroupEntity, homeassistant.components.microbees.switch.MBSwitch, homeassistant.components.microbees.sensor.MBSensor, homeassistant.components.microbees.light.MBLight, homeassistant.components.microbees.cover.MBCover, homeassistant.components.microbees.button.MBButton, homeassistant.components.microbees.binary_sensor.MBBinarySensor, homeassistant.components.mfi.switch.MfiSwitch, homeassistant.components.mfi.sensor.MfiSensor, homeassistant.components.meteoclimatic.weather.MeteoclimaticWeather, homeassistant.components.meteo_france.weather.MeteoFranceWeather, homeassistant.components.melissa.climate.MelissaClimate, homeassistant.components.mediaroom.media_player.MediaroomDevice, homeassistant.components.matter.entity.MatterEntity, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.london_underground.sensor.LondonTubeSensor, homeassistant.components.london_air.sensor.AirSensor, homeassistant.components.lifx_cloud.scene.LifxCloudScene, homeassistant.components.lcn.entity.LcnEntity, homeassistant.components.kwb.sensor.KWBSensor, homeassistant.components.knx.entity._KnxEntityBase, homeassistant.components.kiwi.lock.KiwiLock, homeassistant.components.kankun.switch.KankunSwitch, homeassistant.components.kaiterra.air_quality.KaiterraAirQuality, homeassistant.components.itunes.media_player.AirPlayDevice, homeassistant.components.itunes.media_player.ItunesDevice, homeassistant.components.itach.remote.ITachIP2IRRemote, homeassistant.components.irish_rail_transport.sensor.IrishRailTransportSensor, homeassistant.components.iotawatt.sensor.IotaWattSensor, homeassistant.components.intesishome.climate.IntesisAC, homeassistant.components.insteon.entity.InsteonEntity, homeassistant.components.input_text.InputText, homeassistant.components.input_number.InputNumber, homeassistant.components.input_datetime.InputDatetime, homeassistant.components.input_button.InputButton, homeassistant.components.input_boolean.InputBoolean, homeassistant.components.influxdb.sensor.InfluxSensor, homeassistant.components.ihc.entity.IHCEntity, homeassistant.components.ign_sismologia.geo_location.IgnSismologiaLocationEvent, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.hue.v2.binary_sensor.HueEntertainmentActiveSensor, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.hue.switch.HueBehaviorInstanceEnabledEntity, homeassistant.components.hue.scene.HueSceneEntityBase, homeassistant.components.huawei_lte.device_tracker.HuaweiLteScannerEntity, homeassistant.components.hp_ilo.sensor.HpIloSensor, homeassistant.components.horizon.media_player.HorizonDevice, homeassistant.components.homematicip_cloud.weather.HomematicipHomeWeather, homeassistant.components.homematicip_cloud.weather.HomematicipWeatherSensor, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homematicip_cloud.binary_sensor.HomematicipCloudConnectionSensor, homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity, homeassistant.components.homematic.entity.HMHub, homeassistant.components.homematic.entity.HMDevice, homeassistant.components.homekit_controller.switch.DeclarativeCharacteristicSwitch, homeassistant.components.homekit_controller.sensor.RSSISensor, homeassistant.components.homekit_controller.sensor.SimpleSensor, homeassistant.components.homekit_controller.sensor.HomeKitSensor, homeassistant.components.homekit_controller.select.EcobeeModeSelect, homeassistant.components.homekit_controller.select.HomeKitSelect, homeassistant.components.homekit_controller.number.HomeKitNumber, homeassistant.components.homekit_controller.entity.HomeKitEntity, homeassistant.components.homekit_controller.button.HomeKitProvisionPreferredThreadCredentials, homeassistant.components.homekit_controller.button.HomeKitEcobeeClearHoldButton, homeassistant.components.homekit_controller.button.HomeKitButton, homeassistant.components.homekit_controller.binary_sensor.HomeKitBatteryLowSensor, homeassistant.components.hikvisioncam.switch.HikvisionMotionSwitch, homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor, homeassistant.components.heatmiser.climate.HeatmiserV3Thermostat, homeassistant.components.haveibeenpwned.sensor.HaveIBeenPwnedSensor, homeassistant.components.harman_kardon_avr.media_player.HkAvrDevice, homeassistant.components.gtfs.sensor.GTFSDepartureSensor, homeassistant.components.gstreamer.media_player.GstreamerDevice, homeassistant.components.group.media_player.MediaPlayerGroup, homeassistant.components.gogogate2.sensor.DoorSensorTemperature, homeassistant.components.gogogate2.sensor.DoorSensorBattery, homeassistant.components.gogogate2.cover.DeviceCover, homeassistant.components.gitter.sensor.GitterSensor, homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor, homeassistant.components.geonetnz_quakes.sensor.GeonetnzQuakesSensor, homeassistant.components.geo_rss_events.sensor.GeoRssServiceSensor, homeassistant.components.geniushub.entity.GeniusZone, homeassistant.components.generic_hygrostat.humidifier.GenericHygrostat, homeassistant.components.generic.camera.GenericCamera, homeassistant.components.gc100.switch.GC100Switch, homeassistant.components.gc100.binary_sensor.GC100BinarySensor, homeassistant.components.garadget.cover.GaradgetCover, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.fritz.switch.FritzBoxBaseSwitch, homeassistant.components.forked_daapd.media_player.ForkedDaapdMaster, homeassistant.components.forked_daapd.media_player.ForkedDaapdZone, homeassistant.components.flux.switch.FluxSwitch, homeassistant.components.fixer.sensor.ExchangeRateSensor, homeassistant.components.ffmpeg.camera.FFmpegCamera, homeassistant.components.familyhub.camera.FamilyHubCamera, homeassistant.components.fail2ban.sensor.BanSensor, homeassistant.components.evohome.climate.EvoZone, homeassistant.components.eufy.switch.EufyHomeSwitch, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.etherscan.sensor.EtherscanSensor, homeassistant.components.envisalink.entity.EnvisalinkEntity, homeassistant.components.entur_public_transport.sensor.EnturPublicTransportSensor, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.elv.switch.SmartPlugSwitch, homeassistant.components.egardia.binary_sensor.EgardiaBinarySensor, homeassistant.components.edimax.switch.SmartPlugSwitch, homeassistant.components.ebusd.sensor.EbusdSensor, homeassistant.components.dweet.sensor.DweetSensor, homeassistant.components.dublin_bus_transport.sensor.DublinPublicTransportSensor, homeassistant.components.doods.image_processing.Doods, homeassistant.components.dominos.DominosOrder, homeassistant.components.dlib_face_identify.image_processing.DlibFaceIdentifyEntity, homeassistant.components.dlib_face_detect.image_processing.DlibFaceDetectEntity, homeassistant.components.digital_ocean.switch.DigitalOceanSwitch, homeassistant.components.digital_ocean.binary_sensor.DigitalOceanBinarySensor, homeassistant.components.device_tracker.legacy.Device, homeassistant.components.denon.media_player.DenonDevice, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.danfoss_air.switch.DanfossAir, homeassistant.components.daikin.switch.DaikinZoneSwitch, homeassistant.components.currencylayer.sensor.CurrencylayerSensor, homeassistant.components.cups.sensor.IPPSensor, homeassistant.components.cups.sensor.CupsSensor, homeassistant.components.counter.Counter, homeassistant.components.concord232.binary_sensor.Concord232ZoneSensor, homeassistant.components.channels.media_player.ChannelsPlayer, homeassistant.components.ampio.air_quality.AmpioSmogQuality, and homeassistant.components.amcrest.camera.AmcrestCam.

Definition at line 738 of file entity.py.

schedule_update_ha_state()

None homeassistant.helpers.entity.Entity.schedule_update_ha_state	(		self,
		bool	force_refresh = False
	)

Schedule an update ha state change task.

Scheduling the update avoids executor deadlocks.

Entity state and attributes are read when the update ha state change
task is executed.
If state is changed more than once before the ha state change task has
been executed, the intermediate state transitions will be missed.

Definition at line 1244 of file entity.py.

should_poll()

bool homeassistant.helpers.entity.Entity.should_poll

(

self

)

Return True if entity has to be polled for state.

False if entity pushes its state to HA.

Reimplemented in homeassistant.components.tasmota.entity.TasmotaEntity, homeassistant.components.smlight.binary_sensor.SmInternetSensorEntity, homeassistant.components.litterrobot.update.RobotUpdateEntity, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedFront, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase, homeassistant.components.egardia.alarm_control_panel.EgardiaAlarm, homeassistant.components.device_tracker.config_entry.TrackerEntity, homeassistant.components.bosch_shc.switch.SHCSwitch, and homeassistant.components.airgradient.update.AirGradientUpdate.

Definition at line 572 of file entity.py.

state()

StateType homeassistant.helpers.entity.Entity.state

(

self

)

Return the state of the entity.

Reimplemented in homeassistant.helpers.entity.ToggleEntity, homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.xiaomi_miio.vacuum.MiroboVacuum, homeassistant.components.xbox.media_player.XboxMediaPlayer, homeassistant.components.weather.WeatherEntity, homeassistant.components.water_heater.WaterHeaterEntity, homeassistant.components.wake_word.WakeWordDetectionEntity, homeassistant.components.volumio.media_player.Volumio, homeassistant.components.valve.ValveEntity, homeassistant.components.vacuum.StateVacuumEntity, homeassistant.components.update.UpdateEntity, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.tuya.vacuum.TuyaVacuumEntity, homeassistant.components.tts.TextToSpeechEntity, homeassistant.components.todo.TodoListEntity, homeassistant.components.timer.Timer, homeassistant.components.time.TimeEntity, homeassistant.components.text.TextEntity, homeassistant.components.tessie.media_player.TessieMediaEntity, homeassistant.components.tensorflow.image_processing.TensorFlowImageProcessor, homeassistant.components.template.vacuum.TemplateVacuum, homeassistant.components.tag.TagEntity, homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer, homeassistant.components.sun.entity.Sun, homeassistant.components.stt.SpeechToTextEntity, homeassistant.components.squeezebox.media_player.SqueezeBoxMediaPlayerEntity, homeassistant.components.spotify.media_player.SpotifyMediaPlayer, homeassistant.components.soundtouch.media_player.SoundTouchMediaPlayer, homeassistant.components.sonos.media_player.SonosMediaPlayerEntity, homeassistant.components.songpal.media_player.SongpalEntity, homeassistant.components.snapcast.media_player.SnapcastClientDevice, homeassistant.components.snapcast.media_player.SnapcastGroupDevice, homeassistant.components.slimproto.media_player.SlimProtoPlayer, homeassistant.components.sisyphus.media_player.SisyphusPlayer, homeassistant.components.sighthound.image_processing.SighthoundEntity, homeassistant.components.sharkiq.vacuum.SharkVacuumEntity, homeassistant.components.seven_segments.image_processing.ImageProcessingSsocr, homeassistant.components.sensor.SensorEntity, homeassistant.components.select.SelectEntity, homeassistant.components.scene.Scene, homeassistant.components.russound_rio.media_player.RussoundZoneDevice, homeassistant.components.roomba.entity.IRobotVacuum, homeassistant.components.roku.media_player.RokuMediaPlayer, homeassistant.components.roborock.vacuum.RoborockVacuum, homeassistant.components.remember_the_milk.entity.RememberTheMilkEntity, homeassistant.components.qrcode.image_processing.QrEntity, homeassistant.components.private_ble_device.device_tracker.BasePrivateDeviceTracker, homeassistant.components.plant.Plant, homeassistant.components.pioneer.media_player.PioneerDevice, homeassistant.components.panasonic_viera.media_player.PanasonicVieraTVEntity, homeassistant.components.openalpr_cloud.image_processing.ImageProcessingAlprEntity, homeassistant.components.number.NumberEntity, homeassistant.components.notify.NotifyEntity, homeassistant.components.mpd.media_player.MpdDevice, homeassistant.components.microsoft_face.MicrosoftFaceGroupEntity, homeassistant.components.media_player.MediaPlayerEntity, homeassistant.components.lock.LockEntity, homeassistant.components.litterrobot.vacuum.LitterRobotCleaner, homeassistant.components.lawn_mower.LawnMowerEntity, homeassistant.components.kaleidescape.media_player.KaleidescapeMediaPlayer, homeassistant.components.itunes.media_player.AirPlayDevice, homeassistant.components.itunes.media_player.ItunesDevice, homeassistant.components.input_text.InputText, homeassistant.components.input_number.InputNumber, homeassistant.components.input_datetime.InputDatetime, homeassistant.components.image_processing.ImageProcessingFaceEntity, homeassistant.components.image.ImageEntity, homeassistant.components.ibeacon.device_tracker.IBeaconTrackerEntity, homeassistant.components.homematic.entity.HMHub, homeassistant.components.homekit_controller.media_player.HomeKitTelevision, homeassistant.components.heos.media_player.HeosMediaPlayer, homeassistant.components.group.entity.Group, homeassistant.components.geo_location.GeolocationEvent, homeassistant.components.forked_daapd.media_player.ForkedDaapdMaster, homeassistant.components.forked_daapd.media_player.ForkedDaapdZone, homeassistant.components.event.EventEntity, homeassistant.components.esphome.media_player.EsphomeMediaPlayer, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.ecovacs.vacuum.EcovacsLegacyVacuum, homeassistant.components.dunehd.media_player.DuneHDPlayerEntity, homeassistant.components.doods.image_processing.Doods, homeassistant.components.dominos.DominosOrder, homeassistant.components.directv.media_player.DIRECTVMediaPlayer, homeassistant.components.device_tracker.legacy.Device, homeassistant.components.device_tracker.config_entry.ScannerEntity, homeassistant.components.device_tracker.config_entry.TrackerEntity, homeassistant.components.devialet.media_player.DevialetMediaPlayerEntity, homeassistant.components.denonavr.media_player.DenonDevice, homeassistant.components.denon.media_player.DenonDevice, homeassistant.components.demo.vacuum.StateDemoVacuum, homeassistant.components.datetime.DateTimeEntity, homeassistant.components.date.DateEntity, homeassistant.components.cover.CoverEntity, homeassistant.components.counter.Counter, homeassistant.components.conversation.entity.ConversationEntity, homeassistant.components.control4.media_player.Control4Room, homeassistant.components.climate.ClimateEntity, homeassistant.components.channels.media_player.ChannelsPlayer, homeassistant.components.cast.media_player.CastMediaPlayerEntity, homeassistant.components.camera.Camera, homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice, homeassistant.components.calendar.CalendarEntity, homeassistant.components.button.ButtonEntity, homeassistant.components.braviatv.media_player.BraviaTVMediaPlayer, homeassistant.components.bluesound.media_player.BluesoundPlayer, homeassistant.components.bang_olufsen.media_player.BangOlufsenMediaPlayer, homeassistant.components.arcam_fmj.media_player.ArcamFmj, homeassistant.components.apple_tv.media_player.AppleTvMediaPlayer, homeassistant.components.androidtv_remote.media_player.AndroidTVRemoteMediaPlayerEntity, homeassistant.components.alert.entity.AlertEntity, homeassistant.components.alarm_control_panel.AlarmControlPanelEntity, and homeassistant.components.air_quality.AirQualityEntity.

Definition at line 750 of file entity.py.

state_attributes()

dict[str, Any] | None homeassistant.helpers.entity.Entity.state_attributes

(

self

)

Return the state attributes.

Implemented by component base class, should not be extended by integrations.
Convention for attribute names is lowercase snake_case.

Reimplemented in homeassistant.components.weather.WeatherEntity, homeassistant.components.water_heater.WaterHeaterEntity, homeassistant.components.valve.ValveEntity, homeassistant.components.vacuum.StateVacuumEntity, homeassistant.components.update.UpdateEntity, homeassistant.components.time.TimeEntity, homeassistant.components.sensor.SensorEntity, homeassistant.components.remote.RemoteEntity, homeassistant.components.media_player.MediaPlayerEntity, homeassistant.components.lock.LockEntity, homeassistant.components.light.LightEntity, homeassistant.components.image_processing.ImageProcessingFaceEntity, homeassistant.components.image.ImageEntity, homeassistant.components.humidifier.HumidifierEntity, homeassistant.components.geo_location.GeolocationEvent, homeassistant.components.fan.FanEntity, homeassistant.components.event.EventEntity, homeassistant.components.device_tracker.legacy.Device, homeassistant.components.device_tracker.config_entry.ScannerEntity, homeassistant.components.device_tracker.config_entry.TrackerEntity, homeassistant.components.device_tracker.config_entry.BaseTrackerEntity, homeassistant.components.datetime.DateTimeEntity, homeassistant.components.date.DateEntity, homeassistant.components.cover.CoverEntity, homeassistant.components.climate.ClimateEntity, homeassistant.components.camera.Camera, homeassistant.components.calendar.CalendarEntity, homeassistant.components.alarm_control_panel.AlarmControlPanelEntity, and homeassistant.components.air_quality.AirQualityEntity.

Definition at line 778 of file entity.py.

suggested_object_id()

str | None homeassistant.helpers.entity.Entity.suggested_object_id

(

self

)

Return input for object id.

Definition at line 716 of file entity.py.

supported_features()

int | None homeassistant.helpers.entity.Entity.supported_features

(

self

)

Flag supported features.

Reimplemented in homeassistant.components.zwave_js.fan.ZwaveThermostatFan, homeassistant.components.zwave_js.fan.ValueMappingZwaveFan, homeassistant.components.yeelight.light.YeelightNightLightMode, homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.yamaha.media_player.YamahaDeviceZone, homeassistant.components.xbox.media_player.XboxMediaPlayer, homeassistant.components.webostv.media_player.LgWebOSMediaPlayerEntity, homeassistant.components.weatherkit.weather.WeatherKitWeather, homeassistant.components.water_heater.WaterHeaterEntity, homeassistant.components.venstar.climate.VenstarThermostat, homeassistant.components.velux.cover.VeluxCover, homeassistant.components.valve.ValveEntity, homeassistant.components.vacuum.StateVacuumEntity, homeassistant.components.uvc.camera.UnifiVideoCamera, homeassistant.components.update.UpdateEntity, homeassistant.components.upb.light.UpbLight, homeassistant.components.universal.media_player.UniversalMediaPlayer, homeassistant.components.tessie.update.TessieUpdateEntity, homeassistant.components.tesla_fleet.climate.TeslaFleetCabinOverheatProtectionEntity, homeassistant.components.tedee.lock.TedeeLockWithLatchEntity, homeassistant.components.system_bridge.media_player.SystemBridgeMediaPlayer, homeassistant.components.spotify.media_player.SpotifyMediaPlayer, homeassistant.components.siren.SirenEntity, homeassistant.components.samsungtv.media_player.SamsungTVDevice, homeassistant.components.reolink.update.ReolinkUpdateBaseEntity, homeassistant.components.remote.RemoteEntity, homeassistant.components.plex.media_player.PlexMediaPlayer, homeassistant.components.philips_js.media_player.PhilipsTVMediaPlayer, homeassistant.components.overkiz.cover.vertical_cover.VerticalCover, homeassistant.components.overkiz.cover.generic_cover.OverkizGenericCover, homeassistant.components.overkiz.cover.awning.Awning, homeassistant.components.onkyo.media_player.OnkyoMediaPlayer, homeassistant.components.netatmo.camera.NetatmoCamera, homeassistant.components.mysensors.remote.MySensorsRemote, homeassistant.components.mysensors.climate.MySensorsHVAC, homeassistant.components.mqtt.update.MqttUpdate, homeassistant.components.mpd.media_player.MpdDevice, homeassistant.components.motion_blinds.cover.MotionTiltOnlyDevice, homeassistant.components.media_player.MediaPlayerEntity, homeassistant.components.lock.LockEntity, homeassistant.components.light.LightEntity, homeassistant.components.lg_netcast.media_player.LgTVDevice, homeassistant.components.lawn_mower.LawnMowerEntity, homeassistant.components.knx.fan.KNXFan, homeassistant.components.jellyfin.media_player.JellyfinMediaPlayer, homeassistant.components.izone.climate.ZoneDevice, homeassistant.components.iotty.cover.IottyShutter, homeassistant.components.humidifier.HumidifierEntity, homeassistant.components.homematic.light.HMLight, homeassistant.components.homekit_controller.media_player.HomeKitTelevision, homeassistant.components.homekit_controller.fan.BaseHomeKitFan, homeassistant.components.homekit_controller.cover.HomeKitWindowCover, homeassistant.components.homekit_controller.climate.HomeKitClimateEntity, homeassistant.components.homekit_controller.climate.HomeKitHeaterCoolerEntity, homeassistant.components.homekit_controller.climate.HomeKitBaseClimateEntity, homeassistant.components.hdmi_cec.media_player.CecPlayerEntity, homeassistant.components.forked_daapd.media_player.ForkedDaapdMaster, homeassistant.components.forked_daapd.media_player.ForkedDaapdZone, homeassistant.components.fan.FanEntity, homeassistant.components.emby.media_player.EmbyDevice, homeassistant.components.econet.water_heater.EcoNetWaterHeater, homeassistant.components.ecobee.climate.Thermostat, homeassistant.components.dunehd.media_player.DuneHDPlayerEntity, homeassistant.components.directv.media_player.DIRECTVMediaPlayer, homeassistant.components.devialet.media_player.DevialetMediaPlayerEntity, homeassistant.components.denonavr.media_player.DenonDevice, homeassistant.components.denon.media_player.DenonDevice, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.cover.CoverEntity, homeassistant.components.coolmaster.climate.CoolmasterClimate, homeassistant.components.control4.light.Control4Light, homeassistant.components.climate.ClimateEntity, homeassistant.components.cast.media_player.CastMediaPlayerEntity, homeassistant.components.camera.Camera, homeassistant.components.cambridge_audio.media_player.CambridgeAudioDevice, homeassistant.components.bluesound.media_player.BluesoundPlayer, homeassistant.components.bang_olufsen.media_player.BangOlufsenMediaPlayer, homeassistant.components.aprilaire.climate.AprilaireClimate, homeassistant.components.aosmith.water_heater.AOSmithWaterHeaterEntity, homeassistant.components.alarm_control_panel.AlarmControlPanelEntity, and homeassistant.components.acmeda.cover.AcmedaCover.

Definition at line 861 of file entity.py.

translation_key()

str | None homeassistant.helpers.entity.Entity.translation_key

(

self

)

Return the translation key to translate the entity's states.

Reimplemented in homeassistant.components.husqvarna_automower.sensor.WorkAreaSensorEntity, and homeassistant.components.husqvarna_automower.number.WorkAreaNumberEntity.

Definition at line 904 of file entity.py.

translation_placeholders()

Mapping[str, str] homeassistant.helpers.entity.Entity.translation_placeholders

(

self

)

Return the translation placeholders for translated entity's name.

Definition at line 914 of file entity.py.

unique_id()

str | None homeassistant.helpers.entity.Entity.unique_id

(

self

)

Return a unique ID.

Reimplemented in homeassistant.helpers.trigger_template_entity.TriggerBaseEntity, homeassistant.components.zhong_hong.climate.ZhongHongClimate, homeassistant.components.zha.device_tracker.ZHADeviceScannerEntity, homeassistant.components.zestimate.sensor.ZestimateDataSensor, homeassistant.components.yeelight.light.YeelightAmbientLight, homeassistant.components.yeelight.light.YeelightNightLightMode, homeassistant.components.yeelight.entity.YeelightEntity, homeassistant.components.yeelight.binary_sensor.YeelightNightlightModeSensor, homeassistant.components.yamaha_musiccast.media_player.MusicCastMediaPlayer, homeassistant.components.xiaomi_miio.remote.XiaomiMiioRemote, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.entity.XiaomiGatewayDevice, homeassistant.components.xiaomi_miio.entity.XiaomiMiioEntity, homeassistant.components.xiaomi_aqara.entity.XiaomiDevice, homeassistant.components.xbox.remote.XboxRemote, homeassistant.components.xbox.media_player.XboxMediaPlayer, homeassistant.components.wemo.light.WemoLight, homeassistant.components.versasense.switch.VActuator, homeassistant.components.versasense.sensor.VSensor, homeassistant.components.verisure.binary_sensor.VerisureEthernetStatus, homeassistant.components.verisure.alarm_control_panel.VerisureAlarm, homeassistant.components.venstar.sensor.VenstarSensor, homeassistant.components.upb.entity.UpbEntity, homeassistant.components.unifi.device_tracker.UnifiScannerEntity, homeassistant.components.tmb.sensor.TMBSensor, homeassistant.components.timer.Timer, homeassistant.components.tellduslive.sensor.TelldusLiveSensor, homeassistant.components.tellduslive.entity.TelldusLiveEntity, homeassistant.components.tasmota.entity.TasmotaEntity, homeassistant.components.syncthru.sensor.SyncThruSensor, homeassistant.components.syncthru.binary_sensor.SyncThruBinarySensor, homeassistant.components.switchmate.switch.SwitchmateEntity, homeassistant.components.swiss_hydrological_data.sensor.SwissHydrologicalDataSensor, homeassistant.components.songpal.media_player.SongpalEntity, homeassistant.components.soma.entity.SomaEntity, homeassistant.components.solaredge.sensor.SolarEdgeDetailsSensor, homeassistant.components.solaredge.sensor.SolarEdgeSensorEntity, homeassistant.components.smappee.switch.SmappeeActuator, homeassistant.components.smappee.sensor.SmappeeSensor, homeassistant.components.sisyphus.media_player.SisyphusPlayer, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.shelly.climate.BlockSleepingClimate, homeassistant.components.schluter.climate.SchluterThermostat, homeassistant.components.roomba.sensor.RoombaSensor, homeassistant.components.roomba.entity.IRobotEntity, homeassistant.components.roomba.binary_sensor.RoombaBinStatus, homeassistant.components.recswitch.switch.RecSwitchSwitch, homeassistant.components.rachio.switch.RachioRainDelay, homeassistant.components.rachio.switch.RachioStandbySwitch, homeassistant.components.rachio.binary_sensor.RachioRainSensor, homeassistant.components.rachio.binary_sensor.RachioControllerOnlineBinarySensor, homeassistant.components.qwikswitch.sensor.QSSensor, homeassistant.components.qwikswitch.entity.QSEntity, homeassistant.components.qwikswitch.binary_sensor.QSBinarySensor, homeassistant.components.powerwall.sensor.PowerWallBackupReserveSensor, homeassistant.components.powerwall.sensor.PowerWallChargeSensor, homeassistant.components.powerwall.binary_sensor.PowerWallChargingStatusSensor, homeassistant.components.powerwall.binary_sensor.PowerWallGridStatusSensor, homeassistant.components.powerwall.binary_sensor.PowerWallGridServicesActiveSensor, homeassistant.components.powerwall.binary_sensor.PowerWallConnectedSensor, homeassistant.components.powerwall.binary_sensor.PowerWallRunningSensor, homeassistant.components.pi_hole.switch.PiHoleSwitch, homeassistant.components.panasonic_viera.remote.PanasonicVieraRemoteEntity, homeassistant.components.owntracks.device_tracker.OwnTracksEntity, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.oru.sensor.CurrentEnergyUsageSensor, homeassistant.components.opple.light.OppleLight, homeassistant.components.nuki.sensor.NukiBatterySensor, homeassistant.components.nuki.binary_sensor.NukiBatteryChargingEntity, homeassistant.components.nuki.binary_sensor.NukiBatteryCriticalEntity, homeassistant.components.nuki.binary_sensor.NukiRingactionEntity, homeassistant.components.nuki.binary_sensor.NukiDoorsensorEntity, homeassistant.components.nsw_fuel_station.sensor.StationPriceSensor, homeassistant.components.nmbs.sensor.NMBSLiveBoard, homeassistant.components.mysensors.sensor.MyBatterySensor, homeassistant.components.mysensors.entity.MySensorsChildEntity, homeassistant.components.music_assistant.entity.MusicAssistantEntity, homeassistant.components.mobile_app.device_tracker.MobileAppEntity, homeassistant.components.mfi.switch.MfiSwitch, homeassistant.components.meteoclimatic.weather.MeteoclimaticWeather, homeassistant.components.meteo_france.weather.MeteoFranceWeather, homeassistant.components.mediaroom.media_player.MediaroomDevice, homeassistant.components.lutron_caseta.entity.LutronCasetaEntity, homeassistant.components.lutron_caseta.binary_sensor.LutronOccupancySensor, homeassistant.components.lutron.entity.LutronBaseEntity, homeassistant.components.lcn.entity.LcnEntity, homeassistant.components.kaiterra.air_quality.KaiterraAirQuality, homeassistant.components.intesishome.climate.IntesisAC, homeassistant.components.insteon.entity.InsteonEntity, homeassistant.components.input_text.InputText, homeassistant.components.input_number.InputNumber, homeassistant.components.input_datetime.InputDatetime, homeassistant.components.ihc.entity.IHCEntity, homeassistant.components.hue.v1.sensor.HueBattery, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.huawei_lte.entity.HuaweiLteBaseEntity, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematicip_cloud.entity.HomematicipGenericEntity, homeassistant.components.homematicip_cloud.alarm_control_panel.HomematicipAlarmControlPanelEntity, homeassistant.components.homematic.entity.HMDevice, homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor, homeassistant.components.geonetnz_quakes.sensor.GeonetnzQuakesSensor, homeassistant.components.geniushub.entity.GeniusEntity, homeassistant.components.fritz.switch.FritzBoxBaseSwitch, homeassistant.components.forked_daapd.media_player.ForkedDaapdMaster, homeassistant.components.forked_daapd.media_player.ForkedDaapdZone, homeassistant.components.eufy.switch.EufyHomeSwitch, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.energy.sensor.EnergyCostSensor, homeassistant.components.elkm1.entity.ElkEntity, homeassistant.components.edimax.switch.SmartPlugSwitch, homeassistant.components.ecobee.sensor.EcobeeSensor, homeassistant.components.ecobee.binary_sensor.EcobeeBinarySensor, homeassistant.components.dynalite.entity.DynaliteBase, homeassistant.components.devolo_home_control.sensor.DevoloConsumptionEntity, homeassistant.components.device_tracker.config_entry.ScannerEntity, homeassistant.components.demo.light.DemoLight, homeassistant.components.demo.fan.BaseDemoFan, homeassistant.components.demo.cover.DemoCover, homeassistant.components.demo.climate.DemoClimate, homeassistant.components.demo.binary_sensor.DemoBinarySensor, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.daikin.climate.DaikinClimate, homeassistant.components.counter.Counter, homeassistant.components.awair.sensor.AwairSensor, and homeassistant.components.ampio.air_quality.AmpioSmogQuality.

Definition at line 580 of file entity.py.

unit_of_measurement()

str | None homeassistant.helpers.entity.Entity.unit_of_measurement

(

self

)

Return the unit of measurement of this entity, if any.

Reimplemented in homeassistant.components.xiaomi_miio.air_quality.AirMonitorV1, homeassistant.components.sensor.SensorEntity, homeassistant.components.number.NumberEntity, homeassistant.components.norway_air.air_quality.AirSensor, homeassistant.components.input_text.InputText, homeassistant.components.input_number.InputNumber, homeassistant.components.demo.geo_location.DemoGeolocationEvent, and homeassistant.components.air_quality.AirQualityEntity.

Definition at line 815 of file entity.py.

use_device_name()

bool homeassistant.helpers.entity.Entity.use_device_name

(

self

)

Return if this entity does not have its own name.

Should be True if the entity represents the single main feature of a device.

Definition at line 585 of file entity.py.

Member Data Documentation

__capabilities_updated_at

homeassistant.helpers.entity.Entity.__capabilities_updated_at

private

Definition at line 1168 of file entity.py.

__capabilities_updated_at_reported

homeassistant.helpers.entity.Entity.__capabilities_updated_at_reported

private

Definition at line 1176 of file entity.py.

__combined_unrecorded_attributes

homeassistant.helpers.entity.Entity.__combined_unrecorded_attributes

private

Definition at line 553 of file entity.py.

__remove_future

homeassistant.helpers.entity.Entity.__remove_future

private

Definition at line 1401 of file entity.py.

_async_update_ha_state_reported [1/2]

bool homeassistant.helpers.entity.Entity._async_update_ha_state_reported = False

staticprivate

Definition at line 465 of file entity.py.

_async_update_ha_state_reported [2/2]

homeassistant.helpers.entity.Entity._async_update_ha_state_reported

private

Definition at line 976 of file entity.py.

_context

homeassistant.helpers.entity.Entity._context

private

Definition at line 939 of file entity.py.

_context_set

homeassistant.helpers.entity.Entity._context_set

private

Definition at line 940 of file entity.py.

_deprecated_supported_features_reported [1/2]

bool homeassistant.helpers.entity.Entity._deprecated_supported_features_reported = False

staticprivate

Definition at line 458 of file entity.py.

_deprecated_supported_features_reported [2/2]

homeassistant.helpers.entity.Entity._deprecated_supported_features_reported

private

Definition at line 1649 of file entity.py.

_disabled_reported [1/2]

bool homeassistant.helpers.entity.Entity._disabled_reported = False

staticprivate

Definition at line 461 of file entity.py.

_disabled_reported [2/2]

homeassistant.helpers.entity.Entity._disabled_reported

private

Definition at line 1135 of file entity.py.

_job_types

homeassistant.helpers.entity.Entity._job_types

private

Definition at line 564 of file entity.py.

_name_translation_placeholders_reported [1/2]

bool homeassistant.helpers.entity.Entity._name_translation_placeholders_reported = False

staticprivate

Definition at line 471 of file entity.py.

_name_translation_placeholders_reported [2/2]

homeassistant.helpers.entity.Entity._name_translation_placeholders_reported

private

Definition at line 686 of file entity.py.

_no_platform_reported [1/2]

bool homeassistant.helpers.entity.Entity._no_platform_reported = False

staticprivate

Definition at line 468 of file entity.py.

_no_platform_reported [2/2]

homeassistant.helpers.entity.Entity._no_platform_reported

private

Definition at line 1000 of file entity.py.

_on_remove

homeassistant.helpers.entity.Entity._on_remove

private

Definition at line 1334 of file entity.py.

_platform_state

homeassistant.helpers.entity.Entity._platform_state = EntityPlatformState.NOT_ADDED

staticprivate

Definition at line 502 of file entity.py.

_removed_from_registry

homeassistant.helpers.entity.Entity._removed_from_registry

private

Definition at line 1514 of file entity.py.

_slow_reported [1/2]

bool homeassistant.helpers.entity.Entity._slow_reported = False

staticprivate

Definition at line 455 of file entity.py.

_slow_reported [2/2]

homeassistant.helpers.entity.Entity._slow_reported

private

Definition at line 1196 of file entity.py.

_state_info

homeassistant.helpers.entity.Entity._state_info

private

Definition at line 1477 of file entity.py.

_unsub_device_updates

homeassistant.helpers.entity.Entity._unsub_device_updates

private

Definition at line 1570 of file entity.py.

_update_staged [1/2]

bool homeassistant.helpers.entity.Entity._update_staged = False

staticprivate

Definition at line 474 of file entity.py.

_update_staged [2/2]

homeassistant.helpers.entity.Entity._update_staged

private

Definition at line 1305 of file entity.py.

_verified_state_writable [1/2]

bool homeassistant.helpers.entity.Entity._verified_state_writable = False

staticprivate

Definition at line 478 of file entity.py.

_verified_state_writable [2/2]

homeassistant.helpers.entity.Entity._verified_state_writable

private

Definition at line 1007 of file entity.py.

bool

homeassistant.helpers.entity.Entity.bool

static

Definition at line 487 of file entity.py.

device_entry

homeassistant.helpers.entity.Entity.device_entry

Definition at line 1543 of file entity.py.

entity_id

homeassistant.helpers.entity.Entity.entity_id

Definition at line 1557 of file entity.py.

EntityPlatform

homeassistant.helpers.entity.Entity.EntityPlatform

static

Definition at line 449 of file entity.py.

hass

homeassistant.helpers.entity.Entity.hass

Definition at line 1357 of file entity.py.

HomeAssistant

homeassistant.helpers.entity.Entity.HomeAssistant

static

Definition at line 444 of file entity.py.

None

homeassistant.helpers.entity.Entity.None

static

Definition at line 481 of file entity.py.

parallel_updates

homeassistant.helpers.entity.Entity.parallel_updates

Definition at line 1359 of file entity.py.

platform

homeassistant.helpers.entity.Entity.platform

Definition at line 1358 of file entity.py.

registry_entry

homeassistant.helpers.entity.Entity.registry_entry

Definition at line 1188 of file entity.py.

StateInfo

homeassistant.helpers.entity.Entity.StateInfo

static

Definition at line 520 of file entity.py.

StateType

homeassistant.helpers.entity.Entity.StateType

static

Definition at line 543 of file entity.py.

str

homeassistant.helpers.entity.Entity.str

static

Definition at line 439 of file entity.py.

---

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

• core/homeassistant/helpers/entity.py