home-assistant.io/source/_components/binary_sensor.nx584.markdown
Klaas Schoute 4f7c62b21f Update NX584 component configuration variable (#6684)
* Update NX584 component configuration variable

Update style of NX584 component documentation to follow new configuration variables description.
Related to #6385.

* ✏️ Tweak

* ✏️ Typo
2018-10-11 20:46:58 +02:00

2.3 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_iot_class, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_iot_class ha_release
page NX584 zones Instructions on how to set up nx584 zones as sensors 2016-02-18 20:47 true false true true networx.png Binary Sensor Local Push 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 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.

To enable this feature, add the following lines to your configuration.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 default: localhost type: string port: description: The port where the server process is running. required: false default: 5007 type: integer 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 %}

An extended configuration entry could look like this:

# 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