Update Volumio documentation with config flow (#14093)

Co-authored-by: Franck Nijhof <frenck@frenck.dev>
This commit is contained in:
On Freund 2020-07-27 10:38:53 +03:00 committed by GitHub
parent b7b3617f18
commit 78103961f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,40 +1,26 @@
--- ---
title: Volumio title: Volumio
description: How to set up the Volumio media player platform description: How to set up the Volumio media player integration
ha_category: ha_category:
- Media Player - Media Player
ha_release: 0.41 ha_release: 0.41
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@OnFreund'
ha_domain: volumio ha_domain: volumio
--- ---
The `Volumio` platform allows you to control a [Volumio](https://volumio.org/) media player from Home Assistant. The `Volumio` platform allows you to control a [Volumio](https://volumio.org/) media player from Home Assistant.
The preferred way to set up the Volumio platform is by enabling the [discovery component](/integrations/discovery/). ## Configuration
In case the discovery does not work, or you need specific configuration variables, you can add the following to your `configuration.yaml` file: Menu: **Configuration** -> **Integrations**.
```yaml In most cases, your Volumio device should be discovered and you'll simply need to click "Configure" to add it to Home Assistant.
# Example configuration.yaml entry
media_player:
- platform: volumio
host: homeaudio.local
port: 3000
```
{% configuration %} If it's not discovered, you can click on the `+` sign to add an integration and then click on **Volumio**, and finally input the host and port.
name:
description: The name of the device. <div class='note'>
required: false Volumio versions 2.799 and below do not have a unique id when manually configured, so you will not be able to rename your entity or add your device to a area. If discovery does not work for you, it is advised to upgrade Volumio before configuring.
default: Volumio </div>
type: string
host:
description: The IP address or hostname of the device.
required: true
default: localhost
type: string
port:
description: The Port number of Volumio service.
required: true
default: 3000
type: integer
{% endconfiguration %}