Version Sensor

The version sensor platform that can display the current Home Assistant versions.

Configuration

To enable this sensor, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
sensor:
  - platform: version

Configuration Variables

name

(string)(Optional)

Name to use in the frontend.

Default value:

Current Version in case of source: local, Latest Version otherwise.

beta

(boolean)(Optional)

Flag to indicate that it will check for beta versions, only supported for the sources pypi, hassio and docker.

Default value:

false

image

(string)(Optional)

The image you want to check against, this is only supported for hassio and docker, see full list under.

Default value:

default

source

(string)(Optional)

The source you want to check against, possible values are local, pypi, hassio, haio and docker.

Default value:

local

Supported images for Hass.io and Docker

default, qemux86, qemux86-64, qemuarm, qemuarm-64, intel-nuc, raspberrypi, raspberrypi2, raspberrypi3, raspberrypi3-64, raspberrypi4, raspberrypi4-64, tinker, odroid-c2, odroid-xu

Alternatives for showing local version

This sensor is an alternative to the existing solutions to achieve the same result through various platforms. Remember that you can easily get the installed version on the command line.

hass --version

Or go to the Info section of the Developer Tools.

A command_line with hass to display your current version.

sensor:
  - platform: command_line
    name: Version
    command: "/home/homeassistant/bin/hass --version"

It’s also possible to read a file called .HA_VERSION which is located in your Home Assistant configuration folder.

sensor:
  - platform: command_line
    name: Version
    command: "cat /home/homeassistant/.homeassistant/.HA_VERSION"

You might think that a rest sensor could work, too, but it will not as Home Assistant is not ready when the sensor gets initialized.

sensor:
  - platform: rest
    resource: http://IP_ADDRESS:8123/api/config
    name: Current Version
    value_template: '{{ value_json.version }}'