Core Classes¶

Initialize the service.

Send a message via chosen transport, returning the notification, if one could be made

via_notify is the notify.* entity or action of this integration's own that the message came in through. It's refused while a notification is being delivered, since that can only be a delivery calling back into Supernotify, which could otherwise go round in a loop.

Listen for mobile actions relevant to snooze and silence notifications

Example Action: event_type: mobile_app_notification_action data: foo: a origin: REMOTE time_fired: "2024-04-20T13:14:09.360708+00:00" context: id: 01HVXT93JGWEDW0KE57Z0X6Z1K parent_id: null user_id: a9dbae1a5abf33dbbad52ff82201bb17

Re-publish the current state of every entity SuperNotify provides.

Entities are only refreshed once added to Home Assistant, so this is a safe no-op for any whose platform hasn't loaded (e.g. in tests that build SupernotifyEngine directly without a config entry). Must run in the event loop, as it writes entity state.

Put everything switched on or off at runtime back to its configured enabled state, returning the names reset for each kind. The state changes are attributed to context, the action call or button press asking for the reset, if given.

Walks the scenarios, recipients, deliveries and transports themselves rather than their switches, so one whose switch is disabled in the entity registry is reset too.

The scenarios and entities a tag snooze would cover now, as scenario names and entity_ids

Fetch a still image directly from a camera entity, via HA's own camera component API, rather than triggering the camera.snapshot service and polling the filesystem for the resulting file to appear.

Fetch a still image directly from an image entity, via HA's own image component API.

Active, non-system HA user ids mapped to their login username - for discovering recipients that have no Person record (see CONF_USER_ID in const.py), excluding internal accounts like Supervisor/Home Assistant Content that aren't real people.

All enabled mobile apps

The title of the config entry that registered this entity, if any.

A path relative to the Home Assistant config directory, or the path itself if absolute.

Wrap a blocking function call in a HomeAssistant awaitable job

The device this entity belongs to, if any.

entity_ids in domain (e.g. "notify") registered by a specific integration.

Reads the entity registry directly (not the state machine), so a freshly registered entity counts even before it has reported a first state.

device_model_select optionally filters by the backing device's model (e.g. {"exclude": ["Speaker Group"]}), same include/exclude rule shape used elsewhere.

Entities that can be called this, see entity_spoken_names()

What an entity can be called, by entity_id, object_id, friendly name or alias - and by object_id then domain, so 'driveway camera' is camera.driveway - as spoken_name() has them

Return the data of the first enabled, non-ignored config entry for domain, if any.

Fully expanded members of a group.* helper or a platform group (media_player, light... groups created by the group integration expose members in an entity_id state attribute). None if not a group.

Other entities, e.g. scene.* or min/max sensor.*, also expose an entity_id attribute, so anything outside the group domain is only treated as a group if the entity registry says its platform is group.

Guard for HA functionality, largely for tests or docgen

Client aiohttp session for async web requests

True if device_id is this integration's own 'SuperNotify' device (see ha_device_info)

Load integration state previously persisted to Home Assistant's .storage/ area, via HA's own Store helper, or None if nothing has been persisted yet for this key.

Whether a mobile app can be notified, by its notify action or its notify entity

The integration that registered this entity (RegistryEntry.platform), if any.

Entity ids and device ids an exclude block of a target leaves out, as Home Assistant 2026.11 does for entity actions - config and diagnostic entities included, and with the members of any group, so one can't come back when its group is expanded.

Resolve HA area/floor/label selectors to the entities they reference, through the same core helper as HA entity actions, so groups are expanded and entities inherit the area of their device.

Persist integration state to Home Assistant's .storage/ area, via HA's own Store helper. Fire-and-forget: the write happens in a tracked background task rather than blocking the caller, since this is called from both sync and async contexts. Sync callers include actions without @callback (e.g. clear_snoozes), which Home Assistant runs in its executor, so off the event loop the thread-safe hass.create_task is used.

The automations and scripts whose current run carries this context, i.e. what sent a notification.

An automation or script writes its state with the context of the run it starts, and the actions of that run carry the same context (a script started by an automation gets it as parent), so the sender is the automation or script whose state has the context's id or its parent's

WARNING: best effort only, and not to be built on further. Home Assistant has no native way to get the original cause of a context, so this relies on the state still carrying the context of that run - a later or parallel run replaces it, and a sender further up the chain than the parent isn't found. It also scans every automation and script state on each call, so callers should only use it when the answer could matter.

E-mail address of each recipient set up in Home Assistant's SMTP integration, to its notify entity

Call on_change once things settle after a mobile_app device, or its notify action, comes or goes

Re-pairing or renaming a phone changes its notify action, and HA registers that action a little after the device itself, so both kinds of change are debounced into one call

Supernotify's own strings for a translation category, in the given language or else the configured one, keyed component.supernotify.<category>.<key>, English filling in any not translated