Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow Class Reference
Inheritance diagram for homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow:
[legend]
Collaboration diagram for homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow:
[legend]

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_dhcp (self, dhcp.DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_encrypted_pairing (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_pairing (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_reauth (self, Mapping[str, Any] entry_data)
 
ConfigFlowResult async_step_reauth_confirm (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_reauth_confirm_encrypted (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_ssdp (self, ssdp.SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_user (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_zeroconf (self, zeroconf.ZeroconfServiceInfo discovery_info)
 
bool is_matching (self, Self other_flow)
 
- Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
None __init_subclass__ (cls, *str|None domain=None, **Any kwargs)
 
ConfigFlowResult async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
 
ConfigFlowResult async_create_entry (self, *str title, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None, Mapping[str, Any]|None options=None)
 
ConfigEntry|None async_set_unique_id (self, str|None unique_id=None, *bool raise_on_progress=True)
 
ConfigFlowResult async_show_form (self, *str|None step_id=None, vol.Schema|None data_schema=None, dict[str, str]|None errors=None, Mapping[str, str]|None description_placeholders=None, bool|None last_step=None, str|None preview=None)
 
ConfigFlowResult async_step_bluetooth (self, BluetoothServiceInfoBleak discovery_info)
 
ConfigFlowResult async_step_dhcp (self, DhcpServiceInfo discovery_info)
 
ConfigFlowResult async_step_discovery (self, DiscoveryInfoType discovery_info)
 
ConfigFlowResult async_step_hassio (self, HassioServiceInfo discovery_info)
 
ConfigFlowResult async_step_homekit (self, ZeroconfServiceInfo discovery_info)
 
ConfigFlowResult async_step_ignore (self, dict[str, Any] user_input)
 
ConfigFlowResult async_step_integration_discovery (self, DiscoveryInfoType discovery_info)
 
ConfigFlowResult async_step_mqtt (self, MqttServiceInfo discovery_info)
 
ConfigFlowResult async_step_ssdp (self, SsdpServiceInfo discovery_info)
 
ConfigFlowResult async_step_usb (self, UsbServiceInfo discovery_info)
 
ConfigFlowResult async_step_zeroconf (self, ZeroconfServiceInfo discovery_info)
 
bool async_supports_options_flow (cls, ConfigEntry config_entry)
 
ConfigFlowResult async_update_reload_and_abort (self, ConfigEntry entry, *str|None|UndefinedType unique_id=UNDEFINED, str|UndefinedType title=UNDEFINED, Mapping[str, Any]|UndefinedType data=UNDEFINED, Mapping[str, Any]|UndefinedType data_updates=UNDEFINED, Mapping[str, Any]|UndefinedType options=UNDEFINED, str|UndefinedType reason=UNDEFINED, bool reload_even_if_entry_is_unchanged=True)
 
str|None unique_id (self)
 
- Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
vol.Schema add_suggested_values_to_schema (self, vol.Schema data_schema, Mapping[str, Any]|None suggested_values)
 
None async_cancel_progress_task (self)
 
_FlowResultT async_create_entry (self, *str|None title=None, Mapping[str, Any] data, str|None description=None, Mapping[str, str]|None description_placeholders=None)
 
_FlowResultT async_external_step (self, *str|None step_id=None, str url, Mapping[str, str]|None description_placeholders=None)
 
_FlowResultT async_external_step_done (self, *str next_step_id)
 
asyncio.Task[Any]|None async_get_progress_task (self)
 
None async_remove (self)
 
None async_set_progress_task (self, asyncio.Task[Any] progress_task)
 
_FlowResultT async_show_menu (self, *str|None step_id=None, Container[str] menu_options, Mapping[str, str]|None description_placeholders=None)
 
_FlowResultT async_show_progress (self, *str|None step_id=None, str progress_action, Mapping[str, str]|None description_placeholders=None, asyncio.Task[Any]|None progress_task=None)
 
_FlowResultT async_show_progress_done (self, *str next_step_id)
 
bool show_advanced_options (self)
 
str|None source (self)
 

Static Public Attributes

int MINOR_VERSION = 2
 
int VERSION = 2
 
- Static Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 Any
 
bool deprecated_show_progress = False
 
 HomeAssistant
 
string init_step = "init"
 
int MINOR_VERSION = 1
 
 None
 
 str
 
int VERSION = 1
 

Private Member Functions

None _abort_if_manufacturer_is_not_samsung (self)
 
None _async_abort_if_host_already_in_progress (self)
 
None _async_create_bridge (self)
 
bool _async_get_and_check_device_info (self)
 
tuple[str, str|None, dict[str, Any]|None_async_get_device_info_and_method (self)
 
tuple[ConfigEntry|None, bool] _async_get_existing_matching_entry (self)
 
None _async_set_device_unique_id (self, bool raise_on_progress=True)
 
None _async_set_name_host_from_input (self, dict[str, Any] user_input)
 
None _async_set_unique_id_from_udn (self, bool raise_on_progress=True)
 
None _async_start_discovery_with_mac_address (self)
 
None _async_start_encrypted_pairing (self, str host)
 
None _async_update_and_abort_for_matching_unique_id (self)
 
ConfigEntry|None _async_update_existing_matching_entry (self)
 
dict[str, Any_base_config_entry (self)
 
ConfigFlowResult _get_entry_from_bridge (self)
 

Private Attributes

 _authenticator
 
 _bridge
 
 _connect_result
 
 _device_info
 
 _host
 
 _mac
 
 _manufacturer
 
 _method
 
 _model
 
 _name
 
 _ssdp_main_tv_agent_location
 
 _ssdp_rendering_control_location
 
 _title
 
 _udn
 
 _upnp_udn
 

Additional Inherited Members

- Static Public Member Functions inherited from homeassistant.config_entries.ConfigFlow
OptionsFlow async_get_options_flow (ConfigEntry config_entry)
 
- Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None async_setup_preview (HomeAssistant hass)
 
- Public Attributes inherited from homeassistant.config_entries.ConfigFlow
 source
 
- Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
 deprecated_show_progress
 

Detailed Description

Handle a Samsung TV config flow.

Definition at line 100 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.__init__ (   self)
Initialize flow.

Definition at line 106 of file config_flow.py.

Member Function Documentation

◆ _abort_if_manufacturer_is_not_samsung()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._abort_if_manufacturer_is_not_samsung (   self)
private

Definition at line 435 of file config_flow.py.

◆ _async_abort_if_host_already_in_progress()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_abort_if_host_already_in_progress (   self)
private

Definition at line 426 of file config_flow.py.

◆ _async_create_bridge()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_create_bridge (   self)
private
Create the bridge.

Definition at line 196 of file config_flow.py.

◆ _async_get_and_check_device_info()

bool homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_get_and_check_device_info (   self)
private
Try to get the device info.

Definition at line 219 of file config_flow.py.

◆ _async_get_device_info_and_method()

tuple[str, str | None, dict[str, Any] | None] homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_get_device_info_and_method (   self)
private
Get device info and method only once.

Definition at line 205 of file config_flow.py.

◆ _async_get_existing_matching_entry()

tuple[ConfigEntry | None, bool] homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_get_existing_matching_entry (   self)
private
Get first existing matching entry (prefer unique id).

Definition at line 333 of file config_flow.py.

◆ _async_set_device_unique_id()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_set_device_unique_id (   self,
bool   raise_on_progress = True 
)
private
Set device unique_id.

Definition at line 151 of file config_flow.py.

◆ _async_set_name_host_from_input()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_set_name_host_from_input (   self,
dict[str, Any user_input 
)
private

Definition at line 249 of file config_flow.py.

◆ _async_set_unique_id_from_udn()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_set_unique_id_from_udn (   self,
bool   raise_on_progress = True 
)
private
Set the unique id from the udn.

Definition at line 158 of file config_flow.py.

◆ _async_start_discovery_with_mac_address()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_start_discovery_with_mac_address (   self)
private
Start discovery.

Definition at line 416 of file config_flow.py.

◆ _async_start_encrypted_pairing()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_start_encrypted_pairing (   self,
str  host 
)
private

Definition at line 574 of file config_flow.py.

◆ _async_update_and_abort_for_matching_unique_id()

None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_update_and_abort_for_matching_unique_id (   self)
private
Abort and update host and mac if we have it.

Definition at line 179 of file config_flow.py.

◆ _async_update_existing_matching_entry()

ConfigEntry | None homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._async_update_existing_matching_entry (   self)
private
Check existing entries and update them.

Returns the existing entry if it was updated.

Definition at line 352 of file config_flow.py.

◆ _base_config_entry()

dict[str, Any] homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._base_config_entry (   self)
private
Generate the base config entry without the method.

Definition at line 125 of file config_flow.py.

◆ _get_entry_from_bridge()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._get_entry_from_bridge (   self)
private
Get device entry.

Definition at line 140 of file config_flow.py.

◆ async_step_confirm()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Handle user-confirmation of discovered node.

Definition at line 512 of file config_flow.py.

◆ async_step_dhcp()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_dhcp (   self,
dhcp.DhcpServiceInfo   discovery_info 
)
Handle a flow initialized by dhcp discovery.

Definition at line 488 of file config_flow.py.

◆ async_step_encrypted_pairing()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_encrypted_pairing (   self,
dict[str, Any] | None   user_input = None 
)
Handle a encrypted pairing.

Definition at line 299 of file config_flow.py.

◆ async_step_pairing()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_pairing (   self,
dict[str, Any] | None   user_input = None 
)
Handle a pairing by accepting the message on the TV.

Definition at line 277 of file config_flow.py.

◆ async_step_reauth()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_reauth (   self,
Mapping[str, Any]   entry_data 
)
Handle configuration by re-auth.

Definition at line 527 of file config_flow.py.

◆ async_step_reauth_confirm()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_reauth_confirm (   self,
dict[str, Any] | None   user_input = None 
)
Confirm reauth.

Definition at line 537 of file config_flow.py.

◆ async_step_reauth_confirm_encrypted()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_reauth_confirm_encrypted (   self,
dict[str, Any] | None   user_input = None 
)
Confirm reauth (encrypted method).

Definition at line 582 of file config_flow.py.

◆ async_step_ssdp()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_ssdp (   self,
ssdp.SsdpServiceInfo   discovery_info 
)
Handle a flow initialized by ssdp discovery.

Definition at line 441 of file config_flow.py.

◆ async_step_user()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_user (   self,
dict[str, Any] | None   user_input = None 
)
Handle a flow initialized by the user.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 259 of file config_flow.py.

◆ async_step_zeroconf()

ConfigFlowResult homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.async_step_zeroconf (   self,
zeroconf.ZeroconfServiceInfo   discovery_info 
)
Handle a flow initialized by zeroconf discovery.

Definition at line 500 of file config_flow.py.

◆ is_matching()

bool homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.is_matching (   self,
Self  other_flow 
)
Return True if other_flow is matching this flow.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 430 of file config_flow.py.

Member Data Documentation

◆ _authenticator

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._authenticator
private

Definition at line 576 of file config_flow.py.

◆ _bridge

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._bridge
private

Definition at line 203 of file config_flow.py.

◆ _connect_result

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._connect_result
private

Definition at line 211 of file config_flow.py.

◆ _device_info

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._device_info
private

Definition at line 213 of file config_flow.py.

◆ _host

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._host
private

Definition at line 251 of file config_flow.py.

◆ _mac

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._mac
private

Definition at line 242 of file config_flow.py.

◆ _manufacturer

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._manufacturer
private

Definition at line 464 of file config_flow.py.

◆ _method

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._method
private

Definition at line 212 of file config_flow.py.

◆ _model

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._model
private

Definition at line 233 of file config_flow.py.

◆ _name

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._name
private

Definition at line 235 of file config_flow.py.

◆ _ssdp_main_tv_agent_location

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._ssdp_main_tv_agent_location
private

Definition at line 454 of file config_flow.py.

◆ _ssdp_rendering_control_location

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._ssdp_rendering_control_location
private

Definition at line 448 of file config_flow.py.

◆ _title

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._title
private

Definition at line 236 of file config_flow.py.

◆ _udn

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._udn
private

Definition at line 237 of file config_flow.py.

◆ _upnp_udn

homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow._upnp_udn
private

Definition at line 340 of file config_flow.py.

◆ MINOR_VERSION

int homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.MINOR_VERSION = 2
static

Definition at line 104 of file config_flow.py.

◆ VERSION

int homeassistant.components.samsungtv.config_flow.SamsungTVConfigFlow.VERSION = 2
static

Definition at line 103 of file config_flow.py.


The documentation for this class was generated from the following file: