mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-24 02:56:49 +00:00
58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
---
|
|
title: cmus
|
|
description: Instructions on how to integrate cmus Music Player into Home Assistant.
|
|
ha_category:
|
|
- Media player
|
|
ha_iot_class: Local Polling
|
|
ha_release: 0.23
|
|
ha_domain: cmus
|
|
ha_platforms:
|
|
- media_player
|
|
ha_integration_type: integration
|
|
ha_quality_scale: legacy
|
|
---
|
|
|
|
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 {% term "`configuration.yaml`" %} file.
|
|
{% include integrations/restart_ha_after_config_inclusion.md %}
|
|
|
|
Running it locally will look like:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
media_player:
|
|
- platform: cmus
|
|
```
|
|
|
|
If cmus is running on a remote server:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
media_player:
|
|
- platform: cmus
|
|
host: IP_ADDRESS_OF_CMUS_PLAYER
|
|
password: YOUR_PASSWORD
|
|
```
|
|
|
|
{% configuration %}
|
|
host:
|
|
description: 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.
|
|
required: inclusive
|
|
type: string
|
|
password:
|
|
description: Password for your cmus player.
|
|
required: inclusive
|
|
type: string
|
|
port:
|
|
description: Port of the cmus socket.
|
|
required: false
|
|
default: 3000
|
|
type: integer
|
|
name:
|
|
description: The name you'd like to give the cmus player in Home Assistant.
|
|
required: false
|
|
default: cmus
|
|
type: string
|
|
{% endconfiguration %}
|