Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMustafa Ozcelikors2017-08-22 12:16:27 +0000
committerMustafa Ozcelikors2017-08-22 12:16:27 +0000
commit67430ce152ee0c348717f4d124901bd1a72c2d7d (patch)
tree57acffe15010f2b2d93e683bb4e7793a3bd067a8
parentba16c76a5dc10b3d0be1a72846ad1232053d8d00 (diff)
downloadorg.eclipse.app4mc.examples-67430ce152ee0c348717f4d124901bd1a72c2d7d.tar.gz
org.eclipse.app4mc.examples-67430ce152ee0c348717f4d124901bd1a72c2d7d.tar.xz
org.eclipse.app4mc.examples-67430ce152ee0c348717f4d124901bd1a72c2d7d.zip
A4MCAR - Sphinx documentation source files are updated.
Signed-off-by: Mustafa Ozcelikors <mozcelikors@gmail.com>
-rw-r--r--a4mcar/docs/howtosetup/source/content/more.rst2
-rw-r--r--a4mcar/docs/howtosetup/source/content/software.rst15
2 files changed, 16 insertions, 1 deletions
diff --git a/a4mcar/docs/howtosetup/source/content/more.rst b/a4mcar/docs/howtosetup/source/content/more.rst
index acde1d3..1d973d7 100644
--- a/a4mcar/docs/howtosetup/source/content/more.rst
+++ b/a4mcar/docs/howtosetup/source/content/more.rst
@@ -30,7 +30,7 @@ Two documentations are delivered with A4MCAR project:
* This A4MCAR Introduction and Setup manual that is hosted under `http://a4mcar.readthedocs.io <http://a4mcar.readthedocs.io>`_.
-* The comprehensive documentation of A4MCAR which address research focuses can be accessed using `This PDF <http://www.thewebblog.net/a4mcar_documentation.pdf>`_
+* The comprehensive documentation of A4MCAR which address research focuses can be accessed using `This PDF <https://gitlab.idial.institute/RPublic/A4mcar_documentation/raw/master/a4mcar_documentation.pdf>`_
External Links
diff --git a/a4mcar/docs/howtosetup/source/content/software.rst b/a4mcar/docs/howtosetup/source/content/software.rst
index 884a99e..376613b 100644
--- a/a4mcar/docs/howtosetup/source/content/software.rst
+++ b/a4mcar/docs/howtosetup/source/content/software.rst
@@ -41,6 +41,21 @@ Provided Filesystem
:align: center
A4MCAR Filesystem
+
+The repository should have the following main folders:
+
+* **web_interface :** The web interface that is developed for A4MCAR project which is used to control A4MCAR over remote Wi-Fi connection. In order to set up web_interface, run the setup script: ``web_interface/setup_web_interface.sh``. In order to run the web_interface correctly, the high-level modules core_reader and ethernet_client should be ready and working. To run the ``web_interface`` one should connect to the access point of Raspberry Pi from a client computer web browser and visit ``http://<IP_Address>/jqueryControl2.php`` or ``http://<IP_Address>/jqueryControl.php``.
+
+* **high_level_applications :** This module consists of several high-level applications that are developed for A4MCAR's high-level module (Raspberry Pi). These applications involve: ``touchscreen_display``, ``core_recorder``, ``dummy_loads``, ``ethernet_client``, and ``image_processing``. n order to run the applications, respective Python files could be run or C/C++ binaries could be executed. Also the scripts that are located under scripts folder could be used to initialize some of the applications. In order to set up high_level_applications module dependencies, one should run the setup script and follow the instructions: ``high_level_applications/setup_high_level_applications.sh``.
+
+* **models:** A4MCAR's hardware and software model with Eclipse APP4MC is located in this directory.
+
+* **android_application:** This directory consists of the source files that belong to the A4MCAR's bluetooth based driving application. The source and design files could be used in an Android IDE in order to make tweaks to the application and to generate new .apk files.
+
+* **low_level_applications:** ``low_level_applications`` module involves the source code for the low-level module that are run using a multi-core microcontroller XMOS xCORE-200 eXplorerKIT. The low level applications are responsible for tasks such as sensor driving, actuation, communication, and core monitoring of the A4MCAR. The low_level_applications module could be imported into xTIMEcomposer to make tweaks to the tasks.
+
+* **docs:** Involves documentation and Sphinx-generated how-to-setup manual.
+
*******************************
High-Level Applications Setup

Back to the top