Minimizing of the configuration sample (#1033)
This commit is contained in:
parent
bb9533e546
commit
a175486bb3
26 changed files with 117 additions and 123 deletions
|
@ -9,35 +9,33 @@ comments: false
|
|||
sharing: true
|
||||
footer: true
|
||||
ha_category: Media Player
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `cmus` platform allows you to control a [cmus](https://cmus.github.io/) music player on a remote or local machine from Home Assistant.
|
||||
|
||||
To add cmus to your installation, add the following to your `configuration.yaml` file if cmus is running on a remote server:
|
||||
To add cmus to your installation, add the following to your `configuration.yaml` file if running locally it will look like:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
platform: cmus
|
||||
host: IP_ADDRESS
|
||||
port: 3000
|
||||
password: PASSWORD
|
||||
name: Desktop Computer Music Player
|
||||
- platform: cmus
|
||||
```
|
||||
|
||||
if running locally it will look like:
|
||||
if cmus is running on a remote server:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
platform: cmus
|
||||
name: Local Music Player
|
||||
- platform: cmus
|
||||
host: IP_ADDRESS
|
||||
password: PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** Hostname or IP address of the machine running cmus. Note if a remote
|
||||
cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
|
||||
- **host** (*Optional*): Hostname or IP address of the machine running cmus. Note if a remote cmus is configured that instance must be configured to listen to remote connections, which also requires a password to be set.
|
||||
- **password** (*Required if host is set*): Password for your cmus player.
|
||||
- **port** (*Optional*): Port of the cmus socket, defaults to 3000.
|
||||
- **name** (*Optional*): The name you'd like to give the cmus player in Home Assistant
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue