Skip to content

Commit d7ad1ca

Browse files
committed
docs: add new sensors and buttons
1 parent fa3488c commit d7ad1ca

File tree

5 files changed

+25
-2
lines changed

5 files changed

+25
-2
lines changed
25.3 KB
Loading
25 KB
Loading

docs/assets/example-sensors.png

18.8 KB
Loading

docs/sensors.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1-
The built-in sensor can be used to monitor the status of your backups.
1+
# Entities
2+
3+
Entities for monitoring and controlling the Auto Backup integration.
4+
5+
![example-sensors.png](assets/example-sensors.png)
6+
7+
| Name | Type | Enabled by default | Description |
8+
| ----------------- | --------------- | ------------------ | ------------------------------------------------------------------------------------------------------------ |
9+
| Purge | `button` || Purge expired backups ondemand, otherwise, they are purged automatically when creating a new backup |
10+
| Backup Status | `binary_sensor` || Displays whether a backup operation is currently running |
11+
| Successful | `binary_sensor` | | Whether the last backup **succeeded** or **failed** |
12+
| Last Failure | `sensor` || Time of the last **failed** backup |
13+
| Last Success | `sensor` || Time of the last **successful** backup |
14+
| Monitored backups | `sensor` || How many backups have an expiry date and are being monitored to be purged. |
15+
| Purgeable backups | `sensor` || The number of backups which have passed their expiry date and will be purged during the next purge operation |
16+
| Next Expiration | `sensor` | | How long until the next non-expired backup will expire |
17+
18+
---
19+
20+
**Additional images**
21+
22+
![example-sensors-extra.png](assets/example-sensors-extra.png)
23+
24+
![example-sensors-list.png](assets/example-sensors-list.png)
225

326
![Sensor Example](assets/example-sensor.png)

mkdocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ extra:
1919
nav:
2020
- "index.md"
2121
- "services.md"
22-
- "events.md"
2322
- "sensors.md"
23+
- "events.md"
2424
- "faq.md"
2525
- Examples:
2626
- "examples.md"

0 commit comments

Comments
 (0)