Home Assistant Unofficial Reference 2024.12.1
const.py
Go to the documentation of this file.
1 """Constants for the cloud component."""
2 
3 from __future__ import annotations
4 
5 import asyncio
6 from typing import TYPE_CHECKING, Any
7 
8 from homeassistant.util.hass_dict import HassKey
9 from homeassistant.util.signal_type import SignalType
10 
11 if TYPE_CHECKING:
12  from hass_nabucasa import Cloud
13 
14  from .client import CloudClient
15 
16 DOMAIN = "cloud"
17 DATA_CLOUD: HassKey[Cloud[CloudClient]] = HassKey(DOMAIN)
18 DATA_PLATFORMS_SETUP: HassKey[dict[str, asyncio.Event]] = HassKey(
19  "cloud_platforms_setup"
20 )
21 REQUEST_TIMEOUT = 10
22 
23 PREF_ENABLE_ALEXA = "alexa_enabled"
24 PREF_ENABLE_GOOGLE = "google_enabled"
25 PREF_ENABLE_REMOTE = "remote_enabled"
26 PREF_GOOGLE_SECURE_DEVICES_PIN = "google_secure_devices_pin"
27 PREF_CLOUDHOOKS = "cloudhooks"
28 PREF_CLOUD_USER = "cloud_user"
29 PREF_GOOGLE_ENTITY_CONFIGS = "google_entity_configs"
30 PREF_GOOGLE_REPORT_STATE = "google_report_state"
31 PREF_ALEXA_ENTITY_CONFIGS = "alexa_entity_configs"
32 PREF_ALEXA_REPORT_STATE = "alexa_report_state"
33 PREF_DISABLE_2FA = "disable_2fa"
34 PREF_INSTANCE_ID = "instance_id"
35 PREF_SHOULD_EXPOSE = "should_expose"
36 PREF_GOOGLE_LOCAL_WEBHOOK_ID = "google_local_webhook_id"
37 PREF_USERNAME = "username"
38 PREF_REMOTE_DOMAIN = "remote_domain"
39 PREF_ALEXA_DEFAULT_EXPOSE = "alexa_default_expose"
40 PREF_GOOGLE_DEFAULT_EXPOSE = "google_default_expose"
41 PREF_ALEXA_SETTINGS_VERSION = "alexa_settings_version"
42 PREF_GOOGLE_SETTINGS_VERSION = "google_settings_version"
43 PREF_TTS_DEFAULT_VOICE = "tts_default_voice"
44 PREF_GOOGLE_CONNECTED = "google_connected"
45 PREF_REMOTE_ALLOW_REMOTE_ENABLE = "remote_allow_remote_enable"
46 PREF_ENABLE_CLOUD_ICE_SERVERS = "cloud_ice_servers_enabled"
47 DEFAULT_TTS_DEFAULT_VOICE = ("en-US", "JennyNeural")
48 DEFAULT_DISABLE_2FA = False
49 DEFAULT_ALEXA_REPORT_STATE = True
50 DEFAULT_GOOGLE_REPORT_STATE = True
51 DEFAULT_EXPOSED_DOMAINS = [
52  "climate",
53  "cover",
54  "fan",
55  "humidifier",
56  "light",
57  "lock",
58  "scene",
59  "script",
60  "sensor",
61  "switch",
62  "vacuum",
63  "water_heater",
64 ]
65 
66 CONF_ALEXA = "alexa"
67 CONF_ALIASES = "aliases"
68 CONF_COGNITO_CLIENT_ID = "cognito_client_id"
69 CONF_ENTITY_CONFIG = "entity_config"
70 CONF_FILTER = "filter"
71 CONF_GOOGLE_ACTIONS = "google_actions"
72 CONF_USER_POOL_ID = "user_pool_id"
73 
74 CONF_ACCOUNT_LINK_SERVER = "account_link_server"
75 CONF_ACCOUNTS_SERVER = "accounts_server"
76 CONF_ACME_SERVER = "acme_server"
77 CONF_ALEXA_SERVER = "alexa_server"
78 CONF_CLOUDHOOK_SERVER = "cloudhook_server"
79 CONF_RELAYER_SERVER = "relayer_server"
80 CONF_REMOTESTATE_SERVER = "remotestate_server"
81 CONF_THINGTALK_SERVER = "thingtalk_server"
82 CONF_SERVICEHANDLERS_SERVER = "servicehandlers_server"
83 
84 MODE_DEV = "development"
85 MODE_PROD = "production"
86 
87 DISPATCHER_REMOTE_UPDATE: SignalType[Any] = SignalType("cloud_remote_update")
88 
89 STT_ENTITY_UNIQUE_ID = "cloud-speech-to-text"
90 TTS_ENTITY_UNIQUE_ID = "cloud-text-to-speech"