Lannouncer

source/_components/notify.lannouncer.markdown

@@ -0,0 +1,80 @@
+---
+layout: page
+title: "Lannouncer"
+description: "Instructions how to add Lannouncer notifications to Home Assistant."
+date: 2017-01-06 10:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: lannouncer.png
+ha_category: Notifications
+ha_release: 0.36
+---
+
+
+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 usefull 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.
+
+To enable Lannouncer notifications in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+notify:
+  - name: NOTIFIER_NAME
+    platform: lannouncer
+    host: HOSTNAME_OR_IP
+```
+
+Configuration variables:
+
+- **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`.
+- **host** (*Required*): The hostname or IP-address of the Android device that is running Lannouncer.
+- **port** (*Optional*): The port on which Lannouncer is running. By default this is `1035`.
+
+### {% linkable_title Installation %}
+
+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.
+
+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.
+
+More information can be found [here](http://www.keybounce.com/lannouncer/configuring-lannouncer/).
+
+### {% linkable_title Sending messages %}
+
+Lannouncer supports two types of messages.
+
+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.
+
+```json
+{
+  "message": "I'm sorry, I cannot do that Dave."
+}
+```
+
+The second method is to play notifications (`alarm`). There are 4 build-in sounds (`chime`, `doorbell`, `alarm` and `siren`).
+
+```json
+{
+  "message": "chime",
+  "data": {
+    "method": "alarm"
+  }
+}
+```
+
+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.
+
+```json
+{
+  "message": "FILE1",
+  "data": {
+    "method": "alarm"
+  }
+}
+```
+
+<p class='note info'>
+  The free version only supports one additional soundfile. 
+</p>
+
+To use notifications, please see the [getting started with automation page](/getting-started/automation/).