brydonleonard/gatekeynotifier

GateKeyNotifier

This is the repository for a companion notification device for my GateKey system. GateKey sends notifications to my phone when people enter the complex gate, but I'm not always with my phone. The notifier runs on an ESP32 with a connected speaker and RGB LED and makes noises to make sure I notice visitors.

Check out this video for a demo:

Getting started

You'll need:

• An ESP32
• A speaker (I used this 1W 8Ω one)
• A RGB LED (I used this one)
• An enclosure to hold everything

Solder up the speaker to any pins that support analog output. When the two were wired to the same ground pin, I encountered some audio interference, so I'd recommend using separate pins.

In main.cpp configure:

• The three LED pin numbers
• The speaker pin number
• Your GateKey server's address (if you're using managed GateKey, that'll be http://brydonleonard.com/register_device)
• Your WiFi name
• Your WiFi password

That's it! Once plugged in, the device will begin the handshake with GateKey.

Built with

Connecting devices to GateKey

See the GateKey README for more info on the device registration flow and API.

GateKey uses passworldess device registration to add devices to households. Once connected to the internet, this code will make requests to the configured GateKey server to register the device. A user in the desired household then requests the device via their Telegram app, closing the registration loop. The device is then issued with a set of credentials and an MQTT topic to which notifications are published whenever the gate opens.

License

Distributed under the MIT License. See LICENSE for more information.