Add docs for upcoming SimpliSafe component (#6543)

* Add docs for upcoming SimpliSafe component

* Bumped HASS version
This commit is contained in:
Aaron Bach 2018-10-13 09:18:40 -06:00 committed by Franck Nijhof
parent f495cd1dc7
commit 755fdf54f4
2 changed files with 46 additions and 28 deletions

View File

@ -12,33 +12,10 @@ ha_release: 0.24
ha_category: Alarm
---
The `simplisafe` platform enables the ability to control a [SimpliSafe](http://simplisafe.com/) control panel.
The `simplisafe` alarm control panel platform gives users the ability to
control a SimpliSafe home alarm system.
To enable this, add the following lines to your `configuration.yaml`:
You must have the [`simplisafe` component](/components/simplisafe/) configured
to use this platform. After configuring that component, any alarm control
panels defined will automatically appear.
```yaml
# Example configuration.yaml entry
alarm_control_panel:
platform: simplisafe
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
username:
description: Username for the SimpliSafe account.
required: true
type: string
password:
description: Password for SimpliSafe account.
required: true
type: string
name:
description: The name of the alarm. Default is the SimpliSafe alarm id.
required: false
type: string
code:
description: Specifies a code to enable or disable the alarm in the frontend.
required: false
type: string
{% endconfiguration %}

View File

@ -0,0 +1,41 @@
---
layout: page
title: "SimpliSafe"
description: "Instructions on how to integrate SimpliSafe into Home Assistant."
date: 2018-10-05 14:00
sidebar: true
comments: false
sharing: true
footer: true
logo: simplisafe.png
ha_release: 0.81
ha_category: Alarm
---
The `simplisafe` component integrates SimpliSafe home security (V2 and V3)
systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated.
To enable this component, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
simplisafe:
accounts:
- username: user@email.com
password: password123
```
{% configuration %}
username:
description: The email address of a SimpliSafe account.
required: true
type: string
password:
description: The password of a SimpliSafe account.
required: true
type: string
code:
description: A code to enable or disable the alarm in the frontend.
required: false
type: string
{% endconfiguration %}