|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "Lannouncer" |
| 4 | +description: "Instructions how to add Lannouncer notifications to Home Assistant." |
| 5 | +date: 2017-01-06 10:00 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +logo: lannouncer.png |
| 11 | +ha_category: Notifications |
| 12 | +ha_release: 0.36 |
| 13 | +--- |
| 14 | + |
| 15 | + |
| 16 | +The `lannouncer` notification platform allows you to play spoken messages (TTS) or sounds on an Android device running [Lannouncer](http://www.keybounce.com/lannouncer/). This can be useful when you have a wall mounted Android tablet, or an Android device that is permanently powered and turned on and want to use that to play notifications. |
| 17 | + |
| 18 | +To enable Lannouncer notifications in your installation, add the following to your `configuration.yaml` file: |
| 19 | + |
| 20 | +```yaml |
| 21 | +# Example configuration.yaml entry |
| 22 | +notify: |
| 23 | + - name: NOTIFIER_NAME |
| 24 | + platform: lannouncer |
| 25 | + host: HOSTNAME_OR_IP |
| 26 | +``` |
| 27 | +
|
| 28 | +Configuration variables: |
| 29 | +
|
| 30 | +- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. |
| 31 | +- **host** (*Required*): The hostname or IP-address of the Android device that is running Lannouncer. |
| 32 | +- **port** (*Optional*): The port on which Lannouncer is running. By default this is `1035`. |
| 33 | + |
| 34 | +### {% linkable_title Installation %} |
| 35 | + |
| 36 | +You need to install the Lannouncer app and enable the *Network (TCP) Listener* and *Auto-Start Network Listener*. You can disable the *GCM (Google Cloud) and WAN Messaging* and *SMS Listener* since this component doesn't use them. |
| 37 | + |
| 38 | +Lannouncer uses the default Android TTS voice. You can tweak that in the Android configuration, or you can install a different TTS engine from the Play Store. You might want to raise the volume in the app settings since that depends on the actual hardware device. |
| 39 | + |
| 40 | +More information can be found [here](http://www.keybounce.com/lannouncer/configuring-lannouncer/). |
| 41 | + |
| 42 | +### {% linkable_title Sending messages %} |
| 43 | + |
| 44 | +Lannouncer supports two types of messages. |
| 45 | + |
| 46 | +Spoken messages is the default method (`speak`). You just invoke the `notify` service with the following json and the device will speak out the specified message. |
| 47 | + |
| 48 | +```json |
| 49 | +{ |
| 50 | + "message": "I'm sorry, I cannot do that Dave." |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +The second method is to play notifications (`alarm`). There are 4 build-in sounds (`chime`, `doorbell`, `alarm` and `siren`). |
| 55 | + |
| 56 | +```json |
| 57 | +{ |
| 58 | + "message": "chime", |
| 59 | + "data": { |
| 60 | + "method": "alarm" |
| 61 | + } |
| 62 | +} |
| 63 | +``` |
| 64 | + |
| 65 | +You can also request to play a configured additional soundfiles (`FILE1`, `FILE2`, `FILE3`, `FILE4` or `FILE5`). You can configure this file in the app settings. |
| 66 | + |
| 67 | +```json |
| 68 | +{ |
| 69 | + "message": "FILE1", |
| 70 | + "data": { |
| 71 | + "method": "alarm" |
| 72 | + } |
| 73 | +} |
| 74 | +``` |
| 75 | + |
| 76 | +<p class='note info'> |
| 77 | + The free version only supports one additional soundfile. |
| 78 | +</p> |
| 79 | + |
| 80 | +To use notifications, please see the [getting started with automation page](/getting-started/automation/). |
0 commit comments