homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow Class Reference

Inheritance diagram for homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow:

Collaboration diagram for homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow:

Public Member Functions
None	__init__ (self)
ConfigFlowResult	async_step_init (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_prompt_options (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_set_device_options (self, dict[str, Any]|None user_input=None)
None	update_config_data (self, dict[str, Any]|None global_options=None, dict[str, Any]|None devices=None)
Public Member Functions inherited from homeassistant.config_entries.OptionsFlow
ConfigEntry	config_entry (self)
None	config_entry (self, ConfigEntry value)
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)
_FlowResultT	async_abort (self, *str reason, Mapping[str, str]|None description_placeholders=None)
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_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)
_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)

Private Member Functions
None	_async_replace_device (self, str replace_device)
bool	_can_add_device (self, rfxtrxmod.RFXtrxEvent new_rfx_obj)
bool	_can_replace_device (self, str entry_id)
DeviceData	_get_device_data (self, str entry_id)
str|None	_get_device_event_code (self, str entry_id)

Private Attributes
	_device_entries
	_device_registry
	_global_options
	_selected_device
	_selected_device_entry_id
	_selected_device_event_code
	_selected_device_object

Additional Inherited Members
Static Public Member Functions inherited from homeassistant.data_entry_flow.FlowHandler
None	async_setup_preview (HomeAssistant hass)
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress
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

Detailed Description

Handle Rfxtrx options.

Definition at line 84 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow.__init__

(

self

)

Handle Rfxtrx options.

Initialize rfxtrx options flow.

Definition at line 90 of file config_flow.py.

Member Function Documentation

_async_replace_device()

None homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._async_replace_device (   self, str  replace_device  )

private

Migrate properties of a device into another.

Definition at line 319 of file config_flow.py.

_can_add_device()

bool homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._can_add_device (   self, rfxtrxmod.RFXtrxEvent  new_rfx_obj  )

private

Check if device does not already exist.

Definition at line 422 of file config_flow.py.

_can_replace_device()

bool homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._can_replace_device (   self, str  entry_id  )

private

Check if device can be replaced with selected device.

Definition at line 435 of file config_flow.py.

_get_device_data()

DeviceData homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._get_device_data (   self, str  entry_id  )

private

Get event code based on device identifier.

Definition at line 461 of file config_flow.py.

_get_device_event_code()

str | None homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._get_device_event_code (   self, str  entry_id  )

private

Definition at line 456 of file config_flow.py.

async_step_init()

ConfigFlowResult homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow.async_step_init	(		self,
		dict[str, Any] | None	user_input = None
	)

Manage the options.

Definition at line 98 of file config_flow.py.

async_step_prompt_options()

ConfigFlowResult homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow.async_step_prompt_options	(		self,
		dict[str, Any] | None	user_input = None
	)

Prompt for options.

Definition at line 104 of file config_flow.py.

async_step_set_device_options()

ConfigFlowResult homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow.async_step_set_device_options	(		self,
		dict[str, Any] | None	user_input = None
	)

Manage device options.

Definition at line 176 of file config_flow.py.

update_config_data()

None homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow.update_config_data	(		self,
		dict[str, Any] | None	global_options = None,
		dict[str, Any] | None	devices = None
	)

Update data in ConfigEntry.

Definition at line 475 of file config_flow.py.

Member Data Documentation

_device_entries

homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._device_entries

private

Definition at line 151 of file config_flow.py.

_device_registry

homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._device_registry

private

Definition at line 150 of file config_flow.py.

_global_options

homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._global_options

private

Definition at line 111 of file config_flow.py.

_selected_device

homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._selected_device

private

Definition at line 122 of file config_flow.py.

_selected_device_entry_id

homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._selected_device_entry_id

private

Definition at line 118 of file config_flow.py.

_selected_device_event_code

homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._selected_device_event_code

private

Definition at line 121 of file config_flow.py.

_selected_device_object

homeassistant.components.rfxtrx.config_flow.RfxtrxOptionsFlow._selected_device_object

private

Definition at line 123 of file config_flow.py.

---

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

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