Home Assistant Home Assistant

NX584

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.

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

Alarm Control Panel

To enable this, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
alarm_control_panel:
  - platform: nx584

Configuration Variables

Looking for your configuration file?
host string (Optional, default: localhost)

The host where the nx584 server process is running.

name string (Optional, default: NX584)

This parameter allows you to override the name.

port integer (Optional, default: 5007)

The port where the Alarm panel is listening.

Binary Sensor

Enabling this binary 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 Variables

Looking for your configuration file?
host string (Optional, default: localhost)

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.

port integer (Optional, default: 5007)

The port where the server process is running.

exclude_zones list | integer (Optional)

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.

zone_types list (Optional)

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.

opening

Opening

motion

Motion

gas

Gas

smoke

Smoke

moisture

Moisture

safety

Safety

Full example

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

Services

Service bypass_zone

This service will bypass a given zone.

Service data attribute Optional Description
entity_id yes entity_id of the NX584 Alarm.
zone no Zone number you want to bypass.

Service unbypass_zone

This service will unbypass a given zone.

Service data attribute Optional Description
entity_id yes entity_id of the NX584 Alarm.
zone no Zone number you want to unbypass.