Add docs for Vanderbilt SPC hub/sensor/alarm. (#2666)

This commit is contained in:
Martin Berg 2017-06-16 00:03:50 +02:00 committed by Fabian Affolter
parent ca97b0ec7f
commit 388313c942
4 changed files with 74 additions and 0 deletions

View File

@ -0,0 +1,20 @@
---
layout: page
title: "Vanderbilt SPC Alarm"
description: "Instructions how to setup the Vanderbilt SPC Alarm control panel within Home Assistant."
date: 2017-05-18 22:01
sidebar: true
comments: false
sharing: true
footer: true
logo: vanderbilt_spc.png
ha_category: Alarm
ha_release: 0.45
ha_iot_class: "Local Push"
---
The `spc` alarm control panel platform allows you to control your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) alarms.
The requirement is that you have setup your [SPC hub](/components/spc/).

View File

@ -0,0 +1,20 @@
---
layout: page
title: "SPC Binary Sensor"
description: "Instructions how to integrate Vanderbilt SPC binary sensors into Home Assistant."
date: 2017-05-18 22:05
sidebar: true
comments: false
sharing: true
footer: true
logo: vanderbilt_spc.png
ha_release: 0.45
ha_category: Binary Sensor
ha_iot_class: "Local Push"
---
The `spc` platform allows you to get data from your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) binary sensors from within Home Assistant.
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone. Currently motion, smoke and door sensors are supported.
The requirement is that you have setup your [SPC hub](/components/spc/).

View File

@ -0,0 +1,34 @@
---
layout: page
title: "SPC"
description: "Instructions how to setup Vanderbilt SPC devices within Home Assistant."
date: 2017-05-18 08:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
ha_release: 0.45
logo: vanderbilt_spc.png
---
Home Assistant has support to integrate your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) alarm panel and any connected motion, door and smoke sensors.
Integration with SPC is done through a third-party API gateway called [SPC Web Gateway](http://www.lundix.se/smarta-losningar/) which must be installed and configured somewhere on your network.
Home Assistant needs to know where to find the SPC Web Gateway API endpoints, to configure this add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
spc:
api_url: API_URL
ws_url: WS_URL
```
Configuration variables:
- **api_url** (*Required*): URL of the SPC Web Gateway command REST API, e.g. `http://<ip>:8088`.
- **ws_url** (*Required*): URL of the SPC Web Gateway websocket, e.g. `ws://<ip>:8088`.
Supported sensors will be automatically discovered and added, however they will be hidden by default.

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB