Skip to content

Paradox Interface for Magellan, Spectra and EVO supporting MQTT, Signal, Pushbullet and others

License

Notifications You must be signed in to change notification settings

yellowonblack/pai

 
 

Repository files navigation

PAI - Paradox Alarm Interface

Middleware that aims to connect to a Paradox Alarm panel, exposing the interface for monitoring and control via several technologies. With this interface it is possible to integrate Paradox panels with HomeAssistant, OpenHAB, Homebridge or other domotics system that supports MQTT, as well as several IM methods.

It supports MG/SP/EVO panels connected through a serial port, which is present in all panels (TTL 5V), or through a USB 307 module. It also has beta support to connections using the IP150 module, both directly (firmware version <4.0), and through the SITE ID (firmware versions >4.0).

Support for Magellan and Spectra panels is very stable. Support for EVO panels is being added, so YMMV. If you find a bug, please report it.

For further information and detailed usage refer to the Wiki.

If you are having issues, or wish to discuss new features, join us at our Gitter community

On Android, if you install MQTT Dash, and follow the instructions you will automatically get a panel like this: mqtt_dash

How to use

Docker

If you have docker running, this will be the easiest way:

cd <projectFolder>
docker build -t pai .
docker run -it -v <projectFolder>/pai.conf:/etc/pai/pai.conf pai

or simply:

docker run -it -v <confFolder>/pai.conf:/etc/pai/pai.conf jpbarraca/pai

Manually

  1. Download the files in this repository and place it in some directory
git clone https://github.com/jpbarraca/pai.git
  1. Copy config/pai.conf.example to /etc/pai/pai.conf and edit it to match your setup. The file uses Python syntax.
cd config
mkdir -p /etc/pai
cp pai.conf.example /etc/pai/pai.conf
cd ..
  1. Install the python requirements.
pip3 install -r requirements.txt

If some requirement fail to install, this may not be critical.

  • gi, pygobject and pydbus are only required when using Signal
  • Pushbullet.py and ws4py are only required when using Pushbullet
  • chump is only required when using Pushover
  • paho_mqtt is only required for MQTT support
  • pyserial is only required when connecting to the panel directly through the serial port or using a GSM modem.
  1. Run the script:
python3 run.py

If something goes wrong, you can edit the config/user.py to increase the debug level. Check config/defaults.py for all configuration options

Tested Environment

Tested in the following environment:

  • Python > 3.5.2
  • Mosquitto MQTT Broker >v 1.4.8
  • OrangePi 2G-IOT, NanoPi NEO, and Raspberry Pi 3 through their built in Serial Port (with a level shifter!), or a USB RS232 TTL adapter (CP2102, PL2303, CH340, etc..)
  • Ubuntu Server 16.04.3 LTS
  • Paradox MG5050, SP7000 and EVO panels
  • Signal Cli through a DBUS interface
  • Pushbullet.py
  • SIM900 module through a serial port

Authors

  • João Paulo Barraca - @jpbarraca - Main code and MG/SP devices
  • Ion Darie - @iondarie - Homebridge integration
  • Jevgeni Kiski - @yozik04 - EVO devices

Acknowledgments

This work is inspired or uses parts from the following projects:

Disclaimer

Paradox, MG5050 and IP150 are registered marks of PARADOX. Other brands are owned by their respective owners.

The code was developed as a way of integrating personally owned Paradox systems, and it cannot be used for other purposes. It is not affiliated with any company and it doesn't have have commercial intent.

The code is provided AS IS and the developers will not be held responsible for failures in the alarm systems, or any other malfunction.

About

Paradox Interface for Magellan, Spectra and EVO supporting MQTT, Signal, Pushbullet and others

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.8%
  • Dockerfile 0.2%