README.md

Garage Door

Garage Door is a project for creating a DIY Smart Garage Door controller, with HomeKit compatibility.

Getting Started

This project includes all of the software requirements for creating a DIY Smart Garage Door Controller based on the NodeMCU ESP8266 Development Board.
For details on the hardware build, see my write up.

This initial version of the project consists of 3 parts:

• GarageDoor.ino: The Arduino IDE project containing the firmware for the ESP8266 board
• cmd/gdhk: Go application providing a HomeKit proxy
• spksrc/spk/garagedoor: Quick packaging solution for installation of the proxy on a Synology NAS

It is currently very specific to the author's use case, without many configuration options. Check the issues list to see known issues and roadmap items.

Prerequisites

• Arduino IDE
• ESP8266 Packages
• go

Optional:

• spksrc

Building/Installing

TODO

Deployment

TODO

Built With

• hc - HomeControl is an implementation of the HomeKit Accessory Protocol (HAP) in Go
• Arduino IDE - Build and flash ESP8266 Dev Board firmware
• Arduino ESP8266 Add-On - Libraries for using ESP8266 boards in Arduino IDE
• spksrc - Packaging the go binary for installation on Synology NAS

Contributing

TODO

Author

Dave Russell - forfuncsake

• https://forfuncsake.github.io/
• @forfuncsake

License

This project is licensed under the MIT License - see the LICENSE file for details