Franck Nijhof 298bdbaeab
Add remark linter for prohibited strings (#28126)
* Add remark linter for prohibited strings

* Formated .remarkrc with prettier
2023-07-07 13:38:35 +02:00

79 lines
2.6 KiB
Markdown

---
title: Vanderbilt SPC
description: Instructions on how to setup Vanderbilt SPC devices within Home Assistant.
ha_category:
- Alarm
- Binary Sensor
- Hub
ha_release: 0.47
ha_iot_class: Local Push
ha_domain: spc
ha_platforms:
- alarm_control_panel
- binary_sensor
ha_integration_type: integration
---
Home Assistant has support to integrate your [Vanderbilt SPC](https://www.spcsupportinfo.com/SPCConnectPro/) alarm panel and any connected motion, door, smoke and technical sensors.
Integration with SPC is done through a third-party API gateway called [SPC Web Gateway](https://www.lundix.se/smarta-losningar/) which must be installed and configured somewhere on your network.
There is currently support for the following device types within Home Assistant:
- [Alarm](#alarm)
- [Binary Sensor](#binary-sensor)
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 %}
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](https://www.spcsupportinfo.com/SPCConnectPro/) alarms.
The `changed_by` attribute enables one to be able to take different actions depending on who armed/disarmed the alarm in [automation](/getting-started/automation/).
{% raw %}
```yaml
automation:
- alias: "Alarm status changed"
trigger:
- platform: state
entity_id: alarm_control_panel.alarm_1
action:
- service: notify.notify
data:
message: >
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](https://www.spcsupportinfo.com/SPCConnectPro/) binary sensors from within Home Assistant.
Check the [type/class](/integrations/binary_sensor/) list for a possible visualization of your zone. Currently motion, smoke, door and technical sensors are supported.
Hint: In SPC, Technical zones can be used to track (for example) the status of an output. Virtual zones are supported in SPC firmware from 3.11. You can set up a virtual zone as technical, and link it to a mapping key that is controlling an output.