Skip to content
This repository has been archived by the owner on Aug 16, 2019. It is now read-only.

Commit

Permalink
Merge pull request #148 from cshadd/dev-v1.0.0
Browse files Browse the repository at this point in the history
Dev v1.0.0
  • Loading branch information
cshadd authored May 19, 2018
2 parents 5e0fdd4 + 6f888e0 commit 1d0900f
Show file tree
Hide file tree
Showing 133 changed files with 22,943 additions and 578 deletions.
13 changes: 13 additions & 0 deletions .settings/net.sf.jautodoc.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
add_header=true
add_todo=false
eclipse.preferences.version=1
get_set_from_field=true
header_text=/*\n * MIT License\n * \n * Copyright (c) 2018 Christian Shadd\n * \n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the "Software"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions\:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n * \n * https\://cshadd.github.io/fetch-bot/\n */
include_subpackages=true
mode=mode_keep
multi_header=true
project_specific_settings=true
replace_header=true
replacements=<?xml version\="1.0" standalone\="yes"?>\n\n<replacements>\n<replacement key\="get" scope\="1" mode\="0">Gets the</replacement>\n<replacement key\="set" scope\="1" mode\="0">Sets the</replacement>\n<replacement key\="add" scope\="1" mode\="0">Adds the</replacement>\n<replacement key\="edit" scope\="1" mode\="0">Edits the</replacement>\n<replacement key\="remove" scope\="1" mode\="0">Removes the</replacement>\n<replacement key\="init" scope\="1" mode\="0">Inits the</replacement>\n<replacement key\="parse" scope\="1" mode\="0">Parses the</replacement>\n<replacement key\="create" scope\="1" mode\="0">Creates the</replacement>\n<replacement key\="build" scope\="1" mode\="0">Builds the</replacement>\n<replacement key\="is" scope\="1" mode\="0">Checks if is</replacement>\n<replacement key\="print" scope\="1" mode\="0">Prints the</replacement>\n<replacement key\="has" scope\="1" mode\="0">Checks for</replacement>\n<replacement key\="new" scope\="1" mode\="0">Makes the</replacement>\n</replacements>\n\n
single_line_comment=false
use_internal_formatter=true
425 changes: 425 additions & 0 deletions .settings/org.eclipse.jdt.core.prefs

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions .settings/org.eclipse.jdt.ui.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
cleanup_settings_version=2
eclipse.preferences.version=1
formatter_profile=_cshadd
formatter_settings_version=13
org.eclipse.jdt.ui.javadoc=true
org.eclipse.jdt.ui.text.custom_code_templates=<?xml version\="1.0" encoding\="UTF-8" standalone\="no"?><templates><template autoinsert\="true" context\="gettercomment_context" deleted\="false" description\="Comment for getter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name\="gettercomment">/**\n * @return the ${bare_field_name}\n */</template><template autoinsert\="true" context\="settercomment_context" deleted\="false" description\="Comment for setter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.settercomment" name\="settercomment">/**\n * @param ${param} the ${bare_field_name} to set\n */</template><template autoinsert\="true" context\="constructorcomment_context" deleted\="false" description\="Comment for created constructors" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name\="constructorcomment">/**\n * ${tags}\n */</template><template autoinsert\="true" context\="filecomment_context" deleted\="false" description\="Comment for created Java files" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.filecomment" name\="filecomment">/**\n * \n */</template><template autoinsert\="true" context\="typecomment_context" deleted\="false" description\="Comment for created types" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.typecomment" name\="typecomment">/**\n * @author ${user}\n *\n * ${tags}\n */</template><template autoinsert\="true" context\="fieldcomment_context" deleted\="false" description\="Comment for fields" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name\="fieldcomment">/**\n * \n */</template><template autoinsert\="true" context\="methodcomment_context" deleted\="false" description\="Comment for non-overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name\="methodcomment">/**\n * ${tags}\n */</template><template autoinsert\="false" context\="overridecomment_context" deleted\="false" description\="Comment for overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name\="overridecomment">/**\n * ${see_to_overridden}\n */</template><template autoinsert\="true" context\="delegatecomment_context" deleted\="false" description\="Comment for delegate methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name\="delegatecomment">/**\n * ${tags}\n * ${see_to_target}\n */</template><template autoinsert\="true" context\="newtype_context" deleted\="false" description\="Newly created files" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.newtype" name\="newtype">${filecomment}\n${package_declaration}\n\n${typecomment}\n${type_declaration}</template><template autoinsert\="true" context\="classbody_context" deleted\="false" description\="Code in new class type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.classbody" name\="classbody">\n</template><template autoinsert\="true" context\="interfacebody_context" deleted\="false" description\="Code in new interface type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name\="interfacebody">\n</template><template autoinsert\="true" context\="enumbody_context" deleted\="false" description\="Code in new enum type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.enumbody" name\="enumbody">\n</template><template autoinsert\="true" context\="annotationbody_context" deleted\="false" description\="Code in new annotation type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name\="annotationbody">\n</template><template autoinsert\="true" context\="catchblock_context" deleted\="false" description\="Code in new catch blocks" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.catchblock" name\="catchblock">// ${todo} Auto-generated catch block\n${exception_var}.printStackTrace();</template><template autoinsert\="true" context\="methodbody_context" deleted\="false" description\="Code in created method stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodbody" name\="methodbody">// ${todo} Auto-generated method stub\n${body_statement}</template><template autoinsert\="true" context\="constructorbody_context" deleted\="false" description\="Code in created constructor stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name\="constructorbody">${body_statement}\n// ${todo} Auto-generated constructor stub</template><template autoinsert\="true" context\="getterbody_context" deleted\="false" description\="Code in created getters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.getterbody" name\="getterbody">return ${field};</template><template autoinsert\="true" context\="setterbody_context" deleted\="false" description\="Code in created setters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.setterbody" name\="setterbody">${field} \= ${param};</template></templates>
2 changes: 2 additions & 0 deletions .settings/org.eclipse.ltk.core.refactoring.prefs
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
eclipse.preferences.version=1
org.eclipse.ltk.core.refactoring.enable.project.refactoring.history=false
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Release](https://img.shields.io/github/release/cshadd/fetch-bot/all.svg)](https://github.com/cshadd/fetch-bot/releases)
[![License](https://img.shields.io/github/license/cshadd/fetch-bot.svg)](LICENSE)
[![Zenhub](https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)](https://www.zenhub.com/)
[![Travis CI Build Status](https://www.travis-ci.org/cshadd/fetch-bot.svg)](https://www.travis-ci.org/cshadd/fetch-bot)

# Fetch Bot
Expand Down Expand Up @@ -75,6 +76,7 @@ Let's face it. In our day and age of the 21st century, we want lightweight mobil
- Java SE Runtime Environment 8.0 or higher
- OpenCV 3.4.1
- PHP 7.0.27 or higher
- VNC Server
- Packaged Software (apt-get):
- arduino-core
- arduino-mk
Expand All @@ -90,7 +92,7 @@ Let's face it. In our day and age of the 21st century, we want lightweight mobil
You may use any IDE of your choice to edit project files. We have included files for importing the project into Eclipse Oxygen or higher and Visual Studio 2017 or higher. These would be ``.project`` and ``fetch-bot.sln`` respectively.

## Installing The Project Software
Before installing this project, you must make sure that you have installed all the dependencies necessary and have assembled the hardware correctly.
Before installing this project, you must make sure that you have installed all the dependencies necessary and have assembled the hardware correctly. This will overwrite any code on the Arduino.

### Easy Install
Execute
Expand Down Expand Up @@ -176,6 +178,7 @@ The folder for the training data is ``<PROJECT DIRECTORY>/src/neural-network/``.
Tutorials on training is beyond the scope of this project.

## Uninstalling The Project Software
This will help you to uninstall the project. This will not uninstall any of the code on the Arduino so you will have to do that part manually yourself.

### Easy Uninstall
Only do this if you did the Easy Install!
Expand Down Expand Up @@ -208,6 +211,8 @@ in a Bash terminal.

To control and terminate the application, you must use the web interface. The address to the web interface depends on your Apache configuration. Normally it would just be http://localhost/FetchBot.

The OpenCV Controller Terminal Window is located at the VNC server :1.

## Web Page
https://cshadd.github.io/fetch-bot/

Expand All @@ -232,6 +237,9 @@ See [here](LICENSE).
## Development Standards
See [here](/docs/development-standards/DevelopmentStandards.pdf).

## Product Report
See [here](/docs/product-report/ProductReport.pdf).

## Software Requirements Specification
See [here](/docs/software-requirements-specification/SoftwareRequirementsSpecification.pdf).

Expand Down
2 changes: 1 addition & 1 deletion bash-install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ cd ../../..
mkdir -p ~/bin
mvn clean package
cp -r ./target/libs ~/bin
cp ./target/fetch-bot-v1.0.0-alpha.jar ~/bin/fetch-bot-v1.0.0-alpha.jar
cp ./target/fetch-bot-v1.0.0.jar ~/bin/fetch-bot-v1.0.0.jar
cp ./src/bash-start.sh ~/bin/StartFetchBot.sh
sudo cp -R ./src/www /var/www/html/FetchBot
sudo chmod 764 ~/bin/StartFetchBot.sh
Expand Down
1 change: 1 addition & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<a href="https://github.com/cshadd/fetch-bot/">GitHub</a><br />
<a href="main-java-api/">Java API</a><br />
<a href="development-standards/DevelopmentStandards.pdf">Development Standards</a> (<a href="development-standards/DevelopmentStandards.Base.docx">Base Document</a>)<br />
<a href="product-report/ProductReport.pdf">Product Report</a> (<a href="product-report/ProductReport.Base.docx">Base Document</a>)<br />
<a href="software-requirements-specification/SoftwareRequirementsSpecification.pdf">Software Requirements Specification</a> (<a href="software-requirements-specification/SoftwareRequirementsSpecification.Base.docx">Base Document</a>)<br />
<a href="https://www.youtube.com/channel/UCADVkzWCPG4dhzPKLP6Gzqg">Youtube</a>
</p>
Expand Down
48 changes: 48 additions & 0 deletions docs/main-java-api/allclasses-frame.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_131) on Fri May 18 19:17:57 PDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (Fetch Bot v1.0.0 API)</title>
<meta name="date" content="2018-05-18">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="io/github/cshadd/fetch_bot/io/AbstractArduinoCommunication.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">AbstractArduinoCommunication</a></li>
<li><a href="io/github/cshadd/fetch_bot/io/AbstractCommunication.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">AbstractCommunication</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/AbstractController.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">AbstractController</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/AbstractOpenCVController.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">AbstractOpenCVController</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/AbstractPathfindController.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">AbstractPathfindController</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/AbstractPathfindController.CartesianGraph.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">AbstractPathfindController.CartesianGraph</a></li>
<li><a href="io/github/cshadd/fetch_bot/io/AbstractWebInterfaceCommunication.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">AbstractWebInterfaceCommunication</a></li>
<li><a href="io/github/cshadd/fetch_bot/io/ArduinoCommunication.html" title="interface in io.github.cshadd.fetch_bot.io" target="classFrame"><span class="interfaceName">ArduinoCommunication</span></a></li>
<li><a href="io/github/cshadd/fetch_bot/io/ArduinoCommunicationException.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">ArduinoCommunicationException</a></li>
<li><a href="io/github/cshadd/fetch_bot/io/ArduinoCommunicationImpl.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">ArduinoCommunicationImpl</a></li>
<li><a href="io/github/cshadd/fetch_bot/io/Communication.html" title="interface in io.github.cshadd.fetch_bot.io" target="classFrame"><span class="interfaceName">Communication</span></a></li>
<li><a href="io/github/cshadd/fetch_bot/io/CommunicationException.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">CommunicationException</a></li>
<li><a href="io/github/cshadd/fetch_bot/Component.html" title="annotation in io.github.cshadd.fetch_bot" target="classFrame">Component</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/Controller.html" title="interface in io.github.cshadd.fetch_bot.controllers" target="classFrame"><span class="interfaceName">Controller</span></a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/ControllerException.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">ControllerException</a></li>
<li><a href="io/github/cshadd/fetch_bot/Core.html" title="class in io.github.cshadd.fetch_bot" target="classFrame">Core</a></li>
<li><a href="io/github/cshadd/fetch_bot/FetchBot.html" title="interface in io.github.cshadd.fetch_bot" target="classFrame"><span class="interfaceName">FetchBot</span></a></li>
<li><a href="io/github/cshadd/fetch_bot/FetchBotException.html" title="class in io.github.cshadd.fetch_bot" target="classFrame">FetchBotException</a></li>
<li><a href="io/github/cshadd/fetch_bot/util/Logger.html" title="class in io.github.cshadd.fetch_bot.util" target="classFrame">Logger</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/OpenCVController.html" title="interface in io.github.cshadd.fetch_bot.controllers" target="classFrame"><span class="interfaceName">OpenCVController</span></a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/OpenCVControllerException.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">OpenCVControllerException</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/OpenCVControllerImpl.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">OpenCVControllerImpl</a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/PathfindController.html" title="interface in io.github.cshadd.fetch_bot.controllers" target="classFrame"><span class="interfaceName">PathfindController</span></a></li>
<li><a href="io/github/cshadd/fetch_bot/controllers/PathfindControllerImpl.html" title="class in io.github.cshadd.fetch_bot.controllers" target="classFrame">PathfindControllerImpl</a></li>
<li><a href="io/github/cshadd/fetch_bot/util/VersionCheck.html" title="class in io.github.cshadd.fetch_bot.util" target="classFrame">VersionCheck</a></li>
<li><a href="io/github/cshadd/fetch_bot/util/VersionCheckException.html" title="class in io.github.cshadd.fetch_bot.util" target="classFrame">VersionCheckException</a></li>
<li><a href="io/github/cshadd/fetch_bot/io/WebInterfaceCommunication.html" title="interface in io.github.cshadd.fetch_bot.io" target="classFrame"><span class="interfaceName">WebInterfaceCommunication</span></a></li>
<li><a href="io/github/cshadd/fetch_bot/io/WebInterfaceCommunicationException.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">WebInterfaceCommunicationException</a></li>
<li><a href="io/github/cshadd/fetch_bot/io/WebInterfaceCommunicationImpl.html" title="class in io.github.cshadd.fetch_bot.io" target="classFrame">WebInterfaceCommunicationImpl</a></li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit 1d0900f

Please sign in to comment.