README.md

AlarmDecoder to MQTT Bridge (ad-mqtt)

Simple Python application to interface AlarmDecoder with a MQTT Broker.

Designed to work with Home Assistant.
Uses MQTT discovery to create sensors for all zones and the alarm panel automatically. Times are passed in the MQTT messages and retained so they can be used to create real "last changed" time sensors if desired in HASS.

Direct python execution

git clone https://github.com/TD22057/ad-mqtt.git
python3 -m venv venv
./venv/bin/pip install -r requirements.txt

[edit run.py to add ser2sock+mqtt broker host:port settings, 
edit devices.py to add zone info]

./run.py

Direct Docker Execution

Example docker execution with some parameters passed as environment vars. Please notice the mandatory devices.py mapping.

sudo docker run -e ADMQTT_SOCKET_HOST=192.168.1.71  
  -e ADMQTT_MQTT_HOST=192.168.1.6 
  -e ADMQTT_LOG_LEVEL=DEBUG 
  -e ADMQTT_ALARM_CODE=4321
  -v /home/user/devices.py:/home/devices.py -d ad-mqtt:latest

Use devices.py file in this repo as example file for configuring your zones. Check run.py for available environment variables.

Docker Compose

Example docker compose file:

version: "3"
services:
  ad-mqtt:
    image: rgriffogoes/ad-mqtt:latest
    container_name: ad-mqtt
    environment:
      - ADMQTT_SOCKET_HOST=192.168.1.71
      - ADMQTT_MQTT_HOST=192.168.1.6
      - ADMQTT_LOG_LEVEL=DEBUG
      - ADMQTT_ALARM_CODE=4321
    volumes:
      - /mnt/data/docker-data/ad-mqtt-data/devices.py:/home/devices.py
    restart: unless-stopped

Note device.py mounting and environment parameters.

Changelog

Version: 0.3.0

• Environment variables for major configurations
• External zone config file
• Dockerfile for containerized execution
• Github workflow to build and push docker image
• Updating README to include further instruction, descripiton and changelog

Version: 0.2.3

• Initial changelog recording