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