Wakeus

A homemade wake up light designed to emulate the sunrise. The project contains three parts:

• Hardware server (Raspberry Pi Zero W + WS2812B LED strip + Python RPC server)
• Server (Golang REST API server + Golang RPC Client)
• Client (Simple React app)

Table of contents

1. Getting Started
2. Components
3. Raspberry Pi Zero W Headless Setup
4. Architecture

Getting Started

1. Make sure you have set up the hardware components
2. Make sure you have set up the pi
3. Run

   # clone this repo
   cd $HOME
   git clone https://github.com/james-woo/wakeus.git
   cd wakus
   
   # run docker compose
   docker-compose up -d

The strip should perform a test.

Components

Parts used in this project

• Raspberry Pi Zero W
• 5V WS2812X LED strip (WS2811, WS2812, WS2812B)
  • I would recommend the WS2812(B) strips because these strips have individually addressable LEDs (1 led/pixel)
  • WS2811 does not have individually addressable LEDs (3 leds/pixel)
  • These strips come in different densities (30 LEDs/m, 60 LEDs/m, etc.)
• Breadboard for prototyping
• Jumper wires (male to female)
• Jumper wires (male to male)
• Level shifter such as 74HC125 or CD4050, a buffer
  • converts Raspberry Pi 3.3V to LED strip 5V
• 5V DC Power supply
  • Amperage depends on number of LEDs the strip has
  • e.g. 1 LED can consume up to 60mA, if you have 60 LEDs that is 3.6A
• 470Ω resistor
• 1000µF capacitor

Here is what the initial prototype looks like.

Wiring

Corresponding wiring diagram

Final Setup

Top of PCB

Bottom of PCB

LEDs

Raspberry Pi Zero W Headless Setup

Setup your Pi without a screen

1. Download Raspian Stretch Lite ("lite" means no GUI)

2. Download Etcher

3. Flash Raspbian onto MicroSD with Etcher

4. You should see a new device named boot

5. Enable SSH, in boot create a file called ssh

6. Enable Wifi, in boot create a file called wpa_supplicant.conf

   # wpa_supplicant.conf
   country=CA
   ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
   update_config=1
   
   network={
    ssid="WIFI_SSID"
    scan_ssid=1
    psk="WIFI_PASSWORD"
    key_mgmt=WPA-PSK
   }

   ssh and wpa_supplicant.conf are configuration files that allow you to pre-configure the Raspberry Pi. Specifically, these two allow the Raspberry Pi to do two things: 1. enable SSH, and 2. Enable Wifi. If you notice that these two files disappear when you read the SD card on your computer, that is normal, the Pi deletes these files after reading them on boot.

7. Insert the SD card into the Pi. If you have done everything right, you should now be able to SSH into the Pi

8. SSH into the pi: ssh pi@raspberrypi.local (recommend to disconnect any other Pi's you have on the local network)

9. Update your password and enable SSH

   sudo raspi-config

10. Update and install libraries

    sudo apt-get update && sudo apt-get upgrade && sudo apt-get install -y \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg2 \
    software-properties-common \
    libffi-dev \
    libssl-dev \
    python \
    python-pip
    
    # Add Docker GPG key for Raspbian
    curl -fsSL https://download.docker.com/linux/raspbian/gpg | sudo apt-key add -
    
    # Setup Docker repository
    echo "deb [arch=armhf] https://download.docker.com/linux/raspbian $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list
    
    # Update package list
    sudo apt-get update
    
    # Install 18.06.2~ce~3-0~raspbian (Last known working version for Raspberry Pi Zero)
    sudo apt-get install -y docker-ce=18.06.2~ce~3-0~raspbian containerd.io
    
    # Add user to Docker group
    sudo usermod -aG docker $USER
    
    # Test
    sudo docker info
    sudo docker run arm32v5/hello-world
    
    # Install docker-compose
    sudo pip install docker-compose

    Note: I had to update my root password using sudo passwd root, and reboot

Architecture

The project consists of three main parts as shown in the diagram below

The LED strip, Raspberry Pi Zero W, and a mobile device. Both the Pi and mobile device can communicate directly with the hardware via RPC to perform any action the LED strip should perform. The mobile device can communicate directly with the Wakeus server to perform basic CRUD operations for Tasks.

gRPC codegen

• Go: protoc --proto_path=proto --proto_path=vendor --go_out=plugins=grpc:api/rpc service.proto
• Python: python -m grpc_tools.protoc --proto_path=proto --python_out=plugins=grpc:hardware --grpc_python_out=./hardware service.proto

Database connection

• docker exec --tty --interactive wakeus_database_1 psql -h localhost -U rpi -d wakeus

Hardware Server

The hardware server's job is to recieve any remote procedure calls (RPC's) and perform any hardware related actions.

Fade

Name	Type	Description
start_color	hash	The red, green, blue values ranging from 0-255
end_color	hash	The red, green, blue values ranging from 0-255
start_intensity	float	The intensity of the LEDs ranging from 0-1
end_intensity	float	The intensity of the LEDs ranging from 0-1
duration	int	The duration of the fade operation. The fade will start with the start_color, start_intensity and end with the end_color, end_intensity

Basic

Name	Type	Description
color	hash	The red, green, blue values ranging from 0-255
intensity	float	The intensity of the LEDs ranging from 0-1

Wakeus API

The primary purpose of this server is to provide a RESTful API around tasks created by the client. The task API allows you to list, view, edit, and create tasks.

POST /task

Name	Type	Description
type	string	The type of command, e.g. basic, fade
data	string	The arguments for the command
schedule	string	The schedule you want the command to run in cron expression format

Example

{
    "type": "fade",
    "data": {
      "start_color": {
        "r": 0,
        "g": -50,
        "b": -120
      },
      "end_color": {
        "r": 255,
        "g": 130,
        "b": 40
      },
      "start_intensity": 0,
      "end_intensity": 1,
      "duration":1200000
    },
    "schedule": "0 0 7 ? * MON,TUE,WED,THU,FRI"
}

List all tasks

GET /tasks

Response

Status: 200 OK
Link: localhost:8000/tasks

[
  {
    "type": "fade",
    "data": {
      "start_color": {
        "r": 0,
        "g": -50,
        "b": -120
      },
      "end_color": {
        "r": 255,
        "g": 130,
        "b": 40
      },
      "start_intensity": 0,
      "end_intensity": 1,
      "duration":1200000
    },
    "schedule": "0 0 7 ? * MON,TUE,WED,THU,FRI"
  }
]

Get a task

GET /task/:id

Response

Status: 200 OK
Link: localhost:8000/task/1

{
  "type": "fade",
  "data": {
    "start_color": {
      "r": 0,
      "g": -50,
      "b": -120
    },
    "end_color": {
      "r": 255,
      "g": 130,
      "b": 40
    },
    "start_intensity": 0,
    "end_intensity": 1,
    "duration":1200000
  },
  "schedule": "0 0 7 ? * MON,TUE,WED,THU,FRI"
}

Edit a task

PATCH /task/:id

Name	Type	Description
type	string	The type of command, e.g. basic, fade
data	string	The arguments for the command
schedule	string	The schedule you want the command to run in cron expression format

Example

{
    "type": "fade",
    "data": {
      "start_color": {
        "r": 0,
        "g": -50,
        "b": -120
      },
      "end_color": {
        "r": 255,
        "g": 130,
        "b": 40
      },
      "start_intensity": 0,
      "end_intensity": 1,
      "duration":1200000
    },
    "schedule": "0 0 7 ? * MON,TUE,WED,THU,FRI"
}

Response

Status: 200 OK
Link: localhost:8000/task/1

{
  "type": "fade",
  "data": {
    "start_color": {
      "r": 0,
      "g": -50,
      "b": -120
    },
    "end_color": {
      "r": 255,
      "g": 130,
      "b": 40
    },
    "start_intensity": 0,
    "end_intensity": 1,
    "duration":1200000
  },
  "schedule": "0 0 7 ? * MON,TUE,WED,THU,FRI"
}

Delete a task

DELETE /task/:id

Response

Status: 204 No Content

Wakeus Client

The primary purpose of the client is to provide the user the ability to set alarms, set tasks, or manual drive of the hardware.

Features

• Basic: set the color and intensity
• Fade: fade from one color to another with a duration
• Rainbow: cycle through rainbow colors
• Clear: turn off LEDs