trev/README.md

# 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. It’s 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)

# Dependicies and Requirements
## Hardware
- [x] Raspberry Pi
- [x] Arduino Uno Rev3
- [x] Heat-Sensor
- [x] Light-Sensor
- [x] RC-Transmitter (Receiver?)
- [x] IR-Transmitter
- [x] IR-Receiver
- [x] RC-Poweroutlets
- [x] LEDs

## Software
- [x] [Node.js](https://nodejs.org/en/)
- [x] [MySQL](http://www.raspberry-projects.com/pi/software_utilities/mysql)
- [ ] [Passport?](http://passportjs.org/)
- [x] [Serialport](https://www.npmjs.com/package/serialport)
- [x] [mysql](https://www.npmjs.com/package/mysql)
- [x] [Express](http://expressjs.com/)
- [x] [AngularJS](https://angularjs.org/)
- [x] [Ino](http://inotool.org/)
- [x] Raspberry Pi Arduino Package (`sudo apt-get install arduino`)

# Pins
## Analog
|Pin  | Function       |
|---- |--------------- |
|A0   | Temperature    |
|A1   | Light          |

## Digital
|Pin  | Function       |
|---- |--------------- |
| ~3* | IR-Trasmitter  |
|~10* | IR-Receiver    |
|~11  | RC-Trasmitter  |
|~13* | LED (Status)   |

The pins marked with an * are fixed and cannot be changed to another pin.

# Protocol
```
0,5 Byte Overhead
0,5 Byte Command
1 Byte Pin
6 Byte Value
----
8 Byte
```

## Description
All messages start with the header, which consits of a nibble:
```
0101
```
Those four Bits are followed by one of ten commands which are also encoded in a nibble e.g.:
```
0000 - toggle Debug mode
or combined
0101 0000 - Ascii: P / Dec: 80
```
The server side of the protocol deals with the messages as Ascii encoded strings. This is followed by the second byte which encodes the pin that shall be used:
```
Pin ranges digital: 110 0001 / Ascii: a / DEC: 97  - 110 1110 / Ascii: n / DEC: 110
Pin ranges analog:  110 1111 / Ascii: o / DEC: 111 - 111 0100 / Ascii: t / DEC: 116
```
Followed by six byte long value

## Possible Commands

- [x] 80 - P - toggle Debug
- [x] 81 - Q - set pin mode 
- [x] 82 - R - digital write
- [x] 83 - S - digital read
- [x] 84 - T - analog write
- [x] 85 - U - analog read
- [x] 86 - V - handle RC Decimal
- [x] 87 - W - handle RC TriState
- [x] 88 - X - handle IR send
- [x] 89 - Y - handle IR read

## Special Command
- [x] 90 - Z - Beginn Communication

## Possible future commands
- 91 - [ - 
- 92 - \ - 
- 93 - ] - 
- 94 - ^ - 
- 95 - _ -