5 files changed, 417 insertions, 0 deletions

diff --git a/doc/CHANGELOG b/doc/CHANGELOG
new file mode 100644
index 0000000..16206fd
--- /dev/null
+++ b/doc/CHANGELOG
@@ -0,0 +1,84 @@
+==0.6 (27/03/13)==
+   Added CoAP ([http://tools.ietf.org/html/draft-ietf-core-coap-14 draft-14]) implementation (Server and Client)
+   Added Python WebIOPi Client class (HTTP or CoAP with HTTP fallback)
+   Added Python WebIOPi MulticastClient class (CoAP)
+   Added Serial, I2C, SPI and 1-Wire  support
+     Python lightweight drivers with no dependency
+     Automatically load required linux modules
+     Added many device drivers, see [DEVICES device support page]
+   Added [Configuration] file
+   Added Serial monitor web app
+   Added Devices monitor web app
+   Added Devices abstractions Javascript class
+   Added GPIO digitalRead/Write and getFunction methods
+   Added Cache-Control REST response header
+   Added Server logging facility
+   Added jQuery-mobile
+   Improved button up/down handling on mobile devices
+   Fixed error fetching python-dev package during setup
+   Fixed webiopi-passwd missing execution flag when installing with PiStore
+   Fixed binary file serving
+   Fixed iOS6 Safari Mobile bug
+
+
+==0.5.3 (01/07/13)==
+   Added board revision REST URI (submitted by Andreas Riegg)
+   Added encrypted passwd file to store credentials used for HTTP authentication
+   Added webiopi-passwd command-line program to generate passwd file
+   Moved demo to examples/custom folder, added examples/basic
+   Changed /dev/mem access to allow webiopi import without root privileges when not using GPIOs
+   Disabled update checker to avoid "Update available" link
+   Improved GPIO error handling
+   Fixed encoding issue with python 2.x giving a blank page
+   Fixed setup script
+
+==0.5.2 (12/21/12 - PiStore only)==
+   Fixed blank page and file handling when server start at boot
+   Improved macros handling to allow zeo, one or more args
+   Added server loop helper
+   Improved setup.sh for the PiStore
+   Added play.sh for the PiStore to open the browser
+
+==0.5.1 (11/16/12)==
+===New Features===
+   REV 2 boards support
+   Added setup script to ease WebIOPi install
+   Use WebIOPi in your own Python scripts
+   Login/Password protection
+   Software PWM
+   Binary sequence output
+
+===Python Server & REST API===
+   Usable as a library
+   Added Python 3 support
+   Removed RPi.GPIO library dependency
+   Improved security
+   Improved file serving
+   Improved REST API
+   Added ability to use custom REST macro
+   Added ability to output a single pulse
+   Added ability to output a binary sequence
+   Added software PWM
+
+===Javascript Library===
+   Improved and simplified
+   Added ability to create custom buttons with one or two callbacks (mousedown and mouseup)
+   Added helpers for new REST functions (macro, pulse, sequence, PWM, ...)
+
+===Other changes===  
+   PHP Server discontinued
+
+
+==0.3 (08/27/12)==
+   Fixed security issue in the Python server
+   Python server general improvements
+   Python server display real IP
+   Allow PHP5 < 5.4 (Works on Debian wheezy)
+   Added update tracking
+   Refactored Javascript code to be used as a library
+   Changed IDs and CSS naming
+   Added expert app
+
+
+==0.2 (08/21/12)==
+   Initial release
\ No newline at end of file
diff --git a/doc/INSTALL b/doc/INSTALL
new file mode 100644
index 0000000..e34f9db
--- /dev/null
+++ b/doc/INSTALL
@@ -0,0 +1,46 @@
+WebIOPi is developed and tested on Raspbian.
+
+You only need Python, either 2.7 or 3.2. Download, then extract and install WebIOPi. The setup script will automatically download and install required dependencies using apt-get. You may have to manually install GCC and Python development headers if you are not using Raspbian.
+
+$ wget http://webiopi.googlecode.com/files/WebIOPi-0.6.0.tar.gz
+$ tar xvzf WebIOPi-0.6.0.tar.gz
+$ cd WebIOPi-0.6.0
+$ sudo ./setup.sh
+
+Finally, run Python using webiopi command :
+$ sudo webiopi [-h] [-c config] [-l log] [-s script] [-d] [port]
+
+    Options:
+      -h, --help           Display this help
+      -c, --config file    Load config from file
+      -l, --log file       Log to file
+      -s, --script file    Load script from file
+      -d, --debug          Enable DEBUG
+
+    Arguments:
+      port                 Port to bind the HTTP Server
+ 
+You're done, and ready to enjoy WebIOPi ! But the server and GPIO state will be lost when you'll stop the script (CTRL-C) or close the terminal.
+
+You can also start/stop the background service :
+$ sudo /etc/init.d/webiopi start
+and
+$ sudo /etc/init.d/webiopi stop
+
+You can even setup your system to start webiopi at startup :
+$ sudo update-rc.d webiopi defaults
+
+
+=Usage=
+If your are directly using your Raspberry Pi with keyboard/mouse/display plugged,  open a browser to http://localhost:8000/
+
+If your Raspberry Pi is connected to your network, you can open a browser to http://raspberrypi:8000/ with any device of your network. Replace raspberrypi by its IP.
+
+You can even add a port redirection on your router (and/or use IPv6) to control your GPIOs over Internet !
+
+Default user is "webiopi" and password is "raspberry"
+
+By choosing the GPIO Header link on the main page, you will be able to control GPIO using a web UI which looks like the board header.
+   Click/Tap the OUT/IN button to change GPIO direction.
+   Click/Tap pins to change the GPIO output state.
+http://trouch.com/wp-content/uploads/2012/08/webiopi-chrome.png
\ No newline at end of file
diff --git a/doc/LICENSE b/doc/LICENSE
new file mode 100644
index 0000000..4112d3e
--- /dev/null
+++ b/doc/LICENSE
@@ -0,0 +1,204 @@
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..f17ecc9
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,60 @@
+===WebIOPi is a fully integrated Internet of Things framework for the Raspberry Pi.===
+   Control, debug, and use your Pi's GPIO locally or remotely, from a browser or any app.
+   WebIOPi is the perfect Swiss-knife to make connected things with the Raspberry Pi.
+   Developed and provided by Eric PTAK, french R&D engineer in networks, software, and Internet of Things.
+
+===Features===
+   REST API over HTTP and CoAP (draft-14) with multicast support
+   Server written in Python with zero dependency
+   Supports GPIO, Serial, I2C, SPI, 1-Wire with zero dependency
+   Supports more than [DEVICES 30 devices] including DAC, ADC, sensors...
+   Full Python library for the Server, GPIO, Serial, I2C, SPI and devices drivers
+   Compatible with both Python 2 and 3
+   Extensible and highly customizable
+   Login/Password protection
+   Mobile devices compatible
+   Includes debug web apps
+     GPIO Header
+     GPIO List
+     Serial Monitor
+     Devices Monitor
+   Javascript client library built on top of jQuery
+   Python client library with HTTP and CoAP support
+
+===What for===
+   Use webiopi.GPIO library to control GPIO in your Python scripts
+   Use devices drivers to interact with DAC, ADC, sensors and more in your Python scripts
+   Use Serial, I2C and SPI webiopi classes in your Python scripts
+   Use the GPIO Header web-app to play with GPIO and debug circuits
+   Use the Serial Monitor web-app to debug Serial devices
+   Use the Devices Monitor web-app to debug devices like DAC, ADC, sensors and more
+   Create a web-app with the Javascript library to remote controls things connected on GPIO
+   Add webiopi in your existing Python script to simply add all WebIOPi features
+   Extends webiopi with your own macro
+   Extends webiopi with scripts loading facilities in a Arduino fashion way (setup, loop, destroy)
+   Use the Python Client to make Pi-2-Pi communication through the REST API
+   Use the Python Multicast Client to control multiple Pis with a single REST call
+   Use the Java Client to use the REST API from a Java application, including Android
+   Use the REST API from any technology/language
+
+===Where to start===
+   [INSTALL Installation]
+   [http://groups.google.com/group/webiopi Support & Discussion]
+   [http://trouch.com Developer's Blog (Eric/trouch)]
+   [http://issuu.com/themagpi/docs/issue9final?mode=window WebRobotCam Part 1 in MagPi #9] by Eric
+   [http://issuu.com/themagpi/docs/issue10final?mode=window WebRobotCam Part 2 in MagPi #10] by Eric
+   [http://www.youtube.com/watch?v=wGahWkjettw Video tutorial] by RaspberryPiBeginners
+
+<p></p>
+
+http://trouch.com/wp-content/uploads/2012/11/webiopi-architecture.png
+
+http://trouch.com/wp-content/uploads/2012/08/webiopi-chrome.png
+
+http://trouch.com/wp-content/uploads/2013/03/webiopi-0.6-serialmon.png
+
+http://trouch.com/wp-content/uploads/2013/03/webiopi-0.6-devices1.png
+
+<p></p>
+
+<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
diff --git a/doc/updatedoc b/doc/updatedoc
new file mode 100755
index 0000000..aa0e5bc
--- /dev/null
+++ b/doc/updatedoc
@@ -0,0 +1,23 @@
+#!/bin/sh
+
+if [ -z "$*" ]; then
+        files=`ls`
+else
+        files="$*"
+fi
+
+for file in $files; do
+        echo "Downloading $file..." 
+        wget -q http://webiopi.googlecode.com/svn/wiki/$file.wiki &&
+        echo "Processing $file..." &&
+        mv $file.wiki $file &&
+        sed -i 's/<font color="red">\|<\/font>//g' $file &&
+        sed -i 's/<pre>\|<\/pre>//g' $file &&
+        sed -i 's/[_*]//g' $file &&
+        sed -i '/{{{\|}}}/d' $file &&
+        echo "$file OK" ||
+        echo "$file not on wiki"
+done
+
+echo "Uploading changes on SVN..."
+svn commit -m "updated doc from wiki"
\ No newline at end of file