Namespaces
	const

	entity

	media_player

	switch

Functions
def	pad_physical_address (addr)

def	parse_mapping (mapping, parents=None)

bool	setup (HomeAssistant hass, ConfigType base_config)

Variables
	_LOGGER = logging.getLogger(__name__)

	_VOL_HEX = vol.Any(vol.Coerce(int), lambda x: int(x, 16))

string	ATTR_ABT = "abt"

string	ATTR_ATT = "att"

string	ATTR_CMD = "cmd"

string	ATTR_DEVICE = "device"

string	ATTR_DIR = "dir"

string	ATTR_DST = "dst"

string	ATTR_DUR = "dur"

string	ATTR_KEY = "key"

string	ATTR_NEW = "new"

string	ATTR_OFF = "off"

string	ATTR_ON = "on"

string	ATTR_RAW = "raw"

string	ATTR_SRC = "src"

string	ATTR_TOGGLE = "toggle"

string	CMD_DOWN = "down"

string	CMD_MUTE = "mute"

string	CMD_MUTE_TOGGLE = "toggle mute"

string	CMD_PRESS = "press"

string	CMD_RELEASE = "release"

string	CMD_UNMUTE = "unmute"

string	CMD_UP = "up"

string	CONF_DISPLAY_NAME = "osd_name"

string	CONF_TYPES = "types"

	CONFIG_SCHEMA

string	DEFAULT_DISPLAY_NAME = "HA"

string	EVENT_CEC_COMMAND_RECEIVED = "cec_command_received"

string	EVENT_CEC_KEYPRESS_RECEIVED = "cec_keypress_received"

	Schema

string	SERVICE_POWER_ON = "power_on"

string	SERVICE_SELECT_DEVICE = "select_device"

string	SERVICE_SEND_COMMAND = "send_command"

	SERVICE_SEND_COMMAND_SCHEMA

string	SERVICE_STANDBY = "standby"

string	SERVICE_UPDATE_DEVICES = "update"

	SERVICE_UPDATE_DEVICES_SCHEMA

string	SERVICE_VOLUME = "volume"

	SERVICE_VOLUME_SCHEMA

int	WATCHDOG_INTERVAL = 120

Detailed Description

Support for HDMI CEC.

Function Documentation

◆ pad_physical_address()

def homeassistant.components.hdmi_cec.pad_physical_address ( addr )

Right-pad a physical address.

Definition at line 141 of file __init__.py.

◆ parse_mapping()

def homeassistant.components.hdmi_cec.parse_mapping	(	mapping,
		parents = `None`
	)

Parse configuration device mapping.

Definition at line 146 of file __init__.py.

◆ setup()

bool homeassistant.components.hdmi_cec.setup	(	HomeAssistant	hass,
		ConfigType	base_config
	)

Set up the CEC capability.

Definition at line 161 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.hdmi_cec._LOGGER = logging.getLogger(__name__)

private

Definition at line 42 of file __init__.py.

◆ _VOL_HEX

homeassistant.components.hdmi_cec._VOL_HEX = vol.Any(vol.Coerce(int), lambda x: int(x, 16))

private

Definition at line 73 of file __init__.py.

◆ ATTR_ABT

string homeassistant.components.hdmi_cec.ATTR_ABT = "abt"

Definition at line 67 of file __init__.py.

◆ ATTR_ATT

string homeassistant.components.hdmi_cec.ATTR_ATT = "att"

Definition at line 64 of file __init__.py.

◆ ATTR_CMD

string homeassistant.components.hdmi_cec.ATTR_CMD = "cmd"

Definition at line 63 of file __init__.py.

◆ ATTR_DEVICE

string homeassistant.components.hdmi_cec.ATTR_DEVICE = "device"

Definition at line 58 of file __init__.py.

◆ ATTR_DIR

string homeassistant.components.hdmi_cec.ATTR_DIR = "dir"

Definition at line 66 of file __init__.py.

◆ ATTR_DST

string homeassistant.components.hdmi_cec.ATTR_DST = "dst"

Definition at line 62 of file __init__.py.

◆ ATTR_DUR

string homeassistant.components.hdmi_cec.ATTR_DUR = "dur"

Definition at line 60 of file __init__.py.

◆ ATTR_KEY

string homeassistant.components.hdmi_cec.ATTR_KEY = "key"

Definition at line 59 of file __init__.py.

◆ ATTR_NEW

string homeassistant.components.hdmi_cec.ATTR_NEW = "new"

Definition at line 68 of file __init__.py.

◆ ATTR_OFF

string homeassistant.components.hdmi_cec.ATTR_OFF = "off"

Definition at line 70 of file __init__.py.

◆ ATTR_ON

string homeassistant.components.hdmi_cec.ATTR_ON = "on"

Definition at line 69 of file __init__.py.

◆ ATTR_RAW

string homeassistant.components.hdmi_cec.ATTR_RAW = "raw"

Definition at line 65 of file __init__.py.

◆ ATTR_SRC

string homeassistant.components.hdmi_cec.ATTR_SRC = "src"

Definition at line 61 of file __init__.py.

◆ ATTR_TOGGLE

string homeassistant.components.hdmi_cec.ATTR_TOGGLE = "toggle"

Definition at line 71 of file __init__.py.

◆ CMD_DOWN

string homeassistant.components.hdmi_cec.CMD_DOWN = "down"

Definition at line 48 of file __init__.py.

◆ CMD_MUTE

string homeassistant.components.hdmi_cec.CMD_MUTE = "mute"

Definition at line 49 of file __init__.py.

◆ CMD_MUTE_TOGGLE

string homeassistant.components.hdmi_cec.CMD_MUTE_TOGGLE = "toggle mute"

Definition at line 51 of file __init__.py.

◆ CMD_PRESS

string homeassistant.components.hdmi_cec.CMD_PRESS = "press"

Definition at line 52 of file __init__.py.

◆ CMD_RELEASE

string homeassistant.components.hdmi_cec.CMD_RELEASE = "release"

Definition at line 53 of file __init__.py.

◆ CMD_UNMUTE

string homeassistant.components.hdmi_cec.CMD_UNMUTE = "unmute"

Definition at line 50 of file __init__.py.

◆ CMD_UP

string homeassistant.components.hdmi_cec.CMD_UP = "up"

Definition at line 47 of file __init__.py.

◆ CONF_DISPLAY_NAME

string homeassistant.components.hdmi_cec.CONF_DISPLAY_NAME = "osd_name"

Definition at line 117 of file __init__.py.

◆ CONF_TYPES

string homeassistant.components.hdmi_cec.CONF_TYPES = "types"

Definition at line 45 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.hdmi_cec.CONFIG_SCHEMA

Initial value:

 =  vol.Schema(
     {
         DOMAIN: vol.Schema(
             {
                 vol.Optional(CONF_DEVICES): vol.Any(
                     DEVICE_SCHEMA, vol.Schema({vol.All(cv.string): vol.Any(cv.string)})
                 ),
                 vol.Optional(CONF_PLATFORM): vol.Any(SWITCH, MEDIA_PLAYER),
                 vol.Optional(CONF_HOST): cv.string,
                 vol.Optional(CONF_DISPLAY_NAME): cv.string,
                 vol.Optional(CONF_TYPES, default={}): vol.Schema(
                     {cv.entity_id: vol.Any(MEDIA_PLAYER, SWITCH)}
                 ),
             }
         )
     },
     extra=vol.ALLOW_EXTRA,
 )

Definition at line 119 of file __init__.py.

◆ DEFAULT_DISPLAY_NAME

string homeassistant.components.hdmi_cec.DEFAULT_DISPLAY_NAME = "HA"

Definition at line 44 of file __init__.py.

◆ EVENT_CEC_COMMAND_RECEIVED

string homeassistant.components.hdmi_cec.EVENT_CEC_COMMAND_RECEIVED = "cec_command_received"

Definition at line 55 of file __init__.py.

◆ EVENT_CEC_KEYPRESS_RECEIVED

string homeassistant.components.hdmi_cec.EVENT_CEC_KEYPRESS_RECEIVED = "cec_keypress_received"

Definition at line 56 of file __init__.py.

◆ Schema

homeassistant.components.hdmi_cec.Schema

Definition at line 107 of file __init__.py.

◆ SERVICE_POWER_ON

string homeassistant.components.hdmi_cec.SERVICE_POWER_ON = "power_on"

Definition at line 104 of file __init__.py.

◆ SERVICE_SELECT_DEVICE

string homeassistant.components.hdmi_cec.SERVICE_SELECT_DEVICE = "select_device"

Definition at line 102 of file __init__.py.

◆ SERVICE_SEND_COMMAND

string homeassistant.components.hdmi_cec.SERVICE_SEND_COMMAND = "send_command"

Definition at line 75 of file __init__.py.

◆ SERVICE_SEND_COMMAND_SCHEMA

homeassistant.components.hdmi_cec.SERVICE_SEND_COMMAND_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Optional(ATTR_CMD): _VOL_HEX,
         vol.Optional(ATTR_SRC): _VOL_HEX,
         vol.Optional(ATTR_DST): _VOL_HEX,
         vol.Optional(ATTR_ATT): _VOL_HEX,
         vol.Optional(ATTR_RAW): vol.Coerce(str),
     },
     extra=vol.PREVENT_EXTRA,
 )

Definition at line 76 of file __init__.py.

◆ SERVICE_STANDBY

string homeassistant.components.hdmi_cec.SERVICE_STANDBY = "standby"

Definition at line 105 of file __init__.py.

◆ SERVICE_UPDATE_DEVICES

string homeassistant.components.hdmi_cec.SERVICE_UPDATE_DEVICES = "update"

Definition at line 97 of file __init__.py.

◆ SERVICE_UPDATE_DEVICES_SCHEMA

homeassistant.components.hdmi_cec.SERVICE_UPDATE_DEVICES_SCHEMA

Initial value:

 =  vol.Schema(
     {DOMAIN: vol.Schema({})}, extra=vol.PREVENT_EXTRA
 )

Definition at line 98 of file __init__.py.

◆ SERVICE_VOLUME

string homeassistant.components.hdmi_cec.SERVICE_VOLUME = "volume"

Definition at line 87 of file __init__.py.

◆ SERVICE_VOLUME_SCHEMA

homeassistant.components.hdmi_cec.SERVICE_VOLUME_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Optional(CMD_UP): vol.Any(CMD_PRESS, CMD_RELEASE, vol.Coerce(int)),
         vol.Optional(CMD_DOWN): vol.Any(CMD_PRESS, CMD_RELEASE, vol.Coerce(int)),
         vol.Optional(CMD_MUTE): vol.Any(ATTR_ON, ATTR_OFF, ATTR_TOGGLE),
     },
     extra=vol.PREVENT_EXTRA,
 )

Definition at line 88 of file __init__.py.

◆ WATCHDOG_INTERVAL

int homeassistant.components.hdmi_cec.WATCHDOG_INTERVAL = 120

Definition at line 138 of file __init__.py.

Home Assistant Unofficial Reference 2024.12.1

Namespaces

Functions

Variables

Detailed Description

Function Documentation

◆ pad_physical_address()

◆ parse_mapping()

◆ setup()

Variable Documentation

◆ _LOGGER

◆ _VOL_HEX

◆ ATTR_ABT

◆ ATTR_ATT

◆ ATTR_CMD

◆ ATTR_DEVICE

◆ ATTR_DIR

◆ ATTR_DST

◆ ATTR_DUR

◆ ATTR_KEY

◆ ATTR_NEW

◆ ATTR_OFF

◆ ATTR_ON

◆ ATTR_RAW

◆ ATTR_SRC

◆ ATTR_TOGGLE

◆ CMD_DOWN

◆ CMD_MUTE

◆ CMD_MUTE_TOGGLE

◆ CMD_PRESS

◆ CMD_RELEASE

◆ CMD_UNMUTE

◆ CMD_UP

◆ CONF_DISPLAY_NAME

◆ CONF_TYPES

◆ CONFIG_SCHEMA

◆ DEFAULT_DISPLAY_NAME

◆ EVENT_CEC_COMMAND_RECEIVED

◆ EVENT_CEC_KEYPRESS_RECEIVED

◆ Schema

◆ SERVICE_POWER_ON

◆ SERVICE_SELECT_DEVICE

◆ SERVICE_SEND_COMMAND

◆ SERVICE_SEND_COMMAND_SCHEMA

◆ SERVICE_STANDBY

◆ SERVICE_UPDATE_DEVICES

◆ SERVICE_UPDATE_DEVICES_SCHEMA

◆ SERVICE_VOLUME

◆ SERVICE_VOLUME_SCHEMA

◆ WATCHDOG_INTERVAL