Doorman home automation server

This repository contains a small home automation server that I installed on a Raspberry PI. It is written in Python/Flask and can easily be extended by putting new drivers into doormanhub/drivers, which are just Python module with a driver.py that contains an on_init() method.

Warnings

The code for this server was pieced together from multiple sources in a few hours, and includes numerous anti-patterns. Among other problems:

It uses tons of plain (garbage) JS code instead of a proper UI framework like Vue.
It puts static files into the app folder and serves them through Flask without caching them in nginx.
I am not planning to maintain it much. Pull requests and take-overs are welcome.

You have been warned. That said, it should work as intended and most of these issues could probably be fixed in a few hours, except for maybe the JS library part.

Getting started

Prerequisites

You need to have docker-compose installed. Doorman has Docker images for amd64 and arm64.

Choose a Docker image for your platform

To force Docker to use the right platform version, make sure to run

docker pull knipknap/doorman-hub:latest --platform linux/amd64

or on ARM:

docker pull knipknap/doorman-hub:latest --platform linux/arm/v7

or on ARM64:

docker pull knipknap/doorman-hub:latest --platform linux/arm64

Installation

First, you need to allow Docker containers to access your GPIO pins:

sudo chmod a+rw /dev/gpiomem

Is there a better way to do this without hard-coding the group or user ID of the host device into your Docker container? I am not aware of one, so if you are, let me know :-).

Lastly, to start Doorman, download the docker-compose.yml to your server, and type

docker-compose up

That's it. The server should be reachable on port 80.

Load the hub at startup

Put the following into /etc/systemd/system/doorman-hub.service:

[Unit]
Description=Doorman Hub Service
Requires=docker.service
After=docker.service

[Service]
WorkingDirectory=/home/pi
ExecStart=/usr/bin/docker-compose up
ExecStop=/usr/bin/docker-compose down
TimeoutStartSec=0
Restart=on-failure
StartLimitIntervalSec=60
StartLimitBurst=3

[Install]
WantedBy=multi-user.target

Note that WorkingDirectory must point to the directory containing the docker-dompose.yml.

You can then enable the service and start it:

sudo systemctl enable doorman-hub.service
sudo systemctl start doorman-hub