Coverage for custom_components/supernotify/const.py: 100%
200 statements
« prev ^ index » next coverage.py v7.10.6, created at 2026-04-01 15:06 +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_ARCHIVE_EVENT_NAME: Final[str] = "event_name"
67CONF_ARCHIVE_EVENT_SELECTION: Final[str] = "event_selection"
68CONF_ARCHIVE_DIAGNOSTICS: Final[str] = "diagnostics"
69CONF_MEDIA_STORAGE_DAYS: Final[str] = "media_storage_days"
71OCCUPANCY_ANY_IN = "any_in"
72OCCUPANCY_ANY_OUT = "any_out"
73OCCUPANCY_ALL_IN = "all_in"
74OCCUPANCY_ALL = "all"
75OCCUPANCY_NONE = "none"
76OCCUPANCY_ALL_OUT = "all_out"
77OCCUPANCY_ONLY_IN = "only_in"
78OCCUPANCY_ONLY_OUT = "only_out"
80ATTR_ENABLED = "enabled"
81ATTR_PRIORITY = "priority"
82ATTR_ACTION = "action"
83ATTR_SCENARIOS_REQUIRE = "require_scenarios"
84ATTR_SCENARIOS_APPLY = "apply_scenarios"
85ATTR_FORCE_RESEND: Final[str] = "force_resend"
86ATTR_SCENARIOS_CONSTRAIN = "constrain_scenarios"
87ATTR_DELIVERY = "delivery"
88ATTR_DEFAULT = "default"
89ATTR_NOTIFICATION_ID = "notification_id"
90ATTR_DELIVERY_SELECTION = "delivery_selection"
91ATTR_RECIPIENTS = "recipients"
92ATTR_DATA = "data"
93ATTR_MEDIA = "media"
94ATTR_TITLE = "title"
95ATTR_MEDIA_SNAPSHOT_URL = "snapshot_url"
96ATTR_MEDIA_CAMERA_ENTITY_ID = "camera_entity_id"
97ATTR_MEDIA_CAMERA_DELAY = "camera_delay"
98ATTR_MEDIA_CAMERA_PTZ_PRESET = "camera_ptz_preset"
99ATTR_MEDIA_CLIP_URL = "clip_url"
100ATTR_MEDIA_SNAPSHOT_PATH = "snapshot_image_path"
101ATTR_ACTION_GROUPS = "action_groups"
102CONF_ACTION_GROUP_NAMES = "action_groups"
103ATTR_ACTION_CATEGORY = "action_category"
104ATTR_ACTION_URL = "action_url"
105ATTR_ACTION_URL_TITLE = "action_url_title"
106ATTR_MESSAGE_HTML = "message_html"
107ATTR_JPEG_OPTS = "jpeg_opts"
108ATTR_PNG_OPTS = "png_opts"
109ATTR_TIMESTAMP = "timestamp"
110ATTR_SPOKEN_MESSAGE = "spoken_message"
111ATTR_DEBUG = "debug"
112ATTR_ACTIONS = "actions"
113ATTR_USER_ID = "user_id"
114ATTR_PERSON_ID = "person_id"
115ATTR_MOBILE_APP_ID = "mobile_app_id"
116ATTR_EMAIL = "email"
117ATTR_PHONE = "phone"
118ATTR_ALIAS = "alias"
120DELIVERY_SELECTION_IMPLICIT = "implicit"
121DELIVERY_SELECTION_EXPLICIT = "explicit"
122DELIVERY_SELECTION_FIXED = "fixed"
124DELIVERY_SELECTION_VALUES = [DELIVERY_SELECTION_EXPLICIT, DELIVERY_SELECTION_FIXED, DELIVERY_SELECTION_IMPLICIT]
125PTZ_METHOD_ONVIF = "onvif"
126PTZ_METHOD_FRIGATE = "frigate"
127PTZ_METHOD_VALUES = [PTZ_METHOD_ONVIF, PTZ_METHOD_FRIGATE]
129SELECTION_FALLBACK_ON_ERROR = "fallback_on_error"
130SELECTION_FALLBACK = "fallback"
131SELECTION_BY_SCENARIO = "scenario"
132SELECTION_DEFAULT = "default"
133SELECTION_EXPLICIT = "explicit"
134SELECTION_VALUES = [
135 SELECTION_FALLBACK_ON_ERROR,
136 SELECTION_EXPLICIT,
137 SELECTION_BY_SCENARIO,
138 SELECTION_DEFAULT,
139 SELECTION_FALLBACK,
140]
142OCCUPANCY_VALUES = [
143 OCCUPANCY_ALL_IN,
144 OCCUPANCY_ALL_OUT,
145 OCCUPANCY_ANY_IN,
146 OCCUPANCY_ANY_OUT,
147 OCCUPANCY_ONLY_IN,
148 OCCUPANCY_ONLY_OUT,
149 OCCUPANCY_ALL,
150 OCCUPANCY_NONE,
151]
153PRIORITY_CRITICAL = "critical"
154PRIORITY_HIGH = "high"
155PRIORITY_MEDIUM = "medium"
156PRIORITY_LOW = "low"
157PRIORITY_MINIMUM = "minimum"
159PRIORITY_VALUES: dict[str, int] = {
160 PRIORITY_MINIMUM: 1,
161 PRIORITY_LOW: 2,
162 PRIORITY_MEDIUM: 3,
163 PRIORITY_HIGH: 4,
164 PRIORITY_CRITICAL: 5,
165}
167CONF_TARGET_USAGE = "target_usage"
168TARGET_USE_ON_NO_DELIVERY_TARGETS = "no_delivery"
169TARGET_USE_ON_NO_ACTION_TARGETS = "no_action"
170TARGET_USE_FIXED = "fixed"
171TARGET_USE_MERGE_ALWAYS = "merge_always"
172TARGET_USE_MERGE_ON_DELIVERY_TARGETS = "merge_delivery"
174OPTION_SIMPLIFY_TEXT = "simplify_text"
175OPTION_STRIP_URLS = "strip_urls"
176OPTION_MESSAGE_USAGE = "message_usage"
177OPTION_RAW = "raw"
178OPTION_JPEG = "jpeg_opts"
179OPTION_PNG = "png_opts"
180OPTION_TTS_ENTITY_ID = "tts_entity_id"
181MEDIA_OPTION_REPROCESS = "reprocess"
182OPTION_TARGET_CATEGORIES = "target_categories"
183OPTION_UNIQUE_TARGETS = "unique_targets"
184OPTION_TARGET_INCLUDE_RE = "target_include_re" # deprecated v1.9.0
185OPTION_TARGET_SELECT = "target_select"
186OPTION_CHIME_ALIASES = "chime_aliases"
187OPTION_DATA_KEYS_SELECT = "data_keys_select"
188OPTION_DATA_KEYS_INCLUDE_RE = "data_keys_include_re" # deprecated v1.9.0
189OPTION_DATA_KEYS_EXCLUDE_RE = "data_keys_exclude_re" # deprecated v1.9.0
190OPTION_GENERIC_DOMAIN_STYLE = "handle_as_domain"
191OPTION_STRICT_TEMPLATE = "strict_template"
193SELECT_INCLUDE = "include"
194SELECT_EXCLUDE = "exclude"
196RE_DEVICE_ID = r"^[0-9a-f]{32}$"
198RESERVED_DELIVERY_NAMES: list[str] = ["ALL"]
199RESERVED_SCENARIO_NAMES: list[str] = ["NO_SCENARIO", "NULL"]
200RESERVED_DATA_KEYS: list[str] = [ATTR_DOMAIN, ATTR_SERVICE, "action"]
203CONF_DUPE_CHECK: Final[str] = "dupe_check"
204CONF_DUPE_POLICY: Final[str] = "dupe_policy"
205CONF_TTL: Final[str] = "ttl"
206CONF_SIZE: Final[str] = "size"
207ATTR_DUPE_POLICY_MTSLP: Final[str] = "dupe_policy_message_title_same_or_lower_priority"
208ATTR_DUPE_POLICY_MT: Final[str] = "dupe_policy_message_title_same"
209ATTR_DUPE_POLICY_NONE: Final[str] = "dupe_policy_none"
210CONF_MOBILE_APP_ID: Final[str] = "mobile_app_id"
211CONF_TRANSPORT_DATA: Final[str] = "transport_data"
214CONF_DEVICE_TRACKER: Final[str] = "device_tracker"
217CONF_DEVICE_NAME: Final[str] = "device_name"
218CONF_DEVICE_LABELS: Final[str] = "device_labels"
220OPTION_DEVICE_DOMAIN: Final[str] = "device_domain"
222OPTION_DEVICE_MODEL_SELECT: Final[str] = "device_model_select"
223OPTION_DEVICE_MANUFACTURER_SELECT: Final[str] = "device_manufacturer_select"
224OPTION_DEVICE_OS_SELECT: Final[str] = "device_os_select"
225OPTION_DEVICE_LABEL_SELECT: Final[str] = "device_label_select"
226OPTION_DEVICE_AREA_SELECT: Final[str] = "device_area_select"
227OPTION_DEVICE_DISCOVERY: Final[str] = "device_discovery"
230TARGET_REQUIRE_ALWAYS = "always"
231TARGET_REQUIRE_NEVER = "never"
232TARGET_REQUIRE_OPTIONAL = "optional"
235TRANSPORT_SMS = "sms"
236TRANSPORT_TTS = "tts"
237TRANSPORT_MQTT = "mqtt"
238TRANSPORT_EMAIL = "email"
239TRANSPORT_ALEXA = "alexa_devices"
240TRANSPORT_ALEXA_MEDIA_PLAYER = "alexa_media_player"
241TRANSPORT_MOBILE_PUSH = "mobile_push"
242TRANSPORT_MEDIA = "media"
243TRANSPORT_CHIME = "chime"
244TRANSPORT_GENERIC = "generic"
245TRANSPORT_NOTIFY_ENTITY = "notify_entity"
246TRANSPORT_PERSISTENT = "persistent"
247TRANSPORT_VALUES = [
248 TRANSPORT_SMS,
249 TRANSPORT_MQTT,
250 TRANSPORT_ALEXA,
251 TRANSPORT_ALEXA_MEDIA_PLAYER,
252 TRANSPORT_MOBILE_PUSH,
253 TRANSPORT_CHIME,
254 TRANSPORT_EMAIL,
255 TRANSPORT_MEDIA,
256 TRANSPORT_PERSISTENT,
257 TRANSPORT_TTS,
258 TRANSPORT_GENERIC,
259 TRANSPORT_NOTIFY_ENTITY,
260]
263CONF_DEVICE_DISCOVERY: Final[str] = "device_discovery"
264CONF_DEVICE_DOMAIN: Final[str] = OPTION_DEVICE_DOMAIN
265CONF_DEVICE_MODEL_INCLUDE: Final[str] = "device_model_include"
266CONF_DEVICE_MODEL_EXCLUDE: Final[str] = "device_model_exclude"
268CONF_SNOOZE = "snooze"
269CONF_SNOOZE_TIME = "snooze_time"
271# Idea - differentiate enabled as recipient vs as occupant, for ALL_IN etc check
272# May need condition, and also enabled if delivery disabled
273# CONF_OCCUPANCY="occupancy"
274# OPTION_OCCUPANCY_DEFAULT="default"
275# OPTIONS_OCCUPANCY=[OPTION_OCCUPANCY_DEFAULT,OPTION_OCCUPANCY_EXCLUDE]
276# OPTION_OCCUPANCY_EXCLUDE="exclude"
278CONF_PHONE_NUMBER: str = "phone_number"
281CONF_TUNE: Final[str] = "tune"
282CONF_VOLUME: Final[str] = "volume"
283CONF_DURATION: Final[str] = "duration"
285OPTIONS_CHIME_DOMAINS = ["media_player", "switch", "script", "rest_command", "siren", "alexa_devices"]