homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler Class Reference

Inheritance diagram for homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler:

Collaboration diagram for homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler:

Public Member Functions
None	__init__ (self, str flow_type, Callable[..., ConfigFlowResult] create_entry_cb)
ConfigFlowResult	async_step_usb_config (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_usb_manual_config (self, dict[str, Any]|None user_input=None)
ConfigFlowResult	async_step_usb_sphere_config (self, dict[str, Any]|None user_input=None)
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)

Public Attributes
	create_entry_callback
	flow_type
	usb_path
	usb_sphere_id
Public Attributes inherited from homeassistant.data_entry_flow.FlowHandler
	deprecated_show_progress

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

Represent the base flow for Crownstone.

Definition at line 46 of file config_flow.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.__init__	(		self,
		str	flow_type,
		Callable[..., ConfigFlowResult]	create_entry_cb
	)

Set up flow instance.

Definition at line 51 of file config_flow.py.

Member Function Documentation

async_step_usb_config()

ConfigFlowResult homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.async_step_usb_config	(		self,
		dict[str, Any] | None	user_input = None
	)

Set up a Crownstone USB dongle.

Definition at line 60 of file config_flow.py.

async_step_usb_manual_config()

ConfigFlowResult homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.async_step_usb_manual_config	(		self,
		dict[str, Any] | None	user_input = None
	)

Manually enter Crownstone USB dongle path.

Definition at line 98 of file config_flow.py.

async_step_usb_sphere_config()

ConfigFlowResult homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.async_step_usb_sphere_config	(		self,
		dict[str, Any] | None	user_input = None
	)

Select a Crownstone sphere that the USB operates in.

Definition at line 111 of file config_flow.py.

Member Data Documentation

create_entry_callback

homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.create_entry_callback

Definition at line 56 of file config_flow.py.

flow_type

homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.flow_type

Definition at line 55 of file config_flow.py.

usb_path

homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.usb_path

Definition at line 86 of file config_flow.py.

usb_sphere_id

homeassistant.components.crownstone.config_flow.BaseCrownstoneFlowHandler.usb_sphere_id

Definition at line 128 of file config_flow.py.

---

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

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