home-assistant.io/source/_integrations/ness_alarm.markdown
Franck Nijhof 0c3ea85fe1
Rename Services to Actions in integrations: N (#33822)
* Rename Services to Actions in integrations: N

* Update source/_integrations/nanoleaf.markdown

* Update source/_integrations/netatmo.markdown

* Update source/_integrations/netgear_lte.markdown

* Update source/_integrations/nissan_leaf.markdown

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
2024-07-17 06:41:21 +02:00

4.2 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain, ha_platforms, ha_integration_type, related
title description ha_category ha_release ha_iot_class ha_codeowners ha_domain ha_platforms ha_integration_type related
Ness Alarm Instructions on how to integrate a Ness D8x/D16x alarm system with Home Assistant.
Alarm
Binary sensor
0.85 Local Push
@nickw444
ness_alarm
alarm_control_panel
binary_sensor
integration
docs title
/docs/configuration/ Configuration file

The ness_alarm {% term integration %} will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm.

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

  • Binary sensor: Reports on zone statuses
  • Alarm control panel: Reports on alarm status, and can be used to arm/disarm the system

The module communicates via the Ness D8x/D16x ASCII protocol.

Configuration

A ness_alarm section must be present in the {% term "configuration.yaml" %} file and contain the following options as required: {% include integrations/restart_ha_after_config_inclusion.md %}

# Example configuration.yaml entry
ness_alarm:
  host: alarm.local
  port: 2401
  zones:
    - name: Garage
      id: 1
    - name: Storeroom
      id: 2
    - name: Kitchen
      id: 3
    - name: Front Entrance
      id: 4
    - name: Front Door
      id: 5
      type: door

{% configuration %} host: description: The hostname of the IP232 module on your home network. required: true type: string port: description: The port on which the IP232 module listens for clients. required: true type: integer scan_interval: description: "Time interval between updates. Supported formats: scan_interval: 'HH:MM:SS', scan_interval: 'HH:MM' and Time period dictionary (see example below)." required: false default: "00:01:00" type: time infer_arming_state: description: Infer the disarmed arming state only via system status events. This works around a bug with some panels (<v5.8) which emit update.status = [] when they are armed. required: false default: false type: boolean zones: description: List of zones to add required: false type: list keys: zone_id: description: ID of the zone on the alarm system (i.e Zone 1 -> Zone 16). required: true type: integer name: description: Name of the zone. required: true type: string type: description: The zone type. Can be any binary_sensor device class. required: false default: motion type: string {% endconfiguration %}

Time period dictionary example

scan_interval:
  # At least one of these must be specified:
  days: 0
  hours: 0
  minutes: 0
  seconds: 10
  milliseconds: 0

Actions

Action aux

Trigger an aux output. This requires PCB version 7.8 or higher.

Data attribute Optional Description
output_id No The aux output you wish to change. A number from 1-4.
state Yes The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E.

Action panic

Trigger a panic

Data attribute Optional Description
code No The user code to use to trigger the panic.