homeassistant 2025.9.4__py3-none-any.whl → 2025.10.0b0__py3-none-any.whl

homeassistant/components/ntfy/notify.py

@@ -2,32 +2,68 @@
 
 from __future__ import annotations
 
+from datetime import timedelta
+from typing import Any
+
 from aiontfy import Message
 from aiontfy.exceptions import (
     NtfyException,
     NtfyHTTPError,
     NtfyUnauthorizedAuthenticationError,
 )
+import voluptuous as vol
 from yarl import URL
 
 from homeassistant.components.notify import (
+    ATTR_MESSAGE,
+    ATTR_TITLE,
     NotifyEntity,
     NotifyEntityDescription,
     NotifyEntityFeature,
 )
-from homeassistant.config_entries import ConfigSubentry
-from homeassistant.const import CONF_NAME, CONF_URL
 from homeassistant.core import HomeAssistant
-from homeassistant.exceptions import HomeAssistantError
-from homeassistant.helpers.device_registry import DeviceEntryType, DeviceInfo
+from homeassistant.exceptions import HomeAssistantError, ServiceValidationError
+from homeassistant.helpers import config_validation as cv, entity_platform
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
-from .const import CONF_TOPIC, DOMAIN
+from .const import DOMAIN
 from .coordinator import NtfyConfigEntry
+from .entity import NtfyBaseEntity
 
 PARALLEL_UPDATES = 0
 
 
+SERVICE_PUBLISH = "publish"
+ATTR_ATTACH = "attach"
+ATTR_CALL = "call"
+ATTR_CLICK = "click"
+ATTR_DELAY = "delay"
+ATTR_EMAIL = "email"
+ATTR_ICON = "icon"
+ATTR_MARKDOWN = "markdown"
+ATTR_PRIORITY = "priority"
+ATTR_TAGS = "tags"
+
+SERVICE_PUBLISH_SCHEMA = cv.make_entity_service_schema(
+    {
+        vol.Optional(ATTR_TITLE): cv.string,
+        vol.Optional(ATTR_MESSAGE): cv.string,
+        vol.Optional(ATTR_MARKDOWN): cv.boolean,
+        vol.Optional(ATTR_TAGS): vol.All(cv.ensure_list, [str]),
+        vol.Optional(ATTR_PRIORITY): vol.All(vol.Coerce(int), vol.Range(1, 5)),
+        vol.Optional(ATTR_CLICK): vol.All(vol.Url(), vol.Coerce(URL)),
+        vol.Optional(ATTR_DELAY): vol.All(
+            cv.time_period,
+            vol.Range(min=timedelta(seconds=10), max=timedelta(days=3)),
+        ),
+        vol.Optional(ATTR_ATTACH): vol.All(vol.Url(), vol.Coerce(URL)),
+        vol.Optional(ATTR_EMAIL): vol.Email(),
+        vol.Optional(ATTR_CALL): cv.string,
+        vol.Optional(ATTR_ICON): vol.All(vol.Url(), vol.Coerce(URL)),
+    }
+)
+
+
 async def async_setup_entry(
     hass: HomeAssistant,
     config_entry: NtfyConfigEntry,
@@ -40,43 +76,47 @@ async def async_setup_entry(
             [NtfyNotifyEntity(config_entry, subentry)], config_subentry_id=subentry_id
         )
 
+    platform = entity_platform.async_get_current_platform()
+    platform.async_register_entity_service(
+        SERVICE_PUBLISH,
+        SERVICE_PUBLISH_SCHEMA,
+        "publish",
+    )
+
 
-class NtfyNotifyEntity(NotifyEntity):
+class NtfyNotifyEntity(NtfyBaseEntity, NotifyEntity):
     """Representation of a ntfy notification entity."""
 
     entity_description = NotifyEntityDescription(
         key="publish",
         translation_key="publish",
         name=None,
-        has_entity_name=True,
     )
     _attr_supported_features = NotifyEntityFeature.TITLE
 
-    def __init__(
-        self,
-        config_entry: NtfyConfigEntry,
-        subentry: ConfigSubentry,
-    ) -> None:
-        """Initialize a notification entity."""
-
-        self._attr_unique_id = f"{config_entry.entry_id}_{subentry.subentry_id}_{self.entity_description.key}"
-        self.topic = subentry.data[CONF_TOPIC]
-
-        self._attr_device_info = DeviceInfo(
-            entry_type=DeviceEntryType.SERVICE,
-            manufacturer="ntfy LLC",
-            model="ntfy",
-            name=subentry.data.get(CONF_NAME, self.topic),
-            configuration_url=URL(config_entry.data[CONF_URL]) / self.topic,
-            identifiers={(DOMAIN, f"{config_entry.entry_id}_{subentry.subentry_id}")},
-            via_device=(DOMAIN, config_entry.entry_id),
-        )
-        self.config_entry = config_entry
-        self.ntfy = config_entry.runtime_data.ntfy
-
     async def async_send_message(self, message: str, title: str | None = None) -> None:
         """Publish a message to a topic."""
-        msg = Message(topic=self.topic, message=message, title=title)
+        await self.publish(message=message, title=title)
+
+    async def publish(self, **kwargs: Any) -> None:
+        """Publish a message to a topic."""
+
+        params: dict[str, Any] = kwargs
+        delay: timedelta | None = params.get("delay")
+        if delay:
+            params["delay"] = f"{delay.total_seconds()}s"
+            if params.get("email"):
+                raise ServiceValidationError(
+                    translation_domain=DOMAIN,
+                    translation_key="delay_no_email",
+                )
+            if params.get("call"):
+                raise ServiceValidationError(
+                    translation_domain=DOMAIN,
+                    translation_key="delay_no_call",
+                )
+
+        msg = Message(topic=self.topic, **params)
         try:
             await self.ntfy.publish(msg)
         except NtfyUnauthorizedAuthenticationError as e:

homeassistant/components/ntfy/quality_scale.yaml

@@ -7,21 +7,15 @@ rules:
     status: exempt
     comment: the integration does not poll
   brands: done
-  common-modules:
-    status: exempt
-    comment: the integration currently implements only one platform and has no coordinator
+  common-modules: done
   config-flow-test-coverage: done
   config-flow: done
   dependency-transparency: done
-  docs-actions:
-    status: exempt
-    comment: integration has only entity actions
+  docs-actions: done
   docs-high-level-description: done
   docs-installation-instructions: done
   docs-removal-instructions: done
-  entity-event-setup:
-    status: exempt
-    comment: the integration does not subscribe to events
+  entity-event-setup: done
   entity-unique-id: done
   has-entity-name: done
   runtime-data: done
@@ -36,13 +30,9 @@ rules:
     status: exempt
     comment: the integration has no options
   docs-installation-parameters: done
-  entity-unavailable:
-    status: exempt
-    comment: the integration only implements a stateless notify entity.
+  entity-unavailable: done
   integration-owner: done
-  log-when-unavailable:
-    status: exempt
-    comment: the integration only integrates state-less entities
+  log-when-unavailable: done
   parallel-updates: done
   reauthentication-flow: done
   test-coverage: done
@@ -73,9 +63,7 @@ rules:
   exception-translations: done
   icon-translations: done
   reconfiguration-flow: done
-  repair-issues:
-    status: exempt
-    comment: the integration has no repairs
+  repair-issues: done
   stale-devices:
     status: exempt
     comment: only one device per entry, is deleted with the entry.

homeassistant/components/ntfy/repairs.py

@@ -0,0 +1,56 @@
+"""Repairs for ntfy integration."""
+
+from __future__ import annotations
+
+import voluptuous as vol
+
+from homeassistant import data_entry_flow
+from homeassistant.components.repairs import ConfirmRepairFlow, RepairsFlow
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers import entity_registry as er
+
+from .const import CONF_TOPIC
+
+
+class TopicProtectedRepairFlow(RepairsFlow):
+    """Handler for protected topic issue fixing flow."""
+
+    def __init__(self, data: dict[str, str]) -> None:
+        """Initialize."""
+        self.entity_id = data["entity_id"]
+        self.topic = data["topic"]
+
+    async def async_step_init(
+        self, user_input: dict[str, str] | None = None
+    ) -> data_entry_flow.FlowResult:
+        """Init repair flow."""
+
+        return await self.async_step_confirm()
+
+    async def async_step_confirm(
+        self, user_input: dict[str, str] | None = None
+    ) -> data_entry_flow.FlowResult:
+        """Confirm repair flow."""
+        if user_input is not None:
+            er.async_get(self.hass).async_update_entity(
+                self.entity_id,
+                disabled_by=er.RegistryEntryDisabler.USER,
+            )
+            return self.async_create_entry(data={})
+
+        return self.async_show_form(
+            step_id="confirm",
+            data_schema=vol.Schema({}),
+            description_placeholders={CONF_TOPIC: self.topic},
+        )
+
+
+async def async_create_fix_flow(
+    hass: HomeAssistant,
+    issue_id: str,
+    data: dict[str, str],
+) -> RepairsFlow:
+    """Create flow."""
+    if issue_id.startswith("topic_protected"):
+        return TopicProtectedRepairFlow(data)
+    return ConfirmRepairFlow()

homeassistant/components/ntfy/services.yaml

@@ -0,0 +1,90 @@
+publish:
+  target:
+    entity:
+      domain: notify
+      integration: ntfy
+  fields:
+    title:
+      required: false
+      selector:
+        text:
+      example: Hello
+    message:
+      required: false
+      selector:
+        text:
+          multiline: true
+      example: World
+    markdown:
+      required: false
+      selector:
+        constant:
+          value: true
+          label: ""
+      example: true
+    tags:
+      required: false
+      selector:
+        text:
+          multiple: true
+      example: '["partying_face", "grin"]'
+    priority:
+      required: false
+      selector:
+        select:
+          options:
+            - value: "5"
+              label: "max"
+            - value: "4"
+              label: "high"
+            - value: "3"
+              label: "default"
+            - value: "2"
+              label: "low"
+            - value: "1"
+              label: "min"
+          mode: dropdown
+          translation_key: "priority"
+          sort: false
+      example: "5"
+    click:
+      required: false
+      selector:
+        text:
+          type: url
+          autocomplete: url
+      example: https://example.org
+    delay:
+      required: false
+      selector:
+        duration:
+          enable_day: true
+      example: '{"seconds": 30}'
+    attach:
+      required: false
+      selector:
+        text:
+          type: url
+          autocomplete: url
+      example: https://example.org/download.zip
+    email:
+      required: false
+      selector:
+        text:
+          type: email
+          autocomplete: email
+      example: mail@example.org
+    call:
+      required: false
+      selector:
+        text:
+          type: tel
+          autocomplete: tel
+      example: "1234567890"
+    icon:
+      required: false
+      selector:
+        text:
+          type: url
+          autocomplete: url
+      example: https://example.org/logo.png

homeassistant/components/ntfy/strings.json

@@ -102,6 +102,40 @@
           "data_description": {
             "topic": "Enter the name of the topic you want to use for notifications. Topics may not be password-protected, so choose a name that's not easy to guess.",
             "name": "Set an alternative name to display instead of the topic name. This helps identify topics with complex or hard-to-read names more easily."
+          },
+          "sections": {
+            "filter": {
+              "data": {
+                "filter_priority": "Filter by priority",
+                "filter_tags": "Filter by tags",
+                "filter_title": "Filter by title",
+                "filter_message": "Filter by message content"
+              },
+              "data_description": {
+                "filter_priority": "Include messages that match any of the selected priority levels. If no priority is selected, all messages are included by default",
+                "filter_tags": "Only include messages that have all selected tags",
+                "filter_title": "Include messages with a title that exactly matches the specified text",
+                "filter_message": "Include messages with content that exactly matches the specified text"
+              },
+              "name": "Message filters (optional)",
+              "description": "Apply filters to narrow down the messages received when Home Assistant subscribes to the topic. Filters apply only to the event entity."
+            }
+          }
+        },
+        "reconfigure": {
+          "title": "Message filters for {topic}",
+          "description": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::description%]",
+          "data": {
+            "filter_priority": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data::filter_priority%]",
+            "filter_tags": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data::filter_tags%]",
+            "filter_title": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data::filter_title%]",
+            "filter_message": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data::filter_message%]"
+          },
+          "data_description": {
+            "filter_priority": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data_description::filter_priority%]",
+            "filter_tags": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data_description::filter_tags%]",
+            "filter_title": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data_description::filter_title%]",
+            "filter_message": "[%key:component::ntfy::config_subentries::topic::step::add_topic::sections::filter::data_description::filter_message%]"
           }
         }
       },
@@ -116,11 +150,34 @@
         "invalid_topic": "Invalid topic. Only letters, numbers, underscores, or dashes allowed."
       },
       "abort": {
-        "already_configured": "Topic is already configured"
+        "already_configured": "Topic is already configured",
+        "reconfigure_successful": "[%key:common::config_flow::abort::reconfigure_successful%]"
       }
     }
   },
   "entity": {
+    "event": {
+      "subscribe": {
+        "state_attributes": {
+          "event_type": {
+            "state": {
+              "triggered": "Triggered"
+            }
+          },
+          "time": { "name": "Time" },
+          "expires": { "name": "Expires" },
+          "topic": { "name": "[%key:component::ntfy::common::topic%]" },
+          "message": { "name": "Message" },
+          "title": { "name": "Title" },
+          "tags": { "name": "Tags" },
+          "priority": { "name": "Priority" },
+          "click": { "name": "Click" },
+          "icon": { "name": "Icon" },
+          "actions": { "name": "Actions" },
+          "attachment": { "name": "Attachment" }
+        }
+      }
+    },
     "sensor": {
       "messages": {
         "name": "Messages published",
@@ -221,6 +278,94 @@
     },
     "timeout_error": {
       "message": "Failed to connect to ntfy service due to a connection timeout"
+    },
+    "entity_not_found": {
+      "message": "The selected ntfy entity could not be found."
+    },
+    "entry_not_loaded": {
+      "message": "The selected ntfy service is currently not loaded or disabled in Home Assistant."
+    },
+    "delay_no_email": {
+      "message": "Delayed email notifications are not supported"
+    },
+    "delay_no_call": {
+      "message": "Delayed call notifications are not supported"
+    }
+  },
+  "services": {
+    "publish": {
+      "name": "Publish notification",
+      "description": "Publishes a notification message to a ntfy topic",
+      "fields": {
+        "title": {
+          "name": "[%key:component::notify::services::send_message::fields::title::name%]",
+          "description": "[%key:component::notify::services::send_message::fields::title::description%]"
+        },
+        "message": {
+          "name": "[%key:component::notify::services::send_message::fields::message::name%]",
+          "description": "[%key:component::notify::services::send_message::fields::message::description%]"
+        },
+        "markdown": {
+          "name": "Format as Markdown",
+          "description": "Enable Markdown formatting for the message body (Web app only). See the Markdown guide for syntax details: https://www.markdownguide.org/basic-syntax/."
+        },
+        "tags": {
+          "name": "Tags/Emojis",
+          "description": "Add tags or emojis to the notification. Emojis (using shortcodes like smile) will appear in the notification title or message. Other tags will be displayed below the notification content."
+        },
+        "priority": {
+          "name": "Message priority",
+          "description": "All messages have a priority that defines how urgently your phone notifies you, depending on the configured vibration patterns, notification sounds, and visibility in the notification drawer or pop-over."
+        },
+        "click": {
+          "name": "Click URL",
+          "description": "URL that is opened when notification is clicked."
+        },
+        "delay": {
+          "name": "Delay delivery",
+          "description": "Set a delay for message delivery. Minimum delay is 10 seconds, maximum is 3 days."
+        },
+        "attach": {
+          "name": "Attachment URL",
+          "description": "Attach images or other files by URL."
+        },
+        "email": {
+          "name": "Forward to email",
+          "description": "Specify the address to forward the notification to, for example mail@example.com"
+        },
+        "call": {
+          "name": "Phone call",
+          "description": "Phone number to call and read the message out loud using text-to-speech. Requires ntfy Pro and prior phone number verification."
+        },
+        "icon": {
+          "name": "Icon URL",
+          "description": "Include an icon that will appear next to the text of the notification. Only JPEG and PNG images are supported."
+        }
+      }
+    }
+  },
+  "selector": {
+    "priority": {
+      "options": {
+        "1": "Minimum",
+        "2": "[%key:common::state::low%]",
+        "3": "Default",
+        "4": "[%key:common::state::high%]",
+        "5": "Maximum"
+      }
+    }
+  },
+  "issues": {
+    "topic_protected": {
+      "title": "Subscription failed: Topic {topic} is protected",
+      "fix_flow": {
+        "step": {
+          "confirm": {
+            "title": "Topic {topic} is protected",
+            "description": "The topic **{topic}** is protected and requires authentication to subscribe.\n\nTo resolve this issue, you have two options:\n\n1. **Reconfigure the ntfy integration**\nAdd a username and password that has permission to access this topic.\n\n2. **Deactivate the event entity**\nThis will stop Home Assistant from subscribing to the topic.\nClick **Submit** to deactivate the entity."
+          }
+        }
+      }
     }
   }
 }

homeassistant/components/ntfy/translations/bg.json

@@ -57,7 +57,8 @@
     "config_subentries": {
         "topic": {
             "abort": {
-                "already_configured": "\u0422\u0435\u043c\u0430\u0442\u0430 \u0432\u0435\u0447\u0435 \u0435 \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0438\u0440\u0430\u043d\u0430"
+                "already_configured": "\u0422\u0435\u043c\u0430\u0442\u0430 \u0432\u0435\u0447\u0435 \u0435 \u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0438\u0440\u0430\u043d\u0430",
+                "reconfigure_successful": "\u041f\u0440\u0435\u043a\u043e\u043d\u0444\u0438\u0433\u0443\u0440\u0438\u0440\u0430\u043d\u0435\u0442\u043e \u0431\u0435\u0448\u0435 \u0443\u0441\u043f\u0435\u0448\u043d\u043e"
             },
             "entry_type": "\u0422\u0435\u043c\u0430",
             "error": {
@@ -88,6 +89,36 @@
         }
     },
     "entity": {
+        "event": {
+            "subscribe": {
+                "state_attributes": {
+                    "actions": {
+                        "name": "\u0414\u0435\u0439\u0441\u0442\u0432\u0438\u044f"
+                    },
+                    "attachment": {
+                        "name": "\u041f\u0440\u0438\u043b\u043e\u0436\u0435\u043d\u0438\u0435"
+                    },
+                    "icon": {
+                        "name": "\u0418\u043a\u043e\u043d\u0430"
+                    },
+                    "message": {
+                        "name": "\u0421\u044a\u043e\u0431\u0449\u0435\u043d\u0438\u0435"
+                    },
+                    "priority": {
+                        "name": "\u041f\u0440\u0438\u043e\u0440\u0438\u0442\u0435\u0442"
+                    },
+                    "time": {
+                        "name": "\u0412\u0440\u0435\u043c\u0435"
+                    },
+                    "title": {
+                        "name": "\u0417\u0430\u0433\u043b\u0430\u0432\u0438\u0435"
+                    },
+                    "topic": {
+                        "name": "\u0422\u0435\u043c\u0430"
+                    }
+                }
+            }
+        },
         "sensor": {
             "calls": {
                 "unit_of_measurement": "\u043e\u0431\u0430\u0436\u0434\u0430\u043d\u0438\u044f"
@@ -122,5 +153,25 @@
         "publish_failed_request_error": {
             "message": "\u041d\u0435\u0443\u0441\u043f\u0435\u0448\u043d\u043e \u043f\u0443\u0431\u043b\u0438\u043a\u0443\u0432\u0430\u043d\u0435 \u043d\u0430 \u0438\u0437\u0432\u0435\u0441\u0442\u0438\u0435\u0442\u043e: {error_msg}"
         }
+    },
+    "services": {
+        "publish": {
+            "fields": {
+                "call": {
+                    "name": "\u0422\u0435\u043b\u0435\u0444\u043e\u043d\u043d\u043e \u043e\u0431\u0430\u0436\u0434\u0430\u043d\u0435"
+                },
+                "message": {
+                    "description": "\u0412\u0430\u0448\u0435\u0442\u043e \u0441\u044a\u043e\u0431\u0449\u0435\u043d\u0438\u0435 \u0437\u0430 \u0438\u0437\u0432\u0435\u0441\u0442\u0438\u0435.",
+                    "name": "\u0421\u044a\u043e\u0431\u0449\u0435\u043d\u0438\u0435"
+                },
+                "priority": {
+                    "name": "\u041f\u0440\u0438\u043e\u0440\u0438\u0442\u0435\u0442 \u043d\u0430 \u0441\u044a\u043e\u0431\u0449\u0435\u043d\u0438\u0435\u0442\u043e"
+                },
+                "title": {
+                    "description": "\u0417\u0430\u0433\u043b\u0430\u0432\u0438\u0435 \u0437\u0430 \u0432\u0430\u0448\u0435\u0442\u043e \u0441\u044a\u043e\u0431\u0449\u0435\u043d\u0438\u0435 \u0437\u0430 \u0438\u0437\u0432\u0435\u0441\u0442\u0438\u0435.",
+                    "name": "\u0417\u0430\u0433\u043b\u0430\u0432\u0438\u0435"
+                }
+            }
+        }
     }
 }

homeassistant/components/ntfy/translations/ca.json

@@ -47,10 +47,35 @@
     },
     "config_subentries": {
         "topic": {
+            "abort": {
+                "reconfigure_successful": "Reconfiguraci\u00f3 realitzada correctament"
+            },
             "error": {
                 "cannot_connect": "Ha fallat la connexi\u00f3",
                 "unknown": "Error inesperat"
             }
         }
+    },
+    "selector": {
+        "priority": {
+            "options": {
+                "2": "Baix/a",
+                "4": "Alt/a"
+            }
+        }
+    },
+    "services": {
+        "publish": {
+            "fields": {
+                "message": {
+                    "description": "El missatge de notificaci\u00f3.",
+                    "name": "Missatge"
+                },
+                "title": {
+                    "description": "T\u00edtol del missatge de notificaci\u00f3.",
+                    "name": "T\u00edtol"
+                }
+            }
+        }
     }
 }