Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.vlc_telnet.config_flow Namespace Reference

Classes

class  CannotConnect
 
class  InvalidAuth
 
class  VLCTelnetConfigFlow
 

Functions

vol.Schema user_form_schema (dict[str, Any]|None user_input)
 
dict[str, str] validate_input (HomeAssistant hass, dict[str, Any] data)
 
None vlc_connect (Client vlc)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 STEP_REAUTH_DATA_SCHEMA = vol.Schema({vol.Required(CONF_PASSWORD): str})
 

Detailed Description

Config flow for VLC media player Telnet integration.

Function Documentation

◆ user_form_schema()

vol.Schema homeassistant.components.vlc_telnet.config_flow.user_form_schema ( dict[str, Any] | None  user_input)
Return user form schema.

Definition at line 24 of file config_flow.py.

◆ validate_input()

dict[str, str] homeassistant.components.vlc_telnet.config_flow.validate_input ( HomeAssistant  hass,
dict[str, Any]  data 
)
Validate the user input allows us to connect.

Definition at line 50 of file config_flow.py.

◆ vlc_connect()

None homeassistant.components.vlc_telnet.config_flow.vlc_connect ( Client  vlc)
Connect to VLC.

Definition at line 43 of file config_flow.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.vlc_telnet.config_flow._LOGGER = logging.getLogger(__name__)
private

Definition at line 21 of file config_flow.py.

◆ STEP_REAUTH_DATA_SCHEMA

homeassistant.components.vlc_telnet.config_flow.STEP_REAUTH_DATA_SCHEMA = vol.Schema({vol.Required(CONF_PASSWORD): str})

Definition at line 40 of file config_flow.py.