homeassistant.exceptions

The exceptions used by Home Assistant.

exception homeassistant.exceptions.ConditionError(type: str)[source]

Error during condition evaluation.

output(indent: int) → collections.abc.Generator[source]

Yield an indented representation.

exception homeassistant.exceptions.ConditionErrorContainer(type: str, errors: Sequence[ConditionError])[source]

Condition error with subconditions.

output(indent: int) → collections.abc.Generator[source]

Yield an indented representation.

exception homeassistant.exceptions.ConditionErrorIndex(type: str, index: int, total: int, error: homeassistant.exceptions.ConditionError)[source]

Condition error with index.

output(indent: int) → collections.abc.Generator[source]

Yield an indented representation.

exception homeassistant.exceptions.ConditionErrorMessage(type: str, message: str)[source]

Condition error message.

output(indent: int) → collections.abc.Generator[source]

Yield an indented representation.

exception homeassistant.exceptions.ConfigEntryAuthFailed[source]

Error to indicate that config entry could not authenticate.

exception homeassistant.exceptions.ConfigEntryNotReady[source]

Error to indicate that config entry is not ready.

exception homeassistant.exceptions.HomeAssistantError[source]

General Home Assistant exception occurred.

exception homeassistant.exceptions.IntegrationError[source]

Base class for platform and config entry exceptions.

exception homeassistant.exceptions.InvalidEntityFormatError[source]

When an invalid formatted entity is encountered.

exception homeassistant.exceptions.InvalidStateError[source]

When an invalid state is encountered.

exception homeassistant.exceptions.MaxLengthExceeded(value: str, property_name: str, max_length: int)[source]

Raised when a property value has exceeded the max character length.

exception homeassistant.exceptions.NoEntitySpecifiedError[source]

When no entity is specified.

exception homeassistant.exceptions.PlatformNotReady[source]

Error to indicate that platform is not ready.

exception homeassistant.exceptions.RequiredParameterMissing(parameter_names: list[str])[source]

Raised when a required parameter is missing from a function call.

exception homeassistant.exceptions.ServiceNotFound(domain: str, service: str)[source]

Raised when a service is not found.

exception homeassistant.exceptions.TemplateError(exception: Exception)[source]

Error during template rendering.

exception homeassistant.exceptions.Unauthorized(context: Context | None = None, user_id: str | None = None, entity_id: str | None = None, config_entry_id: str | None = None, perm_category: str | None = None, permission: str | None = None)[source]

When an action is unauthorized.

exception homeassistant.exceptions.UnknownUser(context: Context | None = None, user_id: str | None = None, entity_id: str | None = None, config_entry_id: str | None = None, perm_category: str | None = None, permission: str | None = None)[source]

When call is made with user ID that doesn’t exist.