Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate functionalities into bullet points #21

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Separate functionalities into bullet points #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d767534
Separate functionalities into bullet points
vivianlink Jun 20, 2018
72c19b8
fix grammatical error
vivianlink Jun 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# GarHAge
## a Home-Automation-friendly ESP8266-based MQTT Garage Door Controller
## A Home-Automation-friendly ESP8266-based MQTT Garage Door Controller

GarHAge allows two "dumb" garage door openers to be controlled (open/close) and report garage door status (open/closed) via MQTT.
GarHage has two main functionalities:
1. Allows 2 "dumb" garage door openers to be controlled (open/close)
2. Reports garage door status (opened/closed) via MQTT

GarHAge is almost completely compatible with Home Assistant's "MQTT Cover" platform. It responds to HASS's open and close commands and reports door status to keep HASS's GUI in sync with the door state. GarHAge does not implement HASS's "stop" command (as this functionality varies between garage door openers) or "tilt" functionality. Sample HASS configuration snippets are provided in this repository to get your garage door openers connected to HASS as quickly and painlessly as possible.

Expand Down