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
This commit is contained in:
Klaas Schoute 2018-10-11 20:46:58 +02:00 committed by Franck Nijhof
parent 6cc2e8189e
commit 4f7c62b21f
2 changed files with 50 additions and 11 deletions

View File

@ -22,8 +22,20 @@ alarm_control_panel:
- platform: nx584
```
Configuration variables:
- **host** (*Optional*): The host where the nx584 server process is running. Defaults to `localhost`.
- **port** (*Optional*): The port where the Alarm panel is listening. Defaults to `5007`.
{% configuration %}
host:
description: The host where the nx584 server process is running.
required: false
default: localhost
type: string
name:
description: This parameter allows you to override the name.
required: false
default: NX584
type: string
port:
description: The port where the Alarm panel is listening.
required: false
default: 5007
type: integer
{% endconfiguration %}

View File

@ -25,12 +25,39 @@ binary_sensor:
platform: nx584
```
Configuration variables:
- **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.
- **port** (*Optional*): The port where the server process is running. Defaults to `5007`.
- **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.
- **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`.
{% 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: