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

Classes

class  BaseZhaFlow
 
class  ZhaConfigFlowHandler
 
class  ZhaOptionsFlowHandler
 

Functions

str _format_backup_choice (zigpy.backups.NetworkBackup backup, *bool pan_ids=True)
 
list[ListPortInfo] list_serial_ports (HomeAssistant hass)
 

Variables

string CHOOSE_AUTOMATIC_BACKUP = "choose_automatic_backup"
 
string CONF_MANUAL_PATH = "Enter Manually"
 
string DECONZ_DOMAIN = "deconz"
 
string FORMATION_CHOOSE_AUTOMATIC_BACKUP = "choose_automatic_backup"
 
string FORMATION_FORM_INITIAL_NETWORK = "form_initial_network"
 
string FORMATION_FORM_NEW_NETWORK = "form_new_network"
 
string FORMATION_REUSE_SETTINGS = "reuse_settings"
 
string FORMATION_STRATEGY = "formation_strategy"
 
string FORMATION_UPLOAD_MANUAL_BACKUP = "upload_manual_backup"
 
int LEGACY_ZEROCONF_ESPHOME_API_PORT = 6053
 
int LEGACY_ZEROCONF_PORT = 6638
 
string OPTIONS_INTENT_MIGRATE = "intent_migrate"
 
string OPTIONS_INTENT_RECONFIGURE = "intent_reconfigure"
 
string OVERWRITE_COORDINATOR_IEEE = "overwrite_coordinator_ieee"
 
string REPAIR_MY_URL = "https://my.home-assistant.io/redirect/repairs/"
 
tuple SUPPORTED_PORT_SETTINGS
 
string UPLOADED_BACKUP_FILE = "uploaded_backup_file"
 
 ZEROCONF_PROPERTIES_SCHEMA
 
string ZEROCONF_SERVICE_TYPE = "_zigbee-coordinator._tcp.local."
 

Detailed Description

Config flow for ZHA.

Function Documentation

◆ _format_backup_choice()

str homeassistant.components.zha.config_flow._format_backup_choice ( zigpy.backups.NetworkBackup  backup,
*bool   pan_ids = True 
)
private
Format network backup info into a short piece of text.

Definition at line 86 of file config_flow.py.

◆ list_serial_ports()

list[ListPortInfo] homeassistant.components.zha.config_flow.list_serial_ports ( HomeAssistant  hass)
List all serial ports, including the Yellow radio and the multi-PAN addon.

Definition at line 103 of file config_flow.py.

Variable Documentation

◆ CHOOSE_AUTOMATIC_BACKUP

string homeassistant.components.zha.config_flow.CHOOSE_AUTOMATIC_BACKUP = "choose_automatic_backup"

Definition at line 63 of file config_flow.py.

◆ CONF_MANUAL_PATH

string homeassistant.components.zha.config_flow.CONF_MANUAL_PATH = "Enter Manually"

Definition at line 49 of file config_flow.py.

◆ DECONZ_DOMAIN

string homeassistant.components.zha.config_flow.DECONZ_DOMAIN = "deconz"

Definition at line 54 of file config_flow.py.

◆ FORMATION_CHOOSE_AUTOMATIC_BACKUP

string homeassistant.components.zha.config_flow.FORMATION_CHOOSE_AUTOMATIC_BACKUP = "choose_automatic_backup"

Definition at line 60 of file config_flow.py.

◆ FORMATION_FORM_INITIAL_NETWORK

string homeassistant.components.zha.config_flow.FORMATION_FORM_INITIAL_NETWORK = "form_initial_network"

Definition at line 58 of file config_flow.py.

◆ FORMATION_FORM_NEW_NETWORK

string homeassistant.components.zha.config_flow.FORMATION_FORM_NEW_NETWORK = "form_new_network"

Definition at line 57 of file config_flow.py.

◆ FORMATION_REUSE_SETTINGS

string homeassistant.components.zha.config_flow.FORMATION_REUSE_SETTINGS = "reuse_settings"

Definition at line 59 of file config_flow.py.

◆ FORMATION_STRATEGY

string homeassistant.components.zha.config_flow.FORMATION_STRATEGY = "formation_strategy"

Definition at line 56 of file config_flow.py.

◆ FORMATION_UPLOAD_MANUAL_BACKUP

string homeassistant.components.zha.config_flow.FORMATION_UPLOAD_MANUAL_BACKUP = "upload_manual_backup"

Definition at line 61 of file config_flow.py.

◆ LEGACY_ZEROCONF_ESPHOME_API_PORT

int homeassistant.components.zha.config_flow.LEGACY_ZEROCONF_ESPHOME_API_PORT = 6053

Definition at line 74 of file config_flow.py.

◆ LEGACY_ZEROCONF_PORT

int homeassistant.components.zha.config_flow.LEGACY_ZEROCONF_PORT = 6638

Definition at line 73 of file config_flow.py.

◆ OPTIONS_INTENT_MIGRATE

string homeassistant.components.zha.config_flow.OPTIONS_INTENT_MIGRATE = "intent_migrate"

Definition at line 66 of file config_flow.py.

◆ OPTIONS_INTENT_RECONFIGURE

string homeassistant.components.zha.config_flow.OPTIONS_INTENT_RECONFIGURE = "intent_reconfigure"

Definition at line 67 of file config_flow.py.

◆ OVERWRITE_COORDINATOR_IEEE

string homeassistant.components.zha.config_flow.OVERWRITE_COORDINATOR_IEEE = "overwrite_coordinator_ieee"

Definition at line 64 of file config_flow.py.

◆ REPAIR_MY_URL

string homeassistant.components.zha.config_flow.REPAIR_MY_URL = "https://my.home-assistant.io/redirect/repairs/"

Definition at line 71 of file config_flow.py.

◆ SUPPORTED_PORT_SETTINGS

tuple homeassistant.components.zha.config_flow.SUPPORTED_PORT_SETTINGS
Initial value:
1 = (
2  CONF_BAUDRATE,
3  CONF_FLOW_CONTROL,
4 )

Definition at line 50 of file config_flow.py.

◆ UPLOADED_BACKUP_FILE

string homeassistant.components.zha.config_flow.UPLOADED_BACKUP_FILE = "uploaded_backup_file"

Definition at line 69 of file config_flow.py.

◆ ZEROCONF_PROPERTIES_SCHEMA

homeassistant.components.zha.config_flow.ZEROCONF_PROPERTIES_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required("radio_type"): vol.All(str, vol.In([t.name for t in RadioType])),
4  vol.Required("serial_number"): str,
5  },
6  extra=vol.ALLOW_EXTRA,
7 )

Definition at line 77 of file config_flow.py.

◆ ZEROCONF_SERVICE_TYPE

string homeassistant.components.zha.config_flow.ZEROCONF_SERVICE_TYPE = "_zigbee-coordinator._tcp.local."

Definition at line 76 of file config_flow.py.