home-assistant.github.io/source/_components/media_player.bluesound.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942)
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

82 lines
3 KiB
Markdown

---
layout: page
title: "Bluesound"
description: "Instructions on how to integrate Bluesound devices into Home Assistant."
date: 2017-04-21 19:00
sidebar: true
comments: false
sharing: true
footer: true
logo: bluesound.png
ha_category: Media Player
featured: false
ha_release: 0.51
ha_iot_class: "Local Polling"
---
The `bluesound` platform allows you to control your [Bluesound](http://www.bluesound.com/) HiFi wireless speakers and audio components from Home Assistant.
If you want to automatically discover new devices, just make sure you have discovery: in your configuration.yaml file. To manually add a Bluesound device to your installation, add the following to your configuration.yaml file:
```yaml
# Example configuration.yaml
media_player:
- platform: bluesound
hosts:
- host: 192.168.1.100
```
Configuration variables:
- **hosts** (*Optional*): List with your bluesound devices
- **host** (*Required*): IP-address or hostname of the player
- **name** (*Optional*): The name of the device used in the frontend
- **port** (*Optional*): Port of communication to the device (default: 11000)
## Advanced configuration example
```yaml
# Example configuration.yaml entry with manually specified addresses
media_player:
- platform: bluesound
hosts:
- host: 192.168.1.100
name: bluesound_kitchen
port: 11000
- host: 192.168.1.131
```
### {% linkable_title Service `bluesound_join` %}
Group players together under a single master speaker. That will make a new group or join to exists group.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `master` | no | A single `entity_id` that will become/hold the master speaker.
| `entity_id` | no | String or list of a single `entity_id` that will group to master speaker.
### {% linkable_title Service `bluesound_unjoin` %}
Remove one or more speakers from a group of speakers. If no `entity_id` is provided, all speakers are unjoined.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker.
### {% linkable_title Service `bluesound_set_sleep_timer` %}
Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0.
If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers set.
### {% linkable_title Service `bluesound_clear_sleep_timer` %}
Clear the sleep timer on a speaker, if one is set.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared.