Home Assistant Supervisor for Home Assistant (built-in integration)

About

Home Assistant Supervisor is a built-in integration that exposes the Supervisor's status and controls inside Home Assistant. It works locally and provides binary sensors, sensors, switches and update entities. The sensors cover versions, CPU and memory use, and disk space, while the binary sensors report whether it is connected and running. Actions let automations start, stop and restart add-ons and apps, write to their standard input, create full or partial backups, restore from them, reboot or power off the host, and reload a network storage mount. It also raises repair notices for issues such as app conflicts, low disk space, failed network storage, time synchronization problems and a pending reboot, and adds its status to system health. Setup is done in configuration.yaml.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in YAML Added through configuration.yaml.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Switches
Sensors

Setting it up

It is set up in configuration.yaml, not in the UI.

Entities

Binary sensorsConnected, Running
SensorsOS Agent version, AppArmor version, CPU percent, Disk free, Disk total, Disk used, Memory percent, Version, Newest version
UpdatesUpdate

Actions

Restart add-onRestarts an add-on.Fields: Add-on
Start add-onStarts an add-on.Fields: Add-on
Write data to add-on stdinWrites data to the add-on's standard input.Fields: Add-on
Stop add-onStops an add-on.Fields: Add-on
Restart appRestarts a Home Assistant app.Fields: App
Start appStarts a Home Assistant app.Fields: App
Write data to app stdinWrites data to the standard input of a Home Assistant app.Fields: App, Input
Stop appStops a Home Assistant app.Fields: App
Create a full backupCreates a full backup.Fields: Compressed, Home Assistant exclude database, Location, Name, Password
Create a partial backupCreates a partial backup.Fields: Add-ons (legacy), Apps, Compressed, Folders, Home Assistant settings, Home Assistant exclude database, Location, Name, Password
Reboot the host systemReboots the host system.
Power off the host systemPowers off the host system.
Reload network storage mountReloads a network storage mount.Fields: Device ID
Restore from full backupRestores from full backup.Fields: Password, Slug
Restore from partial backupRestores from a partial backup.Fields: Add-ons (legacy), Apps, Folders, Home Assistant settings, Password, Slug

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
System healthAdds its status to Home Assistant's system information.
Repair noticesNotices it can show in Settings, Repairs:App port conflict, App failed to start at boot, Installed app is deprecated, Installed app is built for unsupported architectures and/or machines, Missing repository for an installed app, Installed app has been removed from repository, Insecure secrets detected in app configuration, Network storage device failed, Disk lifetime exceeding 90%, Restart(s) required, Data disk is running low on free space, Multiple data disks detected, Time synchronization issue detected, Reboot required, Legacy "homeassistant" folder used in partial backup/restore