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

Public Member Functions

None __init__ (self)
 
ConfigFlowResult async_step_add_sensor (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_choose_sensor (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_init (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_remove_sensor (self, dict[str, Any]|None user_input=None)
 
ConfigFlowResult async_step_settings (self, dict[str, Any]|None user_input=None)
 
vol.Schema settings_schema (self)
 
- 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)
 

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 a PurpleAir options flow.

Definition at line 315 of file config_flow.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler.__init__ (   self)
Initialize.

Definition at line 318 of file config_flow.py.

Member Function Documentation

◆ async_step_add_sensor()

ConfigFlowResult homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler.async_step_add_sensor (   self,
dict[str, Any] | None   user_input = None 
)
Add a sensor.

Definition at line 338 of file config_flow.py.

◆ async_step_choose_sensor()

ConfigFlowResult homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler.async_step_choose_sensor (   self,
dict[str, Any] | None   user_input = None 
)
Choose a sensor.

Definition at line 369 of file config_flow.py.

◆ async_step_init()

ConfigFlowResult homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler.async_step_init (   self,
dict[str, Any] | None   user_input = None 
)
Manage the options.

Definition at line 389 of file config_flow.py.

◆ async_step_remove_sensor()

ConfigFlowResult homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler.async_step_remove_sensor (   self,
dict[str, Any] | None   user_input = None 
)
Remove a sensor.

Definition at line 398 of file config_flow.py.

◆ async_step_settings()

ConfigFlowResult homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler.async_step_settings (   self,
dict[str, Any] | None   user_input = None 
)
Manage settings.

Definition at line 460 of file config_flow.py.

◆ settings_schema()

vol.Schema homeassistant.components.purpleair.config_flow.PurpleAirOptionsFlowHandler.settings_schema (   self)
Return the settings schema.

Definition at line 323 of file config_flow.py.


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