Home Assistant Unofficial Reference 2024.12.1
const.py
Go to the documentation of this file.
1 """Constants for Synology DSM."""
2 
3 from __future__ import annotations
4 
5 from aiohttp import ClientTimeout
6 from synology_dsm.api.surveillance_station.const import SNAPSHOT_PROFILE_BALANCED
7 from synology_dsm.exceptions import (
8  SynologyDSMAPIErrorException,
9  SynologyDSMLogin2SARequiredException,
10  SynologyDSMLoginDisabledAccountException,
11  SynologyDSMLoginFailedException,
12  SynologyDSMLoginInvalidException,
13  SynologyDSMLoginPermissionDeniedException,
14  SynologyDSMRequestException,
15 )
16 
17 from homeassistant.const import Platform
18 
19 DOMAIN = "synology_dsm"
20 ATTRIBUTION = "Data provided by Synology"
21 PLATFORMS = [
22  Platform.BINARY_SENSOR,
23  Platform.BUTTON,
24  Platform.CAMERA,
25  Platform.SENSOR,
26  Platform.SWITCH,
27  Platform.UPDATE,
28 ]
29 EXCEPTION_DETAILS = "details"
30 EXCEPTION_UNKNOWN = "unknown"
31 
32 # Configuration
33 CONF_SERIAL = "serial"
34 CONF_VOLUMES = "volumes"
35 CONF_DEVICE_TOKEN = "device_token"
36 CONF_SNAPSHOT_QUALITY = "snap_profile_type"
37 
38 DEFAULT_USE_SSL = True
39 DEFAULT_VERIFY_SSL = False
40 DEFAULT_PORT = 5000
41 DEFAULT_PORT_SSL = 5001
42 # Options
43 DEFAULT_SCAN_INTERVAL = 15 # min
44 DEFAULT_TIMEOUT = ClientTimeout(total=60, connect=15)
45 DEFAULT_SNAPSHOT_QUALITY = SNAPSHOT_PROFILE_BALANCED
46 
47 ENTITY_UNIT_LOAD = "load"
48 
49 SHARED_SUFFIX = "_shared"
50 
51 # Signals
52 SIGNAL_CAMERA_SOURCE_CHANGED = "synology_dsm.camera_stream_source_changed"
53 
54 # Services
55 SERVICE_REBOOT = "reboot"
56 SERVICE_SHUTDOWN = "shutdown"
57 SERVICES = [
58  SERVICE_REBOOT,
59  SERVICE_SHUTDOWN,
60 ]
61 
62 SYNOLOGY_AUTH_FAILED_EXCEPTIONS = (
63  SynologyDSMLogin2SARequiredException,
64  SynologyDSMLoginDisabledAccountException,
65  SynologyDSMLoginInvalidException,
66  SynologyDSMLoginPermissionDeniedException,
67 )
68 
69 SYNOLOGY_CONNECTION_EXCEPTIONS = (
70  SynologyDSMAPIErrorException,
71  SynologyDSMLoginFailedException,
72  SynologyDSMRequestException,
73 )