diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b57a6c2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,23 @@ +Copyright (c) 2014 +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md index fb8b332..fbd7d50 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,33 @@ DataHouse ========= -Collect an print different data like (temperature, humidity, electric consumption ...) +Collect an print different data like (temperature, humidity, electric consumption ...) and manage relays. -Add temperature -======== -To add a temperature (°C), juste acces to GET http://IP_Server:Port/addTemp/sensorMAC/value. -The sensor will be added into the database as the temperature. +## Compilation +### Dependencies + + * [Beego](https://github.com/astaxie/beego), a web framework. + +Download the CA at [https://kingpenguin.tk/ressources/cacert.pem](https://kingpenguin.tk/ressources/cacert.pem), then edit your .gitconfig and add the following lines +``` +[https "https://git.kingpenguin.tk"] + sslCAPath = /path/to/CA +``` + +Then go into your $GOPATH directory and go get the code. +```sh +go get git.kingpenguin.tk/chteufleur/datahouse.git +``` + +### Configure +Configure the web server by editing the ``conf/app.conf`` file. +Change the runmode from ``dev`` to ``prod``, specify information for database access and change the SessionHadhKey to whatever you whant. + + +## Sensors +Sensors code and schemas can be found in the sensors file. It requires Arduino IDE with ESP8266 module. +More information on [ESP8266 Github](https://github.com/esp8266/Arduino). + +## Help +To get any help, please visit the XMPP conference room at ``datahouse@muc.kingpenguin.tk`` with your prefered client, or [with your browser](https://jappix.kingpenguin.tk/?r=datahouse@muc.kingpenguin.tk).