Home Assistant

cmus

The cmus platform allows you to control a cmus music player on a remote or local machine from Home Assistant.

To add cmus to your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.[Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.[Learn more] file, restart Home Assistant to apply the changes. To view the changes, go to Settings > Devices & services > Entities.

Running it locally will look like:

# Example configuration.yaml entry
media_player:
  - platform: cmus

If cmus is running on a remote server:

# Example configuration.yaml entry
media_player:
  - platform: cmus
    host: IP_ADDRESS_OF_CMUS_PLAYER
    password: YOUR_PASSWORD

Configuration Variables

Looking for your configuration file?
host string (Inclusive)

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 string (Inclusive)

Password for your cmus player.

port integer (Optional, default: 3000)

Port of the cmus socket.

name string (Optional, default: cmus)

The name you’d like to give the cmus player in Home Assistant.