Add config flow instructions to version integration (#18935)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Joakim Sørensen 2021-12-24 13:22:52 +01:00 committed by GitHub
parent cfb69e24dd
commit 20364dbab2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,43 +13,9 @@ ha_codeowners:
ha_domain: version
ha_platforms:
- sensor
ha_config_flow: true
---
The `version` sensor platform that can display the current Home Assistant versions.
The Version integration can display the current Home Assistant versions.
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml`:
```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`, `supervisor` and `container`.
required: false
type: boolean
default: false
image:
description: The image you want to check against, this is only supported for `supervisor` and `container`, see full list under.
required: false
type: string
default: default
source:
description: The source you want to check against, possible values are `local`, `pypi`, `supervisor`, `haio` and `container`.
required: false
type: string
default: local
{% endconfiguration %}
### Supported images for Home Assistant
`default`, `qemux86`, `qemux86-64`, `qemuarm`, `qemuarm-64`, `generic-x86-64`, `raspberrypi`, `raspberrypi2`, `raspberrypi3`, `raspberrypi3-64`, `raspberrypi4`, `raspberrypi4-64`, `tinker`, `odroid-c2`, `odroid-n2`, `odroid-xu`
{% include integrations/config_flow.md %}