cFlat - Smart Home Gateway

cFlat is an docker integration platform on RPI for easy integration of various devices into the Apple Home Kit universe.

Note:

cFlat 0.0.x alpha is a preliminary release intended primarily for developers and advanced users only

[GERMAN]:

(Anmerkung: Dieses Dokument ist eine Rohfassung, aber um fünf Uhr Morgens kann man von mir keine grossen journalistische Ergüsse erwarten, Sorry)

cFlat ist eine Integrationsplattform zur vereinfachten Einbindung verschiedener Smart Home Geräte ins Apple Homekit Universum. Die Plattform basiert auf HypriotOS, diese Distribution wurde für den Einsatz von Docker optimiert. Das OS selbst, setzt auf einer Debian-basierten Distribution (Raspbian Lite) auf und ist somit auf allen Raspberry Pi. Modellen (ARMv6 & ARMv7) und deren Artverwandten lauffähig.

Um die Grösse der einzelnen Images so gering wie möglich zu halten, basieren diese, wenn möglich, auf Alpine Linux, deren Basisgrösse bei 5 MB liegt.

Es sind folgende Service/Komponenten implementiert:

• homebridge
• node-red
• mqtt (Brocker)
• docker-ui
• proxy
• watchtower (noch nicht implementiert)

Environment

Es ist sind zwei Umgebungen implementiert, wobei diese in verschiedenen „Modi“ (prod/dev/debug) gestartet werden. Diese sind wenn nötig, als npm-scripts in den jeweiligen Services definiert (siehe cflat-homebridge).

1. Produktion

   • prod-mode: → docker-compose.prod.yml → „npm run prod“

2. Development

   • dev-mode: → docker-compose.dev.yml → „npm run dev“
   • debug-mode: → docker-compose.debug.yml → „npm run debug“

Die Compose Files sind so aufgebaut, dass sie die Definitionen voneinander „erben“ und somit nur die jeweilige Spezialisierung (es lebe der OO Gedanke) definiert werden muss.

Hierarchie: Produktion (root) → Development → Debug

CLI interface

Zur einfacheren handhabe des Systems, wird ein einfaches Script (cflat.sh) bereitgestellt, über das die Platform gesteuert werden kann.

# Init platform
./cflat.sh init

# Build platform
./cflat.sh build [ARG...]

# Run platform in prod-mode
./cflat.sh prod [ARG...]
# Run platform in dev-mode
./cflat.sh dev [ARG...]
# Run platform in debug-brk-mode
./cflat.sh debug-brk [ARG...]

# Shutdown platform
./cflat.sh shutdown [ARG...]

# View logfiles
./cflat.sh logs [ARG...]

Getting Started

Step-1. Install hypriotOS on RPI Documentation

flash -n [hostname] -s [ssid] -p [password] https://github.com/hypriot/image-builder-rpi/releases/download/[ver]/hypriotos-rpi-[ver].img.zip
# eg:
flash -n cflat https://github.com/hypriot/image-builder-rpi/releases/download/v1.4.0/hypriotos-rpi-v1.4.0.img.zip

Step-2. Login

# (default-password 'hypriot')
ssh pirate@cFlat.local
# change default-password (important for security reason)
passwd

Step-3. Clone github

git clone https://github.com/cgHome/cflat.git
chmod +x cflat/cflat.sh

Step-4. Build

# Init platform
./cflat.sh init

# Build whole platform
./cflat.sh build    # (drink a coup of coffee)

Step-5. Usage

# Run - production
./cflat.sh prod

# View log-files
./cflat.sh logs

# Install Plugin
homebridge/homebridge.sh installPlugin homebridge-XXXX

# Edit config.json
nano homebridge/data/config.json  # (after save, it will restart automatically)

# Uninstall Plugin
homebridge/homebridge.sh uninstallPlugin homebridge-XXXX

# Check (UI will be reworked)
http://cflat.local:8080/
http://cflat.local/docker/
http://cflat.local/node-red/

Install Development-System

Install samba-client on RPI/hypriotOS

sudo apt-get update
sudo apt-get install smbclient cifs-utils

Mount RPI to Dev-Server

sudo mount.cifs //[ip]/[repo] /mnt/smb/ -o user=[username],password=[password],rw,file_mode=0777,dir_mode=0777
e.g.:
sudo mount.cifs //192.168.188.xx/repo /mnt/smb/ -o user=Chris,rw,file_mode=0777,dir_mode=0777

Setup samba-share

For terminal hater

# Set samaba user & password
sudo smbpasswd -a pirate

# Save samba.conf
sudo cp /etc/samba/smb.conf /etc/samba/smb.conf.bak

# Add to samba.conf
security = user

[pirate]
path = /home/pirate/
writeable = yes
guest ok = no

# Test samba.conf
testparm

# Restart samba to use the new configuration file.
sudo /etc/init.d/samba restart

Used open source components

• homebridge - HomeKit support for the impatient
• Node-RED - A visual tool for wiring the Internet of Things
• portainer - Simple management UI for Docker
• mosquitto - MQTT - Broker
• traefik - HTTP reverse proxy
• hypriotOS - DockerOS for Raspberry Pi

ToDo

• Docu, Docu ....
• Basic UI
• SSL/TSL - Support

Copyright and license

Copyright 2016, 2017 cgHome under MIT License