mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-30 16:27:37 +00:00
5c852edbde
* More various fixed - letter b Adds titles (and make other linkable) Improved indentation Reorder configuration keys Remove empty lines and trailing spaces * No idea why this happened * String can't start with *
83 lines
2.4 KiB
Markdown
83 lines
2.4 KiB
Markdown
---
|
|
layout: page
|
|
title: NX584 zones
|
|
description: "Instructions on how to set up nx584 zones as sensors"
|
|
date: 2016-02-18 20:47
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: networx.png
|
|
ha_category: Binary Sensor
|
|
ha_iot_class: "Local Push"
|
|
ha_release: 0.14
|
|
---
|
|
|
|
The `nx584` platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](http://github.com/kk7ds/pynx584) which is required for this to work.
|
|
|
|
Enabling this sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger.
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
To enable this feature, add the following lines to your `configuration.yaml`:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
binary_sensor:
|
|
platform: nx584
|
|
```
|
|
|
|
{% configuration %}
|
|
host:
|
|
description: This is the host where the nx584 server process is running. If unset, it is assumed to be `localhost`, which will work if the server process is running on the same system as Home Assistant.
|
|
required: false
|
|
type: string
|
|
default: localhost
|
|
port:
|
|
description: The port where the server process is running.
|
|
required: false
|
|
type: integer
|
|
default: 5007
|
|
exclude_zones:
|
|
description: This is a list of zone numbers that should be excluded. Use this to avoid exposing a zone that is of no interest, unconnected, etc.
|
|
required: false
|
|
type: [list, integer]
|
|
zone_types:
|
|
description: This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. See the list of available zone types relevant to alarm zones below.
|
|
required: false
|
|
type: map
|
|
keys:
|
|
opening:
|
|
description: Opening
|
|
motion:
|
|
description: Motion
|
|
gas:
|
|
description: Gas
|
|
smoke:
|
|
description: Smoke
|
|
moisture:
|
|
description: Moisture
|
|
safety:
|
|
description: Safety
|
|
{% endconfiguration %}
|
|
|
|
## {% linkable_title Full example %}
|
|
|
|
An extended configuration entry could look like this:
|
|
|
|
```yaml
|
|
# Full example configuration.yaml entry
|
|
binary_sensor:
|
|
platform: nx584
|
|
host: 192.168.1.10
|
|
port: 5007
|
|
exclude_zones:
|
|
- 3
|
|
- 5
|
|
zone_types:
|
|
1: opening
|
|
2: opening
|
|
4: motion
|
|
6: moisture
|
|
```
|