hdmi_cec component provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use
cec-client (part of the
libcec package) to listen to traffic on the CEC bus and discover the correct numbers.
The computer running Home Assistant must support CEC, and of course be connected via HDMI to a device also supporting CEC. You can purchase a USB CEC adapter to add support if necessary. Note that all Raspberry Pi models support CEC natively.
libcec must be installed for this component to work. Follow the installation instructions for your environment, provided at the link.
libcec installs Python 3 bindings by default as a system Python module. If you are running Home Assistant in a Python virtual environment, make sure it can access the system module, by either symlinking it or using the
If you are using Hass.io then just move forward to the configuration as all requirements are already fulfilled.
Create a symlink to the
cec installation. Keep in mind different installation methods will result in different locations of cec.
$ ln -s /path/to/your/installation/of/cec /path/to/your/venv/lib/python3.4/site-packages
For the default virtual environment of a HASSbian Image for Raspberry Pi the command would be as follows.
$ ln -s /usr/local/lib/python3.4/dist-packages/cec /srv/homeassistant/lib/python3.4/site-packages
For the default virtual environment of a Raspberry Pi All-In-One installation the command would be as follows.
$ ln -s /usr/local/lib/python3.4/site-packages/cec /srv/homeassistant/homeassistant_venv/lib/python3.4/site-packages
For the default virtual environment of a Manual installation the command would be as follows.
$ ln -s /usr/local/lib/python3.4/site-packages/cec /srv/hass/hass_venv/lib/python3.4/site-packages
If after symlinking and adding
hdmi_cec: to your configuration you are getting the following error in your logs,
* failed to open vchiq instance you will also need to add the user account Home Assistant runs under, to the
video group. To add the Home Assistant user account to the
video group, run the following command.
$ usermod -a -G video <hass_user_account>
- Login to Raspberry Pi
ssh [email protected]_raspberry_pi_ip
- at the command line type:
echo scan | cec-client -s -d 1
- This will give you the list of devices that are on the bus
opening a connection to the CEC adapter... requesting CEC bus information ... CEC bus information =================== device #4: Playback 1 address: 188.8.131.52 active source: no vendor: Sony osd string: BD CEC version: 1.4 power status: on language: ???
address: entry above this will be used to configure Home Assistant, this address is represented below as 3: BlueRay player.
In the following example, a Pi Zero running Home Assistant is on a TV’s HDMI port 1. HDMI port 2 is attached to a AV receiver. Three devices are attached to the AV receiver on HDMI ports 1 through 3.
You can use either direct mapping name to physical address of device
hdmi_cec: devices: TV: 0.0.0.0 Pi Zero: 184.108.40.206 Fire TV Stick: 220.127.116.11 Chromecast: 18.104.22.168 Another Device: 22.214.171.124 BlueRay player: 126.96.36.199
or port mapping tree:
hdmi_cec: devices: 1: Pi Zero 2: 1: Fire TV Stick 2: Chromecast 3: Another Device 3: BlueRay player
Choose just one schema. Mixing both approaches is not possible.
Another option you can use in config is
platform which specifying of default platform of HDMI devices. “switch” and “media_player” are supported. Switch is default.
hdmi_cec: platform: media_player
Then you set individual platform for devices in customizations:
hdmi_cec: types: hdmi_cec.hdmi_5: media_player
And the last option is
host. PyCEC supports bridging CEC commands over TCP. When you start pyCEC on machine with HDMI port (
python -m pycec), you can then run homeassistant on another machine and connect to CEC over TCP. Specify TCP address of pyCEC server:
hdmi_cec: host: 192.168.1.3
hdmi_cec/select_device service with the name of the device from config or entity_id or physical address”to select it, for example:
So an Automation action using the example above would look something like this.
action: service: hdmi_cec.select_device data: device: Chromecast
hdmi_cec/power_on service (no arguments) to power on any devices that support this function.
hdmi_cec/standby service (no arguments) to place in standby any devices that support this function.
hdmi_cec/volume service with one of following commands:
Increase volume three times:
Keep increasing volume until release is called:
Stop increasing volume:
Decrease volume three times:
Keep decreasing volume until release is called:
Stop decreasing volume:
value is ignored.