Home Assistant Unofficial Reference: homeassistant.exceptions.HomeAssistantError Class Reference

Home Assistant Unofficial Reference 2024.12.1

Inherits Exception.

Inherited by homeassistant.auth.providers.command_line.InvalidAuthError, homeassistant.auth.providers.homeassistant.InvalidAuth, homeassistant.auth.providers.homeassistant.InvalidUser, homeassistant.auth.providers.insecure_example.InvalidAuthError, homeassistant.auth.providers.trusted_networks.InvalidUserError, homeassistant.components.acmeda.errors.PulseException, homeassistant.components.airnow.config_flow.CannotConnect, homeassistant.components.airnow.config_flow.InvalidAuth, homeassistant.components.airnow.config_flow.InvalidLocation, homeassistant.components.alexa.errors.NoTokenAvailable, homeassistant.components.alexa.errors.UnsupportedProperty, homeassistant.components.alexa.intent.UnknownRequest, homeassistant.components.apple_tv.config_flow.DeviceAlreadyConfigured, homeassistant.components.apple_tv.config_flow.DeviceNotFound, homeassistant.components.assist_pipeline.error.PipelineError, homeassistant.components.assist_satellite.errors.AssistSatelliteError, homeassistant.components.axis.errors.AxisException, homeassistant.components.balboa.config_flow.CannotConnect, homeassistant.components.blink.config_flow.InvalidAuth, homeassistant.components.blink.config_flow.Require2FA, homeassistant.components.blueprint.errors.BlueprintException, homeassistant.components.blueprint.importer.UnsupportedUrl, homeassistant.components.bmw_connected_drive.config_flow.CannotConnect, homeassistant.components.bmw_connected_drive.config_flow.InvalidAuth, homeassistant.components.bmw_connected_drive.config_flow.MissingCaptcha, homeassistant.components.bond.config_flow.InputValidationError, homeassistant.components.brother.config_flow.AnotherDevice, homeassistant.components.brother.config_flow.InvalidHost, homeassistant.components.cert_expiry.errors.CertExpiryException, homeassistant.components.cloud.CloudNotAvailable, homeassistant.components.cloudflare.config_flow.CannotConnect, homeassistant.components.cloudflare.config_flow.InvalidAuth, homeassistant.components.coinbase.config_flow.AlreadyConfigured, homeassistant.components.coinbase.config_flow.CannotConnect, homeassistant.components.coinbase.config_flow.CurrencyUnavailable, homeassistant.components.coinbase.config_flow.ExchangeRateUnavailable, homeassistant.components.coinbase.config_flow.InvalidAuth, homeassistant.components.coinbase.config_flow.InvalidKey, homeassistant.components.coinbase.config_flow.InvalidSecret, homeassistant.components.comelit.config_flow.CannotConnect, homeassistant.components.comelit.config_flow.InvalidAuth, homeassistant.components.control4.config_flow.CannotConnect, homeassistant.components.control4.config_flow.InvalidAuth, homeassistant.components.deconz.errors.DeconzException, homeassistant.components.device_automation.exceptions.DeviceNotFound, homeassistant.components.device_automation.exceptions.EntityNotFound, homeassistant.components.device_automation.exceptions.InvalidDeviceAutomationConfig, homeassistant.components.devolo_home_control.exceptions.CredentialsInvalid, homeassistant.components.devolo_home_control.exceptions.UuidChanged, homeassistant.components.dialogflow.DialogFlowError, homeassistant.components.doorbird.config_flow.CannotConnect, homeassistant.components.doorbird.config_flow.InvalidAuth, homeassistant.components.downloader.config_flow.DirectoryDoesNotExist, homeassistant.components.dsmr.config_flow.CannotCommunicate, homeassistant.components.dsmr.config_flow.CannotConnect, homeassistant.components.dunehd.config_flow.AlreadyConfigured, homeassistant.components.dunehd.config_flow.CannotConnect, homeassistant.components.dwd_weather_warnings.exceptions.EntityNotFoundError, homeassistant.components.ecowitt.config_flow.InvalidPort, homeassistant.components.elkm1.config_flow.InvalidAuth, homeassistant.components.elmax.config_flow.NoOnlinePanelsError, homeassistant.components.epson.exceptions.CannotConnect, homeassistant.components.epson.exceptions.PoweredOff, homeassistant.components.evil_genius_labs.config_flow.CannotConnect, homeassistant.components.fibaro.FibaroAuthFailed, homeassistant.components.fibaro.FibaroConnectFailed, homeassistant.components.fitbit.exceptions.FitbitApiException, homeassistant.components.fjaraskupan.coordinator.UnableToConnect, homeassistant.components.fjaraskupan.fan.UnsupportedPreset, homeassistant.components.flick_electric.config_flow.CannotConnect, homeassistant.components.flick_electric.config_flow.InvalidAuth, homeassistant.components.flo.config_flow.CannotConnect, homeassistant.components.flume.config_flow.CannotConnect, homeassistant.components.flume.config_flow.InvalidAuth, homeassistant.components.foscam.config_flow.CannotConnect, homeassistant.components.foscam.config_flow.InvalidAuth, homeassistant.components.foscam.config_flow.InvalidResponse, homeassistant.components.freedompro.config_flow.CannotConnect, homeassistant.components.freedompro.config_flow.InvalidAuth, homeassistant.components.fronius.config_flow.CannotConnect, homeassistant.components.gardena_bluetooth.coordinator.DeviceUnavailable, homeassistant.components.glances.ServerVersionMismatch, homeassistant.components.go2rtc.server.Go2RTCServerStartError, homeassistant.components.go2rtc.server.Go2RTCWatchdogError, homeassistant.components.google_tasks.exceptions.GoogleTasksApiError, homeassistant.components.harmony.config_flow.CannotConnect, homeassistant.components.hassio.addon_manager.AddonError, homeassistant.components.hlk_sw16.errors.SW16Exception, homeassistant.components.homematicip_cloud.errors.HmipcException, homeassistant.components.homewizard.config_flow.RecoverableError, homeassistant.components.hue.errors.HueException, homeassistant.components.hunterdouglas_powerview.config_flow.UnsupportedDevice, homeassistant.components.image.ImageContentTypeError, homeassistant.components.imap.errors.InvalidAuth, homeassistant.components.imap.errors.InvalidFolder, homeassistant.components.incomfort.errors.NotFound, homeassistant.components.iotawatt.config_flow.CannotConnect, homeassistant.components.iotawatt.config_flow.InvalidAuth, homeassistant.components.iskra.config_flow.CannotConnect, homeassistant.components.iskra.config_flow.UnknownException, homeassistant.components.isy994.config_flow.CannotConnect, homeassistant.components.isy994.config_flow.InvalidAuth, homeassistant.components.isy994.config_flow.InvalidHost, homeassistant.components.jellyfin.client_wrapper.CannotConnect, homeassistant.components.jellyfin.client_wrapper.InvalidAuth, homeassistant.components.juicenet.config_flow.CannotConnect, homeassistant.components.juicenet.config_flow.InvalidAuth, homeassistant.components.kaleidescape.UnsupportedError, homeassistant.components.kmtronic.config_flow.CannotConnect, homeassistant.components.kmtronic.config_flow.InvalidAuth, homeassistant.components.kodi.config_flow.CannotConnect, homeassistant.components.kodi.config_flow.InvalidAuth, homeassistant.components.kodi.config_flow.WSCannotConnect, homeassistant.components.konnected.errors.KonnectedException, homeassistant.components.lacrosse_view.config_flow.InvalidAuth, homeassistant.components.lacrosse_view.config_flow.NoLocations, homeassistant.components.lacrosse_view.config_flow.NonExistentEntry, homeassistant.components.landisgyr_heat_meter.config_flow.CannotConnect, homeassistant.components.linear_garage_door.config_flow.InvalidAuth, homeassistant.components.linear_garage_door.config_flow.InvalidDeviceID, homeassistant.components.loqed.config_flow.CannotConnect, homeassistant.components.loqed.config_flow.InvalidAuth, homeassistant.components.lovelace.const .ConfigNotFound, homeassistant.components.lupusec.config_flow.CannotConnect, homeassistant.components.matter.config_flow.FailedConnect, homeassistant.components.matter.helpers.MissingNode, homeassistant.components.media_player.errors.MediaPlayerException, homeassistant.components.media_source.error.MediaSourceError, homeassistant.components.met.coordinator.CannotConnect, homeassistant.components.metoffice.config_flow.CannotConnect, homeassistant.components.mikrotik.errors.CannotConnect, homeassistant.components.mikrotik.errors.LoginError, homeassistant.components.mjpeg.config_flow.InvalidAuth, homeassistant.components.monarch_money.config_flow.BadMFA, homeassistant.components.monarch_money.config_flow.InvalidAuth, homeassistant.components.monoprice.config_flow.CannotConnect, homeassistant.components.motionblinds_ble.config_flow.CouldNotFindMotor, homeassistant.components.motionblinds_ble.config_flow.InvalidMACCode, homeassistant.components.motionblinds_ble.config_flow.NoBluetoothAdapter, homeassistant.components.motionblinds_ble.config_flow.NoDevicesFound, homeassistant.components.mutesync.config_flow.CannotConnect, homeassistant.components.mutesync.config_flow.InvalidAuth, homeassistant.components.nasweb.config_flow.CannotConnect, homeassistant.components.nasweb.config_flow.InvalidAuth, homeassistant.components.nasweb.config_flow.MissingNASwebData, homeassistant.components.nasweb.config_flow.MissingNASwebStatus, homeassistant.components.netgear.errors.NetgearException, homeassistant.components.netgear_lte.config_flow.InputValidationError, homeassistant.components.nexia.config_flow.CannotConnect, homeassistant.components.nexia.config_flow.InvalidAuth, homeassistant.components.nightscout.config_flow.InputValidationError, homeassistant.components.nobo_hub.config_flow.NoboHubConnectError, homeassistant.components.nuheat.config_flow.CannotConnect, homeassistant.components.nuheat.config_flow.InvalidAuth, homeassistant.components.nuheat.config_flow.InvalidThermostat, homeassistant.components.nuki.helpers.CannotConnect, homeassistant.components.nuki.helpers.InvalidAuth, homeassistant.components.nuki.helpers.NukiWebhookException, homeassistant.components.nws.config_flow.CannotConnect, homeassistant.components.octoprint.button.InvalidPrinterState, homeassistant.components.octoprint.config_flow.CannotConnect, homeassistant.components.onewire.onewirehub.CannotConnect, homeassistant.components.onewire.onewirehub.InvalidPath, homeassistant.components.opengarage.config_flow.CannotConnect, homeassistant.components.opengarage.config_flow.InvalidAuth, homeassistant.components.otbr.config_flow.AlreadyConfigured, homeassistant.components.otbr.util.GetBorderAgentIdNotSupported, homeassistant.components.overkiz.config_flow.DeveloperModeDisabled, homeassistant.components.picnic.config_flow.CannotConnect, homeassistant.components.picnic.config_flow.InvalidAuth, homeassistant.components.plex.errors.PlexException, homeassistant.components.powerwall.config_flow.WrongVersion, homeassistant.components.progettihwsw.config_flow.CannotConnect, homeassistant.components.progettihwsw.config_flow.ExistingEntry, homeassistant.components.progettihwsw.config_flow.WrongInfo, homeassistant.components.prosegur.config_flow.CannotConnect, homeassistant.components.prosegur.config_flow.InvalidAuth, homeassistant.components.prusalink.config_flow.CannotConnect, homeassistant.components.prusalink.config_flow.NotSupported, homeassistant.components.python_script.ScriptError, homeassistant.components.rabbitair.config_flow.CannotConnect, homeassistant.components.rabbitair.config_flow.InvalidAccessToken, homeassistant.components.rabbitair.config_flow.InvalidHost, homeassistant.components.rabbitair.config_flow.TimeoutConnect, homeassistant.components.rachio.config_flow.CannotConnect, homeassistant.components.rachio.config_flow.InvalidAuth, homeassistant.components.radiotherm.config_flow.CannotConnect, homeassistant.components.rainforest_eagle.data.RainforestError, homeassistant.components.renson.config_flow.CannotConnect, homeassistant.components.reolink.exceptions.ReolinkException, homeassistant.components.rfxtrx.config_flow.CannotConnect, homeassistant.components.ring.config_flow.InvalidAuth, homeassistant.components.ring.config_flow.Require2FA, homeassistant.components.roomba.CannotConnect, homeassistant.components.roon.config_flow.InvalidAuth, homeassistant.components.ruckus_unleashed.config_flow.CannotConnect, homeassistant.components.ruckus_unleashed.config_flow.InvalidAuth, homeassistant.components.sharkiq.CannotConnect, homeassistant.components.sharkiq.config_flow.CannotConnect, homeassistant.components.sharkiq.config_flow.InvalidAuth, homeassistant.components.sharkiq.config_flow.UnknownAuth, homeassistant.components.smart_meter_texas.config_flow.CannotConnect, homeassistant.components.smart_meter_texas.config_flow.InvalidAuth, homeassistant.components.sms.config_flow.CannotConnect, homeassistant.components.somfy_mylink.config_flow.CannotConnect, homeassistant.components.somfy_mylink.config_flow.InvalidAuth, homeassistant.components.sonos.exception.SonosSubscriptionsFailed, homeassistant.components.sonos.exception.SonosUpdateError, homeassistant.components.srp_energy.config_flow.InvalidAuth, homeassistant.components.streamlabswater.config_flow.CannotConnect, homeassistant.components.suez_water.config_flow.CannotConnect, homeassistant.components.suez_water.config_flow.CounterNotFound, homeassistant.components.suez_water.config_flow.InvalidAuth, homeassistant.components.switchbee.config_flow.CannotConnect, homeassistant.components.switchbee.config_flow.InvalidAuth, homeassistant.components.syncthing.config_flow.CannotConnect, homeassistant.components.syncthing.config_flow.InvalidAuth, homeassistant.components.synology_dsm.config_flow.InvalidData, homeassistant.components.system_bridge.config_flow.CannotConnect, homeassistant.components.system_bridge.config_flow.InvalidAuth, homeassistant.components.tado.config_flow.CannotConnect, homeassistant.components.tado.config_flow.InvalidAuth, homeassistant.components.tado.config_flow.NoHomes, homeassistant.components.tag.TagIDExistsError, homeassistant.components.tami4.config_flow.InvalidPhoneNumber, homeassistant.components.thread.dataset_store.DatasetPreferredError, homeassistant.components.tractive.config_flow.InvalidAuth, homeassistant.components.transmission.errors.AuthenticationError, homeassistant.components.transmission.errors.CannotConnect, homeassistant.components.transmission.errors.UnknownError, homeassistant.components.triggercmd.config_flow.InvalidToken, homeassistant.components.unifi.errors.UnifiException, homeassistant.components.upb.config_flow.CannotConnect, homeassistant.components.upb.config_flow.InvalidUpbFile, homeassistant.components.vallox.config_flow.InvalidHost, homeassistant.components.venstar.config_flow.CannotConnect, homeassistant.components.vilfo.config_flow.CannotConnect, homeassistant.components.vilfo.config_flow.InvalidAuth, homeassistant.components.vilfo.config_flow.InvalidHost, homeassistant.components.vlc_telnet.config_flow.CannotConnect, homeassistant.components.vlc_telnet.config_flow.InvalidAuth, homeassistant.components.volumio.config_flow.CannotConnect, homeassistant.components.volvooncall.errors.InvalidAuth, homeassistant.components.wallbox.coordinator.InvalidAuth, homeassistant.components.websocket_api.error.Disconnect, homeassistant.components.whirlpool.config_flow.CannotConnect, homeassistant.components.whirlpool.config_flow.InvalidAuth, homeassistant.components.whirlpool.config_flow.NoAppliances, homeassistant.components.workday.config_flow.AddDateRangeError, homeassistant.components.workday.config_flow.AddDatesError, homeassistant.components.workday.config_flow.CountryNotExist, homeassistant.components.workday.config_flow.RemoveDateRangeError, homeassistant.components.workday.config_flow.RemoveDatesError, homeassistant.components.ws66i.config_flow.CannotConnect, homeassistant.components.wyoming.error.WyomingError, homeassistant.components.yeelight.config_flow.CannotConnect, homeassistant.components.zwave_js.config_flow.CannotConnect, homeassistant.components.zwave_js.config_flow.InvalidInput, homeassistant.config_entries.ConfigError, homeassistant.data_entry_flow.FlowError, homeassistant.exceptions.ConditionError, homeassistant.exceptions.ConfigValidationError, homeassistant.exceptions.DependencyError, homeassistant.exceptions.IntegrationError, homeassistant.exceptions.InvalidEntityFormatError, homeassistant.exceptions.InvalidStateError, homeassistant.exceptions.MaxLengthExceeded, homeassistant.exceptions.NoEntitySpecifiedError, homeassistant.exceptions.ServiceValidationError, homeassistant.exceptions.TemplateError, homeassistant.exceptions.Unauthorized, homeassistant.helpers.collection.CollectionError, homeassistant.helpers.config_validation.MustValidateInExecutor, homeassistant.helpers.device_registry.DeviceCollisionError, homeassistant.helpers.device_registry.DeviceInfoError, homeassistant.helpers.frame.MissingIntegrationFrame, homeassistant.helpers.intent.IntentError, homeassistant.helpers.network.NoURLAvailableError, homeassistant.helpers.update_coordinator.UpdateFailed, homeassistant.requirements.RequirementsNotFound, homeassistant.util.file.WriteError, and homeassistant.util.json.SerializationError.

Collaboration diagram for homeassistant.exceptions.HomeAssistantError:

Public Member Functions
None	__init__ (self, *object args, str\|None translation_domain=None, str\|None translation_key=None, dict[str, str]\|None translation_placeholders=None)

str	__str__ (self)

Public Attributes
	generate_message

	translation_domain

	translation_key

	translation_placeholders

Static Public Attributes
	bool

	None

Private Attributes
	_message

Detailed Description

General Home Assistant exception occurred.

Definition at line 34 of file exceptions.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.exceptions.HomeAssistantError.__init__	(		self,
		*object	args,
		str \| None	translation_domain = `None`,
		str \| None	translation_key = `None`,
		dict[str, str] \| None	translation_placeholders = `None`
	)

Initialize exception.

Definition at line 40 of file exceptions.py.

Member Function Documentation

◆ str()

str homeassistant.exceptions.HomeAssistantError.__str__ ( self )

Return exception message.

If no message was passed to `__init__`, the exception message is generated from
the translation_key. The message will be in English, regardless of the configured
language.

Reimplemented in homeassistant.helpers.intent.MatchFailedError, homeassistant.exceptions.IntegrationError, homeassistant.exceptions.ConditionError, homeassistant.components.mqtt.models.MqttValueTemplateException, and homeassistant.components.mqtt.models.MqttCommandTemplateException.

Definition at line 57 of file exceptions.py.

Member Data Documentation

◆ _message

homeassistant.exceptions.HomeAssistantError._message

private

Definition at line 69 of file exceptions.py.

◆ bool

homeassistant.exceptions.HomeAssistantError.bool

static

Definition at line 38 of file exceptions.py.

◆ generate_message

homeassistant.exceptions.HomeAssistantError.generate_message

Definition at line 49 of file exceptions.py.

◆ None

homeassistant.exceptions.HomeAssistantError.None

static

Definition at line 37 of file exceptions.py.

◆ translation_domain

homeassistant.exceptions.HomeAssistantError.translation_domain

Definition at line 53 of file exceptions.py.

◆ translation_key

homeassistant.exceptions.HomeAssistantError.translation_key

Definition at line 54 of file exceptions.py.

◆ translation_placeholders

homeassistant.exceptions.HomeAssistantError.translation_placeholders

Definition at line 55 of file exceptions.py.

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

core/homeassistant/exceptions.py