Manual - ParadoxAlarmInterface/pai GitHub Wiki

Requirements

  • Supported panel (SP/MG/EVO)
  • MQTT Broker (we tried only with mosquitto. Others may work) for communication with other systems
  • Python 3.6+ with pip (3.7, 3.8 recommended).

Installation

Install from PyPi

sudo -H pip3 install paradox-alarm-interface

This will install pai-service with dependencies to your PATH. Most probably here: /usr/local/bin/pai-service

Run with: pai-service

or run without installing from source code

Alternatively if you do not want to install you can run it from GIT repo.

  1. Download the files in this repository and place it in some directory
git clone https://github.com/ParadoxAlarmInterface/pai.git
cd pai
  1. Install PAI 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
  • 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.

Run with: ./run.sh

Configuration

Copy config/pai.conf.example to /etc/pai/pai.conf and edit it to match your setup. The file uses Python syntax.

mkdir -p /etc/pai
cp config/pai.conf.example /etc/pai/pai.conf
edit /etc/pai/pai.conf as needed

For configuration see Configuration section for supported file locations.

Run

If something goes wrong, you can edit the configuration file to increase the debug level. You can also run PAI with an alternative config by executing:

pai-service -c pai.conf
# or
./run.sh -c pai.conf

You can override configuration valiables like this:

PAI_VAR_NAME1=x PAI_VAR_NAME2=y pai-service
# or
PAI_VAR_NAME1=x PAI_VAR_NAME2=y ./run.sh

Note: PAI_ prefix.

Autostart on system boot using systemd

Download pai.service and put it to /etc/systemd/system/pai.service

Find where pai-service is installed: which pai-service

Update ExecStart in pai.service to the right file location.

Enable service and start

systemctl daemon-reload
systemctl enable pai.service
systemctl start pai.service

Updating

From PyPi

sudo -H pip3 install -U paradox-alarm-interface

Then restart the service

From repo

cd <project path>
git pull

Then restart the service