ClickPi

This project comes as a pre-built Docker image that enables you to utilize a relay and Raspberry Pi to open a gate, garage door, trigger a deer feeder or anything else that involves shorting a circuit. Includes a mobile-friendly admin dashboard and API endpoints that will allow you to manage users and control one or more relays from a single Raspberry Pi.

Screenshots

Hardware

This is the hardware I am using. You can certainly do this with less. A pi0, jumper wires, and any relay will work.

• Raspberry Pi 3B+
• RPi GPIO Terminal Block Breakout Board HAT
• HiLetgo 5V One Channel Relay Module
• 16 Gauge Wire Combo 6 Pack

Wiring

Installation

1. Install Docker:

• Docker Install Documentation

2. Add the current user to the docker group to avoid using sudo. You must lougout and back in after doing this, otherwise you will need to sudo the rest of the commands!:

sudo usermod -aG docker ${USER}

3. Create a docker-compose.yml file:

mkdir clickpi && cd clickpi && nano docker-compose.yml

4. Add this to the YAML file with your own parameters:

  services:
    click_pi:
      image: christracy/clickpi
      restart: unless-stopped
      privileged: true
      environment:
        FRIENDLY_NAME: "My Garage Door"       # Name of the device you're controlling. Will show up in logs and responses
        SECRET_KEY: "LongSuperSecretKey"      # This can be anything but it should be long, random, and kept secret
        ADMIN_PASSWORD: "SuperSecretPassword" # Password for the admin panel
        GPIO_PIN: "16"                        # GPIO PIN used for the trigger route (this is the GPIO number, NOT the pin number)

        #API_EXPIRATION_DAYS: 90  # Number of days before the API token will expire (Default: 365)
        #CLICK_DELAY: .50         # Time between closing and opening the relay on the trigger route (Default: .10)
        #TRIGGER_LIMIT: 5         # The amount of times the trigger routes can be called within 1 minute (Default: 8)
        
      volumes:
        - ./db:/data
        
      ports:
        - "5151:5151"
        - "5252:5252"

5. Bring up your stack by running:

docker compose up -d

Updating

docker-compose pull

docker-compose up -d

API

These are the API endpoints for the server:

Method	URI	Description	Params	Auth
POST	{default_host}/api/v1/trigger	Triggers the relay with the defualt GPIO pin		api_key
POST	{default_host}/api/v1/customtrigger	Triggers the relay but you can specify the GPIO pin and time	pin click_delay	api_key