Skip to content

Latest commit

 

History

History
85 lines (64 loc) · 2.86 KB

README.md

File metadata and controls

85 lines (64 loc) · 2.86 KB
Raw

DailyHOME

open home automation platform powered by openfaas targeted easy adaptation

Overview of DailyHOME

HOME automation Made Simple

DailyHOME platform make use of OpenFaaS for its core
Gateway : Handle UI and API call
ALEXA : Handle Alexa Request
Metric : Compute Mrtrics and Handle Metrics Request
APPS : User Defined Apps as Function 

MINIO: Store Device Info, Skill Definiton 
PROMETHEUS: Store Metrics

DailyIOT platform Stack

Getting Started

Daily-home platform runs completly on top of openfaas. To set up openfaas for the link: Openfaas Getting Started

Clone the repo

git clone https://github.com/dailyhome/daily-home.git && cd daily-home

Start the Registry (Consul)

Build locally (optional)

cd registry && ./build.sh

Deploy

cd registry && ./deploy.sh

Deploy the DIot Platform

./deploy.sh

After deployment go to http://127.0.0.1:8080/function/dhome-gateway

Login Page (default: admin/admin)

login

Dummy Switching Device

Switching Device

TODO
  • API - Implement HTTP API [dailyhome-gateway]
  • Implement Alexa skill [dailyhome-alexa]
  • API - Authtoken validation [dailyhome-gateway]
  • UI - Implement Glitchfree Switch Page [dailyhome-gateway]
  • UI - Implement Login Page with Cookie [dailyhome-gateway]
  • UI - Enable and Disable all switches [dailyhome-gateway]
  • UI - Ajax request to update/monitor state [dailyhome-gateway]
  • Create METRIC Service and find a way to Generate useful metrics based on API Request, Like:
    - daily/weekly total active period,
    - daily/weekly average active period etc
  • Template and SDK for Writing different IOT APP to run on the Platform (gateway, metric & alexa)
  • Integrate with OpenFaaS-cloud
  • Change password and token to secrets
  • UI/API - provide UI and API support to get the metric [dailyhome-gateway]
  • Use minio as storage to keep device info [dailyhome-gateway]
  • Custom switch name [dailyhome-gateway]
  • UI - Multiple Device Layout [dailyhome-gateway]
  • Write Documentation [dailyhome-gateway]
  • Find a way to create Routine (without Alexa)

Contribution guide

A Contribution can be in any form of a Suggestion/Idea/PR (Implementation/Documentation)/Review
To open an suggestion, Idea or Issue please create an issue at:
https://github.com/dailyhome/daily-home/issues
For a PR please create an issue detailing the Idea/Suggestion/Issue