MQTT ESPHome/ESP32 Alarm Keypad with Screen

TheHolyRoger · May 18, 2022, 3:22pm

This is my MQTT ESPHome based Alarm Keypad for Home Assistant, now with screen See below for the original version.

This comes with a blueprint to automate the alarm panel connection including feeding the display with the alarm state.

Top two LEDs appear as buttons, the bottom 2 LEDs appear as lights. These are controlled by the automation for feedback.

Thing:

ESPHome File:

github.com

TheHolyRoger/THR_HA_Blueprints/blob/master/esphome_configs/alarm_keypad.yaml

substitutions:
  # Device Config
  name: "mqtt-alarm-keypad-main"
  friendly_name: "Alarm Keypad Main"
  # Alarm Action Keys
  key_arm_main: "A"
  key_arm_alternate: "B"
  key_disarm: "D"
  # Alarm arm modes
  # For extra actions add _extra_1, _extra_2 etc to the end of your arm command (Advanced)
  arm_command_main: "away"
  arm_command_alternate: "home"
  # Alarm Pin Code Length
  min_code_length: "0"
  max_code_length: "4"
  # Auto submit disarm code
  auto_submit_disarm_code: "1"
  # LED Brightness
  status_light_brightness: "40%"
  warning_light_brightness: "60%"

This file has been truncated. show original

HASS Blueprint:

github.com

TheHolyRoger/THR_HA_Blueprints/blob/master/MQTT_Alarm_Keypad.yaml

# Blueprint metadata
blueprint:
  name: MQTT Alarm Keypad
  description: |
    # Controller automation for MQTT Alarm Keypad
  domain: automation
  input:
    alarm_entity:
      name: Alarm Control Panel Entity
      description: Alarm Control Panel Entity to be controlled by the keypad
      default: ""
      selector:
        entity:
          filter:
            domain: alarm_control_panel
    mqtt_topic_prefix:
      name: MQTT Device Topic Prefix
      description: The MQTT topic prefix used by the device. Should be it's 'name'.
      default: ""
      selector:

This file has been truncated. show original

More Pics:

Original Version

Here is my attempt works as I want it to, written a little controller software for the esp32, communicates with HASS by MQTT and that’s it HASS verifies the alarm codes, this is simply a controller. Works with the Alarmo integration perfectly!

Orignal Demo Video: https://youtu.be/KX8sle-yERo
Orignal Thing: Thingiverse - Digital Designs for Physical Objects
Orignal Code: GitHub - TheHolyRoger/ESP32-MQTT-AlarmKeypad: Home Assistant Alarm keypad using ESP32 & MQTT.

finity · May 18, 2022, 4:18pm

Are you just bragging or are you really going to share the project?

pepe59 · May 18, 2022, 5:14pm

An interesting project. Can you share, I would like to apply it at home?

TheHolyRoger · May 18, 2022, 5:47pm

@finity @pepe59 Haha sorry! I will push the code to github later and edit the main message, wasn’t sure if anyone wanted it or not

Initial 3d print from video is here: Login Pad by assin - Thingiverse

My modified keypad case I also haven’t uploaded anywhere, will upload it when I get the results if it’s good enough!

ESP32 cases I like (until I move it inside the new keypad case):

Generic 4x4 keypad, pihut link: 4x4 Matrix Keypad– The Pi Hut

LEDs, solder

github link coming soon

TheHolyRoger · May 18, 2022, 8:43pm

@finity @pepe59 GitHub - TheHolyRoger/ESP32-MQTT-AlarmKeypad: Home Assistant Alarm keypad using ESP32 & MQTT. here you go

pepe59 · May 19, 2022, 9:17am

Thanks. I’ll look into it and order parts.

TheHolyRoger · May 19, 2022, 5:00pm

I’m still waiting for my “thing” to be verified, but if you wanna take a look at the other design I’ve ordered to be printed here’s the STL files:

https://thingiverse-production-new.s3.amazonaws.com/assets/d4/3b/ed/c9/b0/case-bottom-v3.stl?AWSAccessKeyId=AKIAJ4LU5KWCMM7WB7YA&Expires=1652979781&Signature=roopmI%2BCKaWxwJe3N26t6cJNamI%3D

https://thingiverse-production-new.s3.amazonaws.com/assets/b9/57/c3/90/52/case-top-v3.stl?AWSAccessKeyId=AKIAJ4LU5KWCMM7WB7YA&Expires=1652979781&Signature=lWxvdk7TtNsiDLqi0RZPxu1NxyI%3D

@finity

I think the links expire soon though.

If anyone else is a better 3d modeller would love to see a better version

finity · May 19, 2022, 5:31pm

both links have already expired.

I just literally started getting into 3d modeling/printing.

So recently in fact that my printer isn’t arriving until tomorrow. The one I wanted was so hard to find I started trying to order it over a month ago now and Amazon kept extending the delivery date until I just gave up and ordered it directly from the manufacturer.

I have a couple of models that I’m going to print with it already tho after a few break-in models are successful.

What software do you use?

TheHolyRoger · May 19, 2022, 5:38pm

Ah here you go try this one Filebin | w9vew9ux7d5ml79d

I don’t have a printer, I’ve been eyeing an ender v2 for a while though I use treatstock to print at the moment.

Blender seems to work best for me so far although it’s not really one for precision tools, i find myself doing extra processes to try and do things with precise measurements, but I don’t know the software well either

finity · May 19, 2022, 7:16pm

I’ve got an Ender 3 S1 pro hopefully showing up tomorrow.

For my 3D modeling I’ve tried Tinkercad which is good for fairly basic shapes but I have been using Onshape (free online software) the last week or so and I’m slowly getting the hang of it.

TheHolyRoger · May 23, 2022, 4:04pm

You convinced me to get an Ender waiting for mine to come still but I tweaked the design:

My print arrived for the other version but it wasn’t great and now all the pins have snapped off

This new version should allow for the esp32 to sit above the usb socket (I hope) - on UK amazon I’m using these:

And this was the smallest right angle cable I could find pointing the right way which I’ve now chopped and attached a dupont connector to:

Hopefully I can get it all together later this week and post some pics

finity · May 24, 2022, 3:53am

I got mine a few days ago and I’m trying to get the hang of it. I haven’t had time to really print anything other than test prints so far. (there is a cute cat test print that my wife loves - so so far on that! )

One thing I’ve learned in my research is to try to strengthen the pins by using fillets at the attachment points instead of sharp angles.

TheHolyRoger · May 27, 2022, 1:22pm

That was very helpful actually thanks for that tip

My first couple of prints came out alright but I hadn’t aligned everything quite right bloody blender…

Should have the next versions printed in a couple days but here’s pics of how these ended up

TheHolyRoger · June 1, 2022, 3:01am

Ok I think this might be the final version: Home Assistant ESP32 Alarm Keypad by TheHolyRoger - Thingiverse

Waiting for the last parts to print before I assemble it all

I added pins and a flap/plate with a screw hole to secure the keypad while allowing you to remove it. I made the pins in a way that you should be able to heat and squish them down flat to fix it in place permanently, although I recommend waiting to do that until you’re happy with the keypad itself since I’ve had one die on me

Edit: pics of how the top fits together

TheHolyRoger · June 1, 2022, 5:13pm

Here it is finally ready @finity @pepe59 ESP32 alarm keypad fully assembled video - YouTube

I updated the thing with a bunch of images and info etc on how to build/assemble

TheHolyRoger · May 26, 2023, 2:15am

I’ve been reworking this project using esphome instead of my own code and also added a screen

Will upload esphome code and latest STL files soon if anyone’s interested

TheHolyRoger · May 28, 2023, 12:11pm

Here’s the assembled upgraded version still MQTT based but using esphome this time.

The code is just an esphome file which should be easy to configure, I’ve made vars for all the config. Then there’s a hass blueprint with three simple parameters to automate the keypad with your alarm control panel (I’m using alarmo)

I’m still testing it out so I’ll upload both the esphome file and blueprint later

TheHolyRoger · May 28, 2023, 12:13pm

@finity get involved sir

finity · May 28, 2023, 2:38pm

??

I like the look of it and it seems you’ve come a ways with your design.

But at the moment I’m swamped with other stuff and don’t really have time (or the need) to build an alarm panel.

I’ve got this bookmarked so if I need it I’ll definitely try it.

TheHolyRoger · May 28, 2023, 3:30pm

No worries