homebridge-mqttgaragedoor

An homebridge plugin that create an HomeKit Garage Door Opener accessory mapped on MQTT topics

Installation

Follow the instruction in homebridge for the homebridge server installation. The can be installed "globally" by typing:

npm install -g git+https://github.com/knstntn1/homebridge-mqttgaragedoor

Release notes

Version 1.0.2

Configuration

Remember to configure the plugin in config.json in your home directory inside the .homebridge directory. Configuration parameters:

{
  "accessory": "mqttgaragedoor",
  "name": "NAME OF THE GARAGE DOOR OPENER",
  "url": "URL OF THE BROKER",
  "username": "USERNAME OF THE BROKER",
  "password": "PASSWORD OF THE BROKER"
  "caption": "LABEL OF THE GARAGE DOOR OPENER",
  "lwt": "OPTIONAL: DOOR OPENER MQTT LAST WILL AND TESTAMENT TOPIC",
  "lwtPayload": "lwt Payload",
  "topics": {
                "statusSet":    "MQTT TOPIC TO SET THE DOOR OPENER",
                "openGet":      "OPTIONAL: MQTT TOPIC TO GET THE DOOR OPEN STATUS",
                "openValue":    "OPTIONAL VALUE THAT MEANS OPEN (DEFAULT true)"
                "closedGet":    "OPTIONAL: MQTT TOPIC TO GET THE DOOR CLOSED STATUS",
                "closedValue":  "OPTIONAL VALUE THAT MEANS CLOSED (DEFAULT true)"
                "openStatusCmdTopic": "OPTIONAL: MQTT TOPIC TO ASK ABOUT THE OPEN STATUS",
                "openStatusCmd": "OPTIONAL: THE OPEN STATUS COMMAND ( DEFAULT "")",
                "closeStatusCmdTopic": "OPTIONAL: MQTT TOPIC TO ASK ABOUT THE CLOSED STATUS",
                "closeStatusCmd": "OPTIONAL THE CLOSED STATUS COMMAND (DEFAULT "")"
            },
  "doorRunInSeconds": "OPEN/CLOSE RUN TIME IN SECONDS (DEFAULT 20"),
  "pauseInSeconds" : "IF DEFINED : AUTO CLOSE AFTER [Seconds]",
  "jsonInjection": "OPTIONAL: IF OPEN/CLOSE STATUS IS RECEIVED INSIDE JSON-PAYLOAD, THE PARSER FUNCTION (JAVASCRIPT) CAN BE DEFINED HERE (DEFAULT ""). MUST RETURN THE PROCESSED STATUS. EXAMPLE: "return JSON.parse(status).["StatusSNS"].Switch1;""
}

Credit

The original homebridge MQTT plugins work was done by ilcato in his homebridge-mqttswitch project.

The original homebridge GarageDoor plugin work was done by [belamonica] (https://github.com/benlamonica) in his [homebridge-rasppi-gpio-garagedoor] (https://github.com/benlamonica/homebridge-rasppi-gpio-garagedoor) project.

The parsing mechanism for json payloads was inspired by MrBalonia in his fork and arachnetech in https://github.com/arachnetech/homebridge-mqttthing and integrated by knstntn1.