Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.matter.config_flow Namespace Reference

Classes

class  FailedConnect
 
class  MatterConfigFlow
 

Functions

str build_ws_address (str host, int port)
 
vol.Schema get_manual_schema (dict[str, Any] user_input)
 
None validate_input (HomeAssistant hass, dict[str, Any] data)
 

Variables

int ADDON_SETUP_TIMEOUT = 5
 
int ADDON_SETUP_TIMEOUT_ROUNDS = 40
 
string DEFAULT_TITLE = "Matter"
 
string DEFAULT_URL = "ws://localhost:5580/ws"
 
 ON_SUPERVISOR_SCHEMA = vol.Schema({vol.Optional(CONF_USE_ADDON, default=True): bool})
 

Detailed Description

Config flow for Matter integration.

Function Documentation

◆ build_ws_address()

str homeassistant.components.matter.config_flow.build_ws_address ( str  host,
int  port 
)
Return the websocket address.

Definition at line 57 of file config_flow.py.

◆ get_manual_schema()

vol.Schema homeassistant.components.matter.config_flow.get_manual_schema ( dict[str, Any]  user_input)
Return a schema for the manual step.

Definition at line 45 of file config_flow.py.

◆ validate_input()

None homeassistant.components.matter.config_flow.validate_input ( HomeAssistant  hass,
dict[str, Any]  data 
)
Validate the user input allows us to connect.

Definition at line 51 of file config_flow.py.

Variable Documentation

◆ ADDON_SETUP_TIMEOUT

int homeassistant.components.matter.config_flow.ADDON_SETUP_TIMEOUT = 5

Definition at line 38 of file config_flow.py.

◆ ADDON_SETUP_TIMEOUT_ROUNDS

int homeassistant.components.matter.config_flow.ADDON_SETUP_TIMEOUT_ROUNDS = 40

Definition at line 39 of file config_flow.py.

◆ DEFAULT_TITLE

string homeassistant.components.matter.config_flow.DEFAULT_TITLE = "Matter"

Definition at line 41 of file config_flow.py.

◆ DEFAULT_URL

string homeassistant.components.matter.config_flow.DEFAULT_URL = "ws://localhost:5580/ws"

Definition at line 40 of file config_flow.py.

◆ ON_SUPERVISOR_SCHEMA

homeassistant.components.matter.config_flow.ON_SUPERVISOR_SCHEMA = vol.Schema({vol.Optional(CONF_USE_ADDON, default=True): bool})

Definition at line 42 of file config_flow.py.