Afroescprogram

.gitignore

@@ -0,0 +1,41 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db
+
+
+node_modules
+src/capture
+temp
+.idea
+etc/rovconfig.json

.scrutinizer.yml

@@ -0,0 +1,7 @@
+tools:
+    js_hint:
+        use_native_config: false
+        config:
+            laxcomma: true
+filter:
+    excluded_paths: [src/static/bower_components/*,src/static/js/libs/*, dashboard/src/static/js/libs/*, dashboard/src/plugins/99_software/public/js/*.min.js, dashboard/src/plugins/99_software/public/js/jquery.ui.widget.js, dashboard/src/plugins/99_software/public/upload/js/vendor/jquery.ui.widget.js, src/plugins/touchcontroller/public/js/gamecontroller.js]

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - 0.8

CONTRIBUTING.md

@@ -0,0 +1,142 @@
+# Contributing to this project
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of
+the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue or assessing
+patches and features.
+
+
+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bugs),
+[features requests](#features) and [submitting pull
+requests](#pull-requests), but please respect the following restrictions:
+
+* Please **do not** use the issue tracker for personal support requests (use
+  [OpenROV Forums](http://openrov.com/forum)).
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and
+  respect the opinions of others.
+
+
+<a name="bugs"></a>
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
+   latest `master` or development branch in the repository.
+
+3. **Isolate the problem** &mdash; create a [reduced test
+   case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What browser(s) and OS
+experience the problem? What would you expect to be the outcome? All these
+details will help people to fix any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the browser/OS environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+
+<a name="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+
+<a name="pull-requests"></a>
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code, porting to a different language),
+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project.  The OpenROV [Software Forum](http://openrov.com/forum/categories/software/listForCategory) is a great place to discuss.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+Follow this process if you'd like your work considered for inclusion in the
+project:
+
+1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/<repo-name>
+   # Navigate to the newly cloned directory
+   cd <repo-name>
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/<upstream-owner>/<repo-name>
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout <dev-branch>
+   git pull upstream <dev-branch>
+   ```
+
+3. Create a new topic branch (off the main project development branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these [git commit
+   message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your code is unlikely be merged into the main project. Use Git's
+   [interactive rebase](https://help.github.com/articles/interactive-rebase)
+   feature to tidy up your commits before making them public.
+
+5. Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream <dev-branch>
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.

LICENSE

@@ -0,0 +1,13 @@
+License
+-------
+
+MIT License
+
+Copyright (C) 2013 OpenROV Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

OpenROV Plugin Architecture.md

@@ -0,0 +1,39 @@
+>The plugin architecure for OpenROV are the conventions used to extend how the the rov and its software behave. 
+
+##Goals for plugins:
+
+1. **Isolate all functions to encourage hacking.** Community members will take more risks and make more amazing things if area's they want to improve such as how lights work won't impact areas they may be less comfortable with such as motor control.
+2. **Have a single plugin module that cuts across all layers of the ROV architecture** as needed that can be versioned and deployed as a single package.
+3. **Keep each layer of the plugins as native to that layer of the ROV architecture as possible.**  A plugin system that takes a lot of memory but is well abstracted at the browser level would probably be a disaster in the memory constrained, embedded program feel of the Arduino.
+4. **Allow the community to make plugins available without having to submit them to OpenROV** to encourage the development of new and conflicting ideas of how ROVs operate, and to open the door for other ROV projects to adopt all or part of what the OpenROV community has developed in their projects.  
+
+##Approach:
+
+I would like to call out Laurent Eschenauer and his [ardrone-webflight](https://github.com/eschnou/ardrone-webflight) project that so heavily inspired the javascript and node plugin solution.  If you are using ardrone you should check it out. 
+
+###Plugin Package
+The plugins are directory based and intended to be listed and managed using twitter's bowser web package manager.  
+
+- PluginName\
+	- bower.json (bower.io metadata about plugin)
+	- index.js (node.js plugin)
+	- public\
+		- css\
+			- PluginName.css
+		- js\
+			- PluginName.js (browser plugin)
+	- microcontroller\
+		- PluginName.h
+		- PluginName.cpp (Arduino plugin)
+		- Supportfiles.h
+		- Supportfiles.cpp
+
+###Browser Plugin
+The browser plugin is a two part plug-in.  The node.js process uses a templating engine to crawl the plugin directory and find all of the plugins.  It then inserts scripts tags for the .js files and tags for the .css files in to the page being loaded.  
+The .js files that are loaded have a convention where they register themselves as javascript functions in a global `plugin[]` variable. The plugin's are activated by a loop in the browser javascript code that instantiates each item in the global `plugin[]` variable.
+
+###Node.js Plugin
+When the node.js process starts, it crawls the configured plugin directly for index.js files in each folder it fines. Is then simply loads the .js file.  
+
+###Arduino Plugin
+The firmware-install shell script copies the base source code to a temporary folder. It then crawls the plugin folder for the Arduino code, copies that code in to the same temporary folder and then injects code to register the plugin in to the plugins.cpp file which get statically linked during the compile process.  Each plugin has a convention based on deriving from the device class.  Any device class simply extends the hooks Arduino programs typically use, so it exposes a device_loop() and device_setup() method.  

README.md

@@ -0,0 +1,138 @@
+[![Views in the last 24 hours](https://sourcegraph.com/api/repos/github.com/OpenROV/openrov-software/counters/views-24h.png)](https://sourcegraph.com/github.com/OpenROV/openrov-software)
+[![Build Status](https://secure.travis-ci.org/OpenROV/openrov-software.png?branch=master)](http://travis-ci.org/OpenROV/openrov-software)
+[![Code Climate](https://codeclimate.com/github/OpenROV/openrov-software.png)](https://codeclimate.com/github/OpenROV/openrov-software)
+[![Coverage Status](https://coveralls.io/repos/OpenROV/openrov-software/badge.png)](https://coveralls.io/r/OpenROV/openrov-software)
+[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/OpenROV/openrov-software/badges/quality-score.png?s=c24130cbf17aaa23f2680e3b45a0ec675ef2037f)](https://scrutinizer-ci.com/g/OpenROV/openrov-software/)
+[![Code Coverage](https://scrutinizer-ci.com/g/OpenROV/openrov-software/badges/coverage.png?s=e356e3047940fb7ea47e36477c6064e23fee12c0)](https://scrutinizer-ci.com/g/OpenROV/openrov-software/)
+
+OpenROV Cockpit
+================
+
+"[OpenROV](http://openrov.com/) is a DIY telerobotics community centered around underwater exploration & adventure."  One goal of OpenROV is to have onboard video for live viewing as the user operates the ROV.  Enter: OpenROV Cockpit.
+
+Getting started
+---------------
+
+**If you just getting started and want to have working environment for the OpenROV Cockpit, we recommend that you start with using our last stable release from our [releases page](https://github.com/OpenROV/openrov-software/releases).  If you want to explore building your own image from scratch, refer to our  
+[OpenROV disk Image](https://github.com/OpenROV/openrov-image/blob/master/README.md) project.  The latest development image (from master) can be downloaded from http://54.187.8.25:8080/job/OpenROV-Image_BuildImage_master/.
+
+Introduction
+------------
+
+We designed the onboard video platform using several key technologies:
+
+- [MJPEG_Streamer](https://code.google.com/p/mjpg-streamer/)
+- [Node.js](http://nodejs.org/)
+- [Socket.io](http://socket.io/)
+
+Combining these great technologies provides a lot of power and room for future growth.  But is also provides well documented means to extend OpenROV.  With Node.js and Socket.io, not only are we able to stream video to a web browser by updating an image, but we are also able to control the ROV and view valuable sensor information.  This is just the beginning.  
+
+Key Related Projects
+----------------
+
+* The firmware for the arduino can be found in [openrov/openrov-software-arduino](https://github.com/OpenROV/openrov-software-arduino) in the /OpenROV project.
+* The dashboard project can be found in [openrov/openrov-dashboard](https://github.com/OpenROV/openrov-dashboard)
+
+Note on Repository Branches
+---------------------------
+
+The "master" branch is the most current development branch of the code.  All work is done outside and submited as pull requests that *should* be working before they are merged.  There will also be a `<release>`-maintanence branch that has the code from the last stable release.  There may also be a `<release>`-alpha|beta|rc1 which is the next release that is being stabalized.  This will more than likely change as committers come and go, but that it what it looks like today.
+
+Requirements
+------------
+- BeagleBone: [http://beagleboard.org/bone](http://beagleboard.org/bone)
+- USB webcam:  we're using the Genius F100 HD
+- Ubuntu for BeagleBone:  [http://elinux.org/BeagleBoardUbuntu#Demo_Image](http://elinux.org/BeagleBoardUbuntu#Demo_Image) or [https://github.com/codewithpassion/openrov-image](https://github.com/codewithpassion/openrov-image)
+- mjpg-streamer:  [http://sourceforge.net/projects/mjpg-streamer/](http://sourceforge.net/projects/mjpg-streamer/)
+- Node.js :  [http://nodejs.org/](http://nodejs.org/)
+- Socket.io:  [http://socket.io/](http://socket.io/)
+
+Installation
+------------
+
+Step 1
+------
+
+Follow the instructions from our image project to get a starting image: https://github.com/OpenROV/openrov-image.  The default user is *rov* and password is *OpenROV*
+
+Step 2
+------
+
+Go ahead and start up the image in the beaglebone.  If you connect the rov to a router it will use DHCP to get an address. You many need to login to your router and examine the dhcp logs to figure out what IP was assigned.  If you connect directly to a laptop, a static IP of 192.168.254.1 is used.
+Go ahead and SSH on to you rov
+
+a) ssh rov@<address of rov>
+
+Step 3
+------
+
+Customize the name of the image to match your rov#.
+
+
+Change from "openrov" (without quotes) to "openrov-XXXX" (without quotes) - where XXXX is your serial number.
+
+    vi /etc/hosts
+    exit
+
+Step 4
+------
+
+Upload the right firmware on to the arduino that is driving the motors and sensors.  The source code for the arduino is actually installed in the git repo on the beaglebone. The beaglebone has a full arduino development environment and the ability to upload the firmware to the arduino.
+
+Since there are multiple versions of the ROV with multiple possible configurations you have to first tailor the options for the firmware to match your ROV.  It defaults to the stock installation for the *current* shipping ROV kit.
+
+a) from the ssh session: sudo pico /opt/openrov/arduino/OpenROV/Aconfig.h
+
+b) put a 1 for the options you have, a 0 if you don't have the option and save. For most folks you don't need to do anything because the type of board will be automatically detected. In case you could
+
+c) Login to the web session for the rov, choose settings, and select the upload firmware to arduino option.
+
+Updating
+------------
+NOTE: This is changing and may not be working properly.  
+The easiest way to upgrade your installation is to ssh on to
+
+1) ssh on to your rov
+
+2) cd /opt/openrov/cockpit
+
+3) sudo ./update.sh
+
+This will go to the github repository and pull the latest code. You may need to reboot after the update.  There is a known issue where the serial.io project sometimes fails to compile.  You can ignore that, but you may have to try again if it aborts the update.
+
+Plugins
+------------
+You can create your own plugins and share them with the community. Take a look at our [openrov-grunt-init-plugin](https://github.com/openrov/openrov-grunt-init-plugin) project.  
+
+
+How to Contribute
+------------
+
+Contributions require that you sign a [CLA](http://wiki.openrov.com/index.php/Special:SignDocument?doc=9) before the project can accept your pull requests.
+
+1) Fork the project in github
+
+2) Add an issue to the issue list for the changes you want to make.  Browser the issues lists for many of the fixes and enhancement requests if your looking for ideas.
+
+3) Make your changes and or fixes.
+
+4) Test them locally on your ROV or using the mock framework for node if you don't have one.
+
+5) Send a pull request back to the Master repository.
+
+More details can be found on the [OpenROV Wiki](http://wiki.openrov.com/index.php/Contributing).
+
+Someone on the team will review the pull request and ensure the changes work on the ROVs before approving the pull request.
+
+License
+-------
+
+MIT License
+
+Copyright (C) 2013 OpenROV Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.