homeassistant.components.synology_dsm.config_flow Namespace Reference

Classes
class	InvalidData
class	SynologyDSMFlowHandler
class	SynologyDSMOptionsFlowHandler

Functions
vol.Schema	_discovery_schema_with_defaults (DiscoveryInfoType discovery_info)
str	_login_and_fetch_syno_info (SynologyDSM api, str|None otp_code)
VolDictType	_ordered_shared_schema (dict[str, Any] schema_input)
vol.Schema	_reauth_schema ()
vol.Schema	_user_schema_with_defaults (dict[str, Any] user_input)
str	format_synology_mac (str mac)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_OTP_CODE = "otp_code"
string	HTTP_SUFFIX = "._http._tcp.local."

Detailed Description

Config flow to configure the Synology DSM integration.

Function Documentation

_discovery_schema_with_defaults()

vol.Schema homeassistant.components.synology_dsm.config_flow._discovery_schema_with_defaults ( DiscoveryInfoType  discovery_info )

private

Definition at line 68 of file config_flow.py.

_login_and_fetch_syno_info()

str homeassistant.components.synology_dsm.config_flow._login_and_fetch_syno_info ( SynologyDSM  api, str | None  otp_code  )

private

Login to the NAS and fetch basic data.

Definition at line 405 of file config_flow.py.

_ordered_shared_schema()

VolDictType homeassistant.components.synology_dsm.config_flow._ordered_shared_schema ( dict[str, Any]  schema_input )

private

Definition at line 90 of file config_flow.py.

_reauth_schema()

vol.Schema homeassistant.components.synology_dsm.config_flow._reauth_schema ( )

private

Definition at line 72 of file config_flow.py.

_user_schema_with_defaults()

vol.Schema homeassistant.components.synology_dsm.config_flow._user_schema_with_defaults ( dict[str, Any]  user_input )

private

Definition at line 81 of file config_flow.py.

format_synology_mac()

str homeassistant.components.synology_dsm.config_flow.format_synology_mac

(

str

mac

)

Format a mac address to the format used by Synology DSM.

Definition at line 105 of file config_flow.py.

Variable Documentation

_LOGGER

homeassistant.components.synology_dsm.config_flow._LOGGER = logging.getLogger(__name__)

private

Definition at line 61 of file config_flow.py.

CONF_OTP_CODE

string homeassistant.components.synology_dsm.config_flow.CONF_OTP_CODE = "otp_code"

Definition at line 63 of file config_flow.py.

HTTP_SUFFIX

string homeassistant.components.synology_dsm.config_flow.HTTP_SUFFIX = "._http._tcp.local."

Definition at line 65 of file config_flow.py.