Registry Classes¶

Info

See the Class Diagram for how these relate to each other.

`custom_components.supernotify.people.PeopleRegistry` ¶

METHOD	DESCRIPTION
`async_refresh_entity`	Re-publish one recipient's binary_sensor now
`mobile_devices_for_person`	Auto detect mobile_app targets for a person.
`mobile_devices_for_user`	Auto detect mobile_app targets for a HA user, with no Person entity required.
`people_named`	The recipients called this, by alias or name, ignoring case and underscores - or failing
`person_id_for_name`	The one recipient called this, by full name, alias or unique first name
`recipient_entities`	Every registered recipient binary_sensor - used by supernotify.refresh_entities.
`register_entity`	Called by SupernotifyRecipientBinarySensor.async_added_to_hass().
`unregister_entity`	Called by SupernotifyRecipientBinarySensor.async_will_remove_from_hass().

`async_refresh_entity(name)` ¶

Re-publish one recipient's binary_sensor now

`mobile_devices_for_person(person_entity_id)` ¶

Auto detect mobile_app targets for a person.

Targets not currently validated as async registration may not be complete at this stage

person_entity_id (str): _description_

list: mobile target actions for this person

`mobile_devices_for_user(user_id)` ¶

Auto detect mobile_app targets for a HA user, with no Person entity required.

`people_named(name)` ¶

The recipients called this, by alias or name, ignoring case and underscores - or failing that, those with it as their first name, so 'jey' finds 'Jey Burrows'

`person_id_for_name(name)` ¶

The one recipient called this, by full name, alias or unique first name

`recipient_entities()` ¶

Every registered recipient binary_sensor - used by supernotify.refresh_entities.

`register_entity(name, entity)` ¶

Called by SupernotifyRecipientBinarySensor.async_added_to_hass().

`unregister_entity(name)` ¶

Called by SupernotifyRecipientBinarySensor.async_will_remove_from_hass().

`custom_components.supernotify.delivery.DeliveryRegistry` ¶

METHOD	DESCRIPTION
`apply_delivery_control`	Give a transport's deliveries the Delivery Control defaults, where the transport's own
`async_refresh_entity`	Re-publish one delivery or transport binary_sensor now, by its unique_id
`initialize_transport_deliveries`	Validate and initialize deliveries at startup for this transport
`legacy_entities`	Every registered delivery and transport binary_sensor - used by supernotify.refresh_entities.
`register_entity`	Called by a delivery or transport binary_sensor's async_added_to_hass().
`resolve_name`	Backward compatibility for the original 'DEFAULT_x' auto-configured naming,
`unload_unused_transports`	Drop any transport that ended up with no delivery at all - explicit or auto-generated.
`unregister_entity`	Called by a delivery or transport binary_sensor's async_will_remove_from_hass().

ATTRIBUTE	DESCRIPTION
`choosable_deliveries`	Deliveries a notification can ask for - not ones only a scenario turns on, or only a fallback. TYPE: `dict[str, Delivery]`
`implicit_deliveries`	Deliveries switched on all the time via implicit inclusion TYPE: `list[Delivery]`

`choosable_deliveries` `property` ¶

Deliveries a notification can ask for - not ones only a scenario turns on, or only a fallback. What the action editor's Delivery list and the LLM tools offer.

`implicit_deliveries` `property` ¶

Deliveries switched on all the time via implicit inclusion

`apply_delivery_control(transport, transport_config)` ¶

Give a transport's deliveries the Delivery Control defaults, where the transport's own YAML delivery_defaults doesn't set them. A delivery's own YAML still wins over both.

`async_refresh_entity(unique_id)` ¶

Re-publish one delivery or transport binary_sensor now, by its unique_id

`initialize_transport_deliveries(context, transport)` `async` ¶

Validate and initialize deliveries at startup for this transport

`legacy_entities()` ¶

Every registered delivery and transport binary_sensor - used by supernotify.refresh_entities.

`register_entity(unique_id, entity)` ¶

Called by a delivery or transport binary_sensor's async_added_to_hass().

`resolve_name(name)` ¶

Backward compatibility for the original 'DEFAULT_x' auto-configured naming, long since replaced by plain transport names: a reference to the old 'DEFAULT_x' form resolves to the current 'x' delivery, if that's what actually exists now.

`unload_unused_transports()` ¶

Drop any transport that ended up with no delivery at all - explicit or auto-generated.

Deliberately deferred until both initialize_transport_deliveries() (explicit) and build_standard_deliveries() (implicit) have run, rather than decided per-transport up front: whether a transport is worth having can only be known once the full, resolved set of deliveries exists - for a transport like generic (bring-your-own-action, entirely delivery-driven), there's no transport-level state to check in advance at all.

`unregister_entity(unique_id)` ¶

Called by a delivery or transport binary_sensor's async_will_remove_from_hass().

`custom_components.supernotify.scenario.ScenarioRegistry` ¶

METHOD	DESCRIPTION
`async_refresh_entity`	Re-publish one scenario's binary_sensor now, whether or not periodic refresh is on
`async_refresh_scenario_states`	Ask each affected scenario's binary_sensor entity to re-read and re-publish its state.
`register_entity`	Called by SupernotifyScenarioBinarySensor.async_added_to_hass().
`scenario_has_state`	Whether a scenario has any state to report - anything that hasn't opted out with
`scenario_is_on`	`is_on` for SupernotifyScenarioBinarySensor - None maps to STATE_UNKNOWN.
`unregister_entity`	Called by SupernotifyScenarioBinarySensor.async_will_remove_from_hass().

`async_refresh_entity(name)` ¶

Re-publish one scenario's binary_sensor now, whether or not periodic refresh is on

`async_refresh_scenario_states(*args)` ¶

Ask each affected scenario's binary_sensor entity to re-read and re-publish its state.

Triggered by the 1-minute timer (time/date scenarios and any dependency not captured by entity extraction) and by state changes of the scenarios' condition entities (immediate reactivity). The entity's own is_on property (via scenario_is_on() above) does the actual (pure, in-memory) evaluation on read; this only decides which entities need to refresh, and is a no-op for a scenario with no entity registered yet (e.g. before the binary_sensor platform has finished loading).

`register_entity(name, entity)` ¶

Called by SupernotifyScenarioBinarySensor.async_added_to_hass().

`scenario_has_state(scenario)` ¶

Whether a scenario has any state to report - anything that hasn't opted out with expose_state. That is the evaluated state of its conditions if it has any, otherwise a manual state that something outside Supernotify sets, see Scenario.manual_active.

`scenario_is_on(scenario)` ¶

is_on for SupernotifyScenarioBinarySensor - None maps to STATE_UNKNOWN.

`unregister_entity(name)` ¶

Called by SupernotifyScenarioBinarySensor.async_will_remove_from_hass().

Registry Classes¶

custom_components.supernotify.people.PeopleRegistry ¶

async_refresh_entity(name) ¶

mobile_devices_for_person(person_entity_id) ¶

mobile_devices_for_user(user_id) ¶

people_named(name) ¶

person_id_for_name(name) ¶

recipient_entities() ¶

register_entity(name, entity) ¶

unregister_entity(name) ¶

custom_components.supernotify.delivery.DeliveryRegistry ¶

choosable_deliveries property ¶

implicit_deliveries property ¶

apply_delivery_control(transport, transport_config) ¶

async_refresh_entity(unique_id) ¶

initialize_transport_deliveries(context, transport) async ¶

legacy_entities() ¶

register_entity(unique_id, entity) ¶

resolve_name(name) ¶

unload_unused_transports() ¶

unregister_entity(unique_id) ¶

custom_components.supernotify.scenario.ScenarioRegistry ¶

async_refresh_entity(name) ¶

async_refresh_scenario_states(*args) ¶

register_entity(name, entity) ¶

scenario_has_state(scenario) ¶

scenario_is_on(scenario) ¶

unregister_entity(name) ¶

`custom_components.supernotify.people.PeopleRegistry` ¶

`async_refresh_entity(name)` ¶

`mobile_devices_for_person(person_entity_id)` ¶

`mobile_devices_for_user(user_id)` ¶

`people_named(name)` ¶

`person_id_for_name(name)` ¶

`recipient_entities()` ¶

`register_entity(name, entity)` ¶

`unregister_entity(name)` ¶

`custom_components.supernotify.delivery.DeliveryRegistry` ¶

`choosable_deliveries` `property` ¶

`implicit_deliveries` `property` ¶

`apply_delivery_control(transport, transport_config)` ¶

`async_refresh_entity(unique_id)` ¶

`initialize_transport_deliveries(context, transport)` `async` ¶

`legacy_entities()` ¶

`register_entity(unique_id, entity)` ¶

`resolve_name(name)` ¶

`unload_unused_transports()` ¶

`unregister_entity(unique_id)` ¶

`custom_components.supernotify.scenario.ScenarioRegistry` ¶

`async_refresh_entity(name)` ¶

`async_refresh_scenario_states(*args)` ¶

`register_entity(name, entity)` ¶

`scenario_has_state(scenario)` ¶

`scenario_is_on(scenario)` ¶

`unregister_entity(name)` ¶