From b388d8718168245e79b9921182f66a2152e2537f Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 20 Feb 2016 00:11:07 +0100 Subject: [PATCH] Add command line notify docs --- .../_components/notify.command_line.markdown | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 source/_components/notify.command_line.markdown diff --git a/source/_components/notify.command_line.markdown b/source/_components/notify.command_line.markdown new file mode 100644 index 00000000000..c31be1081ed --- /dev/null +++ b/source/_components/notify.command_line.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Command line" +description: "Instructions how to add command line notifications to Home Assistant." +date: 2016-02-22 20:00 +sidebar: true +comments: false +sharing: true +footer: true +ha_category: Notifications +--- + + +The `command_line` platform allows you to use external tools for notifications from Home Assistant. + +To enable those notifications in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +notify: + name: NOTIFIER_NAME + platform: command_line + command: "espeak -vmb/mb-us1" +``` + +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`. +- **command** (*Required*): The action to take. + +To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation/). +