add README

This commit is contained in:
Shannon Sterz 2016-01-11 21:14:54 +01:00
parent 0c4ffa6f3b
commit 2db9e6cf32

28
README.md Normal file
View file

@ -0,0 +1,28 @@
# Home Automation
## Vision
This should work in such a way that the user logs into a web interface where they then should be able to easily control their home. A lot like heimcontrol.js, however with a cleaner interface and less wasted space. On the technical side it would be nice to have a better protocol than the one used by duino, which seems counterintuitive. Its not a binary protocol, but rather a text based one, which is odd. It would also be nice if there were a easier way to set up device maybe I could use receivers to learn patterns of, for example IR-remotes, that I then could replicate with the transmitter. It would also be nice to have the capability to schedule tasks. Turning on the radio to wake me up or being able to switch of the lights automatically for example.
## Links
- [duino](https://github.com/ni-c/duino)
- [heimcontrol.js](http://ni-c.github.io/heimcontrol.js/)
- [serialport](https://www.npmjs.com/package/serialport)
## Hardware Requirements
- [x] Raspberry Pi
- [x] Arduino Uno Rev3
- [x] Heat-Sensor
- [x] Light-Sensor
- [x] RC-Transmitter/Receiver
- [ ] IR-Transmitter/Receiver
- [x] RC-Poweroutlets
- [x] LEDs
## Software Requirements
- [x] [Node.js](https://nodejs.org/en/)
- [ ] MySQL
- [ ] [Passport?](http://passportjs.org/)
- [x] [Serialport](https://www.npmjs.com/package/serialport)
- [ ] [mysql](https://www.npmjs.com/package/mysql)
- [ ] [Express](http://expressjs.com/)
- [ ] [AngularJS](https://angularjs.org/)