HDMI CEC
The CEC component provides services that allow selecting the active device, powering on all devices, and setting all devices to standby. 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 Soundbars 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.
CEC Setup
Adapter
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
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 --system-site-packages
flag.
Symlinking into virtual environment
Create a symlink to the cec
installation.
$ ln -s /usr/local/lib/python3.4/dist-packages/cec /path/to/your/venv/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/dist-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>
Testing your installation
- Login to Raspberry Pi
ssh pi@your_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: 3.0.0.0
active source: no
vendor: Sony
osd string: BD
CEC version: 1.4
power status: on
language: ???
Note the address: line above this will be used to configure HA, this address is represented below as 3: BlueRay player
Configuration Example
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.
hdmi_cec:
devices:
1: Pi Zero
2:
1: Fire TV Stick
2: Chromecast
3: Another Device
3: BlueRay player
Services
Select Device
Call the hdmi_cec/select_device
service with the name of the device to select, for example:
{
"device": "Chromecast"
}
So an Automation action using the example above would look something like this.
action:
service: hdmi_cec.select_device
data:
device: Chromecast
Power On
Call the hdmi_cec/power_on
service (no arguments) to power on any devices that support this function.
Standby
Call the hdmi_cec/standby
service (no arguments) to place in standby any devices that support this function.