/Gladys

Your home assistant on your Raspberry Pi built with Node.js

Primary LanguageJavaScriptOtherNOASSERTION

Gladys Project

npm version Build Status Code Climate Join the chat at https://gitter.im/GladysProject/Gladys

Alt

The Project

Gladys is an home automation assistant to help you in your everyday life.

Yes, like a kind of JARVIS!

Gladys is connected to all your devices in your home, she is connected to your calendar, to a lots of API to help you. But let's pick an example :

  • It's 8 AM. Gladys wakes you up automatically because she knows that you need to be at work at 9 AM, and that according to the traffic, you'll need 30min to go to work with your car. She knows that you like 30 min to get ready. She wakes you up with a soft progressive warm light thanks to your Philips Hue, and puts a nice music in your room.
  • It's 8.10 AM, Gladys detects thanks to a motion sensor that you are getting out of bed. She immediately starts the wake-up scenario : she tells the coffee machine to prepare the coffee, and opens the blinds.
  • At 8.30 AM, you leave the house. Gladys detects thanks to your smartphone that you are not at home anymore, and shuts down everything inside.
  • At 6.30 PM, you are getting back home : Everything is ready when you arrive.
  • You are going to sleep, so you simply put your phone on your nightstand where a NFC tag is sticked. It immediately sends a request to Gladys to tell here you are going to sleep. She starts the "Going to sleep" scenario, and turns off all lights.

This is just a simple scenario, possibilities with Gladys are just endless ! Don't hesitate to propose yours :)

Interested in Gladys ? Try it at home, it's free and Open Source !

Website : https://gladysproject.com
Community : https://community.gladysproject.com/

🎉🎉 Subscribe to our newsletter in English or in French 🎉🎉

Gladys Raspbian image has more than 26 000 downloads, and Gladys community has more than 2 000 members !

Specifications

Gladys is 100% written in Node.js.

Prerequisites

  • Node.js ( >= v4.x.x )
  • MySQL
  • Command Line Tools
  •  Mac OS X: Xcode (or OS X 10.9 Mavericks: xcode-select --install)
  •  Windows: Visual Studio
  •  Ubuntu, Debian: sudo apt-get install build-essential

Getting Started

The easiest way to get started is to install on a Raspberry Pi Gladys with the Raspbian image. See https://gladysproject.com for more informations.

But you can also install Gladys manually to develop on it:

git clone https://github.com/GladysProject/gladys gladys
cd gladys
npm install

If you want to use grunt, install grunt-cli :

npm install -g grunt-cli

Connect Gladys to MySQL

To connect Gladys to your database, you will need to set some environment variables. To do so, you'll have to create a .env file at the root of this project. The content of this file can be found by looking at .env-sample, which lists all the customizable env vars.

Note : You will need to create the database as well in MySQL:

CREATE DATABASE gladys; -- or whatever name you've set in your .env file.`

Compile assets

If you want to recompile assets and run all tasks, you can run :

grunt buildProd

Create tables

Gladys create automatically all the tables it needs.

You need to execute the init file :

node init.js

Start Gladys

node app.js

Visit Gladys dashboard

If you are on localhost, visit : http://localhost:1337 (in development mode), orhttp://localhost:8080 (in production).

If you want to access Gladys anywhere on your local network, just replace localhost by the ip of your machine.

Starting Gladys in development mode

To start Gladys on your machine in development mode, and connect to your local MySQL instance, you can create a .env file at the root of your Gladys folder with the following content:

MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=YOUR_MYSQL_USER
MYSQL_PASSWORD=YOUR_MYSQL_PASSWORD
MYSQL_DATABASE=YOUR_GLADYS_DBNAME

Then, to start Gladys in dev mode:

npm start

FAQ

npm install returns me a lot of errors !

Make sure that node-gyp is working fine. Wait, what is node-gyp ?

Node-gyp is a cross-platform command-line tool written in Node.js for compiling native addon modules for Node.js.

To be sure that you're doing that good, check node-gyp installation guide.

Contributing

Pull request are welcome, but code must follow some guidelines.

  • Use JSHint.
  • For the AngularJS client code, follow John Papa's Angular Style Guide.
  • Please Unit test your code. We use Mocha and Istanbul for code coverage. No pull requests will be accepted without good unit tests.

If you want to develop a new functionality, develop a Gladys Module instead of modifying the core! More about modules on the website.

Links

Community

Gladys it's not just a project, it's a community of people. And we like to meet in real life!

See more on our Instagram account:

Alt