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.yaml file if running locally it 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.