Add documentation for cmus media player (#568)

This commit is contained in:
Matthew Treinish 2016-06-25 04:37:50 -04:00 committed by Fabian Affolter
parent c1644d31c5
commit 99e502ea31

View File

@ -0,0 +1,43 @@
---
layout: page
title: "cmus"
description: "Instructions how to integrate cmus Music Player into Home
Assistant."
date: 2016-06-17 18:45
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Media Player
---
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:
```yaml
# Example configuration.yaml entry
media_player:
platform: cmus
host: IP_ADDRESS
port: 3000
password: PASSWORD
name: Desktop Computer Music Player
```
if running locally it will look like:
```yaml
# Example configuration.yaml entry
media_player:
platform: cmus
name: Local Music Player
```
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.
- **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