You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/binary_sensor.nx584.markdown
+12-20Lines changed: 12 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -17,30 +17,14 @@ The `nx584` platform provides integration with GE, Caddx, Interlogix (and other
17
17
18
18
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.
19
19
20
-
To enable this, add the following lines to your `configuration.yaml`:
20
+
To enable this feature, add the following lines to your `configuration.yaml`:
21
21
22
22
```yaml
23
+
# Example configuration.yaml entry
23
24
binary_sensor:
24
25
platform: nx584
25
-
host: ADDRESS
26
-
exclude_zones:
27
-
- ZONE ...
28
-
zone_types:
29
-
ZONE: TYPE
30
-
```
31
-
32
-
Configuration variables:
33
-
34
-
- **host** (*Optional*): This is the host connection string (host:port) for the nx584 server process. If unset, it is assumed to be `localhost:5007`, which will work if the server process is running on the same system as home-assistant.
35
-
- **exclude_zones** (*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.
36
-
- **zone_types** (*Optional*): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: `opening`, `motion`, `gas`, `smoke`, `moisture`, `safety`.
37
-
38
-
Example configuration:
39
-
40
-
```yaml
41
-
binary_sensor:
42
-
platform: nx584
43
-
host: 192.168.1.10:5007
26
+
host: 192.168.1.10
27
+
pport: 5007
44
28
exclude_zones:
45
29
- 3
46
30
- 5
@@ -50,3 +34,11 @@ binary_sensor:
50
34
4: motion
51
35
6: moisture
52
36
```
37
+
38
+
Configuration variables:
39
+
40
+
- **host** (*Optional*): 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.
41
+
- **port** (*Optional*): The port where the server process is running. Defaults to `5007`.
42
+
- **exclude_zones** (*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.
43
+
- **zone_types** (*Optional*): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: `opening`, `motion`, `gas`, `smoke`, `moisture`, `safety`.
0 commit comments