Home Assistant Unofficial Reference 2024.12.1
const.py
Go to the documentation of this file.
1 """Constants for the Plex component."""
2 
3 from datetime import timedelta
4 from typing import Final
5 
6 from homeassistant.const import Platform, __version__
7 
8 DOMAIN = "plex"
9 NAME_FORMAT = "Plex ({})"
10 COMMON_PLAYERS = ["Plex Web"]
11 TRANSIENT_DEVICE_MODELS = ["Plex Web", "Plex for Sonos"]
12 
13 DEFAULT_PORT = 32400
14 DEFAULT_SSL = False
15 DEFAULT_VERIFY_SSL = True
16 
17 PLEXTV_THROTTLE = 60
18 
19 CLIENT_SCAN_INTERVAL = timedelta(minutes=10)
20 DEBOUNCE_TIMEOUT = 1
21 DISPATCHERS: Final = "dispatchers"
22 GDM_DEBOUNCER: Final = "gdm_debouncer"
23 GDM_SCANNER: Final = "gdm_scanner"
24 PLATFORMS = frozenset(
25  [Platform.BUTTON, Platform.MEDIA_PLAYER, Platform.SENSOR, Platform.UPDATE]
26 )
27 PLAYER_SOURCE = "player_source"
28 SERVERS: Final = "servers"
29 WEBSOCKETS: Final = "websockets"
30 
31 PLEX_SERVER_CONFIG = "server_config"
32 
33 PLEX_NEW_MP_SIGNAL = "plex_new_mp_signal.{}"
34 PLEX_UPDATE_MEDIA_PLAYER_SESSION_SIGNAL = "plex_update_session_signal.{}"
35 PLEX_UPDATE_MEDIA_PLAYER_SIGNAL = "plex_update_mp_signal.{}"
36 PLEX_UPDATE_LIBRARY_SIGNAL = "plex_update_libraries_signal.{}"
37 PLEX_UPDATE_PLATFORMS_SIGNAL = "plex_update_platforms_signal.{}"
38 PLEX_UPDATE_SENSOR_SIGNAL = "plex_update_sensor_signal.{}"
39 
40 CONF_SERVER = "server"
41 CONF_SERVER_IDENTIFIER = "server_id"
42 CONF_USE_EPISODE_ART = "use_episode_art"
43 CONF_IGNORE_NEW_SHARED_USERS = "ignore_new_shared_users"
44 CONF_IGNORE_PLEX_WEB_CLIENTS = "ignore_plex_web_clients"
45 CONF_MONITORED_USERS = "monitored_users"
46 
47 AUTH_CALLBACK_PATH = "/auth/plex/callback"
48 AUTH_CALLBACK_NAME = "auth:plex:callback"
49 
50 X_PLEX_DEVICE_NAME = "Home Assistant"
51 X_PLEX_PLATFORM = "Home Assistant"
52 X_PLEX_PRODUCT = "Home Assistant"
53 X_PLEX_VERSION = __version__
54 
55 AUTOMATIC_SETUP_STRING = "Obtain a new token from plex.tv"
56 MANUAL_SETUP_STRING = "Configure Plex server manually"
57 
58 SERVICE_REFRESH_LIBRARY = "refresh_library"
59 SERVICE_SCAN_CLIENTS = "scan_for_clients"
60 
61 PLEX_URI_SCHEME = "plex://"
62 
63 INVALID_TOKEN_MESSAGE = "Invalid token"