maxill1/ialarm-mqtt

•Updated over 3 years ago

A mqtt bridge to iAlarm and other chinese 'TCP IP' alarm system like Meian and Emooluxr

Image

10K+

maxill1/ialarm-mqtt repository overview

⁠ialarm-mqtt

A mqtt bridge to iAlarm (https://www.antifurtocasa365.it/⁠) and other chinese 'TCP IP' alarm system like Meian and Emooluxr (via node-ialarm library).

⁠

⁠features:

arm home
arm away
disarm
zone info (ok/problem, open, alarm, bypass, fault, low battery, signal loss) - NOTE: in order to obtain 'open' property in real time you must enable "DoorDetect" ("Ispezione sensori porta" on italian guard ip panel) in your alarm web panel options (http://192.168.1.x/Option.htm⁠)
home assistant mqtt-discovery⁠

⁠config

edit config.json⁠ and adjust "mqtt" and "server" settings according to your need. Pay attention to "server.zones" number, by default the are 40 but you may want to reduce it to match your sensor number.

Optionally you can edit "hadiscovery" and topic structure (code, zone name prefix, icons, etc) or remove the entire "hadiscovery" node to disable home assistant mqtt discovery.

⁠topics

    "topics" : {
        "availability": "ialarm/alarm/availability", //Last will topic for online/offline
        "error" : "ialarm/alarm/error", //errors
        "alarm" : {
            "state" : "ialarm/alarm/state", //current alarm status
            "command" : "ialarm/alarm/set", //alarm set command
            "event" : "ialarm/alarm/event", //last event string as recorded in the alarm log,
            "bypass": "ialarm/alarm/zone/${zoneId}/bypass" //command to bypass/restore a zone
        },
        "sensors" : {
            "topicType" : "state", //'state' for publishing only "state" topic, 'zone' for publishing only "zone" topics (alarm, active, lowBattery and fault), '' (or undefined) for both types 
            "state": "ialarm/sensors/state", //array containing all zones data in one payload
            "zone": {
                "alarm": "ialarm/sensors/${zoneId}/alarm", //single zone sensor for movement/alert detection (on or off)
                "active": "ialarm/sensors/${zoneId}/active", //single zone sensor representing the active (on) or bypass (off) state
                "lowBattery": "ialarm/sensors/${zoneId}/battery", //single zone sensor for low battery detection (on)
                "fault": "ialarm/sensors/${zoneId}/fault" //single zone sensor for fault detection (on)
            }
        }
    }

⁠payloads

Example with home assistant default payloads

    "payloads": {
        "alarmAvailable" : "online", 
        "alarmNotvailable" : "offline",
		//decode alarmCommand received state (accepting multiple payloads)
        "alarmDecoder": {
            "armAway" : ["armAway", "armedAway", "armed_away", "arm_away", "AA", "AwayArm"],
            "armHome" : ["armHome", "armedHome", "armed_home", "arm_home", "SA", "HomeArm" ,"StayArm", "armStay", "armedStay", "arm_stay", "armed_stay"],
            "disarm" : ["disarm", "disarmed", "D"],
            "cancel" : ["cancel", "canceled", "C"],
            "trigger": [ "trigger",  "triggered", "T"]
        },
		//published payload in "alarmState" command (accepting multiple payloads)
        "alarm":{
            "armAway" : "armed_away",
            "armHome" : "armed_home",
            "disarm" : "disarmed",
            "cancel" : "cancel",
            "triggered": "triggered"
        },
        "sensorOn" : "1", //binary sensor on value
        "sensorOff" : "0" //binary sensor off value
    },

Example with mqttthing (homebridge) default payloads

    "payloads": {
        "alarmAvailable" : "online", 
        "alarmNotvailable" : "offline",
        "alarmDecoder": {
            "armAway" : ["AA", "AwayArm"],
            "armHome" : ["SA", "StayArm"],
            "disarm" : ["D"],
            "cancel" : ["cancel"], //not used by mqqtthing
            "trigger": ["T"]
        },
        "alarm":{
            "armAway" : "AA",
            "armHome" : "SA",
            "disarm" : "D",
            "cancel" : "cancel", //not used by mqqtthing
            "triggered": "T"
        }
    },

⁠running with docker image

docker run --name ialarm-mqtt --restart always -v /path/to/my/config:/config maxill1/ialarm-mqtt:latest

⁠running with nodejs

npx ialarm-mqtt

npm install -g ialarm-mqtt 
ialarm-mqtt -c /path/to/my/config

Tag summary

Recent tags

Content type

Image

Digest

sha256:186a2a022…

Size

59.3 MB

Last updated

almost 4 years ago

docker pull maxill1/ialarm-mqtt