summaryrefslogtreecommitdiffstats
path: root/doc/README
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README')
-rw-r--r--doc/README60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..f17ecc9
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,60 @@
1===WebIOPi is a fully integrated Internet of Things framework for the Raspberry Pi.===
2 Control, debug, and use your Pi's GPIO locally or remotely, from a browser or any app.
3 WebIOPi is the perfect Swiss-knife to make connected things with the Raspberry Pi.
4 Developed and provided by Eric PTAK, french R&D engineer in networks, software, and Internet of Things.
5
6===Features===
7 REST API over HTTP and CoAP (draft-14) with multicast support
8 Server written in Python with zero dependency
9 Supports GPIO, Serial, I2C, SPI, 1-Wire with zero dependency
10 Supports more than [DEVICES 30 devices] including DAC, ADC, sensors...
11 Full Python library for the Server, GPIO, Serial, I2C, SPI and devices drivers
12 Compatible with both Python 2 and 3
13 Extensible and highly customizable
14 Login/Password protection
15 Mobile devices compatible
16 Includes debug web apps
17 GPIO Header
18 GPIO List
19 Serial Monitor
20 Devices Monitor
21 Javascript client library built on top of jQuery
22 Python client library with HTTP and CoAP support
23
24===What for===
25 Use webiopi.GPIO library to control GPIO in your Python scripts
26 Use devices drivers to interact with DAC, ADC, sensors and more in your Python scripts
27 Use Serial, I2C and SPI webiopi classes in your Python scripts
28 Use the GPIO Header web-app to play with GPIO and debug circuits
29 Use the Serial Monitor web-app to debug Serial devices
30 Use the Devices Monitor web-app to debug devices like DAC, ADC, sensors and more
31 Create a web-app with the Javascript library to remote controls things connected on GPIO
32 Add webiopi in your existing Python script to simply add all WebIOPi features
33 Extends webiopi with your own macro
34 Extends webiopi with scripts loading facilities in a Arduino fashion way (setup, loop, destroy)
35 Use the Python Client to make Pi-2-Pi communication through the REST API
36 Use the Python Multicast Client to control multiple Pis with a single REST call
37 Use the Java Client to use the REST API from a Java application, including Android
38 Use the REST API from any technology/language
39
40===Where to start===
41 [INSTALL Installation]
42 [http://groups.google.com/group/webiopi Support & Discussion]
43 [http://trouch.com Developer's Blog (Eric/trouch)]
44 [http://issuu.com/themagpi/docs/issue9final?mode=window WebRobotCam Part 1 in MagPi #9] by Eric
45 [http://issuu.com/themagpi/docs/issue10final?mode=window WebRobotCam Part 2 in MagPi #10] by Eric
46 [http://www.youtube.com/watch?v=wGahWkjettw Video tutorial] by RaspberryPiBeginners
47
48<p></p>
49
50http://trouch.com/wp-content/uploads/2012/11/webiopi-architecture.png
51
52http://trouch.com/wp-content/uploads/2012/08/webiopi-chrome.png
53
54http://trouch.com/wp-content/uploads/2013/03/webiopi-0.6-serialmon.png
55
56http://trouch.com/wp-content/uploads/2013/03/webiopi-0.6-devices1.png
57
58<p></p>
59
60<p align="center"><a href="https://www.paypal.com/cgi-bin/webscr?cmd=s-xclick&hostedbuttonid=79EM7ZV9FQ4HU">https://www.paypal.com/enUS/i/btn/btndonateCCLG.gif</a></p> \ No newline at end of file