homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler Class Reference

Inheritance diagram for homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler:

Collaboration diagram for homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler:

Public Member Functions
None	__init__ (self)
ConfigFlowResult	async_step_confirm (self, FlowInput user_input=None)
ConfigFlowResult	async_step_ignore (self, Mapping[str, Any] user_input)
ConfigFlowResult	async_step_manual (self, FlowInput user_input=None)
ConfigFlowResult	async_step_ssdp (self, ssdp.SsdpServiceInfo discovery_info)
ConfigFlowResult	async_step_user (self, FlowInput user_input=None)
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_user (self, dict[str, Any]|None user_input=None)
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)
bool	is_matching (self, Self other_flow)
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 Member Functions
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)

Static Public Attributes
int	VERSION = 1
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	_async_connect (self)
list[ssdp.SsdpServiceInfo]	_async_get_discoveries (self)
None	_async_set_info_from_discovery (self, ssdp.SsdpServiceInfo discovery_info, bool abort_if_configured=True)
ConfigFlowResult	_create_entry (self)

Private Attributes
	_device_type
	_discoveries
	_location
	_mac
	_name
	_udn

Additional Inherited Members
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 DLNA DMR config flow.

The Unique Device Name (UDN) of the DMR device is used as the unique_id for
config entries and for entities. This UDN may differ from the root UDN if
the DMR is an embedded device.

Definition at line 51 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.__init__

(

self

)

Initialize flow.

Definition at line 61 of file config_flow.py.

Member Function Documentation

_async_connect()

None homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._async_connect (   self )

private

Connect to a device to confirm it works and gather extra information.

Updates this flow's unique ID to the device UDN if not already done.
Raises ConnectError if something goes wrong.

Definition at line 213 of file config_flow.py.

_async_get_discoveries()

list[ssdp.SsdpServiceInfo] homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._async_get_discoveries (   self )

private

Get list of unconfigured DLNA devices discovered by SSDP.

Definition at line 304 of file config_flow.py.

_async_set_info_from_discovery()

None homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._async_set_info_from_discovery (   self, ssdp.SsdpServiceInfo  discovery_info, bool   abort_if_configured = True  )

private

Set information required for a config entry from the SSDP discovery.

Definition at line 269 of file config_flow.py.

_create_entry()

ConfigFlowResult homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._create_entry (   self )

private

Create a config entry, assuming all required information is now known.

Definition at line 251 of file config_flow.py.

async_get_options_flow()

OptionsFlow homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.async_get_options_flow ( ConfigEntry  config_entry )

static

Define the config flow to handle options.

Reimplemented from homeassistant.config_entries.ConfigFlow.

Definition at line 73 of file config_flow.py.

async_step_confirm()

ConfigFlowResult homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.async_step_confirm	(		self,
		FlowInput	user_input = None
	)

Allow the user to confirm adding the device.

Definition at line 201 of file config_flow.py.

async_step_ignore()

ConfigFlowResult homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.async_step_ignore	(		self,
		Mapping[str, Any]	user_input
	)

Ignore this config flow, and add MAC address as secondary identifier.

Not all DMR devices correctly implement the spec, so their UDN may
change between boots. Use the MAC address as a secondary identifier so
they can still be ignored in this case.

Definition at line 165 of file config_flow.py.

async_step_manual()

ConfigFlowResult homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.async_step_manual	(		self,
		FlowInput	user_input = None
	)

Manual URL entry by the user.

Definition at line 111 of file config_flow.py.

async_step_ssdp()

ConfigFlowResult homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.async_step_ssdp	(		self,
		ssdp.SsdpServiceInfo	discovery_info
	)

Handle a flow initialized by SSDP discovery.

Definition at line 133 of file config_flow.py.

async_step_user()

ConfigFlowResult homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.async_step_user	(		self,
		FlowInput	user_input = None
	)

Handle a flow initialized by the user.

Let user choose from a list of found and unconfigured devices or to
enter an URL manually.

Definition at line 79 of file config_flow.py.

Member Data Documentation

_device_type

homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._device_type

private

Definition at line 243 of file config_flow.py.

_discoveries

homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._discoveries

private

Definition at line 100 of file config_flow.py.

_location

homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._location

private

Definition at line 120 of file config_flow.py.

_mac

homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._mac

private

Definition at line 158 of file config_flow.py.

_name

homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._name

private

Definition at line 246 of file config_flow.py.

_udn

homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler._udn

private

Definition at line 175 of file config_flow.py.

VERSION

int homeassistant.components.dlna_dmr.config_flow.DlnaDmrFlowHandler.VERSION = 1

static

Definition at line 59 of file config_flow.py.

---

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

• core/homeassistant/components/dlna_dmr/config_flow.py