homeassistant.components.update Namespace Reference

Namespaces
	const
	device_trigger
	significant_change

Classes
class	UpdateDeviceClass
class	UpdateEntity
class	UpdateEntityDescription

Functions
bool	_version_is_newer (str latest_version, str installed_version)
None	async_clear_skipped (UpdateEntity entity, ServiceCall service_call)
None	async_install (UpdateEntity entity, ServiceCall service_call)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
None	async_skip (UpdateEntity entity, ServiceCall service_call)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
None	websocket_release_notes (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)

Variables
list	__all__
	_LOGGER = logging.getLogger(__name__)
dictionary	CACHED_PROPERTIES_WITH_ATTR_
	DEVICE_CLASSES_SCHEMA = vol.All(vol.Lower, vol.Coerce(UpdateDeviceClass))
	Final
	PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
	PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
	SCAN_INTERVAL = timedelta(minutes=15)

Detailed Description

Component to allow for providing device or service updates.

Function Documentation

_version_is_newer()

bool homeassistant.components.update._version_is_newer ( str  latest_version, str  installed_version  )

private

Return True if latest_version is newer than installed_version.

Definition at line 187 of file __init__.py.

async_clear_skipped()

None homeassistant.components.update.async_clear_skipped	(	UpdateEntity	entity,
		ServiceCall	service_call
	)

Service call wrapper to validate the call.

Definition at line 169 of file __init__.py.

async_install()

None homeassistant.components.update.async_install	(	UpdateEntity	entity,
		ServiceCall	service_call
	)

Service call wrapper to validate the call.

Definition at line 127 of file __init__.py.

async_setup()

bool homeassistant.components.update.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up Select entities.

Definition at line 84 of file __init__.py.

async_setup_entry()

bool homeassistant.components.update.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 117 of file __init__.py.

async_skip()

None homeassistant.components.update.async_skip	(	UpdateEntity	entity,
		ServiceCall	service_call
	)

Service call wrapper to validate the call.

Definition at line 160 of file __init__.py.

async_unload_entry()

bool homeassistant.components.update.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 122 of file __init__.py.

websocket_release_notes()

None homeassistant.components.update.websocket_release_notes	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Get the full release notes for a entity.

Definition at line 528 of file __init__.py.

Variable Documentation

__all__

list homeassistant.components.update.__all__

private

Initial value:

=  [
    "ATTR_BACKUP",
    "ATTR_INSTALLED_VERSION",
    "ATTR_LATEST_VERSION",
    "ATTR_VERSION",
    "DEVICE_CLASSES_SCHEMA",
    "DOMAIN",
    "PLATFORM_SCHEMA_BASE",
    "PLATFORM_SCHEMA",
    "SERVICE_INSTALL",
    "SERVICE_SKIP",
    "UpdateDeviceClass",
    "UpdateEntity",
    "UpdateEntityDescription",
    "UpdateEntityFeature",
]

Definition at line 64 of file __init__.py.

_LOGGER

homeassistant.components.update._LOGGER = logging.getLogger(__name__)

private

Definition at line 46 of file __init__.py.

CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.update.CACHED_PROPERTIES_WITH_ATTR_

Initial value:

=  {
    "auto_update",
    "installed_version",
    "device_class",
    "display_precision",
    "in_progress",
    "latest_version",
    "release_summary",
    "release_url",
    "supported_features",
    "title",
    "update_percentage",
}

Definition at line 192 of file __init__.py.

DEVICE_CLASSES_SCHEMA

homeassistant.components.update.DEVICE_CLASSES_SCHEMA = vol.All(vol.Lower, vol.Coerce(UpdateDeviceClass))

Definition at line 61 of file __init__.py.

Final

homeassistant.components.update.Final

Definition at line 49 of file __init__.py.

PLATFORM_SCHEMA

homeassistant.components.update.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 50 of file __init__.py.

PLATFORM_SCHEMA_BASE

homeassistant.components.update.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 51 of file __init__.py.

SCAN_INTERVAL

homeassistant.components.update.SCAN_INTERVAL = timedelta(minutes=15)

Definition at line 52 of file __init__.py.