openhab-docs/_addons_bindings/digiplex
Yannick Schaus c0eef8b525
Partial merge final -> final-stable (#1569)
This performs a selective merge of the current docs into the "stable" branch
that will hold the default docs for the 3.0.2 release (until they're
replaced with the current ones once 3.1 is released).

* Backport bindings docs that looked applicable to 3.0
* Revert UI components changes not in stable

Signed-off-by: Yannick Schaus <github@schaus.net>

Co-authored-by: openHAB Build Server <infrastructure@openhab.org>
Co-authored-by: stefan-hoehn <stefan.hoehn@aoe.com>
Co-authored-by: jimtng <2554958+jimtng@users.noreply.github.com>
Co-authored-by: Matt <lawrence.matt@gmail.com>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: Kai Kreuzer <kai@openhab.org>
Co-authored-by: Felix Schneider <45742226+Trysupe@users.noreply.github.com>
Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Co-authored-by: J-N-K <J-N-K@users.noreply.github.com>
Co-authored-by: Eiko Wagenknecht <eiko.wagenknecht@web.de>
Co-authored-by: Alexander Behring <github.com@alexander-behring.eu>
Co-authored-by: Matthew Skinner <matt@pcmus.com>
Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de>
Co-authored-by: Patrick Fink <mail@pfink.de>
Co-authored-by: Gifford47 <49484063+Gifford47@users.noreply.github.com>
Co-authored-by: Seganku <seganku@users.noreply.github.com>
Co-authored-by: digitlength <62958838+digitlength@users.noreply.github.com>
Co-authored-by: Ross Kennedy <rossko@culzean.clara.co.uk>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Co-authored-by: Arjan Mels <43108771+arjanmels@users.noreply.github.com>
Co-authored-by: Jonathan Gilbert <github.10.jgilbert@xoxy.net>
Co-authored-by: Richard Koshak <rkoshak@users.noreply.github.com>
Co-authored-by: Wolfgang Schueschen <76775650+WolfgangSn@users.noreply.github.com>
Co-authored-by: Gareth Western <gareth@garethwestern.com>
Co-authored-by: Bob A <bobadair@users.noreply.github.com>
Co-authored-by: Sami Salonen <ssalonen@gmail.com>
Co-authored-by: Peter Schraffl <p.schraffl@gmx.at>
Co-authored-by: Georgios Moutsos <50378548+jossuar@users.noreply.github.com>
Co-authored-by: Markus Storm <markus.storm@gmx.net>
Co-authored-by: JensHoRi <47488279+JensHoRi@users.noreply.github.com>
Co-authored-by: Felix <24674809+fex01@users.noreply.github.com>
Co-authored-by: Koen Schockaert <54985218+QbusKoen@users.noreply.github.com>
Co-authored-by: Ethan Dye <mrtops03@gmail.com>
Co-authored-by: Senne Croughs <38940112+sencro@users.noreply.github.com>
Co-authored-by: Ben Clark <ben@benjyc.uk>
Co-authored-by: Sam Spencer <43712250+samsp99@users.noreply.github.com>
Co-authored-by: chingon007 <76529461+chingon007@users.noreply.github.com>
Co-authored-by: Wouter Born <github@maindrain.net>
Co-authored-by: mueller-ma <mueller-ma@users.noreply.github.com>
Co-authored-by: aurelio1 <aurelio@caliaro.net>
Co-authored-by: Bernd Weymann <bernd.weymann@gmail.com>
Co-authored-by: Martin Hogg <hoggm2@hotmail.co.uk>
2021-05-15 15:11:12 +02:00
..
readme.md Partial merge final -> final-stable (#1569) 2021-05-15 15:11:12 +02:00

readme.md

id label title type description since install
digiplex Digiplex/EVO Digiplex/EVO - Bindings binding This binding provides integration with Digiplex/EVO alarm systems from [Paradox](https://paradox.com). 3x auto

{% include base.html %}

Digiplex/EVO Binding

This binding provides integration with Digiplex/EVO alarm systems from Paradox. It utilizes PRT3 module for serial communication.

Supported Things

PRT3 Module

Before the binding can be used, a serial adapter must be added manually. Select PRT3 Module and enter serial port parameters. Please refer to PRT3 module manual for instructions how to modify baudrate (default setting is 2400)

Discovery

Once PRT3 Module is added and communication with the alarm system confirmed by its online status, please start discovery process to automatically discover (and add as new Things) all zones and areas defined in the alarm system.

Binding Configuration

There is no binding level configuration required.

Thing Configuration

PRT3 Module Configuration

The following section lists the PRT3 Module configuration. If using manual configuration in text files, the parameter names are given in the square brackets.

Serial Port [port]

Sets the serial port name for the communication with the alarm system

Baud Rate [baudrate]

Baud rate to use for serial port communication

Area configuration

Refresh time of area status (in seconds) [refreshPeriod]

Controls how often area status is refreshed from the alarm system.

Channels

PTR3 Module Channels

The table below summarizes all the channels available from the PTR3 Module thing.

Channel Description
messages_sent Counts the number of messages sent to the module
responses_received Counts the number of responses received from the module
events_received Counts the number of events received from the module

Zone Channels

The table below summarizes all the channels available from the zone thing.

Channel Description
status Simple zone status (open/closed)
extended_status Extended zone status as a String (Open/Closed/Tampered/Fire Loop Alarm)
alarm Information whether zone is in alarm (open/closed)
fire_alarm Same as above for fire alarm
supervision_lost Information whether supervision has been lost (open/closed)
low_battery Low battery warning (open/closed)

Area Channels

The table below summarizes all the channels available from the area thing.

Channel Description
status Area status available as a String
armed Simple (open/closed) information whether zone is armed
zone_in_memory Information whether there are zones in the memory (after alarm has been triggered
trouble Information whether some of the zones are in 'trouble' (malfunctioning)
ready Information whether area is ready (no open zones)
in_programming Checks for programming mode enabled
alarm Information whether area is in alarm
strobe Information whether area is in strobe alarm
control Channel for controlling area

User is able to send commands through control channel to arm/quick arm/disarm the zone. Every sent message is followed by the channel state change to either Ok or Failed depending whether command has been accepted by the alarm system. Note that PRT3 module is capable of handling more kinds of messages, but those are not yet supported by this binding. Message format is as follows:

Command String sent to the control channel
Regular Arm AA<pin>
Force Arm AF<pin>
Stay Arm AS<pin>
Instant Arm AI<pin>
Regular Quick Arm QA
Force Quick Arm QF
Stay Quick Arm QS
Instant Quick Arm QI
Disarm D<pin>

<pin> is your PIN as entered on a keypad.

Note: For security reasons please consider not storing your PIN in openHAB configuration files.

Note2: Please consult your alarm system manual how to enable Quick Arm feature. It is not enabled by default.

For example, the following sitemap item can be used to send commands to the area and receive response status as modified color of a label:

Switch item=areaControl label="Actions[]" mappings=[QA="Regular Quick Arm",QS="Stay Quick Arm",D1111="Disarm"] labelcolor=[Ok="green",Fail="red"]