Home-Assistant-custom-components-Saver

KO | EN

gitlite — search

#go #golang #machine-learning #rust #deep-learning #macos #java #windows #cli #kubernetes #vue #pytorch #ios #mcp

Home-Assistant-custom-components-Saver

(★ 102)

This custom component allows you to save current state of any entity and use its data later to restore it.

Home-Assistant-custom-components-Saver 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![HACS Default][hacs_shield]][hacs]
[![GitHub Latest Release][releases_shield]][latest_release]
[![GitHub All Releases][downloads_total_shield]][releases]
[![Installations][installations_shield]][releases]
[![Community Forum][community_forum_shield]][community_forum]
[![Ko-Fi][ko_fi_shield]][ko_fi]
[![buycoffee.to][buycoffee_to_shield]][buycoffee_to]
[![PayPal.Me][paypal_me_shield]][paypal_me]
[![Revolut.Me][revolut_me_shield]][revolut_me]

[hacs_shield]: https://img.shields.io/static/v1.svg?label=HACS&message=Default&style=popout&color=green&labelColor=41bdf5&logo=HomeAssistantCommunityStore&logoColor=white
[hacs]: https://hacs.xyz/docs/default_repositories

[latest_release]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/releases/latest
[releases_shield]: https://img.shields.io/github/release/PiotrMachowski/Home-Assistant-custom-components-Saver.svg?style=popout

[releases]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/releases
[downloads_total_shield]: https://img.shields.io/github/downloads/PiotrMachowski/Home-Assistant-custom-components-Saver/total

[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

[community_forum_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Forum&style=popout&color=41bdf5&logo=HomeAssistant&logoColor=white
[community_forum]: https://community.home-assistant.io/t/custom-component-saver/204249

# Saver

This custom component allows you to save current state of any entity and use its data later to restore it.

Additionally, you can create simple variables and use their values in scripts.

## Installation

### Using [HACS](https://hacs.xyz/) (recommended)

[![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)

This integration can be installed using HACS.
To do it search for `Saver` in *Integrations* section.

### Manual

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:
```bash
mkdir -p custom_components/saver
cd custom_components/saver
wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Saver/releases/latest/download/saver.zip
unzip saver.zip
rm saver.zip
```

## Configuration

### Using UI

[![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)

From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list.

Use the "plus" button in the bottom right to add a new integration called **Saver**.

The success dialog will appear or an error will be displayed in the popup.

### YAML (Deprecated)

Add following code in configuration.yaml:
```yaml
saver:
```

## Available services

### Save state
Saves the state and parameters of the entity. Supports saving multiple entities.
```yaml
service: saver.save_state
data:
  entity_id: cover.living_room
```

### Restore state
Restores saved states (only for entities that support it). Supports restoring multiple entities.
```yaml
service: saver.restore_state
data:
  entity_id: cover.living_room
```

Optional attributes: 
  - `delete_after_run`: allows to disable removing saved states after restoring them (default: `true`).
  - `transition`: Number that represents the time (in seconds) the light should take to transition to the new state.
```yaml
service: saver.restore_state
data:
  entity_id: 
    - cover.living_room
    - light.living_room
  delete_after_run: false
  transition: 3
```

### Delete saved state
Deletes a saved state for an entity.
```yaml
service: saver.delete
data:
  entity_id: cover.living_room
```

### Delete saved states by regex
Deletes saved states for entities that match provided regex.
```yaml
service: saver.delete_regex
data:
  entity_id_regex: light.living_room.*
```

### Set variable
Sets a variable to a manual value, an entity state, or the current timestamp. Only one of `value`, `value_entity` or `use_current_time` can be used at a time.

Manual value:
```yaml
service: saver.set_variable
data:
  name: counter
  value: 3
```

Use the current state of an entity:
```yaml
service: saver.set_variable
data:
  name: living_room_temp
  value_entity: sensor.living_room_temperature
```

Store the current date and time (ISO-8601, supports >24h comparisons):
```yaml
service: saver.set_variable
data:
  name: timer_start
  use_current_time: true
```

### Delete variable
Deletes a saved variable.
```yaml
service: saver.delete_variable
data:
  name: counter
```

### Delete variables by regex
Deletes saved variables that match provided regex.
```yaml
service: saver.delete_variable_regex
data:
  regex: "counter_\\d+"
```

### Clear
Deletes all saved data.
```yaml
service: saver.clear
```

## Using saved values in templates

It is possible to use saved data in templates using the `saver` namespace object:

### Basic access
```yaml
{{ saver.variable("counter") }}              # returns saved variable "counter"
{{ saver.entity("sun.sun") }}                # returns saved state of "sun.sun" entity
{{ saver.entity("sun.sun", "azimuth") }}     # returns "azimuth" attribute of saved "sun.sun" entity
```

### Time comparisons

Compare a saved variable against a time or datetime value. Supports `HH:MM`, `HH:MM:SS` and full ISO-8601 datetime (`2024-01-15T14:30:00`). Plain time values are combined with today's date for comparison. When using `use_current_time: true`, the full datetime (including date) is stored, enabling comparisons across days.

```yaml
{{ saver.cmp_time_after("timer_start", "12:05:00") }}           # true if saved time is after 12:05 today
{{ saver.cmp_time_before("timer_start", "18:00") }}             # true if saved time is before 18:00 today
{{ saver.cmp_time_after("timer_start", "2024-06-15T14:30:00") }} # compare against full datetime
{{ saver.cmp_time_after_now("timer_start") }}                    # true if saved datetime is after current datetime
```

### General comparisons

```yaml
{{ saver.cmp_eq("status", "active") }}    # true if variable equals "active" (string comparison)
{{ saver.cmp_neq("status", "active") }}   # true if variable does not equal "active"
{{ saver.cmp_gt("counter", "10") }}       # true if variable is greater than 10 (numeric)
{{ saver.cmp_lt("counter", "10") }}       # true if variable is less than 10
{{ saver.cmp_gte("counter", "10") }}      # true if variable is greater than or equal to 10
{{ saver.cmp_lte("counter", "10") }}      # true if variable is less than or equal to 10
```

### Elapsed time

Returns the number of seconds elapsed since the datetime stored in a variable. The variable must contain a parseable time or datetime value (e.g. set via `use_current_time: true`). When using full datetime values, elapsed time works correctly across days.

```yaml
{{ saver.time_elapsed("timer_start") }}                       # seconds since the stored time
{{ saver.time_elapsed("timer_start") > 3600 }}                # true if more than 1 hour has passed
```

### Legacy functions

The previous `saver_variable` and `saver_entity` functions are still available for backwards compatibility:
```yaml
{{ saver_variable("counter") }}
{{ saver_entity("sun.sun") }}
{{ saver_entity("sun.sun", "azimuth") }}
```

## Automation Conditions

Saver provides custom automation conditions that appear in the Home Assistant automation UI. These mirror the template comparison functions and can be added visually.

### Time elapsed

Check if the elapsed time since a stored datetime variable exceeds or falls below a threshold (in seconds). At least one of `above` or `below` must be set. If both are set, both must be satisfied (range check).

```yaml
condition: saver.time_elapsed
options:
  variable: timer_start
  above: 1800          # more than 30 minutes ago
```

```yaml
condition: saver.time_elapsed
options:
  variable: timer_start
  above: 60
  below: 3600          # between 1 minute and 1 hour
```

### Compare value

Compare a stored variable against a value. Available operators: `eq`, `neq`, `gt`, `lt`, `gte`, `lte`. Numeric operators (`gt`, `lt`, `gte`, `lte`) convert both sides to numbers.

```yaml
condition: saver.compare_value
options:
  variable: counter
  comparison: gt
  value: "10"
```

### Compare time

Compare a stored datetime variable against another time or the current time. Available comparisons: `after`, `before`, `after_now`. For `after` and `before`, a `compare_to` value is required (supports `HH:MM`, `HH:MM:SS`, or ISO-8601 datetime).

```yaml
condition: saver.compare_time
options:
  variable: timer_start
  comparison: after_now
```

```yaml
condition: saver.compare_time
options:
  variable: timer_start
  comparison: after
  compare_to: "12:05:00"
```

## Events

After the completion of the services mentioned before, the following events are fired:

| **Service Function**      | **Event ID**                          | **Provided Arguments**    |
|---------------------------|---------------------------------------|---------------------------|
| **save_state**            | event_saver_saved_entity              | entity_id                 |
| **restore_state**         | event_saver_restored                  | entity_id                 |
| **delete**                | event_saver_deleted_entity            | entity_id                 |
| **delete_regex**          | event_saver_deleted_entity_by_regex   | entity_id_regex, entities |
| **clear**                 | event_saver_cleared                   |                           |
| **set_variable**          | event_saver_saved_variable            | variable, value           |
| **delete_variable**       | event_saver_deleted_variable          | variable                  |
| **delete_variable_regex** | event_saver_deleted_variable_by_regex | variables, regex          |

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).

## Support

If you want to support my work with a donation you can use one of the following platforms:

<table>
  <tr>
    <th>Platform</th>
    <th>Payment methods</th>
    <th>Link</th>
    <th>Comment</th>
  </tr>
  <tr>
    <td>Ko-fi</td>
    <td>
      <li>PayPal</li>
      <li>Credit card</li>
    </td>
    <td>
      <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' />
    </td>
    <td>
      <li>No fees</li>
      <li>Single or monthly payment</li>
    </td>
  </tr>
  <tr>
    <td>buycoffee.to</td>
    <td>
      <li>BLIK</li>
      <li>Bank transfer</li>
    </td>
    <td>
      <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>
    </td>
    <td></td>
  </tr>
  <tr>
    <td>PayPal</td>
    <td>
      <li>PayPal</li>
    </td>
    <td>
      <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>
    </td>
    <td>
      <li>No fees</li>
    </td>
  </tr>
  <tr>
    <td>Revolut</td>
    <td>
      <li>Revolut</li>
      <li>Credit Card</li>
    </td>
    <td>
      <a href="https://revolut.me/314ma" target="_blank"><img src="https://assets.revolut.com/assets/favicons/favicon-32x32.png" height="32px" alt="Revolut"></a>
    </td>
    <td>
      <li>No fees</li>
    </td>
  </tr>
</table>

### Powered by
[![PyCharm logo.](https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.svg)](https://jb.gg/OpenSourceSupport)

[ko_fi_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Ko-Fi&color=F16061&logo=ko-fi&logoColor=white

[ko_fi]: https://ko-fi.com/piotrmachowski

[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=

[buycoffee_to]: https://buycoffee.to/piotrmachowski

[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

[buy_me_a_coffee]: https://www.buymeacoffee.com/PiotrMachowski

[paypal_me_shield]: https://img.shields.io/static/v1.svg?label=%20&message=PayPal.Me&logo=paypal

[paypal_me]: https://paypal.me/PiMachowski

[revolut_me_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Revolut&logo=revolut

[revolut_me]: https://revolut.me/314ma

Home-Assistant-custom-components-Saver

Home-Assistant-custom-components-Saver 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Home-Assistant-custom-components-Saver

Home-Assistant-custom-components-Saver 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README