homeassistant.components.nest.config_flow Namespace Reference

Classes
class	NestFlowHandler

Functions
str	_generate_subscription_id (str cloud_project_id)
str|None	generate_config_title (Iterable[Structure] structures)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CLOUD_CONSOLE_URL = "https://console.cloud.google.com/home/dashboard"
string	CREATE_NEW_SUBSCRIPTION_KEY = "create_new_subscription"
string	DATA_FLOW_IMPL = "nest_flow_implementation"
tuple	DEVICE_ACCESS_CONSOLE_EDIT_URL
string	DEVICE_ACCESS_CONSOLE_URL = "https://console.nest.google.com/device-access/"
string	MORE_INFO_URL = "https://www.home-assistant.io/integrations/nest/#configuration"
string	PUBSUB_API_URL = "https://console.cloud.google.com/apis/library/pubsub.googleapis.com"
tuple	SDM_API_URL
string	SUBSCRIPTION_FORMAT = "projects/{cloud_project_id}/subscriptions/home-assistant-{rnd}"
int	SUBSCRIPTION_RAND_LENGTH = 10

Detailed Description

Config flow to configure Nest.

This configuration flow supports the following:
  - SDM API with Web OAuth flow with redirect back to Home Assistant
  - Legacy Nest API auth flow with where user enters an auth code manually

NestFlowHandler is an implementation of AbstractOAuth2FlowHandler with
some overrides to custom steps inserted in the middle of the flow.

Function Documentation

_generate_subscription_id()

str homeassistant.components.nest.config_flow._generate_subscription_id ( str  cloud_project_id )

private

Create a new subscription id.

Definition at line 67 of file config_flow.py.

generate_config_title()

str | None homeassistant.components.nest.config_flow.generate_config_title

(

Iterable[Structure]

structures

)

Pick a user friendly config title based on the Google Home name(s).

Definition at line 73 of file config_flow.py.

Variable Documentation

_LOGGER

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

private

Definition at line 64 of file config_flow.py.

CLOUD_CONSOLE_URL

string homeassistant.components.nest.config_flow.CLOUD_CONSOLE_URL = "https://console.cloud.google.com/home/dashboard"

Definition at line 50 of file config_flow.py.

CREATE_NEW_SUBSCRIPTION_KEY

string homeassistant.components.nest.config_flow.CREATE_NEW_SUBSCRIPTION_KEY = "create_new_subscription"

Definition at line 62 of file config_flow.py.

DATA_FLOW_IMPL

string homeassistant.components.nest.config_flow.DATA_FLOW_IMPL = "nest_flow_implementation"

Definition at line 43 of file config_flow.py.

DEVICE_ACCESS_CONSOLE_EDIT_URL

tuple homeassistant.components.nest.config_flow.DEVICE_ACCESS_CONSOLE_EDIT_URL

Initial value:

=  (
    "https://console.nest.google.com/device-access/project/{project_id}/information"
)

Definition at line 59 of file config_flow.py.

DEVICE_ACCESS_CONSOLE_URL

string homeassistant.components.nest.config_flow.DEVICE_ACCESS_CONSOLE_URL = "https://console.nest.google.com/device-access/"

Definition at line 57 of file config_flow.py.

MORE_INFO_URL

string homeassistant.components.nest.config_flow.MORE_INFO_URL = "https://www.home-assistant.io/integrations/nest/#configuration"

Definition at line 47 of file config_flow.py.

PUBSUB_API_URL

string homeassistant.components.nest.config_flow.PUBSUB_API_URL = "https://console.cloud.google.com/apis/library/pubsub.googleapis.com"

Definition at line 54 of file config_flow.py.

SDM_API_URL

tuple homeassistant.components.nest.config_flow.SDM_API_URL

Initial value:

=  (
    "https://console.cloud.google.com/apis/library/smartdevicemanagement.googleapis.com"
)

Definition at line 51 of file config_flow.py.

SUBSCRIPTION_FORMAT

string homeassistant.components.nest.config_flow.SUBSCRIPTION_FORMAT = "projects/{cloud_project_id}/subscriptions/home-assistant-{rnd}"

Definition at line 44 of file config_flow.py.

SUBSCRIPTION_RAND_LENGTH

int homeassistant.components.nest.config_flow.SUBSCRIPTION_RAND_LENGTH = 10

Definition at line 45 of file config_flow.py.