Skip to content

Commit

Permalink
Added more info, pigpio, readme, ...
Browse files Browse the repository at this point in the history
  • Loading branch information
tomashora committed Nov 14, 2014
1 parent 90dcd4d commit c5ee2d5
Show file tree
Hide file tree
Showing 11 changed files with 565 additions and 654 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Apache License
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright {UniPi.technology} {Tomas Hora}
Copyright UniPi.technology - Miroslav Ondra, Tomas Hora; @Faster.cz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
50 changes: 47 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,48 @@
evok
====
# Evok - the UniPi API

UniPis' API
Evok is a main API and WEB interface for the UniPi (Raspberry Pi universal addon) board a sucessfull [IngieGogo] project. It provides REST, JSON, and WebSocket interface to relays, digital and analog inputs, analog output.

It is still in very early development state so more testing is appreciated.

Access to GPIOs is done using the fantastic [PIGPIO] library. Make sure to install it first before use.

It also uses some other python libraries that are not installed on Raspbian by default:
* python-ow
* [tornado]
* [toro]
* modified version of [tornardorpc] available in our repo [tornadorpc-unipi]
* jsonrpclib


### Installation
This is a todo section but basically everything that is needed is functional I2C subsystem (guide can be found on our wiki at www.unipi.technology/wiki), following libraries, installed and running pigpiod.
The evok folder should be located in /opt/, the example configuration can be found in etc/evok.conf and should be placed in that folder.
### Todo list:
* todo

### Known issues/bugs
* todo

### Todo list:
* automatic installation script
* authentication
* this readme

### Development
Want to contribute? Have any improvements or ideas? Great! We are open to all ideas. Contact us on info at unipi DOT technology

### License
----
Apache License, Version 2.0


Raspberry Pi is a trademark of the Raspberry Pi Foundation

[IngieGogo]:https://www.indiegogo.com/projects/unipi-the-universal-raspberry-pi-add-on-board
[UniPi]:http://www.unipi.technology
[PIGPIO]:http://abyz.co.uk/rpi/pigpio/
[tornado]:https://pypi.python.org/pypi/tornado/
[toro]:https://pypi.python.org/pypi/toro/
[tornardorpc]:https://github.com/joshmarshall/tornadorpc
[jsonrpclib]:https://github.com/joshmarshall/jsonrpclib
[tornadorpc-unipi]:https://github.com/UniPiTechnology/tornadorpc-unipi
159 changes: 0 additions & 159 deletions evok.conf

This file was deleted.

Loading

0 comments on commit c5ee2d5

Please sign in to comment.