1.5 KiB
| title | sidebar_label |
|---|---|
| Notify entity | Notify |
A notify entity is an entity that can send a message towards a device or service but remains stateless from the Home Assistant perspective.
A notify entity is derived from the homeassistant.components.notify.NotifyEntity,
and can be helpful to send notification messages as (but not limited to):
- an SMS
- an email
- a direct message or chat
- a screen message on a device's LCD display
States
The state of a notify entity is a timestamp, representing the date and time of the last message sent.
Unlike a text entity, the notify entity has no state that can be set.
If you want to represent something that has a text value that can be changed (and thus has an actual state), you should use a text entity instead.
Properties
As this integration is stateless, it doesn't provide any specific properties for itself.
Other properties that are common to all entities such as icon and name etc are still applicable.
Methods
Send message
The send message method is used to send a message to a device or service.
class MyNotifier(NotifyEntity):
# Implement one of these methods.
def send_message(self, message: str, title: str | None = None) -> None:
"""Send a message."""
async def async_send_message(self, message: str, title: str | None = None) -> None:
"""Send a message."""