├── hacs.json
├── .github
    ├── FUNDING.yml
    └── workflows
    │   ├── hassfest.yaml
    │   ├── hacs.yaml
    │   ├── automerge.yaml
    │   └── release.yaml
├── custom_components
    └── saver
    │   ├── strings.json
    │   ├── translations
    │       ├── en.json
    │       └── pl.json
    │   ├── manifest.json
    │   ├── config_flow.py
    │   ├── const.py
    │   ├── services.yaml
    │   └── __init__.py
├── LICENSE
└── README.md


/hacs.json:
--------------------------------------------------------------------------------
1 | {
2 |   "name": "Saver",
3 |   "render_readme": true,
4 |   "zip_release": true,
5 |   "filename": "saver.zip"
6 | }


--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | ko_fi: piotrmachowski
2 | custom: ["buycoffee.to/piotrmachowski", "paypal.me/PiMachowski", "revolut.me/314ma"]
3 | 


--------------------------------------------------------------------------------
/.github/workflows/hassfest.yaml:
--------------------------------------------------------------------------------
 1 | name: Validate with hassfest
 2 | 
 3 | on:
 4 |   push:
 5 |   pull_request:
 6 | 
 7 | jobs:
 8 |   validate:
 9 |     runs-on: "ubuntu-latest"
10 |     steps:
11 |       - uses: "actions/checkout@v2"
12 |       - uses: home-assistant/actions/hassfest@master
13 | 


--------------------------------------------------------------------------------
/custom_components/saver/strings.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "config": {
 3 |         "abort": {
 4 |             "already_configured": "The Saver is already configured."
 5 |         },
 6 |         "step": {
 7 |             "user": {
 8 |                 "description": "Do you want to configure the Saver?"
 9 |             }
10 |         }
11 |     }
12 | }


--------------------------------------------------------------------------------
/custom_components/saver/translations/en.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "config": {
 3 |         "abort": {
 4 |             "already_configured": "The Saver is already configured."
 5 |         },
 6 |         "step": {
 7 |             "user": {
 8 |                 "description": "Do you want to configure the Saver?"
 9 |             }
10 |         }
11 |     }
12 | }


--------------------------------------------------------------------------------
/custom_components/saver/translations/pl.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "config": {
 3 |         "abort": {
 4 |             "already_configured": "Saver jest ju\u017c skonfigurowany."
 5 |         },
 6 |         "step": {
 7 |             "user": {
 8 |                 "description": "Czy chcesz skonfigurowa\u0107 Saver?"
 9 |             }
10 |         }
11 |     }
12 | }


--------------------------------------------------------------------------------
/custom_components/saver/manifest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "domain": "saver",
 3 |   "name": "Saver",
 4 |   "codeowners": ["@PiotrMachowski"],
 5 |   "config_flow": true,
 6 |   "dependencies": [],
 7 |   "documentation": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver",
 8 |   "iot_class": "calculated",
 9 |   "issue_tracker": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/issues",
10 |   "requirements": [],
11 |   "version": "v0.0.0-dev"
12 | }


--------------------------------------------------------------------------------
/.github/workflows/hacs.yaml:
--------------------------------------------------------------------------------
 1 | name: Validate HACS
 2 | on:
 3 |   push:
 4 |   pull_request:
 5 | jobs:
 6 |   ci:
 7 |     runs-on: ubuntu-latest
 8 |     steps:
 9 |       - uses: actions/checkout@v2
10 |         name: Download repo
11 |         with:
12 |           fetch-depth: 0
13 | 
14 |       - uses: actions/setup-python@v2
15 |         name: Setup Python
16 |         with:
17 |           python-version: '3.13.x'
18 | 
19 |       - name: HACS Action
20 |         uses: hacs/action@main
21 |         with:
22 |           category: integration


--------------------------------------------------------------------------------
/custom_components/saver/config_flow.py:
--------------------------------------------------------------------------------
 1 | from typing import Any
 2 | 
 3 | from homeassistant import config_entries
 4 | from homeassistant.data_entry_flow import FlowResult
 5 | 
 6 | from .const import DOMAIN
 7 | 
 8 | 
 9 | class SaverFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
10 | 
11 |     VERSION = 1
12 |     CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_PUSH
13 | 
14 |     async def async_step_user(self, user_input: dict[str, Any] | None = None) -> FlowResult:
15 |         await self.async_set_unique_id(DOMAIN)
16 |         self._async_abort_entries_match()
17 |         if user_input is not None:
18 |             return self.async_create_entry(title="Saver", data=user_input)
19 |         return self.async_show_form(step_id="user", last_step=True)
20 | 
21 |     async_step_import = async_step_user
22 | 


--------------------------------------------------------------------------------
/.github/workflows/automerge.yaml:
--------------------------------------------------------------------------------
 1 | name: 'Automatically merge master -> dev'
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - master
 7 | 
 8 | jobs:
 9 |   build:
10 |     name: Automatically merge master to dev
11 |     runs-on: ubuntu-latest
12 |     steps:
13 |       - uses: actions/checkout@v3
14 |         name: Git checkout
15 |         with:
16 |           fetch-depth: 0
17 |       - name: Merge master -> dev
18 |         run: |
19 |           git config user.name "GitHub Actions"
20 |           git config user.email "PiotrMachowski@users.noreply.github.com"
21 |           if (git checkout dev)
22 |           then
23 |           git merge --ff-only master || git merge --no-commit master
24 |           git commit -m "Automatically merge master -> dev" || echo "No commit needed"
25 |           git push origin dev
26 |           else
27 |           echo "No dev branch"
28 |           fi


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2023 Piotr Machowski
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/.github/workflows/release.yaml:
--------------------------------------------------------------------------------
 1 | name: Release
 2 | 
 3 | on:
 4 |   release:
 5 |     types: [published]
 6 | 
 7 | env:
 8 |   COMPONENT_NAME: saver
 9 | 
10 | jobs:
11 |   release:
12 |     name: Prepare release
13 |     runs-on: ubuntu-latest
14 |     permissions:
15 |       contents: write
16 |       id-token: write
17 |     steps:
18 |       - name: Download repo
19 |         uses: actions/checkout@v4.2.2
20 | 
21 |       - name: Adjust version number
22 |         shell: bash
23 |         run: |
24 |           version="${{ github.event.release.tag_name }}"
25 |           yq e -P -o=json \
26 |             -i ".version = \"${version}\"" \
27 |             "${{ github.workspace }}/custom_components/${{ env.COMPONENT_NAME }}/manifest.json"
28 | 
29 |       - name: Zip ${{ env.COMPONENT_NAME }} dir
30 |         run: |
31 |           cd "${{ github.workspace }}/custom_components/${{ env.COMPONENT_NAME }}"
32 |           zip ${{ env.COMPONENT_NAME }}.zip -r ./
33 | 
34 | 
35 |       - name: Upload zip to release
36 |         uses: softprops/action-gh-release@v2.1.0
37 |         with:
38 |           files: ${{ github.workspace }}/custom_components/${{ env.COMPONENT_NAME }}/${{ env.COMPONENT_NAME }}.zip
39 | 


--------------------------------------------------------------------------------
/custom_components/saver/const.py:
--------------------------------------------------------------------------------
 1 | import homeassistant.helpers.config_validation as cv
 2 | from homeassistant.const import CONF_ENTITY_ID, CONF_NAME
 3 | from homeassistant.components.light import ATTR_TRANSITION, VALID_TRANSITION
 4 | 
 5 | import voluptuous as vol
 6 | 
 7 | DOMAIN = 'saver'
 8 | NAME = 'Saver'
 9 | 
10 | SAVER_SCHEMA = vol.Schema(
11 |     {
12 |         DOMAIN: vol.Schema({})
13 |     },
14 |     extra=vol.ALLOW_EXTRA
15 | )
16 | 
17 | CONF_DELETE_AFTER_RUN = 'delete_after_run'
18 | CONF_RESTORE_SCRIPT = 'restore_script'
19 | CONF_SCRIPT = 'script'
20 | CONF_VALUE = 'value'
21 | CONF_REGEX = 'regex'
22 | 
23 | SERVICE_CLEAR = 'clear'
24 | SERVICE_CLEAR_SCHEMA = vol.Schema({
25 | })
26 | 
27 | SERVICE_DELETE = 'delete'
28 | SERVICE_DELETE_SCHEMA = vol.Schema({
29 |     vol.Required(CONF_ENTITY_ID): cv.entity_ids
30 | })
31 | 
32 | SERVICE_DELETE_VARIABLE = 'delete_variable'
33 | SERVICE_DELETE_VARIABLE_SCHEMA = vol.Schema({
34 |     vol.Required(CONF_NAME): cv.string
35 | })
36 | 
37 | SERVICE_DELETE_VARIABLE_REGEX = 'delete_variable_regex'
38 | SERVICE_DELETE_VARIABLE_REGEX_SCHEMA = vol.Schema({
39 |     vol.Required(CONF_REGEX): cv.string
40 | })
41 | 
42 | SERVICE_EXECUTE = 'execute'
43 | SERVICE_EXECUTE_SCHEMA = vol.Schema({
44 |     vol.Required(CONF_SCRIPT): cv.SCRIPT_SCHEMA
45 | })
46 | 
47 | SERVICE_RESTORE_STATE = 'restore_state'
48 | SERVICE_RESTORE_STATE_SCHEMA = vol.Schema({
49 |     vol.Required(CONF_ENTITY_ID): cv.entity_ids,
50 |     vol.Optional(CONF_DELETE_AFTER_RUN, default=True): cv.boolean,
51 |     vol.Optional(ATTR_TRANSITION, default=None): vol.Any(VALID_TRANSITION, None),
52 | })
53 | 
54 | SERVICE_SAVE_STATE = 'save_state'
55 | SERVICE_SAVE_STATE_SCHEMA = vol.Schema({
56 |     vol.Required(CONF_ENTITY_ID): cv.entity_ids
57 | })
58 | 
59 | SERVICE_SET_VARIABLE = 'set_variable'
60 | SERVICE_SET_VARIABLE_SCHEMA = vol.Schema({
61 |     vol.Required(CONF_NAME): cv.string,
62 |     vol.Required(CONF_VALUE): cv.string
63 | })
64 | 


--------------------------------------------------------------------------------
/custom_components/saver/services.yaml:
--------------------------------------------------------------------------------
  1 | clear:
  2 |   name: Clear storage
  3 |   description: >
  4 |     Deletes all saved data.
  5 | 
  6 | delete:
  7 |   name: Delete entity
  8 |   description: >
  9 |     Deletes a saved state for an entity.
 10 |   fields:
 11 |     entity_id:
 12 |       name: Entity
 13 |       description: ID of entity to delete from saver.
 14 |       example: sun.sun
 15 |       required: true
 16 |       selector:
 17 |         entity:
 18 |           multiple: true
 19 | 
 20 | delete_variable:
 21 |   name: Delete variable
 22 |   description: >
 23 |     Deletes a saved variable.
 24 |   fields:
 25 |     name:
 26 |       name: Variable
 27 |       description: Name of the variable to delete from saver.
 28 |       example: counter
 29 |       required: true
 30 |       selector:
 31 |         text:
 32 | 
 33 | delete_variable_regex:
 34 |   name: Delete variables by regex
 35 |   description: >
 36 |     Deletes saved variables by regex.
 37 |   fields:
 38 |     regex:
 39 |       name: Regex
 40 |       description: Regex that should be used to delete variables from saver.
 41 |       example: counter_.*
 42 |       required: true
 43 |       selector:
 44 |         text:
 45 | 
 46 | set_variable:
 47 |   name: Set variable
 48 |   description: >
 49 |     Sets the value to the variable.
 50 |   fields:
 51 |     name:
 52 |       name: Variable
 53 |       description: Name of the variable to be set.
 54 |       example: counter
 55 |       required: true
 56 |       selector:
 57 |         text:
 58 |     value:
 59 |       name: Value
 60 |       description: The new value
 61 |       example: 3
 62 |       required: true
 63 |       selector:
 64 |         text:
 65 | 
 66 | save_state:
 67 |   name: Save state
 68 |   description: >
 69 |     Saves the state and parameters of the entity.
 70 |   fields:
 71 |     entity_id:
 72 |       name: Entity
 73 |       description: ID of the entity that should be saved.
 74 |       example: sun.sun
 75 |       required: true
 76 |       selector:
 77 |         entity:
 78 |           multiple: true
 79 | 
 80 | restore_state:
 81 |   name: Restore states
 82 |   description: >
 83 |     Restores saved states of entities.
 84 |   fields:
 85 |     entity_id:
 86 |       name: Entity
 87 |       description: ID of the entity that should be saved.
 88 |       example: sun.sun
 89 |       required: true
 90 |       selector:
 91 |         entity:
 92 |           multiple: true
 93 |     delete_after_run:
 94 |       name: Delete after run
 95 |       description: "Deletes the saved state after an execution of the script. Default: true [Optional]"
 96 |       example: false
 97 |       selector:
 98 |         boolean:
 99 |     transition:
100 |       name: Transition
101 |       description: "Transition that should be used during state restoring (only for light entities)"
102 |       required: false
103 |       selector:
104 |         number:
105 |           min: 0
106 |           max: 300
107 |           unit_of_measurement: seconds
108 | 


--------------------------------------------------------------------------------
/custom_components/saver/__init__.py:
--------------------------------------------------------------------------------
  1 | import json
  2 | import logging
  3 | import regex
  4 | from typing import Any, Callable
  5 | 
  6 | from homeassistant.config_entries import ConfigEntry
  7 | from homeassistant.core import HomeAssistant, ServiceCall
  8 | from homeassistant.helpers.restore_state import RestoreEntity
  9 | from homeassistant.helpers.entity_component import EntityComponent
 10 | from homeassistant.helpers.template import _get_state_if_valid, Template, TemplateEnvironment
 11 | 
 12 | from .const import *
 13 | 
 14 | _LOGGER = logging.getLogger(__name__)
 15 | CONFIG_SCHEMA = SAVER_SCHEMA
 16 | 
 17 | 
 18 | def setup(hass, config) -> bool:
 19 |     if DOMAIN not in config:
 20 |         return True
 21 |     return setup_entry(hass, config)
 22 | 
 23 | 
 24 | async def async_setup_entry(hass, config_entry):
 25 |     result = await hass.async_add_executor_job(setup_entry, hass, config_entry)
 26 |     return result
 27 | 
 28 | 
 29 | class SaverVariableTemplate:
 30 |     def __init__(self, hass: HomeAssistant, entity_id: str) -> None:
 31 |         self._hass = hass
 32 |         self._entity_id = entity_id
 33 | 
 34 |     def __call__(self, variable: str) -> Any:
 35 |         saver_state = _get_state_if_valid(self._hass, self._entity_id)
 36 |         if saver_state is None:
 37 |             return None
 38 |         variables = saver_state.attributes["variables"]
 39 |         if variable in variables:
 40 |             return variables[variable]
 41 |         return None
 42 | 
 43 |     def __repr__(self) -> str:
 44 |         return "<template SaverVariable>"
 45 | 
 46 | 
 47 | class SaverEntityTemplate:
 48 |     def __init__(self, hass: HomeAssistant, entity_id: str) -> None:
 49 |         self._hass = hass
 50 |         self._entity_id = entity_id
 51 | 
 52 |     def __call__(self, entity_id: str, attribute: str | None = None) -> Any:
 53 |         saver_state = _get_state_if_valid(self._hass, self._entity_id)
 54 |         if saver_state is None:
 55 |             return None
 56 |         entities = saver_state.attributes["entities"]
 57 |         if entity_id not in entities:
 58 |             return None
 59 |         state = entities[entity_id]
 60 |         state_val = state["state"] if isinstance(state, dict) else state.state
 61 |         attrs = state["attributes"] if isinstance(state, dict) else state.attributes
 62 |         if attribute is None:
 63 |             return state_val
 64 |         if attribute not in attrs:
 65 |             return None
 66 |         return attrs[attribute]
 67 | 
 68 |     def __repr__(self) -> str:
 69 |         return "<template SaverEntityTemplate>"
 70 | 
 71 | 
 72 | def setup_templates(hass: HomeAssistant) -> None:
 73 |     def is_safe_callable(self: TemplateEnvironment, obj) -> bool:
 74 |         # noinspection PyUnresolvedReferences
 75 |         return (isinstance(obj, (SaverVariableTemplate, SaverEntityTemplate))
 76 |                 or self.saver_original_is_safe_callable(obj))
 77 | 
 78 |     def patch_environment(env: TemplateEnvironment) -> None:
 79 |         env.globals["saver_variable"] = SaverVariableTemplate(hass, f"{DOMAIN}.{DOMAIN}")
 80 |         env.globals["saver_entity"] = SaverEntityTemplate(hass, f"{DOMAIN}.{DOMAIN}")
 81 | 
 82 |     def patched_init(
 83 |         self: TemplateEnvironment,
 84 |         hass_param: HomeAssistant | None,
 85 |         limited: bool | None = False,
 86 |         strict: bool | None = False,
 87 |         log_fn: Callable[[int, str], None] | None = None,
 88 |     ) -> None:
 89 |         # noinspection PyUnresolvedReferences
 90 |         self.saver_original__init__(hass_param, limited, strict, log_fn)
 91 |         patch_environment(self)
 92 | 
 93 |     if not hasattr(TemplateEnvironment, 'saver_original__init__'):
 94 |         TemplateEnvironment.saver_original__init__ = TemplateEnvironment.__init__
 95 |         TemplateEnvironment.__init__ = patched_init
 96 | 
 97 |     if not hasattr(TemplateEnvironment, 'saver_original_is_safe_callable'):
 98 |         TemplateEnvironment.saver_original_is_safe_callable = TemplateEnvironment.is_safe_callable
 99 |         TemplateEnvironment.is_safe_callable = is_safe_callable
100 | 
101 |     tpl = Template("", hass)
102 |     tpl._strict = False
103 |     tpl._limited = False
104 |     patch_environment(tpl._env)
105 |     tpl._strict = True
106 |     tpl._limited = False
107 |     patch_environment(tpl._env)
108 | 
109 | 
110 | def setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
111 |     component = EntityComponent(_LOGGER, DOMAIN, hass)
112 |     saver_entity = SaverEntity()
113 |     component.add_entities([saver_entity])
114 |     setup_templates(hass)
115 | 
116 |     def clear(_call: ServiceCall) -> None:
117 |         saver_entity.clear()
118 |         hass.bus.fire('event_saver_cleared')
119 | 
120 |     def delete(call: ServiceCall) -> None:
121 |         data = call.data
122 |         entity_id = data[CONF_ENTITY_ID]
123 |         saver_entity.delete(entity_id)
124 |         hass.bus.fire('event_saver_deleted_entity', {'entity_id': entity_id})
125 | 
126 |     def delete_variable(call: ServiceCall) -> None:
127 |         data = call.data
128 |         variable = data[CONF_NAME]
129 |         saver_entity.delete_variable(variable)
130 |         hass.bus.fire('event_saver_deleted_variable', {'variable': variable})
131 | 
132 |     def delete_variable_regex(call: ServiceCall) -> None:
133 |         data = call.data
134 |         variable_regex = data[CONF_REGEX]
135 |         variables = saver_entity.delete_variable_regex(variable_regex)
136 |         hass.bus.fire('event_saver_deleted_variable_by_regex', {'regex': variable_regex, 'variables': variables})
137 | 
138 |     def restore_state(call: ServiceCall) -> None:
139 |         data = call.data
140 |         entity_id = data[CONF_ENTITY_ID]
141 |         should_delete = data[CONF_DELETE_AFTER_RUN]
142 |         transition = data.get(ATTR_TRANSITION, None)
143 |         saver_entity.restore(entity_id, should_delete, transition)
144 |         hass.bus.fire('event_saver_restored', {'entity_id': entity_id})
145 | 
146 |     def save_state(call: ServiceCall) -> None:
147 |         data = call.data
148 |         entity_id = data[CONF_ENTITY_ID]
149 |         saver_entity.save(entity_id)
150 |         hass.bus.fire('event_saver_saved_entity', {'entity_id': entity_id})
151 | 
152 |     def set_variable(call) -> None:
153 |         data = call.data
154 |         name = data[CONF_NAME]
155 |         value = data[CONF_VALUE]
156 |         saver_entity.set_variable(name, value)
157 |         hass.bus.fire('event_saver_saved_variable', {'variable': name, 'value': value})
158 | 
159 |     hass.services.register(DOMAIN, SERVICE_CLEAR, clear, SERVICE_CLEAR_SCHEMA)
160 |     hass.services.register(DOMAIN, SERVICE_DELETE, delete, SERVICE_DELETE_SCHEMA)
161 |     hass.services.register(DOMAIN, SERVICE_DELETE_VARIABLE, delete_variable, SERVICE_DELETE_VARIABLE_SCHEMA)
162 |     hass.services.register(DOMAIN, SERVICE_DELETE_VARIABLE_REGEX, delete_variable_regex, SERVICE_DELETE_VARIABLE_REGEX_SCHEMA)
163 |     hass.services.register(DOMAIN, SERVICE_RESTORE_STATE, restore_state, SERVICE_RESTORE_STATE_SCHEMA)
164 |     hass.services.register(DOMAIN, SERVICE_SAVE_STATE, save_state, SERVICE_SAVE_STATE_SCHEMA)
165 |     hass.services.register(DOMAIN, SERVICE_SET_VARIABLE, set_variable, SERVICE_SET_VARIABLE_SCHEMA)
166 | 
167 |     return True
168 | 
169 | 
170 | class SaverEntity(RestoreEntity):
171 | 
172 |     def __init__(self) -> None:
173 |         self._entities_db = {}
174 |         self._variables_db = {}
175 |         self._attr_unique_id = f"{DOMAIN}.{DOMAIN}"
176 | 
177 |     @property
178 |     def name(self) -> str:
179 |         return NAME
180 | 
181 |     def clear(self) -> None:
182 |         self._entities_db = {}
183 |         self._variables_db = {}
184 |         self.schedule_update_ha_state()
185 | 
186 |     def delete(self, entity_ids: list[str]) -> None:
187 |         tmp = {**self._entities_db}
188 |         for entity_id in entity_ids:
189 |             tmp.pop(entity_id)
190 |         self._entities_db = tmp
191 |         self.schedule_update_ha_state()
192 | 
193 |     def delete_variable(self, variable: str) -> None:
194 |         tmp = {**self._variables_db}
195 |         tmp.pop(variable)
196 |         self._variables_db = tmp
197 |         self.schedule_update_ha_state()
198 | 
199 |     def delete_variable_regex(self, variable_regex: str) -> list[str]:
200 |         variables = [variable for variable in self._variables_db if regex.match(variable_regex, variable)]
201 |         tmp = {**self._variables_db}
202 |         for variable in variables:
203 |             tmp.pop(variable)
204 |         self._variables_db = tmp
205 |         self.schedule_update_ha_state()
206 |         return variables
207 | 
208 |     def restore(self, entity_ids: list[str], delete: bool, transition: float | None) -> None:
209 |         entity_ids = [entity_id for entity_id in entity_ids if entity_id in self._entities_db]
210 |         entities_data = {
211 |             entity_id: self.convert_to_scene_params(
212 |                 self._entities_db[entity_id]
213 |             )
214 |             for entity_id in self._entities_db
215 |         }
216 |         if delete:
217 |             tmp = {**self._entities_db}
218 |             for entity_id in entity_ids:
219 |                 tmp.pop(entity_id)
220 |             self._entities_db = tmp
221 |         data: dict[str, Any] = { "entities": entities_data }
222 |         if transition is not None:
223 |             data["transition"] = transition
224 |         self.hass.services.call("scene", "apply", data)
225 | 
226 |     def save(self, entity_ids: list[str]) -> None:
227 |         self._entities_db = {**self._entities_db}
228 |         for entity_id in entity_ids:
229 |             self._entities_db[entity_id] = self.hass.states.get(entity_id)
230 |         self.schedule_update_ha_state()
231 | 
232 |     def set_variable(self, variable: str, value: Any) -> None:
233 |         self._variables_db = {**self._variables_db, variable: value}
234 |         self.schedule_update_ha_state()
235 | 
236 |     @property
237 |     def state_attributes(self) -> dict[str, Any]:
238 |         return {
239 |             "entities": self._entities_db,
240 |             "variables": self._variables_db
241 |         }
242 | 
243 |     @property
244 |     def state(self) -> int:
245 |         return len(self._entities_db) + len(self._variables_db)
246 | 
247 |     async def async_added_to_hass(self) -> None:
248 |         state = await self.async_get_last_state()
249 |         if (
250 |             state is not None
251 |             and state.attributes is not None
252 |             and "variables" in state.attributes and not isinstance(state.attributes["entities"], list)
253 |             and "entities" in state.attributes and not isinstance(state.attributes["variables"], list)
254 |         ):
255 |             self._variables_db = state.attributes["variables"]
256 |             self._entities_db = state.attributes["entities"]
257 | 
258 |     @staticmethod
259 |     def convert_to_scene_params(saved_state: Any) -> dict[str, Any]:
260 |         state = saved_state["state"] if isinstance(saved_state, dict) else saved_state.state
261 |         attrs = saved_state["attributes"] if isinstance(saved_state, dict) else saved_state.attributes
262 |         return {
263 |             "state": state,
264 |             **{attr_key: json.loads(json.dumps(attr_val)) for attr_key, attr_val in attrs.items()},
265 |         }
266 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | [![HACS Default][hacs_shield]][hacs]
  2 | [![GitHub Latest Release][releases_shield]][latest_release]
  3 | [![GitHub All Releases][downloads_total_shield]][releases]
  4 | [![Installations][installations_shield]][releases]
  5 | [![Community Forum][community_forum_shield]][community_forum]<!-- piotrmachowski_support_badges_start -->
  6 | [![Ko-Fi][ko_fi_shield]][ko_fi]
  7 | [![buycoffee.to][buycoffee_to_shield]][buycoffee_to]
  8 | [![PayPal.Me][paypal_me_shield]][paypal_me]
  9 | [![Revolut.Me][revolut_me_shield]][revolut_me]
 10 | <!-- piotrmachowski_support_badges_end -->
 11 | 
 12 | 
 13 | [hacs_shield]: https://img.shields.io/static/v1.svg?label=HACS&message=Default&style=popout&color=green&labelColor=41bdf5&logo=HomeAssistantCommunityStore&logoColor=white
 14 | [hacs]: https://hacs.xyz/docs/default_repositories
 15 | 
 16 | [latest_release]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/releases/latest
 17 | [releases_shield]: https://img.shields.io/github/release/PiotrMachowski/Home-Assistant-custom-components-Saver.svg?style=popout
 18 | 
 19 | [releases]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/releases
 20 | [downloads_total_shield]: https://img.shields.io/github/downloads/PiotrMachowski/Home-Assistant-custom-components-Saver/total
 21 | 
 22 | [installations_shield]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fanalytics.home-assistant.io%2Fcustom_integrations.json&query=%24.saver.total&style=popout&color=41bdf5&label=analytics
 23 | 
 24 | [community_forum_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Forum&style=popout&color=41bdf5&logo=HomeAssistant&logoColor=white
 25 | [community_forum]: https://community.home-assistant.io/t/custom-component-saver/204249
 26 | 
 27 | 
 28 | # Saver
 29 | 
 30 | This custom component allows you to save current state of any entity and use its data later to restore it.
 31 | 
 32 | Additionally, you can create simple variables and use their values in scripts.
 33 | 
 34 | ## Installation
 35 | 
 36 | ### Using [HACS](https://hacs.xyz/) (recommended)
 37 | 
 38 | [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=PiotrMachowski&repository=Home-Assistant-custom-components-Saver&category=Integration)
 39 | 
 40 | This integration can be installed using HACS.
 41 | To do it search for `Saver` in *Integrations* section.
 42 | 
 43 | ### Manual
 44 | 
 45 | To install this integration manually you have to download [*saver.zip*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/releases/latest/download/saver.zip) and extract its contents to `config/custom_components/saver` directory:
 46 | ```bash
 47 | mkdir -p custom_components/saver
 48 | cd custom_components/saver
 49 | wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/releases/latest/download/saver.zip
 50 | unzip saver.zip
 51 | rm saver.zip
 52 | ```
 53 | 
 54 | ## Configuration
 55 | 
 56 | ### Using UI
 57 | 
 58 | [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=saver)
 59 | 
 60 | From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list.
 61 | 
 62 | Use the "plus" button in the bottom right to add a new integration called **Saver**.
 63 | 
 64 | The success dialog will appear or an error will be displayed in the popup.
 65 | 
 66 | ### YAML (Deprecated)
 67 | 
 68 | Add following code in configuration.yaml:
 69 | ```yaml
 70 | saver:
 71 | ```
 72 | 
 73 | ## Available services
 74 | 
 75 | ### Save state
 76 | Saves the state and parameters of the entity. Supports saving multiple entities.
 77 | ```yaml
 78 | service: saver.save_state
 79 | data:
 80 |   entity_id: cover.living_room
 81 | ```
 82 | 
 83 | ### Restore state
 84 | Restores saved states (only for entities that support it). Supports restoring multiple entities.
 85 | ```yaml
 86 | service: saver.restore_state
 87 | data:
 88 |   entity_id: cover.living_room
 89 | ```
 90 | 
 91 | Optional attributes: 
 92 |   - `delete_after_run`: allows to disable removing saved states after restoring them (default: `true`).
 93 |   - `transition`: Number that represents the time (in seconds) the light should take to transition to the new state.
 94 | ```yaml
 95 | service: saver.restore_state
 96 | data:
 97 |   entity_id: 
 98 |     - cover.living_room
 99 |     - light.living_room
100 |   delete_after_run: false
101 |   transition: 3
102 | ```
103 | 
104 | ### Delete saved state
105 | Deletes a saved state for an entity.
106 | ```yaml
107 | service: saver.delete
108 | data:
109 |   entity_id: cover.living_room
110 | ```
111 | 
112 | ### Set variable
113 | Sets the value to the variable.
114 | ```yaml
115 | service: saver.set_variable
116 | data:
117 |   name: counter
118 |   value: 3
119 | ```
120 | 
121 | ### Delete variable
122 | Deletes a saved variable.
123 | ```yaml
124 | service: saver.delete_variable
125 | data:
126 |   name: counter
127 | ```
128 | 
129 | ### Delete variables by regex
130 | Deletes saved variables that match provided regex.
131 | ```yaml
132 | service: saver.delete_variable_regex
133 | data:
134 |   regex: "counter_\\d+"
135 | ```
136 | 
137 | ### Clear
138 | Deletes all saved data.
139 | ```yaml
140 | service: saver.clear
141 | ```
142 | 
143 | 
144 | ## Using saved values in templates
145 | It is possible to use saved data in templates using `saver_entity` and `saver_variable` functions:
146 | ```yaml
147 | {{ saver_entity("sun.sun") }}  # returns saved state of "sun.sun" entity
148 | {{ saver_entity("sun.sun", "azimuth") }}  # returns "azimuth" attribute of saved "sun.sun" entity
149 | {{ saver_variable("counter") }}  # returns saved variable "counter"
150 | ```
151 | 
152 | ## Events
153 | 
154 | After the completion of the services mentioned before, the following events are fired:
155 | 
156 | | **Service Function**      | **Event ID**                          | **Provided Arguments** |
157 | |---------------------------|---------------------------------------|------------------------|
158 | | **save_state**            | event_saver_saved_entity              | entity_id              |
159 | | **restore_state**         | event_saver_restored                  | entity_id              |
160 | | **delete**                | event_saver_deleted_entity            | entity_id              |
161 | | **clear**                 | event_saver_cleared                   |                        |
162 | | **set_variable**          | event_saver_saved_variable            | variable, value        |
163 | | **delete_variable**       | event_saver_deleted_variable          | variable               |
164 | | **delete_variable_regex** | event_saver_deleted_variable_by_regex | variables, regex       |
165 | 
166 | The events can be used to trigger further automations that depend on the completion of the services. The documentation is provided [here](https://www.home-assistant.io/docs/automation/trigger/#event-trigger). 
167 | 
168 | 
169 | <!-- piotrmachowski_support_links_start -->
170 | 
171 | ## Support
172 | 
173 | If you want to support my work with a donation you can use one of the following platforms:
174 | 
175 | <table>
176 |   <tr>
177 |     <th>Platform</th>
178 |     <th>Payment methods</th>
179 |     <th>Link</th>
180 |     <th>Comment</th>
181 |   </tr>
182 |   <tr>
183 |     <td>Ko-fi</td>
184 |     <td>
185 |       <li>PayPal</li>
186 |       <li>Credit card</li>
187 |     </td>
188 |     <td>
189 |       <a href='https://ko-fi.com/piotrmachowski' target='_blank'><img height='35px' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' />
190 |     </td>
191 |     <td>
192 |       <li>No fees</li>
193 |       <li>Single or monthly payment</li>
194 |     </td>
195 |   </tr>
196 |   <tr>
197 |     <td>buycoffee.to</td>
198 |     <td>
199 |       <li>BLIK</li>
200 |       <li>Bank transfer</li>
201 |     </td>
202 |     <td>
203 |       <a href="https://buycoffee.to/piotrmachowski" target="_blank"><img src="https://buycoffee.to/btn/buycoffeeto-btn-primary.svg" height="35px" alt="Postaw mi kawę na buycoffee.to"></a>
204 |     </td>
205 |     <td></td>
206 |   </tr>
207 |   <tr>
208 |     <td>PayPal</td>
209 |     <td>
210 |       <li>PayPal</li>
211 |     </td>
212 |     <td>
213 |       <a href="https://paypal.me/PiMachowski" target="_blank"><img src="https://www.paypalobjects.com/webstatic/mktg/logo/pp_cc_mark_37x23.jpg" border="0" alt="PayPal Logo" height="35px" style="height: auto !important;width: auto !important;"></a>
214 |     </td>
215 |     <td>
216 |       <li>No fees</li>
217 |     </td>
218 |   </tr>
219 |   <tr>
220 |     <td>Revolut</td>
221 |     <td>
222 |       <li>Revolut</li>
223 |       <li>Credit Card</li>
224 |     </td>
225 |     <td>
226 |       <a href="https://revolut.me/314ma" target="_blank"><img src="https://assets.revolut.com/assets/favicons/favicon-32x32.png" height="32px" alt="Revolut"></a>
227 |     </td>
228 |     <td>
229 |       <li>No fees</li>
230 |     </td>
231 |   </tr>
232 | </table>
233 | 
234 | ### Powered by
235 | [![PyCharm logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)
236 | 
237 | 
238 | [ko_fi_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Ko-Fi&color=F16061&logo=ko-fi&logoColor=white
239 | 
240 | [ko_fi]: https://ko-fi.com/piotrmachowski
241 | 
242 | [buycoffee_to_shield]: https://shields.io/badge/buycoffee.to-white?style=flat&labelColor=white&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABhmlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw1AUhU9TpaIVh1YQcchQnayIijhKFYtgobQVWnUweemP0KQhSXFxFFwLDv4sVh1cnHV1cBUEwR8QVxcnRRcp8b6k0CLGC4/3cd49h/fuA4R6malmxzigapaRisfEbG5FDLzChxB6MIZ+iZl6Ir2QgWd93VM31V2UZ3n3/Vm9St5kgE8knmW6YRGvE09vWjrnfeIwK0kK8TnxqEEXJH7kuuzyG+eiwwLPDBuZ1BxxmFgstrHcxqxkqMRTxBFF1ShfyLqscN7irJarrHlP/sJgXltOc53WEOJYRAJJiJBRxQbKsBClXSPFRIrOYx7+QcefJJdMrg0wcsyjAhWS4wf/g9+zNQuTE25SMAZ0vtj2xzAQ2AUaNdv+PrbtxgngfwautJa/UgdmPkmvtbTIEdC3DVxctzR5D7jcAQaedMmQHMlPSygUgPcz+qYcELoFulfduTXPcfoAZGhWSzfAwSEwUqTsNY93d7XP7d+e5vx+AIahcq//o+yoAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH5wETCy4vFNqLzwAAAVpJREFUOMvd0rFLVXEYxvHPOedKJnKJhrDLuUFREULE7YDCMYj+AydpsCWiaKu29hZxiP4Al4aWwC1EdFI4Q3hqEmkIBI8ZChWXKNLLvS0/Qcza84V3enm/7/s878t/HxGkeTaIGziP+EB918nawu7Dq1d0e1+2J2bepnk2jFEUVVF+qKV51o9neBCaugfge70keoxxUbSWjrQ+4SUyzKZ5NlnDZdzGG7w4DIh+dtZEFntDA98l8S0MYwctNGrYz9WqKJePFLq80g5Sr+EHlnATp+NA+4qLaZ7FfzMrzbMBjGEdq8GrJMZnvAvFC/8wfAwjWMQ8XmMzaW9sdevNRgd3MFhvNpbaG1u/Dk2/hOc4gadVUa7Um425qii/7Z+xH9O4jwW8Cqv24Tru4hyeVEU588cfBMgpPMI9nMFe0BkFzVOYrYqycyQgQJLwTC2cDZCPeF8V5Y7jGb8BUpRicy7OU5MAAAAASUVORK5CYII=
243 | 
244 | [buycoffee_to]: https://buycoffee.to/piotrmachowski
245 | 
246 | [buy_me_a_coffee_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Buy%20me%20a%20coffee&color=6f4e37&logo=buy%20me%20a%20coffee&logoColor=white
247 | 
248 | [buy_me_a_coffee]: https://www.buymeacoffee.com/PiotrMachowski
249 | 
250 | [paypal_me_shield]: https://img.shields.io/static/v1.svg?label=%20&message=PayPal.Me&logo=paypal
251 | 
252 | [paypal_me]: https://paypal.me/PiMachowski
253 | 
254 | [revolut_me_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Revolut&logo=revolut
255 | 
256 | [revolut_me]: https://revolut.me/314ma
257 | <!-- piotrmachowski_support_links_end -->


--------------------------------------------------------------------------------