Add config flow to Bose SoundTouch documentation (#23241)

* Add config flow to Bose SoundTouch documentation

* Improve wording
This commit is contained in:
Stefan Rado 2022-07-01 08:49:54 +02:00 committed by GitHub
parent 1a10da6004
commit 87ae9cca6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,62 +1,24 @@
--- ---
title: Bose Soundtouch title: Bose SoundTouch
description: Instructions on how to integrate Bose Soundtouch devices into Home Assistant. description: Instructions on how to integrate Bose SoundTouch devices into Home Assistant.
ha_category: ha_category:
- Media Player - Media Player
ha_release: 0.34 ha_release: 0.34
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: soundtouch ha_domain: soundtouch
ha_config_flow: true
ha_codeowners:
- '@kroimon'
ha_platforms: ha_platforms:
- media_player - media_player
ha_integration_type: integration ha_integration_type: integration
--- ---
The `soundtouch` platform allows you to control your [Bose Soundtouch](https://www.soundtouch.com/) speakers from Home Assistant. The Bose SoundTouch integration allows you to control your [Bose SoundTouch](https://www.soundtouch.com/) speakers from Home Assistant.
By default it supports auto-discovery provided by Home Assistant, and you don't need to add anything to your `configuration.yaml`. {% include integrations/config_flow.md %}
Alternatively, you can add the following to your `configuration.yaml` file. ## Playing media
```yaml
# Example configuration.yaml
media_player:
- platform: soundtouch
host: 192.168.1.1
port: 8090
name: Soundtouch Living Room
```
Or for multiple hosts
```yaml
# Example configuration.yaml with many devices
media_player:
- platform: soundtouch
host: 192.168.1.1
port: 8090
name: Soundtouch Living Room
- platform: soundtouch
host: 192.168.1.1
port: 8090
name: Soundtouch kitchen
```
{% configuration %}
host:
description: The host name or address of the Soundtouch device.
required: true
type: string
name:
description: The name of the device used in the frontend.
required: true
default: Bose Soundtouch
type: string
port:
description: The port number.
required: false
default: 8090
type: integer
{% endconfiguration %}
You can switch between one of your 6 pre-configured presets using ```media_player.play_media``` You can switch between one of your 6 pre-configured presets using ```media_player.play_media```
@ -86,7 +48,9 @@ You can also play HTTP (not HTTPS) URLs:
You can use TTS services like [Google Text-to-Speech](/integrations/google_translate) or [Amazon Polly](/integrations/amazon_polly) only if your Home Assistant is configured in HTTP and not HTTPS (current device limitation, a firmware upgrade is planned). You can use TTS services like [Google Text-to-Speech](/integrations/google_translate) or [Amazon Polly](/integrations/amazon_polly) only if your Home Assistant is configured in HTTP and not HTTPS (current device limitation, a firmware upgrade is planned).
A workaround if you want to publish your Home Assistant installation on Internet in SSL is to configure an HTTPS Web Server as a reverse proxy ([NGINX](/docs/ecosystem/nginx/) for example) and let your Home Assistant configuration in HTTP on your local network. The Soundtouch devices will be available to access the TTS files in HTTP in local and your configuration will be in HTTPS on the Internet. A workaround if you want to publish your Home Assistant installation on Internet in SSL is to configure an HTTPS Web Server as a reverse proxy ([NGINX](/docs/ecosystem/nginx/) for example) and let your Home Assistant configuration in HTTP on your local network. The SoundTouch devices will be available to access the TTS files in HTTP in local and your configuration will be in HTTPS on the Internet.
## Services
### Service `play_everywhere` ### Service `play_everywhere`