jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-08 01:46:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add description of configuration variables

Browse Source
This commit is contained in:
Fabian Affolter 2017-08-21 15:28:55 +02:00
parent 350a062ca9
commit 2ab796979a
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/_components/notify.ciscospark.markdown
View File

@ -12,25 +12,28 @@ ha_category: Notifications
ha_release: "0.40" 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) 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). 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.
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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
notify: notify:
- name: NOTIFIER_NAME - name: NOTIFIER_NAME
platform: ciscospark platform: ciscospark
token: <YOUR_DEVELOPER_TOKEN> token: YOUR_DEVELOPER_TOKEN
roomid: <CISCO_SPARK_ROOMID> 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/). To use notifications, please see the [getting started with automation page](/getting-started/automation/).