GithubHelp home page GithubHelp logo

f1d094 / alarmdecoder-mqtt Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rgriffogoes/ad-mqtt

0.0 0.0 0.0 79 KB

AlarmDecoder to MQTT bridge

License: GNU General Public License v3.0

Python 97.32% Dockerfile 0.97% Shell 1.71%

alarmdecoder-mqtt's Introduction

Docker Image CI codeql

AlarmDecoder to MQTT Bridge (alarmdecoder-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/f1d094/alarmdecoder-mqtt.git
python3 -m venv venv
./venv/bin/pip install -r requirements.txt

[ Edit run-with-vars.sh and devices.py accordingly ]

./run-with-vars.sh
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 alarmdecoder-mqtt:latest

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

Docker Compose

Example docker compose file:


version: "3"
services:
  alarmdecoder-mqtt:
    image: f1d094/alarmdecoder-mqtt:latest
    container_name: alarmdecoder-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/alarmdecoder-mqtt-data/devices.py:/home/devices.py
    restart: unless-stopped

Note device.py mounting and environment parameters.

Changelog
Version: 0.3.2
  • Forked from rgriffogoes/ad-mqtt
  • Fixed encrytion in run.py to use dict entries
  • Updated requirements.txt to use modified insteon-mqtt locked to puha-mqtt<=1.6.1
  • Added notes in devices.py on where to find the data to populate it (Vista 20p)
  • Updated Dockerfile to use bookworm, which has images for ARM64
  • Updated workflow to create docker image f1d094/alarmdecoder-mqtt
Version: 0.3.1
  • Adding Device attribute in discovery (sn3ak)
  • Adding codeql in repo workflow
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

alarmdecoder-mqtt's People

Contributors

f1d094 avatar rgriffogoes avatar sn3ak avatar td22057 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.