This repo was moved to https://github.com/GladysAssistant/gladys-4-docs
The Project • Getting Support • Contributing • Todo • Links • Copyright & License
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 !
If you're looking for some quick links to get you started, try these:
- Detailed install guides EN | Detailed install guides FR
- Full Documentation EN | Full Documentation FR
- Full API reference EN | Full API reference FR
- Frequently Asked Questions EN | Frequently Asked Questions FR
If you're stuck on something and need a helping hand, you'll find a large community of thousands of Gladys users over on the official Gladys forum. Search to see if someone has gotten stuck on the same thing before! If not, feel free to start a new topic 🤗
If you're interested in contributing to our docs either with content or code, we can always use the help ! All of this is open source so that anyone can get involved if they have fixes or improvements to add.
Please check the to-do list and send me a message or create a issue if you decide to contribute. 😄
- Intro ✅
- Image ✅
- Docker ✅
- Manual
- Intro ✅
- House ✅
- Room ✅
- Machine
- Localisation
- Android
- IOS
- Gladys Voice
- Gladys Bluetooth
- Intro
- Alarm
- Event
- Event type
- Scenario
- Device
- Device type
- Area
- Internal module
- External module
- Intro
- Architecture
- Data model
- Intro
- API REST
- API NodeJS
- API MQTT
- Gladys POD (In progress) 🕝
- Gladys MQTT Adapter
- Internal module
- External module
- Script
Copyright (c) 2018 Gladys Project - Released under the MIT license