Config-flow options for DLNA integration (#19087)

This commit is contained in:
Michael Chisholm 2021-09-28 06:53:12 +10:00 committed by GitHub
parent 67396a5575
commit 6fc53d9b20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -5,7 +5,12 @@ ha_category:
- Media Player
ha_release: 0.76
ha_iot_class: Local Push
ha_config_flow: true
ha_codeowners:
- '@StevenLooman'
- '@chishm'
ha_domain: dlna_dmr
ha_ssdp: true
ha_platforms:
- media_player
---
@ -14,37 +19,17 @@ The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](ht
Please note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS service might not work in combination with these devices. If the play_media service does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)).
## Configuration
{% include integrations/config_flow.md %}
To add a DLNA DMR device to your installation, add the following to your `configuration.yaml` file:
## Options
```yaml
# Example configuration.yaml entry
media_player:
- platform: dlna_dmr
url: http://192.168.0.10:9197/description.xml
```
Options for DLNA DMR devices can be set going to **Configuration** -> **Integrations** -> **DLNA Digital Media Renderer** -> **Configuration**.
{% configuration %}
url:
description: The URL to the device description XML file, e.g., `http://192.168.0.10:9197/description.xml`.
required: true
type: string
listen_ip:
description: IP to listen on for events from the device. Only set this when the IP is not detected properly.
required: false
type: string
listen_port:
description: Port to listen on for events from the device.
required: false
default: 8301
type: integer
name:
description: The name you would like to give to the device, e.g., `TV living room`.
required: false
type: string
callback_url_override:
description: Override the advertised callback URL. In case the Home Assistant instance is not directly reachable (e.g., running in a Docker container without bridged-networking), advertise this callback URL for events.
required: false
type: string
{% endconfiguration %}
{% configuration_basic %}
Event listener port:
description: "Local port to listen on for events sent by the DLNA device. If this is not set, a random port will be allocated. Use this if you need a specific incoming port for firewall or NAT reasons."
Event listener callback URL:
description: "Local URL destination for events sent by the DLNA device. It should be of the form `http://{host}:{port}/notify`, where keywords `{host}` and `{port}` will be automatically filled-in but can be set explicitly here, e.g. `http://192.88.99.1:5555/notify`. Use this if the local IP address or port seen by Home Assistant is not what the device should connect to, because of Network Address Translation (NAT)."
Poll for device availability:
description: "Periodically try to connect to the DLNA device, even if it is unavailable. Enable this if SSDP advertisements sent by the device are not received by Home Assistant, e.g. when IP multicast is broken on your network."
{% endconfiguration_basic %}