An home assistant on your Raspberry Pi built with Node.js
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Migrate from gladysproject to gladysassistant Jan 7, 2019
api Switch brain.classify to message.send Jan 29, 2019
assets Refresh new events in websockets on me view, Fix #440 (#471) Jan 29, 2019
cache add cache folder Mar 19, 2016
config Bugfix Gladys Gateway server url Jan 29, 2019
docker 🐳 Docker multiarch support (#465) Feb 6, 2019
logs adding log folder Jun 12, 2015
tasks Copy hooks assets not only in api/hooks folder but in production and … Dec 6, 2018
test Migrate from gladysproject to gladysassistant Jan 7, 2019
views Fix issue when 2 box charts are displayed, fix #462 (#463) Jan 28, 2019
.codeclimate.yml configure codeclimate Oct 16, 2016
.dockerignore 🐳 Update .dockerignore to fix docker image build (#479) Feb 7, 2019
.env-sample Added an env sample to list which variables are available to customiz… Dec 15, 2016
.eslintrc.json Fix linting issue Oct 12, 2018
.gitignore First commit Mar 13, 2018
.jsbeautifyrc Update .jsbeautifyrc Oct 12, 2018
.npmignore Adding .env to npmignore. Dec 15, 2016
.prettierrc.json Fix linting issue Oct 12, 2018
.sailsrc first commit Jun 5, 2015
.travis.yml 🐳 Docker multiarch support (#465) Feb 6, 2019
CHANGELOG.md Update CHANGELOG for Gladys v3.12.1 Feb 4, 2019
Gruntfile.js first commit Jun 5, 2015
LICENSE Change Gladys Project to Gladys Assistant in README Jan 28, 2019
README.md Add Raspbian image upgrade command Feb 4, 2019
apidoc.json remove url from apidoc.json (bug) Jan 27, 2017
app.js Remove old license header on each file Jul 14, 2018
dev.js Remove old license header on each file Jul 14, 2018
index.js in case of error, crash Mar 27, 2016
init.js Remove old license header on each file Jul 14, 2018
jsdoc.json Migrate from gladysproject to gladysassistant Jan 7, 2019
package.json 3.12.1 Jan 29, 2019
yarn.lock Upgrade yarn.lock Jan 28, 2019

README.md

Gladys Assistant

Build Status

Alt

What it does

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://gladysassistant.com
Community : https://community.gladysassistant.com/

Gladys Raspbian image has more than 32 000 downloads, and Gladys community has more than 3 000 members !

Who Am I ?

My name is Pierre-Gilles Leymarie, I'm an indie maker, and recently I decided to move part-time on this open-source project Gladys!

As I'm working completely for free for the community, you can Gladys with the Gladys Community Package, to help me pay my food and rent so I'll not die 🤤😄

Thanks a lot for your support 🙏

Specifications

Gladys is 100% written in Node.js.

Prerequisites

  • Node.js ( >= v8.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://gladysassistant.com for more informations.

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

git clone https://github.com/gladysassistant/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 CHARACTER SET utf8 COLLATE utf8_general_ci; -- 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

Upgrading Gladys inside the Raspbian image

Connect in command line to your Raspberry Pi, and execute the following command:

/home/pi/rpi-update.sh

This will download new upgrades, stop Gladys and restart Gladys with the new version.

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 requests are welcomed!

See Contributing.md.

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

Copyright & License

Copyright (c) 2013-2018 Gladys Assistant - Released under the MIT license.