Home automation, made simple again!
This repository contains the server side code of the Hestia home automation system. The idea behind this project is to create a simple home automation system. We strive to provide a platform that can extend to new types of peripherals without needing structural changes. In the end, it should be possible for consumers to create their own plugins for the system that allow the hestia platform to work with their peripherals as well.
Currently, we are in the development phase of this project. What we have here is what we call our MVP. It is a barebones system with one functional plugin, which is for the Philips Hue. The current audience is still the homebrew and diy community that is willing to do a little setup to get the system working.
The final goal is to make the hestia platform and thus the server easy to work work with, secure and plug and play.
To run the server on the Raspberry Pi (or any other debian based system) you
can use the following command to download and install the server.
wget -O - https://raw.githubusercontent.com/RUGSoftEng/2017-Hestia-Server/master/setup_and_run_on_rasberry_pi.sh | bash -
To setup a development environments or to run the server you can follow these steps.
First, you run dev_setup.sh contained in the root directory of this project.
Then, if you want to run the application from the command you first have to
source the virtual environment activator.
If you have no idea where it is situated it is probably in its default location
so you run source ~/.virtualenvs/hestia/bin/activate.
If you changed the default location you probably know where to find it.
Then to run the application you run python source/application.py dev.
If you are using a pycharm as an IDE you need to go to File | Settings | Project | Project Interpreter
and select the virtual environment named "hestia".
Also you need to add the script parameter dev to your run configuration.
Pycharm will take care of the rest.
The server has a public REST api to interact with. Since we are still in the early beta stage (0.x.y version numbers) no guarantees are made about the stability of the current api. In other words, expect it to change in the near future.
To get an overview of the current public REST api it is best to start up an
instance of the server and to navigate to the port 8000.
Here a nice swagger UI is shown similar to the picture below.
It shows the current state of the current API and allows you to interact with
the server.
