Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.webostv Namespace Reference

Namespaces

 config_flow
 
 const
 
 device_trigger
 
 diagnostics
 
 helpers
 
 media_player
 
 notify
 
 trigger
 
 triggers
 

Classes

class  ServiceMethodDetails
 

Functions

WebOsClient async_control_connect (str host, str|None key)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None async_update_options (HomeAssistant hass, ConfigEntry entry)
 
None update_client_key (HomeAssistant hass, ConfigEntry entry, WebOsClient client)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 BUTTON_SCHEMA = CALL_SCHEMA.extend({vol.Required(ATTR_BUTTON): cv.string})
 
 CALL_SCHEMA = vol.Schema({vol.Required(ATTR_ENTITY_ID): cv.comp_entity_ids})
 
 COMMAND_SCHEMA
 
 CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
 
dictionary SERVICE_TO_METHOD
 
 SOUND_OUTPUT_SCHEMA = CALL_SCHEMA.extend({vol.Required(ATTR_SOUND_OUTPUT): cv.string})
 

Detailed Description

Support for LG webOS Smart TV.

Function Documentation

◆ async_control_connect()

WebOsClient homeassistant.components.webostv.async_control_connect ( str  host,
str | None  key 
)
LG Connection.

Definition at line 151 of file __init__.py.

◆ async_setup()

bool homeassistant.components.webostv.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the LG WebOS TV platform.

Definition at line 77 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.webostv.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set the config entry up.

Definition at line 86 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.webostv.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 176 of file __init__.py.

◆ async_update_options()

None homeassistant.components.webostv.async_update_options ( HomeAssistant  hass,
ConfigEntry  entry 
)
Update options.

Definition at line 146 of file __init__.py.

◆ update_client_key()

None homeassistant.components.webostv.update_client_key ( HomeAssistant  hass,
ConfigEntry  entry,
WebOsClient   client 
)
Check and update stored client key if key has changed.

Definition at line 163 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.webostv._LOGGER = logging.getLogger(__name__)
private

Definition at line 74 of file __init__.py.

◆ BUTTON_SCHEMA

homeassistant.components.webostv.BUTTON_SCHEMA = CALL_SCHEMA.extend({vol.Required(ATTR_BUTTON): cv.string})

Definition at line 55 of file __init__.py.

◆ CALL_SCHEMA

homeassistant.components.webostv.CALL_SCHEMA = vol.Schema({vol.Required(ATTR_ENTITY_ID): cv.comp_entity_ids})

Definition at line 45 of file __init__.py.

◆ COMMAND_SCHEMA

homeassistant.components.webostv.COMMAND_SCHEMA
Initial value:
1 = CALL_SCHEMA.extend(
2  {vol.Required(ATTR_COMMAND): cv.string, vol.Optional(ATTR_PAYLOAD): dict}
3 )

Definition at line 57 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.webostv.CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)

Definition at line 43 of file __init__.py.

◆ SERVICE_TO_METHOD

dictionary homeassistant.components.webostv.SERVICE_TO_METHOD
Initial value:
1 = {
2  SERVICE_BUTTON: ServiceMethodDetails(method="async_button", schema=BUTTON_SCHEMA),
3  SERVICE_COMMAND: ServiceMethodDetails(
4  method="async_command", schema=COMMAND_SCHEMA
5  ),
6  SERVICE_SELECT_SOUND_OUTPUT: ServiceMethodDetails(
7  method="async_select_sound_output",
8  schema=SOUND_OUTPUT_SCHEMA,
9  ),
10 }

Definition at line 63 of file __init__.py.

◆ SOUND_OUTPUT_SCHEMA

homeassistant.components.webostv.SOUND_OUTPUT_SCHEMA = CALL_SCHEMA.extend({vol.Required(ATTR_SOUND_OUTPUT): cv.string})

Definition at line 61 of file __init__.py.