• Stars
    star
    166
  • Rank 227,748 (Top 5 %)
  • Language
    Python
  • Created over 2 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Wireless garage door sensor for Home Assistant powered by Raspberry Pi Pico W

Raspberry Pi Pico W Garage Door Sensor

Lint

I wanted to build a sensor to determine the state of my garage door—open or closed—and send that state to Home Assistant so I can display the status in a dashboard and build automation from it (e.g. warning me if I'm asleep and the garage door is open!).

If I wanted some sort of cloud integration, I could pay for the kit that connects to my garage door opener, but since the cloud is just someone else's computer, and I'd rather not rely on some company's weak security to protect data about my home... I want it all local.

Garage Door sensors

The actual sensors I use are the 'Enforcer' (model SM-4201-LQ) from Seco-Larm. I chose these because they are rugged and purpose-built for mounting to garage door tracks.

Watch this video to see how I installed the sensors on my garage doors, and how I wired them to the Pico W.

RPi Pico Breakout Board wired to garage door sensor

I used a RPi Pico Breakout board mounted directly to my garage wall, and wired one wire of each sensor to ground, and the others thusly:

  • east_garage_door to GPIO pin 2
  • west_garage_door to GPIO pin 3

You can pick any GPIO connection, though—just change the appropriate lines inside garage-door.yml before flashing the Pico W using the instructions below.

Flashing the Pico W

I decided to use a Raspberry Pi Pico W for this project—you could probably also use an ESP32 or ESP8266 with slight modifications, since this project uses ESPHome.

You will have to flash the firmware to the Pico W in order for it to work.

Note: I also have a MicroPython-based setup in the micropython subdirectory.

Preparing to flash the Pico W

Before you can flash anything to the Pico W, you have to define a few secrets that ESPHome will use when it compiles the program.

Create a secrets.yaml file inside this directory, and add the following:

---
wifi_ssid: your-wifi-ssid-here
wifi_password: your-wifi-password-here
ota_password: choose-an-ota-password
api_encryption_key: choose-an-api-encryption-key

Note: The ESPHome docs API page can generate an encryption key in-browser.

Using Docker

Note: This will not work until this Pull Request is merged into ESPHome.

In this directory, I run docker-compose up -d to start an esphome container that I'll use to flash the Pico.

Then enter the container:

$ docker exec -it esphome bash
root@docker-desktop:/config#

This drops you into the container inside the config directory, which is shared from this repository.

Compile the binary for the garage door sensor:

$ esphome compile garage-door.yml

Copy the generated binary into the current directory:

$ cp .esphome/build/rpi-pico/.pioenvs/rpi-pico/firmware.uf2 ./rpi-pico.uf2

Then on your host computer, with the Pico W booted into BOOTSEL mode (hold down the BOOTSEL button while plugging in the USB cable), copy the rpi-pico.uf2 file over to the Pico W. When the copy is complete, the Pico should reboot and start working as a garage door sensor.

Using pip source install

For now, until support for the Pico is merged into ESPHome, you have to install the latest dev release with support for the Pico. Make sure you have Python 3 installed on your computer, then run:

$ pip3 install git+https://github.com/esphome/esphome.git@dev

Make sure your installation is working:

$ esphome version
Version: 2022.11.0-dev

Then plug in your Pico W, while holding the BOOTSEL button, and when it mounts on your computer, run:

$ esphome run garage-door.yml --device /Volumes/RPI-RP2

On Raspberry Pi or other Linux devices, the --device should be /dev/sda1 (or whatever mount point)

After 20-30 seconds, ESPHome should compile and upload the firmware to the Pico.

Note: There's also an led-blink.yml configuration if you want to upload it quickly to verify esphome and your Pico are all wired up correctly. If you run that file, it should make your Pico start blinking it's onboard LED 2x per second.

Installation from a Raspberry Pi

If you are using a Raspberry Pi, first install Pip:

sudo apt install python3-pip git

Then follow the directions above for 'Using pip source install'.

First time install

For now, if you're not running things on a Mac at least, the first install must be done by copying a manually-downloaded .uf2 file to the Pico in BOOTSEL mode.

After ensuring esphome installed (see 'Using pip source install' above):

  1. Run esphome dashboard ./
  2. In a browser, visit the Pi's IP address at port :6052
  3. Click the three dots next to the project
  4. Click 'Install'
  5. Click 'Manual download'
  6. Click the link and wait for the download to be generated, then click the Download link.

Copy the downloaded rpi-pico.uf2 file to the Pico's filesystem while it's in BOOTSEL mode (hold down BOOTSEL while plugging it in). Unplug and replug the Pico.

Debugging with ESPHome

If you want to see debug output, after the first time you flash the Pico, you can change the run command to:

$ esphome run led-blink.yml --device /dev/tty.usbmodem2101

And it will compile ESPHome, load it onto the Pico, and start displaying logged output. You can change the log level using the logger.level setting.

More Repositories

1

ansible-for-devops

Ansible for DevOps examples.
Python
7,475
star
2

mac-dev-playbook

Mac setup and configuration via Ansible.
Shell
5,906
star
3

internet-pi

Raspberry Pi config for all things Internet.
Jinja
3,690
star
4

macos-virtualbox-vm

Instructions and script to help you create a VirtualBox VM running macOS.
Shell
2,519
star
5

ansible-vagrant-examples

Ansible examples using Vagrant to deploy to local VMs.
2,034
star
6

raspberry-pi-dramble

DEPRECATED - Raspberry Pi Kubernetes cluster that runs HA/HP Drupal 8
Shell
1,656
star
7

ansible-role-docker

Ansible Role - Docker
1,515
star
8

drupal-vm

A VM for Drupal development
Jinja
1,370
star
9

pi-webcam

Automation to configure a Raspberry Pi as a USB OTG webcam
1,322
star
10

internet-monitoring

Monitor your network and internet speed with Docker & Prometheus
1,237
star
11

raspberry-pi-pcie-devices

Raspberry Pi PCI Express device compatibility database
HTML
1,230
star
12

ansible-role-mysql

Ansible Role - MySQL
Jinja
988
star
13

ansible-role-jenkins

Ansible Role - Jenkins CI
Groovy
802
star
14

ansible-role-nginx

Ansible Role - Nginx
Jinja
774
star
15

ansible-role-security

Ansible Role - Security
Jinja
706
star
16

ansible-role-certbot

Ansible Role - Certbot (for Let's Encrypt)
Shell
698
star
17

ansible-role-gitlab

Ansible Role - GitLab
Jinja
653
star
18

packer-boxes

Jeff Geerling's Packer build configurations for Vagrant boxes.
Shell
635
star
19

ansible-for-kubernetes

Ansible and Kubernetes examples from Ansible for Kubernetes Book
Shell
612
star
20

my-backup-plan

How I back up all my data.
Shell
576
star
21

dotfiles

My configuration. Minimalist, but helps save a few thousand keystrokes a day.
Shell
540
star
22

ansible-role-firewall

Ansible Role - iptables Firewall configuration.
Shell
481
star
23

ansible-role-postgresql

Ansible Role - PostgreSQL
Jinja
478
star
24

kubernetes-101

Kubernetes 101 - by Jeff Geerling
HTML
477
star
25

ansible-role-php

Ansible Role - PHP
Jinja
468
star
26

ansible-role-kubernetes

Ansible Role - Kubernetes
Jinja
425
star
27

Ping

A PHP class to ping hosts.
PHP
415
star
28

ansible-role-apache

Ansible Role - Apache 2.x.
Jinja
392
star
29

ansible-role-nodejs

Ansible Role - Node.js
Jinja
386
star
30

turing-pi-cluster

DEPRECATED - Turing Pi cluster configuration for Raspberry Pi Compute Modules
Jinja
347
star
31

awx-container

Ansible Container project that manages the lifecycle of AWX on Docker.
297
star
32

ansible-role-java

Ansible Role - Java
Jinja
293
star
33

ansible-role-ntp

Ansible Role - NTP
Jinja
290
star
34

pi-timelapse

Time-lapse app for Raspberry Pi computers.
Python
278
star
35

temperature-monitor

Raspberry Pi-based home temperature monitoring network.
JavaScript
256
star
36

pi-cluster

Raspberry Pi Cluster automation
Shell
231
star
37

ansible-role-awx

DEPRECATED Ansible Role - AWX
230
star
38

ansible-role-homebrew

Ansible Role - Homebrew (MOVED to geerlingguy.mac collection)
Shell
229
star
39

ansible-role-redis

Ansible Role - Redis
Jinja
228
star
40

packer-centos-7

This build has been moved - see README.md
223
star
41

ansible-collection-mac

Collection of macOS automation tools for Ansible.
Shell
220
star
42

ansible-role-dotfiles

Ansible Role - Easy and flexible dotfile installation.
214
star
43

ansible-role-nfs

Ansible Role - NFS
Jinja
207
star
44

ansible-role-haproxy

Ansible Role - HAProxy
Jinja
194
star
45

ansible-role-git

Ansible Role - Git
188
star
46

ansible-role-repo-epel

Ansible Role - EPEL Repository for RHEL/CentOS
175
star
47

ansible-role-composer

Ansible Role - Composer PHP Dependency Manager
Jinja
175
star
48

ansible-role-pip

Ansible Role - Pip (for Python)
174
star
49

turing-pi-2-cluster

DEPRECATED - Turing Pi 2 Cluster
Jinja
174
star
50

ansible-role-logstash

Ansible Role - Logstash
Jinja
168
star
51

ansible-role-elasticsearch

Ansible Role - Elasticsearch
Jinja
167
star
52

drupal-for-kubernetes

Drupal Example Site for Kubernetes
PHP
149
star
53

ansible-role-filebeat

Ansible Role - Filebeat for ELK stack
Jinja
137
star
54

ansible-role-backup

Ansible Role - Backup for simple servers
Shell
135
star
55

ansible-role-ansible

Ansible Role - Ansible
130
star
56

airgradient-prometheus

AirGradient Prometheus exporter.
C++
116
star
57

ansible-role-kibana

Ansible Role - Kibana
Jinja
115
star
58

ansible-role-swap

Ansible Role - Swap
107
star
59

obs-task-list-overlay

An HTML and Node.js-based task list overlay for OBS.
JavaScript
105
star
60

drupal-pi

Drupal on Docker on a Raspberry Pi. Pi Dramble's little brother.
Jinja
105
star
61

ansible-role-glusterfs

Ansible Role - GlusterFS
104
star
62

ansible-role-raspberry-pi

Configures a Raspberry Pi (running Raspbian).
102
star
63

docker-centos7-ansible

CentOS 7 Docker container for Ansible playbook and role testing.
Dockerfile
101
star
64

packer-ubuntu-1804

This build has been moved - see README.md
101
star
65

ansible-role-solr

Ansible Role - Apache Solr
Shell
97
star
66

ansible-mastodon

Mastodon installation on a single server using Ansible.
Jinja
95
star
67

sbc-reviews

Jeff Geerling's SBC review data - Raspberry Pi, Radxa, Orange Pi, etc.
93
star
68

ansible-role-supervisor

Ansible Role - Supervisor
Shell
92
star
69

ansible-role-docker_arm

Ansible Role - Docker for ARM and Pi
91
star
70

ansible-requirements-updater

Update your requirements.yml with this grisly Ansible playbook.
90
star
71

ansible-role-php-versions

Ansible Role - PHP Versions
88
star
72

ansible-role-ruby

Ansible Role - Ruby
Shell
86
star
73

ansible-role-mas

Ansible Role - Mac App Store CLI (MOVED to geerlingguy.mac collection)
85
star
74

JJG-Ansible-Windows

[DEPRECATED] Windows shell provisioning script to bootstrap Ansible from within a Vagrant VM.
Shell
85
star
75

ansible-role-drupal

Ansible Role - Drupal
84
star
76

pi4gpu

Raspberry Pi GPU Carrier Board
OpenSCAD
83
star
77

ansible-role-postfix

Ansible Role - Postfix
82
star
78

tower-operator

DEPRECATED: This project was moved and renamed to: https://github.com/ansible/awx-operator
Dockerfile
82
star
79

ansible-role-varnish

Ansible Role - Varnish HTTP accelerator
Jinja
82
star
80

packer-ubuntu-1404

DEPRECATED - Packer Example - Ubuntu 14.04 Vagrant Box using Ansible provisioner
Shell
82
star
81

pi-camera

A Raspberry Pi Camera
Python
79
star
82

packer-centos-6

This build has been moved - see README.md
79
star
83

pi-router

Raspberry Pi-based OpenWRT router config for 4G/5G Waveshare Dual Ethernet board.
Dockerfile
79
star
84

docker-ubuntu1804-ansible

Ubuntu 18.04 LTS (Bionic) Docker container for Ansible playbook and role testing.
Dockerfile
78
star
85

top500-benchmark

Automated Top500 benchmark for clusters or single nodes.
Jinja
76
star
86

deskpi-super6c-cluster

DEPRECATED - DeskPi Super6c 6-node Raspberry Pi CM4 Cluster
76
star
87

docker-examples

There are many like it, but this one is mine.
Python
75
star
88

youtube-10k-pods

10,000 Kubernetes Pods for 10,000 Subscribers
74
star
89

docker-ubuntu2004-ansible

Ubuntu 20.04 LTS (Focal Fossa) Docker container for Ansible playbook and role testing.
Dockerfile
74
star
90

pi-bell-slapper

The King of Ding. Internet-connected Raspberry Pi-based notification bell.
OpenSCAD
74
star
91

baby-safe-temp

Safe temperature monitor for baby's room. Made for Raspberry Pi Pico.
Python
74
star
92

ansible-role-memcached

Ansible Role - Memcached
Jinja
68
star
93

ansible-role-node_exporter

Ansible role - Node exporter
Jinja
66
star
94

ansible-role-mailhog

Ansible Role - MailHog for catching and viewing emails
Shell
62
star
95

molecule-playbook-testing

This is an example from the Ansible 101 livestream
62
star
96

ansible-role-ssh-chroot-jail

Ansible Role - SSH chroot jail config
Shell
60
star
97

pi-nvr

Raspberry Pi NVR for home CCTV recording.
Dockerfile
58
star
98

Imap

Simple wrapper class for PHP's IMAP-related email functions.
PHP
57
star
99

Request

A simple PHP HTTP request class.
PHP
56
star
100

ansible-role-samba

Ansible Role - Samba
55
star