Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.restore_state Namespace Reference

Classes

class  ExtraStoredData
 
class  RestoredExtraData
 
class  RestoreEntity
 
class  RestoreStateData
 
class  StoredState
 

Functions

RestoreStateData async_get (HomeAssistant hass)
 
None async_load (HomeAssistant hass)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 STATE_DUMP_INTERVAL = timedelta(minutes=15)
 
 STATE_EXPIRATION = timedelta(days=7)
 
string STORAGE_KEY = "core.restore_state"
 
int STORAGE_VERSION = 1
 

Detailed Description

Support for restoring entity states on startup.

Function Documentation

◆ async_get()

RestoreStateData homeassistant.helpers.restore_state.async_get ( HomeAssistant  hass)
Get the restore state data helper.

Definition at line 105 of file restore_state.py.

◆ async_load()

None homeassistant.helpers.restore_state.async_load ( HomeAssistant  hass)
Load the restore state task.

Definition at line 98 of file restore_state.py.

Variable Documentation

◆ _LOGGER

homeassistant.helpers.restore_state._LOGGER = logging.getLogger(__name__)
private

Definition at line 26 of file restore_state.py.

◆ STATE_DUMP_INTERVAL

homeassistant.helpers.restore_state.STATE_DUMP_INTERVAL = timedelta(minutes=15)

Definition at line 32 of file restore_state.py.

◆ STATE_EXPIRATION

homeassistant.helpers.restore_state.STATE_EXPIRATION = timedelta(days=7)

Definition at line 35 of file restore_state.py.

◆ STORAGE_KEY

string homeassistant.helpers.restore_state.STORAGE_KEY = "core.restore_state"

Definition at line 28 of file restore_state.py.

◆ STORAGE_VERSION

int homeassistant.helpers.restore_state.STORAGE_VERSION = 1

Definition at line 29 of file restore_state.py.