From 2ab796979ac3d1adef650971533ecbb08e9ee887 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 21 Aug 2017 15:28:55 +0200 Subject: [PATCH] Add description of configuration variables --- source/_components/notify.ciscospark.markdown | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/source/_components/notify.ciscospark.markdown b/source/_components/notify.ciscospark.markdown index 21ef7eec806..6892b4192e0 100644 --- a/source/_components/notify.ciscospark.markdown +++ b/source/_components/notify.ciscospark.markdown @@ -12,25 +12,28 @@ ha_category: Notifications ha_release: "0.40" --- -The `Cisco Spark` platform allows you to deliver notifications from Home Assistant to [Cisco Spark](https://ciscospark.com/). +The `ciscospark` notification platform allows you to deliver notifications from Home Assistant to [Cisco Spark](https://ciscospark.com/). To use this notification platform you need to get a developer token. To obtain a token visit [Spark for Devleopers](https://developer.ciscospark.com/index.html) -At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Devleopers](https://developer.ciscospark.com/index.html). -Just look in the Doumentation under Rooms. +At this time you also need to specify the `Cisco Spark` `roomid`. The `roomid` can also be found at [Spark for Devleopers](https://developer.ciscospark.com/index.html). Just look in the Doumentation under Rooms. -To enable the `Cisco Spark` notification in your installation, add the following to your `configuration.yaml` file: +To enable the Cisco Spark notification in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry notify: - name: NOTIFIER_NAME platform: ciscospark - token: - roomid: + token: YOUR_DEVELOPER_TOKEN + roomid: CISCO_SPARK_ROOMID ``` +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`. +- **token** (*Required*): Your development token. +- **roomid** (*Required*): The Room ID. To use notifications, please see the [getting started with automation page](/getting-started/automation/).