From 99e502ea3115b4be380a1e282862357ab600a2da Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Sat, 25 Jun 2016 04:37:50 -0400 Subject: [PATCH] Add documentation for cmus media player (#568) --- source/_components/media_player.cmus.markdown | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 source/_components/media_player.cmus.markdown diff --git a/source/_components/media_player.cmus.markdown b/source/_components/media_player.cmus.markdown new file mode 100644 index 00000000000..b26289e46c4 --- /dev/null +++ b/source/_components/media_player.cmus.markdown @@ -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