Adds documentation for home-assistant/home-assistant#18067 (#7305)

* Adds configuration options for additional functionality

* Corrected typo

* Fix typo
This commit is contained in:
Joakim Sørensen 2018-11-01 09:36:25 +01:00 committed by Fabian Affolter
parent 96b91319b2
commit 0c3a7a9b0c

View File

@ -14,11 +14,11 @@ ha_release: 0.52
ha_qa_scale: internal
---
The `version` sensor platform is displaying the current version of Home Assistant in the frontend.
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` file for a GET request:
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
@ -31,10 +31,29 @@ name:
description: Name to use in the frontend.
required: false
type: string
default: Current Version
default: Home Assistant Version
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 Alternatives %}
### {% 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.
@ -56,7 +75,7 @@ sensor:
command: "/home/homeassistant/bin/hass --version"
```
It's also possible to ready a file called `.HA_VERSION` which is located in your
It's also possible to read a file called `.HA_VERSION` which is located in your
Home Assistant [configuration](/docs/configuration/) folder.
```yaml
@ -68,7 +87,7 @@ sensor:
You might think that a [`rest` sensor](/components/sensor.rest/) could work,
too,
but it will not as Home Assistant is not ready when the sensor get initialized.
but it will not as Home Assistant is not ready when the sensor gets initialized.
{% raw %}
```yaml