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
Gladys is 100% written in Node.js, with the sails.js framework on the server-side, and AngularJS client-side.
- 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
The easiest way to get started is to install Gladys with NPM :
npm install -g gladysGladys is now located where you global node_modules are.
For example on Raspbian or on a Mac, it's located in :
/usr/local/lib/node_modules/gladys
To connect Gladys to your database, you need to modify environment variables.
You can set MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_PASSWORD and MYSQL_DATABASE.
Dirty way :
If you are not able to modify environment variables, you can enter your connections informations in the config/connections.js file.
Modify the following lines with your own informations :
sailsmysql: {
adapter: 'sails-mysql',
host: process.env.MYSQL_HOST || 'localhost',
port: process.env.MYSQL_PORT || 3306,
user: process.env.MYSQL_USER || 'root',
password: process.env.MYSQL_PASSWORD || 'root',
database: process.env.MYSQL_DATABASE || 'gladys'
},
Note : You need to create the database first in MySQL :
CREATE DATABASE gladys;
If you want to recompile assets and run all tasks, you can run :
grunt buildProd
Gladys create automatically all the tables it needs.
You need to execute the init file :
node init.jsnode app.js
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.
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.
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.