linkztream ae2509e233 Fixed ws-url and needed steps. (#11717)
* Fixed ws-url and needed steps.

Modified the ws-url to reflect the documentation from SPC-GATEWAY manual and added the two needed changes to customize.yaml + configuration.yaml to make the sensors produce usable output.

* Removed hidden sensors text

After changes made to the integration, sensors are no longer hidden and that text became obsolete. Removed to avoid confusion.
2020-01-13 11:09:03 +01:00

2.3 KiB

title, description, ha_category, ha_release, logo, ha_iot_class
title description ha_category ha_release logo ha_iot_class
Vanderbilt SPC Instructions on how to setup Vanderbilt SPC devices within Home Assistant.
Hub
Alarm
Binary Sensor
0.47 vanderbilt_spc.png Local Push

Home Assistant has support to integrate your Vanderbilt 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 which must be installed and configured somewhere on your network.

There is currently support for the following device types within Home Assistant:

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:

# Example configuration.yaml entry
spc:
  api_url: API_URL
  ws_url: WS_URL

{% configuration %} api_url: description: URL of the SPC Web Gateway command REST API, e.g., http://<ip>:8088. required: true type: string ws_url: description: URL of the SPC Web Gateway websocket, e.g., ws://<ip>:8088/ws/spc. required: true type: string {% endconfiguration %}

Alarm

The spc alarm control panel platform allows you to control your Vanderbilt SPC alarms.

The changed_by attribute enables one to be able to take different actions depending on who armed/disarmed the alarm in automation.

automation:
  - alias: Alarm status changed
    trigger:
      - platform: state
        entity_id: alarm_control_panel.alarm_1
    action:
      - service: notify.notify
        data_template:
          message: >
            {% raw %}Alarm changed from {{ trigger.from_state.state }}
            to {{ trigger.to_state.state }}
            by {{ trigger.to_state.attributes.changed_by }}{% endraw %}

Binary Sensor

The spc platform allows you to get data from your Vanderbilt SPC binary sensors from within Home Assistant.

Check the type/class list for a possible visualization of your zone. Currently motion, smoke and door sensors are supported.