home-assistant.io/source/_components/sensor.version.markdown
2018-11-10 21:13:54 +01:00

2.8 KiB

layout, title, description, date, sidebar, comments, sharing, footer, ha_category, ha_iot_class, logo, ha_release, ha_qa_scale
layout title description date sidebar comments sharing footer ha_category ha_iot_class logo ha_release ha_qa_scale
page Version Sensor Instructions on how to integrate a version sensor into Home Assistant. 2017-08-10 10:30 true false true true Utility Local Pushing home-assistant.png 0.52 internal

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

{% linkable_title Configuration %}

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

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

{% configuration %} name: description: Name to use in the frontend. required: false type: string default: "Current Version in case of source: local, Latest Version otherwise" beta: description: Flag to indicate that it will check for beta versions, only supported for the sources pypi, hassio and docker. required: false type: boolean default: false image: description: The image you want to check against, this is only supported for hassio, see full list under. required: false type: string default: default source: description: The source you want to check against, possible values are local, pypi, hassio and docker. required: false type: string default: local {% endconfiguration %}

{% linkable_title Supported images for Hassio %}

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

{% linkable_title 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 service developer tool icon 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.

{% raw %}

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

{% endraw %}