Coverage for custom_components/supernotify/const.py: 100%
192 statements
« prev ^ index » next coverage.py v7.10.6, created at 2026-02-06 15:18 +0000
1"""The Supernotify integration"""
3from typing import Final
5from homeassistant.const import (
6 ATTR_DOMAIN,
7 ATTR_SERVICE,
8)
10CONF_ACTIONS: Final[str] = "actions"
11CONF_TITLE: Final[str] = "title"
12CONF_URI: Final[str] = "uri"
13CONF_RECIPIENTS: Final[str] = "recipients"
14CONF_RECIPIENTS_DISCOVERY: Final[str] = "recipients_discovery"
15CONF_TEMPLATE_PATH: Final[str] = "template_path"
16CONF_MEDIA_PATH: Final[str] = "media_path"
17CONF_HOUSEKEEPING: Final[str] = "housekeeping"
18CONF_HOUSEKEEPING_TIME: Final[str] = "housekeeping_time"
19CONF_ARCHIVE_PATH: Final[str] = "file_path"
20CONF_ARCHIVE: Final[str] = "archive"
21CONF_ARCHIVE_DAYS: Final[str] = "file_retention_days"
22CONF_ARCHIVE_MQTT_TOPIC: Final[str] = "mqtt_topic"
23CONF_ARCHIVE_MQTT_QOS: Final[str] = "mqtt_qos"
24CONF_ARCHIVE_MQTT_RETAIN: Final[str] = "mqtt_retain"
25CONF_TEMPLATE: Final[str] = "template"
26CONF_DELIVERY_DEFAULTS: Final[str] = "delivery_defaults"
27CONF_LINKS: Final[str] = "links"
28CONF_PERSON: Final[str] = "person"
29CONF_TRANSPORT: Final[str] = "transport"
30CONF_TRANSPORTS: Final[str] = "transports"
31CONF_DELIVERY: Final[str] = "delivery"
32CONF_SELECTION: Final[str] = "selection"
33CONF_SELECTION_RANK: Final[str] = "selection_rank"
36CONF_DATA: Final[str] = "data"
37CONF_OPTIONS: Final[str] = "options"
38CONF_MOBILE: Final[str] = "mobile"
39CONF_NOTIFY: Final[str] = "notify"
41CONF_PRIORITY: Final[str] = "priority"
42CONF_OCCUPANCY: Final[str] = "occupancy"
43CONF_SCENARIOS: Final[str] = "scenarios"
44CONF_MANUFACTURER: Final[str] = "manufacturer"
45CONF_CLASS: Final[str] = "class"
48CONF_MODEL: Final[str] = "model"
49CONF_MESSAGE: Final[str] = "message"
50CONF_TARGET_REQUIRED: Final[str] = "target_required"
51CONF_MOBILE_DEVICES: Final[str] = "mobile_devices"
52CONF_MOBILE_DISCOVERY: Final[str] = "mobile_discovery"
53CONF_ACTION_TEMPLATE: Final[str] = "action_template"
54CONF_ACTION_GROUPS: Final[str] = "action_groups"
55CONF_TITLE_TEMPLATE: Final[str] = "title_template"
56CONF_MEDIA: Final[str] = "media"
57CONF_CAMERA: Final[str] = "camera"
58CONF_CLIP_URL: Final[str] = "clip_url"
59CONF_PTZ_DELAY: Final[str] = "ptz_delay"
60CONF_PTZ_METHOD: Final[str] = "ptz_method"
61CONF_PTZ_CAMERA: Final[str] = "ptz_camera"
62CONF_PTZ_PRESET_DEFAULT: Final[str] = "ptz_default_preset"
63CONF_ALT_CAMERA: Final[str] = "alt_camera"
64CONF_CAMERAS: Final[str] = "cameras"
65CONF_ARCHIVE_PURGE_INTERVAL: Final[str] = "purge_interval"
66CONF_MEDIA_STORAGE_DAYS: Final[str] = "media_storage_days"
68OCCUPANCY_ANY_IN = "any_in"
69OCCUPANCY_ANY_OUT = "any_out"
70OCCUPANCY_ALL_IN = "all_in"
71OCCUPANCY_ALL = "all"
72OCCUPANCY_NONE = "none"
73OCCUPANCY_ALL_OUT = "all_out"
74OCCUPANCY_ONLY_IN = "only_in"
75OCCUPANCY_ONLY_OUT = "only_out"
77ATTR_ENABLED = "enabled"
78ATTR_PRIORITY = "priority"
79ATTR_ACTION = "action"
80ATTR_SCENARIOS_REQUIRE = "require_scenarios"
81ATTR_SCENARIOS_APPLY = "apply_scenarios"
82ATTR_SCENARIOS_CONSTRAIN = "constrain_scenarios"
83ATTR_DELIVERY = "delivery"
84ATTR_DEFAULT = "default"
85ATTR_NOTIFICATION_ID = "notification_id"
86ATTR_DELIVERY_SELECTION = "delivery_selection"
87ATTR_RECIPIENTS = "recipients"
88ATTR_DATA = "data"
89ATTR_MEDIA = "media"
90ATTR_TITLE = "title"
91ATTR_MEDIA_SNAPSHOT_URL = "snapshot_url"
92ATTR_MEDIA_CAMERA_ENTITY_ID = "camera_entity_id"
93ATTR_MEDIA_CAMERA_DELAY = "camera_delay"
94ATTR_MEDIA_CAMERA_PTZ_PRESET = "camera_ptz_preset"
95ATTR_MEDIA_CLIP_URL = "clip_url"
96ATTR_MEDIA_SNAPSHOT_PATH = "snapshot_image_path"
97ATTR_ACTION_GROUPS = "action_groups"
98CONF_ACTION_GROUP_NAMES = "action_groups"
99ATTR_ACTION_CATEGORY = "action_category"
100ATTR_ACTION_URL = "action_url"
101ATTR_ACTION_URL_TITLE = "action_url_title"
102ATTR_MESSAGE_HTML = "message_html"
103ATTR_JPEG_OPTS = "jpeg_opts"
104ATTR_PNG_OPTS = "png_opts"
105ATTR_TIMESTAMP = "timestamp"
106ATTR_DEBUG = "debug"
107ATTR_ACTIONS = "actions"
108ATTR_USER_ID = "user_id"
109ATTR_PERSON_ID = "person_id"
110ATTR_MOBILE_APP_ID = "mobile_app_id"
111ATTR_EMAIL = "email"
112ATTR_PHONE = "phone"
113ATTR_ALIAS = "alias"
115DELIVERY_SELECTION_IMPLICIT = "implicit"
116DELIVERY_SELECTION_EXPLICIT = "explicit"
117DELIVERY_SELECTION_FIXED = "fixed"
119DELIVERY_SELECTION_VALUES = [DELIVERY_SELECTION_EXPLICIT, DELIVERY_SELECTION_FIXED, DELIVERY_SELECTION_IMPLICIT]
120PTZ_METHOD_ONVIF = "onvif"
121PTZ_METHOD_FRIGATE = "frigate"
122PTZ_METHOD_VALUES = [PTZ_METHOD_ONVIF, PTZ_METHOD_FRIGATE]
124SELECTION_FALLBACK_ON_ERROR = "fallback_on_error"
125SELECTION_FALLBACK = "fallback"
126SELECTION_BY_SCENARIO = "scenario"
127SELECTION_DEFAULT = "default"
128SELECTION_EXPLICIT = "explicit"
129SELECTION_VALUES = [
130 SELECTION_FALLBACK_ON_ERROR,
131 SELECTION_EXPLICIT,
132 SELECTION_BY_SCENARIO,
133 SELECTION_DEFAULT,
134 SELECTION_FALLBACK,
135]
137OCCUPANCY_VALUES = [
138 OCCUPANCY_ALL_IN,
139 OCCUPANCY_ALL_OUT,
140 OCCUPANCY_ANY_IN,
141 OCCUPANCY_ANY_OUT,
142 OCCUPANCY_ONLY_IN,
143 OCCUPANCY_ONLY_OUT,
144 OCCUPANCY_ALL,
145 OCCUPANCY_NONE,
146]
148PRIORITY_CRITICAL = "critical"
149PRIORITY_HIGH = "high"
150PRIORITY_MEDIUM = "medium"
151PRIORITY_LOW = "low"
152PRIORITY_MINIMUM = "minimum"
154PRIORITY_VALUES: dict[str, int] = {
155 PRIORITY_MINIMUM: 1,
156 PRIORITY_LOW: 2,
157 PRIORITY_MEDIUM: 3,
158 PRIORITY_HIGH: 4,
159 PRIORITY_CRITICAL: 5,
160}
162CONF_TARGET_USAGE = "target_usage"
163TARGET_USE_ON_NO_DELIVERY_TARGETS = "no_delivery"
164TARGET_USE_ON_NO_ACTION_TARGETS = "no_action"
165TARGET_USE_FIXED = "fixed"
166TARGET_USE_MERGE_ALWAYS = "merge_always"
167TARGET_USE_MERGE_ON_DELIVERY_TARGETS = "merge_delivery"
169OPTION_SIMPLIFY_TEXT = "simplify_text"
170OPTION_STRIP_URLS = "strip_urls"
171OPTION_MESSAGE_USAGE = "message_usage"
172OPTION_RAW = "raw"
173OPTION_JPEG = "jpeg_opts"
174OPTION_PNG = "png_opts"
175OPTION_TTS_ENTITY_ID = "tts_entity_id"
176MEDIA_OPTION_REPROCESS = "reprocess"
177OPTION_TARGET_CATEGORIES = "target_categories"
178OPTION_UNIQUE_TARGETS = "unique_targets"
179OPTION_TARGET_INCLUDE_RE = "target_include_re" # deprecated v1.9.0
180OPTION_TARGET_SELECT = "target_select"
181OPTION_CHIME_ALIASES = "chime_aliases"
182OPTION_DATA_KEYS_SELECT = "data_keys_select"
183OPTION_DATA_KEYS_INCLUDE_RE = "data_keys_include_re" # deprecated v1.9.0
184OPTION_DATA_KEYS_EXCLUDE_RE = "data_keys_exclude_re" # deprecated v1.9.0
185OPTION_GENERIC_DOMAIN_STYLE = "handle_as_domain"
186OPTION_STRICT_TEMPLATE = "strict_template"
188SELECT_INCLUDE = "include"
189SELECT_EXCLUDE = "exclude"
191RE_DEVICE_ID = r"^[0-9a-f]{32}$"
193RESERVED_DELIVERY_NAMES: list[str] = ["ALL"]
194RESERVED_SCENARIO_NAMES: list[str] = ["NO_SCENARIO", "NULL"]
195RESERVED_DATA_KEYS: list[str] = [ATTR_DOMAIN, ATTR_SERVICE, "action"]
198CONF_DUPE_CHECK: Final[str] = "dupe_check"
199CONF_DUPE_POLICY: Final[str] = "dupe_policy"
200CONF_TTL: Final[str] = "ttl"
201CONF_SIZE: Final[str] = "size"
202ATTR_DUPE_POLICY_MTSLP: Final[str] = "dupe_policy_message_title_same_or_lower_priority"
203ATTR_DUPE_POLICY_NONE: Final[str] = "dupe_policy_none"
204CONF_MOBILE_APP_ID: Final[str] = "mobile_app_id"
205CONF_TRANSPORT_DATA: Final[str] = "transport_data"
208CONF_DEVICE_TRACKER: Final[str] = "device_tracker"
211CONF_DEVICE_NAME: Final[str] = "device_name"
212CONF_DEVICE_LABELS: Final[str] = "device_labels"
214OPTION_DEVICE_DOMAIN: Final[str] = "device_domain"
216OPTION_DEVICE_MODEL_SELECT: Final[str] = "device_model_select"
217OPTION_DEVICE_MANUFACTURER_SELECT: Final[str] = "device_manufacturer_select"
218OPTION_DEVICE_OS_SELECT: Final[str] = "device_os_select"
219OPTION_DEVICE_LABEL_SELECT: Final[str] = "device_label_select"
220OPTION_DEVICE_AREA_SELECT: Final[str] = "device_area_select"
221OPTION_DEVICE_DISCOVERY: Final[str] = "device_discovery"
224TARGET_REQUIRE_ALWAYS = "always"
225TARGET_REQUIRE_NEVER = "never"
226TARGET_REQUIRE_OPTIONAL = "optional"
229TRANSPORT_SMS = "sms"
230TRANSPORT_TTS = "tts"
231TRANSPORT_MQTT = "mqtt"
232TRANSPORT_EMAIL = "email"
233TRANSPORT_ALEXA = "alexa_devices"
234TRANSPORT_ALEXA_MEDIA_PLAYER = "alexa_media_player"
235TRANSPORT_MOBILE_PUSH = "mobile_push"
236TRANSPORT_MEDIA = "media"
237TRANSPORT_CHIME = "chime"
238TRANSPORT_GENERIC = "generic"
239TRANSPORT_NOTIFY_ENTITY = "notify_entity"
240TRANSPORT_PERSISTENT = "persistent"
241TRANSPORT_VALUES = [
242 TRANSPORT_SMS,
243 TRANSPORT_MQTT,
244 TRANSPORT_ALEXA,
245 TRANSPORT_ALEXA_MEDIA_PLAYER,
246 TRANSPORT_MOBILE_PUSH,
247 TRANSPORT_CHIME,
248 TRANSPORT_EMAIL,
249 TRANSPORT_MEDIA,
250 TRANSPORT_PERSISTENT,
251 TRANSPORT_TTS,
252 TRANSPORT_GENERIC,
253 TRANSPORT_NOTIFY_ENTITY,
254]
257CONF_DEVICE_DISCOVERY: Final[str] = "device_discovery"
258CONF_DEVICE_DOMAIN: Final[str] = OPTION_DEVICE_DOMAIN
259CONF_DEVICE_MODEL_INCLUDE: Final[str] = "device_model_include"
260CONF_DEVICE_MODEL_EXCLUDE: Final[str] = "device_model_exclude"
262# Idea - differentiate enabled as recipient vs as occupant, for ALL_IN etc check
263# May need condition, and also enabled if delivery disabled
264# CONF_OCCUPANCY="occupancy"
265# OPTION_OCCUPANCY_DEFAULT="default"
266# OPTIONS_OCCUPANCY=[OPTION_OCCUPANCY_DEFAULT,OPTION_OCCUPANCY_EXCLUDE]
267# OPTION_OCCUPANCY_EXCLUDE="exclude"
269CONF_PHONE_NUMBER: str = "phone_number"
272CONF_TUNE: Final[str] = "tune"
273CONF_VOLUME: Final[str] = "volume"
274CONF_DURATION: Final[str] = "duration"
276OPTIONS_CHIME_DOMAINS = ["media_player", "switch", "script", "rest_command", "siren", "alexa_devices"]