Skip to content

Notification Component

Alan Tse edited this page Mar 12, 2019 · 19 revisions

Notification Component

Minimum Version: 1.2.0

The notify component deprecates media_player.alexa_tts and conforms to Home Assistant notifications.

Configuration

notify:
  - platform: alexa_media
    name: alexa_media

Functionality

The component supports three types of notifications as supported by the Alexa App:

  1. TTS - This is the older media_player.alexa_tts functionality. Alexa will speak using Alexa's Simon says and will not be synced by devices. This did not work when specifying an Alexa Whole House Audio group (WHA). Speech will not sync between devices.
  2. Announce - This functionality will result in a beep prior to speaking. It can also allow display on Echo Shows/Spots (currently untested). Speech will sync across multiple devices.
  3. Mobile Push - This will send a Mobile Push to any Alexa Apps linked to the target Alexa device.

How to Use

Use the notify.alexa_media service.

The following args are supported in the Service Data:

  • message - The message to send.
  • title - The title to display. Only works for Announce and Mobile Push.
  • data:type - The type of notification. [tts, announce, push]
  • data:method - For Announce, whether the announcement should be spoken, displayed, or both. [speak, show, all]
  • target - The target Alexa devices. This can be the Friendly Name, Serial Number, entity_id, or Home Assistant Group. Warning: Mobile Push using groups will result in a push from every Echo device to every Alexa App.

TTS

{
"message":"test",
"data":{"type":"tts"},
"target":["group.alexa", "Guest Room", "media_player.kitchen", "serialNumber"]
}

Announce

{
"message":"test",
"title":"Push test 1",
"data":{"type":"tts", "method":"all"},
"target":["Guest Room", "media_player.kitchen", "serialNumber"]
}

Mobile Push

{
"message":"test",
"title":"My title",
"data":{"type":"tts"},
"target":["Guest Room", "media_player.kitchen", "serialNumber"]
}