- Upgrades python to version 3 and updates versions of libraries in requirements.txt
- Added code to update the mqtt availability topic to inform subscribers when the app is offline.
- Added support for opening and closing states for garage doors (requires a second switch for the open position)
- Added validation of config.yaml via voluptuous.
- Replaced print statements with logging.
- Added Dockerfile
- PR #6 (craiginTx) Set initial state of output pin on startup
- PR #7 (craiginTx) Update door status after reconnect.
- PR #9 When mqtt discovery is true automatically generate unique_id and store in config file.
- PR #9 Add optional door parameter press_time. This is the amount of time the 'button' is pressed (in seconds). Default is 0.2.
- PR #9 Add optional door parameter read_delay. This is the amount of time to wait after a state change to take a reading. Default is 0.5.
- PR #9 Add optional door parameter switch_debounce. This is the debounce time passed to RPiGPIO. in ms. Default is 300.
- PR #9 Add optional door parameter poll_time. This is the amount of seconds to wait after a state change to poll the switch and log the result. This is for debuggung only. Default is 0 (disabled).
- If using mqtt discovery the availability topics will be automatically created and updated with default values. You can also overide the default values by adding lines for the availability topic and payloads to the mqtt section of the config file, for example:
mqtt:
host: xxx.xx.x.xx
port: 1883
user: ""
password: ""
discovery: true #defaults to false, uncomment to enable home-assistant discovery
discovery_prefix: homeassistant #change to match with setting of home-assistant
availability_topic: home-assistant/cover/availabilty
payload_available: online
payload_not_available: offline- Getting opening & closing states to display requires the addition of a switch to detect the fully open position for each door. I had trouble mounting a normal magnetic reed switch for this and used one of these instead. After the switch is mounted you enable opening and closing functionality by adding an open line to the door config section, for example.
doors:
-
id: 'garage_door'
name: #garage_door
relay: 21
state: 12
open: 7
state_mode: normally_closed #defaults to normally open, uncomment to switch
# invert_relay: true #defaults to false, uncomment to turn relay pin on by default
state_topic: "home-assistant/cover"
command_topic: "home-assistant/cover/setIf you do not add this open line (whether you installed the switch or not) GarageQTPi will operate in standard open/close mode.
GarageQTPi is an implementation that provides methods to communicate with a Raspberry Pi garage door opener via the MQTT protocol. Although it is designed to work out of the box with a Home Assistant cover component it can also be used as the basis for any Raspberry Pi garage project.
Home Assistant has integration for raspberry pi garage door openers but only if the instance of Home Assistant is running on the raspberry pi. If your raspberry pi is soley a garage door opener like mine then you need to use an MQTT cover component to interface with the pi.
- Raspberry pi 3
- Relay
- Magnetic switches
- Additional wires/wire nuts.
- 14 gauge solid copper wire for garage motor wiring
- 20-22 gauge copper wire for magnetic switch wiring
- jumper wiries for GPIO pins
- Mounting Hardware.
- See installation section for mounting ideas.
Total cost: ~75-$100. Cheaper if you already have some raspberry pi parts
Copyright (c) 2013 andrewshilliday
Note: The switches I linked have 3 terminals (COM, NO, NC). You should wire up COM to GND and NO to the GPIO.
Important: The above diagram is outdated, pin 21 may actually be pin 27. Consult your raspberry pi's pin diagram
IMPORTANT: You shoud always consult with a manual before wiring
It's impossible to write a generic guide as all garage door motors are not equal. I will instead explain what I did as a reference that you can use.
The basic idea is to wire it in parallel with the button on the wall. The code is essentially mimicking a button press by switching the relay on and off quickly. In my case the two leftmost wires (red/white) are connected to the button on the wall. The two rightmost white wires are for the collision detection sensors. So I removed the two leftmost wires, wirenutted 3 solid 14 gauge wires together (the button wire, my relay wire, and then one wire to go to the garage door opener) two times for each of the two wires.
I ran the magnetic switch wires along the same path as the sensor wires, stapled them to the wall, and stuck the magnetic switches to the door and wall as close as I could get them. As noted above wire up the COM (common) to the GND pin and the NO (normally open) to the GPIO pin.
Notice mine aren't exactly on the same plane but I was monitoring the gpio pins in the code to make sure they were close enough to complete the circuit before I attached them. So far the included 3M sticky tape is holding up but time will tell.
I've seen a lot of people mounting the pi/relay onto plywood and mounting that to the ceiling. I wasn't really keen on that so what I did was drill four small holes into the top of my pi and found screws and nylon spacers at lowes. I attached the relay to the top of the pi case.
The pi case included with the Canakit has mounting holes on the back, so I used small bolts that sit flush into the mounting holes, and then large washers and attached the case to the garage door mount. The lid to the case comes off easily so once it was mounted I ran zip ties around the lid and secured it. I also squirted locktite around all the screw threads to keep the vibration of the garage door from shaking any screws loose. So far this has proved to be relatively stable.
- Raspberry pi 3 running rasbian jessie
- Python 2.7.x
- pip (python 2 pip)
git clone https://github.com/Jerrkawz/GarageQTPi.gitpip install -r requirements.txt- edit the configuration.yaml to set up mqtt (See below)
python main.py- To start the server on boot run
sudo bash autostart_systemd.sh
I won't try to butcher an mqtt setup guide but will instead link you to some other resources:
HomeAssistant MQTT Setup: https://home-assistant.io/components/mqtt/
Bruh Automation: https://www.youtube.com/watch?v=AsDHEDbyLfg
Either follow the cover setup or enable mqtt discovery
HomeAssistant MQTT Cover: https://home-assistant.io/components/cover.mqtt/
HomeAssistant MQTT Discovery: https://home-assistant.io/docs/mqtt/discovery/
Screenshot:
The server works with the Home Assisant MQTT Cover component out of the box but if you want to write your own MQTT client you need to adhere to the following API:
Publish one of the following UPPER CASE strings to the command_topic in your config:
OPEN | CLOSE | STOP
Subscribe to the state_topic in your config and you will recieve one of these lower case strings when the state pin changes:
open | closed
Thats it!
config.yaml:
mqtt:
host: m10.cloudmqtt.com
port: *
user: *
password: *
doors:
-
id: 'left'
relay: 23
state: 17
state_topic: "home-assistant/cover/left"
command_topic: "home-assistant/cover/left/set"
-
id: 'right'
relay: 24
state: 27
state_topic: "home-assistant/cover/right"
command_topic: "home-assistant/cover/right/set"
There are eight optional configuration parameters.
Five of the option parameters are for mqtt. One is to enable discovery by HomeAssistant. The second one changes the discovery prefix for HomeAssitant. The other three allow you to set the availability topic, payload for available and payload for not available. Note these three parameters have the following default values:
availability_topic: discovery_prefix + '/cover/availabilty'
payload_available: online (same as home assistant default)
payload_not_available: offline (same as home assistant default)
mqtt:
host: m10.cloudmqtt.com
port: *
user: *
password: *
discovery: true
discovery_prefix: 'homeassistant'
availability_topic: home-assistant/cover/availabilty
payload_available: online
payload_not_available: offline
The discovery parameter defaults to false and should be set to true to enable discovery by HomeAssistant. If set to true, the door state_topic and command_topic parameters are not necessary and are ignored.
The discovery_prefix parameter defaults to 'homeassistant' and shouldn't be changed unless changed in HomeAssistant
The other three of the option parameters are for the doors. One gives the door a name for discovery. The second one to flip the state pin of the magnetic switch in the invent of a different wiring schema. The third one to filp the relay logic. This is a per door configuration option like:
doors:
-
id: 'left'
name: 'Left Garage Door'
relay: 23
state: 17
state_mode: normally_closed
invert_relay: true
state_topic: "home-assistant/cover/left"
command_topic: "home-assistant/cover/left/set"
The name parameter defaults to the unsanitized id parameter
The state_mode parameter defaults to 'normally_open' and isn't necessary unless you want to change it to 'normally_closed'
The invert_relay parameter defaults to false and isn't necessary unless you want to set the relay pin to be powered by default
I wrote the code myself but as far as hardware/wiring and motivation goes I was heavily insipired by Andrew Shilliday. As you can tell I borrowed some images from him. If you find my guide hard to read, need a web gui, or just want a second reference definitely check out his repo: https://github.com/andrewshilliday/garage-door-controller