diff --git a/docs/CommandLayer.rst b/docs/CommandLayer.rst new file mode 100644 index 0000000000000000000000000000000000000000..64f2f15e546dafac226513d03bc12f5286b9af7a --- /dev/null +++ b/docs/CommandLayer.rst @@ -0,0 +1,15 @@ +.. automodule:: source + +.. |br| raw:: html + + <br /> +============ +CommandLayer +============ + +Command +======= + +CommunicationInterface +====================== + diff --git a/docs/CommunicationLayer.rst b/docs/CommunicationLayer.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa4b3ae80374bffc81ef5bdc33c1f8c1e2ff7ad2 --- /dev/null +++ b/docs/CommunicationLayer.rst @@ -0,0 +1,17 @@ +.. automodule:: source + +.. |br| raw:: html + + <br /> +================== +CommunicationLayer +================== + +USB +=== + + +Bluetooth +========= + + diff --git a/docs/_build/doctrees/CommandLayer.doctree b/docs/_build/doctrees/CommandLayer.doctree new file mode 100644 index 0000000000000000000000000000000000000000..451eac7f343fd7e974a21481df4ac98dc8bd5df1 Binary files /dev/null and b/docs/_build/doctrees/CommandLayer.doctree differ diff --git a/docs/_build/doctrees/CommunicationLayer.doctree b/docs/_build/doctrees/CommunicationLayer.doctree new file mode 100644 index 0000000000000000000000000000000000000000..762c24eb0ec2c4441a9b2de7e44a9edf928c029e Binary files /dev/null and b/docs/_build/doctrees/CommunicationLayer.doctree differ diff --git a/docs/_build/doctrees/EV3.doctree b/docs/_build/doctrees/EV3.doctree index 70ab403f9ca4a4dff45c5681df03fc4e5b5376fc..e241fa3c490987e365f278a98ea9a4237aea1362 100644 Binary files a/docs/_build/doctrees/EV3.doctree and b/docs/_build/doctrees/EV3.doctree differ diff --git a/docs/_build/doctrees/Motor.doctree b/docs/_build/doctrees/Motor.doctree index 54fee8fbf081626b575f96b01a76d4e83685e826..1429c57d4bd203241703f8f5a587ce3f423a19a1 100644 Binary files a/docs/_build/doctrees/Motor.doctree and b/docs/_build/doctrees/Motor.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 102dee12678bc29f461d869222a08987ef8392a4..7ea245add719ff2f08796f99df89b95f2bfae5be 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/examples.doctree b/docs/_build/doctrees/examples.doctree index 078a28ecb867f0ec867e908b86687dc271fc73b5..645cd7fd6da6d09b9f99cc6d188944fb3015f6fe 100644 Binary files a/docs/_build/doctrees/examples.doctree and b/docs/_build/doctrees/examples.doctree differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index 57de8bd985d20399e613c663abab145a8b92cb9e..952b1194b5678af1f549ba8a6e96699a8ca413eb 100644 Binary files a/docs/_build/doctrees/index.doctree and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/doctrees/readme.doctree b/docs/_build/doctrees/readme.doctree index 10fd5a846a2c6469d73d1e9444d353551adab5fa..064a22e02b19f19c629d5631abcd64dc98202c24 100644 Binary files a/docs/_build/doctrees/readme.doctree and b/docs/_build/doctrees/readme.doctree differ diff --git a/docs/_build/html/CommandLayer.html b/docs/_build/html/CommandLayer.html new file mode 100644 index 0000000000000000000000000000000000000000..bf7d3ed0ba69fc1ea81015933ea322d4faffe29f --- /dev/null +++ b/docs/_build/html/CommandLayer.html @@ -0,0 +1,175 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>CommandLayer — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + + <link rel="stylesheet" href="_static/basic.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/bootswatch-3.3.6/readable/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: './', + VERSION: 'v0.4-rc.10', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="top" title="Mindstorms EV3 Toolbox v0.4-rc.10 documentation" href="index.html" /> + <link rel="next" title="CommunicationLayer" href="CommunicationLayer.html" /> + <link rel="prev" title="Sensor" href="Sensor.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html"> + Mindstorms EV3 Toolbox</a> + <span class="navbar-text navbar-version pull-left"><b>v0.4</b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><ul> +<li class="toctree-l1"><a class="reference internal" href="readme.html">General</a></li> +<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="EV3.html">EV3</a></li> +<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> +<li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="#">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">CommandLayer</a><ul> +<li><a class="reference internal" href="#command">Command</a></li> +<li><a class="reference internal" href="#communicationinterface">CommunicationInterface</a></li> +</ul> +</li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="Sensor.html" title="Previous Chapter: Sensor"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Sensor</span> + </a> + </li> + <li> + <a href="CommunicationLayer.html" title="Next Chapter: CommunicationLayer"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Communication... »</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="_sources/CommandLayer.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <span class="target" id="module-source"></span><div class="section" id="commandlayer"> +<h1>CommandLayer<a class="headerlink" href="#commandlayer" title="Permalink to this headline">¶</a></h1> +<div class="section" id="command"> +<h2>Command<a class="headerlink" href="#command" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="communicationinterface"> +<h2>CommunicationInterface<a class="headerlink" href="#communicationinterface" title="Permalink to this headline">¶</a></h2> +</div> +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016, LfB - RWTH Aachen.<br/> + Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file diff --git a/docs/_build/html/CommunicationLayer.html b/docs/_build/html/CommunicationLayer.html new file mode 100644 index 0000000000000000000000000000000000000000..be22b64c95243c213bcd89b2f7795559fcd32d4e --- /dev/null +++ b/docs/_build/html/CommunicationLayer.html @@ -0,0 +1,170 @@ +<!DOCTYPE html> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>CommunicationLayer — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + + <link rel="stylesheet" href="_static/basic.css" type="text/css" /> + <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> + <link rel="stylesheet" href="_static/bootswatch-3.3.6/readable/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: './', + VERSION: 'v0.4-rc.10', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="_static/jquery.js"></script> + <script type="text/javascript" src="_static/underscore.js"></script> + <script type="text/javascript" src="_static/doctools.js"></script> + <script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script> + <script type="text/javascript" src="_static/js/jquery-fix.js"></script> + <script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script> + <script type="text/javascript" src="_static/bootstrap-sphinx.js"></script> + <link rel="index" title="Index" href="genindex.html" /> + <link rel="search" title="Search" href="search.html" /> + <link rel="top" title="Mindstorms EV3 Toolbox v0.4-rc.10 documentation" href="index.html" /> + <link rel="prev" title="CommandLayer" href="CommandLayer.html" /> +<meta charset='utf-8'> +<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> +<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> +<meta name="apple-mobile-web-app-capable" content="yes"> + + </head> + <body role="document"> + + <div id="navbar" class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <!-- .btn-navbar is used as the toggle for collapsed navbar content --> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html"> + Mindstorms EV3 Toolbox</a> + <span class="navbar-text navbar-version pull-left"><b>v0.4</b></span> + </div> + + <div class="collapse navbar-collapse nav-collapse"> + <ul class="nav navbar-nav"> + + + <li class="dropdown globaltoc-container"> + <a role="button" + id="dLabelGlobalToc" + data-toggle="dropdown" + data-target="#" + href="index.html">Site <b class="caret"></b></a> + <ul class="dropdown-menu globaltoc" + role="menu" + aria-labelledby="dLabelGlobalToc"><ul> +<li class="toctree-l1"><a class="reference internal" href="readme.html">General</a></li> +<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="EV3.html">EV3</a></li> +<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> +<li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> +</ul> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">CommunicationLayer</a></li> +</ul> +</ul> +</li> + + <li class="dropdown"> + <a role="button" + id="dLabelLocalToc" + data-toggle="dropdown" + data-target="#" + href="#">Page <b class="caret"></b></a> + <ul class="dropdown-menu localtoc" + role="menu" + aria-labelledby="dLabelLocalToc"><ul> +<li><a class="reference internal" href="#">CommunicationLayer</a><ul> +<li><a class="reference internal" href="#usb">USB</a></li> +<li><a class="reference internal" href="#bluetooth">Bluetooth</a></li> +</ul> +</li> +</ul> +</ul> +</li> + + + + + + <li> + <a href="CommandLayer.html" title="Previous Chapter: CommandLayer"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« CommandLayer</span> + </a> + </li> + + + + + + <li class="hidden-sm"> +<div id="sourcelink"> + <a href="_sources/CommunicationLayer.txt" + rel="nofollow">Source</a> +</div></li> + + </ul> + + + +<form class="navbar-form navbar-right" action="search.html" method="get"> + <div class="form-group"> + <input type="text" name="q" class="form-control" placeholder="Search" /> + </div> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> +</form> + + </div> + </div> + </div> + +<div class="container"> + <div class="row"> + <div class="col-md-12 content"> + + <span class="target" id="module-source"></span><div class="section" id="communicationlayer"> +<h1>CommunicationLayer<a class="headerlink" href="#communicationlayer" title="Permalink to this headline">¶</a></h1> +<div class="section" id="usb"> +<h2>USB<a class="headerlink" href="#usb" title="Permalink to this headline">¶</a></h2> +</div> +<div class="section" id="bluetooth"> +<h2>Bluetooth<a class="headerlink" href="#bluetooth" title="Permalink to this headline">¶</a></h2> +</div> +</div> + + + </div> + + </div> +</div> +<footer class="footer"> + <div class="container"> + <p class="pull-right"> + <a href="#">Back to top</a> + + </p> + <p> + © Copyright 2016, LfB - RWTH Aachen.<br/> + Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> + </p> + </div> +</footer> + </body> +</html> \ No newline at end of file diff --git a/docs/_build/html/EV3.html b/docs/_build/html/EV3.html index 55d708d6bf236b129dc0e8f55fa9f06fef82295e..dce9c0a6f2481521f94c419c374111237175058c 100644 --- a/docs/_build/html/EV3.html +++ b/docs/_build/html/EV3.html @@ -76,6 +76,10 @@ <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> @@ -140,7 +144,7 @@ <h1>EV3<a class="headerlink" href="#ev3" title="Permalink to this headline">¶</a></h1> <dl class="class"> <dt id="source.EV3"> -<em class="property">class </em><code class="descclassname">source.</code><code class="descname">EV3</code><span class="sig-paren">(</span><em>varargin</em><span class="sig-paren">)</span><a class="headerlink" href="#source.EV3" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descname">EV3</code><span class="sig-paren">(</span><em>varargin</em><span class="sig-paren">)</span><a class="headerlink" href="#source.EV3" title="Permalink to this definition">¶</a></dt> <dd><p>High-level class to work with physical bricks.</p> <p>This is the 'central' class (from user's view) when working with this toolbox. It delivers a convenient interface for creating a connection to the brick and sending diff --git a/docs/_build/html/Motor.html b/docs/_build/html/Motor.html index 2745b4e244d29a117707ff5c611a1b27fe1b0c10..bd3dc306783c821503f95ee445f4ccd116e4f4ce 100644 --- a/docs/_build/html/Motor.html +++ b/docs/_build/html/Motor.html @@ -76,6 +76,10 @@ <li class="toctree-l1 current"><a class="current reference internal" href="#">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> @@ -140,7 +144,7 @@ <h1>Motor<a class="headerlink" href="#motor" title="Permalink to this headline">¶</a></h1> <dl class="class"> <dt id="source.Motor"> -<em class="property">class </em><code class="descclassname">source.</code><code class="descname">Motor</code><span class="sig-paren">(</span><em>varargin</em><span class="sig-paren">)</span><a class="headerlink" href="#source.Motor" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descname">Motor</code><span class="sig-paren">(</span><em>varargin</em><span class="sig-paren">)</span><a class="headerlink" href="#source.Motor" title="Permalink to this definition">¶</a></dt> <dd><p>High-level class to work with motors.</p> <p>This class is supposed to ease the use of the brick's motors. It is possible to set all kinds of parameters, request the current status of the motor ports and of course send diff --git a/docs/_build/html/Sensor.html b/docs/_build/html/Sensor.html index fb0118f61b82e334c8a090d468a74c00093d9af1..0aa3344dd0829bcc1d64ad232cbca5ae06886f06 100644 --- a/docs/_build/html/Sensor.html +++ b/docs/_build/html/Sensor.html @@ -31,6 +31,7 @@ <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="top" title="Mindstorms EV3 Toolbox v0.4-rc.10 documentation" href="index.html" /> + <link rel="next" title="CommandLayer" href="CommandLayer.html" /> <link rel="prev" title="Motor" href="Motor.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> @@ -75,6 +76,10 @@ <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> @@ -100,6 +105,10 @@ <a href="Motor.html" title="Previous Chapter: Motor"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Motor</span> </a> </li> + <li> + <a href="CommandLayer.html" title="Next Chapter: CommandLayer"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">CommandLayer »</span> + </a> + </li> @@ -135,7 +144,7 @@ <h1>Sensor<a class="headerlink" href="#sensor" title="Permalink to this headline">¶</a></h1> <dl class="class"> <dt id="source.Sensor"> -<em class="property">class </em><code class="descclassname">source.</code><code class="descname">Sensor</code><span class="sig-paren">(</span><em>varargin</em><span class="sig-paren">)</span><a class="headerlink" href="#source.Sensor" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><code class="descname">Sensor</code><span class="sig-paren">(</span><em>varargin</em><span class="sig-paren">)</span><a class="headerlink" href="#source.Sensor" title="Permalink to this definition">¶</a></dt> <dd><p>High-level class to work with sensors.</p> <p>The Sensor-class facilitates the communication with sensors. This mainly consists of reading the sensor's type and current value in a specified mode.</p> diff --git a/docs/_build/html/_sources/CommandLayer.txt b/docs/_build/html/_sources/CommandLayer.txt new file mode 100644 index 0000000000000000000000000000000000000000..64f2f15e546dafac226513d03bc12f5286b9af7a --- /dev/null +++ b/docs/_build/html/_sources/CommandLayer.txt @@ -0,0 +1,15 @@ +.. automodule:: source + +.. |br| raw:: html + + <br /> +============ +CommandLayer +============ + +Command +======= + +CommunicationInterface +====================== + diff --git a/docs/_build/html/_sources/CommunicationLayer.txt b/docs/_build/html/_sources/CommunicationLayer.txt new file mode 100644 index 0000000000000000000000000000000000000000..aa4b3ae80374bffc81ef5bdc33c1f8c1e2ff7ad2 --- /dev/null +++ b/docs/_build/html/_sources/CommunicationLayer.txt @@ -0,0 +1,17 @@ +.. automodule:: source + +.. |br| raw:: html + + <br /> +================== +CommunicationLayer +================== + +USB +=== + + +Bluetooth +========= + + diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt index 4ebb311f2fe3915e3d5b5dba277214e1933c6419..f790a41dd18ca65e4ca9c630800801abb68b8658 100644 --- a/docs/_build/html/_sources/index.txt +++ b/docs/_build/html/_sources/index.txt @@ -9,18 +9,20 @@ MATLAB Toolbox for controlling Lego Mindstorms EV3 This MATLAB toolbox was designed to abstract and simplify controlling Lego Mindstorms EV3 robots. Via Bluetooth or USB you can read sensor values or control -your robots' motors in an intuitive way. On a low level (the ##hyperlink## Communication -layer) you are able to send various commands directly to the brick, while on a high level, +your robots' motors in an intuitive way. On a low level (the :doc:`Communication +layer <CommunicationLayer>`) you are able to send various commands directly to the brick, while on a high level, several classes abstract this behaviour for you. If you want to easily access your EV3 robot, these are the classes you will mostly use. -Take a look at the ##link to readme## for installation instructions. +To get started, take a look at the :doc:`installation instructions <readme>` and :doc:`examples <examples>`. This toolbox is being developed at the RWTH Aachen, Germany, as part of the students' lab -##hyperlink## 'MATLAB meets Mindstorms'. It is the follow-up of the widely used ##hyperlink## MATLAB NXT Toolbox. +'MATLAB meets Mindstorms'. It is the follow-up of the `MATLAB NXT Toolbox`_. ##image## +.. _MATLAB NXT Toolbox: http://www.mindstorms.rwth-aachen.de/trac/ + Contents ======== @@ -46,5 +48,6 @@ Advanced .. toctree:: :maxdepth: 2 - + CommandLayer.rst + CommunicationLayer.rst diff --git a/docs/_build/html/examples.html b/docs/_build/html/examples.html index aa2918ba5f0a45f894afd44d7986283df2866a28..270af7f3b31209bb0a0554123a66af324d8f92fd 100644 --- a/docs/_build/html/examples.html +++ b/docs/_build/html/examples.html @@ -31,8 +31,8 @@ <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="top" title="Mindstorms EV3 Toolbox v0.4-rc.10 documentation" href="index.html" /> - <link rel="next" title="EV3" href="source.html" /> - <link rel="prev" title="General information" href="readme.html" /> + <link rel="next" title="EV3" href="EV3.html" /> + <link rel="prev" title="General" href="readme.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> @@ -68,13 +68,17 @@ <ul class="dropdown-menu globaltoc" role="menu" aria-labelledby="dLabelGlobalToc"><ul class="current"> -<li class="toctree-l1"><a class="reference internal" href="readme.html">General information</a></li> +<li class="toctree-l1"><a class="reference internal" href="readme.html">General</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a></li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="source.html">EV3</a></li> -<li class="toctree-l1"><a class="reference internal" href="source.html#motor">Motor</a></li> -<li class="toctree-l1"><a class="reference internal" href="source.html#sensor">Sensor</a></li> +<li class="toctree-l1"><a class="reference internal" href="EV3.html">EV3</a></li> +<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> +<li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> </ul> </ul> </li> @@ -98,11 +102,11 @@ <li> - <a href="readme.html" title="Previous Chapter: General information"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« General infor...</span> + <a href="readme.html" title="Previous Chapter: General"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« General</span> </a> </li> <li> - <a href="source.html" title="Next Chapter: EV3"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">EV3 »</span> + <a href="EV3.html" title="Next Chapter: EV3"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">EV3 »</span> </a> </li> diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index 00368a1f7d9bd5915cc5c17d2162065a9fd56d71..f905277e3d9ad00cc2b6f9e9c489b60dc4347ac4 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -75,6 +75,10 @@ <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> @@ -367,7 +371,7 @@ </dt> - <dt><a href="EV3.html#module-source">source (module)</a>, <a href="Motor.html#module-source">[1]</a>, <a href="Sensor.html#module-source">[2]</a>, <a href="source.html#module-source">[3]</a> + <dt><a href="CommandLayer.html#module-source">source (module)</a>, <a href="CommunicationLayer.html#module-source">[1]</a>, <a href="EV3.html#module-source">[2]</a>, <a href="Motor.html#module-source">[3]</a>, <a href="Sensor.html#module-source">[4]</a>, <a href="source.html#module-source">[5]</a> </dt> diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 699f7495a3cbaba62f0562407a8161f965e160a3..8fe8515ae9b022c5eadb4599885f16a494cb4af3 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -75,6 +75,10 @@ <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> @@ -140,13 +144,13 @@ <h1>MATLAB Toolbox for controlling Lego Mindstorms EV3<a class="headerlink" href="#matlab-toolbox-for-controlling-lego-mindstorms-ev3" title="Permalink to this headline">¶</a></h1> <p>This MATLAB toolbox was designed to abstract and simplify controlling Lego Mindstorms EV3 robots. Via Bluetooth or USB you can read sensor values or control -your robots’ motors in an intuitive way. On a low level (the ##hyperlink## Communication -layer) you are able to send various commands directly to the brick, while on a high level, +your robots’ motors in an intuitive way. On a low level (the <a class="reference internal" href="CommunicationLayer.html"><span class="doc">Communication +layer</span></a>) you are able to send various commands directly to the brick, while on a high level, several classes abstract this behaviour for you. If you want to easily access your EV3 robot, these are the classes you will mostly use.</p> -<p>Take a look at the ##link to readme## for installation instructions.</p> +<p>To get started, take a look at the <a class="reference internal" href="readme.html"><span class="doc">installation instructions</span></a> and <a class="reference internal" href="examples.html"><span class="doc">examples</span></a>.</p> <p>This toolbox is being developed at the RWTH Aachen, Germany, as part of the students’ lab -##hyperlink## ‘MATLAB meets Mindstorms’. It is the follow-up of the widely used ##hyperlink## MATLAB NXT Toolbox.</p> +‘MATLAB meets Mindstorms’. It is the follow-up of the <a class="reference external" href="http://www.mindstorms.rwth-aachen.de/trac/">MATLAB NXT Toolbox</a>.</p> <p>##image##</p> <div class="section" id="contents"> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2> @@ -172,6 +176,18 @@ these are the classes you will mostly use.</p> </div> <p>Advanced</p> <div class="toctree-wrapper compound"> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a><ul> +<li class="toctree-l2"><a class="reference internal" href="CommandLayer.html#command">Command</a></li> +<li class="toctree-l2"><a class="reference internal" href="CommandLayer.html#communicationinterface">CommunicationInterface</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a><ul> +<li class="toctree-l2"><a class="reference internal" href="CommunicationLayer.html#usb">USB</a></li> +<li class="toctree-l2"><a class="reference internal" href="CommunicationLayer.html#bluetooth">Bluetooth</a></li> +</ul> +</li> +</ul> </div> </div> </div> diff --git a/docs/_build/html/mat-modindex.html b/docs/_build/html/mat-modindex.html index 4fe4e6dfebc179395d25af11ea684b794bdf2433..b38672dbedf8ed662a43038f49129b4474587969 100644 --- a/docs/_build/html/mat-modindex.html +++ b/docs/_build/html/mat-modindex.html @@ -81,6 +81,10 @@ <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> diff --git a/docs/_build/html/readme.html b/docs/_build/html/readme.html index e1c71fa07e150a9c9b44313e99557683b3093c74..954c61500add5d65144d7234cc4d4db1c280da4e 100644 --- a/docs/_build/html/readme.html +++ b/docs/_build/html/readme.html @@ -72,9 +72,13 @@ <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="source.html">EV3</a></li> -<li class="toctree-l1"><a class="reference internal" href="source.html#motor">Motor</a></li> -<li class="toctree-l1"><a class="reference internal" href="source.html#sensor">Sensor</a></li> +<li class="toctree-l1"><a class="reference internal" href="EV3.html">EV3</a></li> +<li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> +<li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> </ul> </ul> </li> diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index fa41c0079c3d867f593e594e6c95508aa63332dc..83cf5d5221404857bcf632782488a125ce1779df 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -82,6 +82,10 @@ <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index f3bd4579bd6b1b428fda10e4037434e7c6f4aa3e..4a505bd84798362af93e1d3ac5cd3d1a1e732d94 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:49,filenames:["EV3","Motor","Sensor","examples","index","readme","source"],objects:{"":{source:[6,0,1,""]},"source.EV3":{batteryMode:[6,2,1,""],batteryValue:[6,2,1,""],beep:[6,3,1,""],connect:[6,3,1,""],debug:[6,2,1,""],disconnect:[6,3,1,""],isConnected:[6,2,1,""],motorA:[6,2,1,""],motorB:[6,2,1,""],motorC:[6,2,1,""],motorD:[6,2,1,""],playTone:[6,3,1,""],sensor1:[6,2,1,""],sensor2:[6,2,1,""],sensor3:[6,2,1,""],sensor4:[6,2,1,""],setProperties:[6,3,1,""],stopAllMotors:[6,3,1,""],stopTone:[6,3,1,""],tonePlayed:[6,3,1,""]},"source.Motor":{brakeMode:[1,2,1,""],currentSpeed:[1,2,1,""],debug:[1,2,1,""],internalReset:[1,3,1,""],isRunning:[1,2,1,""],limitMode:[1,2,1,""],limitValue:[1,2,1,""],power:[1,2,1,""],resetTachoCount:[1,3,1,""],setBrake:[1,3,1,""],setProperties:[1,3,1,""],smoothStart:[1,2,1,""],smoothStop:[1,2,1,""],speedRegulation:[1,2,1,""],start:[1,3,1,""],stop:[1,3,1,""],syncedStart:[1,3,1,""],syncedStop:[1,3,1,""],tachoCount:[1,2,1,""],type:[1,2,1,""],waitFor:[1,3,1,""]},"source.Sensor":{debug:[2,2,1,""],mode:[2,2,1,""],reset:[2,3,1,""],setProperties:[2,3,1,""],type:[2,2,1,""],value:[2,2,1,""]},source:{EV3:[6,1,1,""],Motor:[1,1,1,""],Sensor:[2,1,1,""]}},objnames:{"0":["mat","module","MATLAB module"],"1":["mat","class","MATLAB class"],"2":["mat","attribute","MATLAB attribute"],"3":["mat","method","MATLAB method"]},objtypes:{"0":"mat:module","1":"mat:class","2":"mat:attribute","3":"mat:method"},terms:{"5000hz":[0,6],"abstract":4,"case":1,"catch":1,"class":[0,1,2,4,6],"default":2,"function":1,"long":1,"return":[0,1,6],"true":[0,1,6],"try":1,"while":[1,4],aachen:4,abl:4,about:[0,1,2,6],acceler:[1,2],accelerationallax:2,access:4,accident:[0,6],act:1,action:1,actual:1,advanc:4,affect:1,afraid:[],after:[],again:[],all:[0,1,2,6],allow:2,alreadi:1,also:[0,1,6],alternatingli:1,ambient:2,angular:2,ani:1,anoth:1,apply:1,aren:1,around:1,ask:[],automat:[0,1,2,6],avail:2,avoid:[],batteri:[0,6],batterymod:[0,1,6],batterymode:[0,6],batteryvalu:[0,6],been:[0,1,2,6],beep:[0,6],befor:[0,6],behav:1,behaviour:[1,4],better:1,between:1,bit:1,blue:2,bluetooth:[0,4,6],bool:[0,1,2,6],both:1,brake:1,brakemod:1,brick:[0,1,2,4,6],bug:[],buggi:1,bump:2,c_output:1,call:[0,1,2,6],can:[1,2,4],cannot:[],car:1,central:[0,6],chang:1,charg:[0,6],check:[0,1,6],clear:2,coast:1,code:2,col:2,color:2,com:[0,6],comm:[0,6],command:[0,1,2,4,6],comment:1,commun:[1,2,4],confus:[],connect:[0,1,2,6],connectiontyp:[0,6],consist:[1,2],consol:[0,1,2,6],constantli:1,content:[],continu:1,contribut:[],conveni:[0,6],correctli:1,count:1,counter:1,cours:1,creat:[0,1,2,6],current:[0,1,2,6],currentspe:1,dba:2,debug:[0,1,2,6],defin:1,degre:[1,2],delet:[0,6],deliber:[],deliv:[0,6],depend:[0,1,2,6],descript:[],design:4,desir:[],destroi:[0,6],dev:[0,1,2,6],develop:4,devic:1,devicemod:2,devicetyp:[1,2],differ:[0,6],direct:1,directli:4,disconnect:[0,6],distcm:2,distin:2,document:4,doe:[],doesn:1,don:[1,2],done:1,down:1,durat:[0,6],each:[0,1,2,6],eas:1,easili:4,effect:[],either:[0,1,6],enabl:[0,6],equal:[0,1,6],error:[1,2],establish:[0,6],even:1,everytim:[1,2],exampl:[],excerpt:[],execut:1,exit:[],expect:1,explicitli:[],facilit:2,fals:1,far:1,feedback:[0,1,2,6],finish:1,firmwar:[0,1,6],first:[0,1,6],follow:[1,2,4],forward:1,four:1,frequenc:[0,6],from:[0,1,2,6],fun:[0,6],gener:[],germani:4,get:[0,1,6],given:[0,1,6],glanc:[0,6],goe:1,greater:1,green:2,gyro:2,happen:1,have:[0,6],heavi:1,hertz:[0,6],high:[0,1,2,4,6],highest:1,hold:1,how:1,howev:[],htacceleromet:2,htcolor:2,htcompass:2,hyperlink:4,hysic:2,imag:4,immedi:[0,1,6],index:[],indic:1,individu:[1,2],infinit:1,inform:[],infrare:2,input:1,inputpars:[0,1,2,6],instal:4,installat:[],instanc:[1,2],instead:[0,1,2,6],instruct:4,interfac:[0,6],intern:1,internalreset:1,interpret:1,intuit:4,isconnect:[0,6],isrun:1,iter:1,itself:1,keep:1,kind:1,know:[],lab:4,largemotor:2,last:1,later:1,layer:[0,1,2,4,6],lead:1,left:1,less:1,level:[0,1,2,4,6],licens:[],like:1,limit:1,limitmod:1,limitvalu:[0,1,6],link:4,listen:2,load:1,look:4,loop:1,low:[0,4,6],lower:1,mai:1,mainli:2,make:1,manual:[],master:1,mean:1,mediummotor:2,meet:4,messag:1,method:[0,1,6],millisecond:[0,1,6],mind:1,mode:[0,1,2,6],modul:[],mostli:[1,4],motor:[],motora:[0,1,6],motorb:[0,1,6],motorc:[0,6],motord:[0,6],move:1,multipl:[0,1,2,6],name:1,necessari:[],need:[1,2],neg:1,newpag:[],none:2,note:[0,1,2,6],now:[1,2],numer:[0,1,2,6],nxt:4,nxtcolor:2,nxtlight:2,nxtsound:2,nxttemperatur:2,nxttouch:2,nxtultrason:2,object:[0,1,2,6],off:[0,1,2,6],old:1,onc:[0,1,2,6],once:2,onli:1,only:[0,1,2,6],opcod:[0,1,6],opposit:1,optional:[0,6],other:[1,2],otherwis:1,output:[0,6],outputreadi:1,outputtest:1,packet:[0,1,6],page:[],paramet:[0,1,2,6],part:4,pass:[1,2],path:[0,6],paus:[0,6],percent:[0,1,6],percentag:[0,1,6],physic:[0,1,2,6],plai:[0,6],playton:[0,6],point:1,poll:1,port:[0,1,2,6],posit:1,possibl:[1,2],power:[0,1,6],pretti:1,previous:1,print:[0,6],probabl:1,program:1,properti:[0,1,2,6],prox:2,pull:1,push:2,rais:1,rate:2,ratio:1,raw:2,reach:1,read:[0,1,2,4,6],readm:4,realli:[],reason:1,receiv:[0,1,6],red:2,reflect:2,regul:1,releas:1,remot:2,repli:1,repres:[1,2],request:1,reset:[0,1,2,6],resetposit:1,resettachocount:1,respect:1,respons:1,result:1,rfcomm0:[0,1,2,6],rfcomm1:[0,6],rfcomm2:[0,6],right:[1,2],robot:[1,4],run:1,rwth:4,same:[0,1,6],search:[],second:[0,1,6],secur:1,see:[0,1,6],seek:2,seem:[0,6],send:[0,1,4,6],sensor1:[0,2,6],sensor2:[0,6],sensor3:[0,6],sensor4:[0,6],sensor:[],sent:[0,6],serial:[0,6],serport:[0,1,2,6],set:[0,1,2,4,6],setbrak:1,setpow:[],setproperti:[0,1,2,6],setup:[0,6],sever:4,should:1,simplifi:4,slave:1,slow:1,slower:1,slowli:1,smoothli:1,smoothstart:1,smoothstop:1,some:1,sometim:1,somewhat:1,soon:[],sooner:1,sourc:[0,1,2,6],special:[],specifi:2,speed:1,speedregul:1,spin:1,start:[0,1,6],state:1,statu:[0,1,6],still:1,stop:[0,1,6],stopallmotor:[0,6],stopton:[0,6],straight:1,string:[0,6],student:4,stuff:[0,1,6],sublay:[1,2],suppos:1,sync:1,syncedstart:1,syncedstop:1,synchron:1,syncmotor:1,tacho:1,tachocount:1,tacholimit:1,take:[1,4],test:[0,1,6],than:1,them:[0,1,2,6],thi:[0,1,2,4,6],thoroughli:[0,6],tight:[],time:1,timeout:1,tone:[0,6],toneplai:[0,6],too:1,touch:2,tricki:1,turn:[0,1,2,6],turn_ratio:[],turnratio:1,two:1,type:[0,1,2,6],ultrason:2,und:1,undefin:2,unexpect:1,unknown:2,until:1,usb:[0,1,4,6],use:1,user:[0,6],valu:[0,1,2,4,6],varargin:[0,1,2,6],variou:4,via:[0,1,2,4,6],view:[0,6],virtual:[0,6],voltag:[0,1,6],volum:[0,6],wai:4,waitfor:[0,1,6],want:4,wast:1,weird:1,what:[0,1,2,6],whatev:1,when:[0,1,6],which:[1,2],white:2,wide:4,without:1,work:[0,1,2,6],workaround:1,would:1,wrap:[0,6],writable:[0,1,2,6],wrong:[0,6],yet:[0,6],you:[1,2,4],your:4,zero:[]},titles:["EV3","Motor","Sensor","Examples","MATLAB Toolbox for controlling Lego Mindstorms EV3","General","EV3"],titleterms:{content:4,contribut:5,control:4,ev3:[0,4,6],exampl:3,gener:5,indice:[],inform:[],installat:5,lego:4,licens:5,matlab:4,mindstorm:4,motor:1,sensor:2,tabl:[],toolbox:4}}) \ No newline at end of file +Search.setIndex({envversion:49,filenames:["CommandLayer","CommunicationLayer","EV3","Motor","Sensor","examples","index","readme","source"],objects:{"":{source:[8,0,1,""]},"source.EV3":{batteryMode:[8,2,1,""],batteryValue:[8,2,1,""],beep:[8,3,1,""],connect:[8,3,1,""],debug:[8,2,1,""],disconnect:[8,3,1,""],isConnected:[8,2,1,""],motorA:[8,2,1,""],motorB:[8,2,1,""],motorC:[8,2,1,""],motorD:[8,2,1,""],playTone:[8,3,1,""],sensor1:[8,2,1,""],sensor2:[8,2,1,""],sensor3:[8,2,1,""],sensor4:[8,2,1,""],setProperties:[8,3,1,""],stopAllMotors:[8,3,1,""],stopTone:[8,3,1,""],tonePlayed:[8,3,1,""]},"source.Motor":{brakeMode:[3,2,1,""],currentSpeed:[3,2,1,""],debug:[3,2,1,""],internalReset:[3,3,1,""],isRunning:[3,2,1,""],limitMode:[3,2,1,""],limitValue:[3,2,1,""],power:[3,2,1,""],resetTachoCount:[3,3,1,""],setBrake:[3,3,1,""],setProperties:[3,3,1,""],smoothStart:[3,2,1,""],smoothStop:[3,2,1,""],speedRegulation:[3,2,1,""],start:[3,3,1,""],stop:[3,3,1,""],syncedStart:[3,3,1,""],syncedStop:[3,3,1,""],tachoCount:[3,2,1,""],type:[3,2,1,""],waitFor:[3,3,1,""]},"source.Sensor":{debug:[4,2,1,""],mode:[4,2,1,""],reset:[4,3,1,""],setProperties:[4,3,1,""],type:[4,2,1,""],value:[4,2,1,""]},source:{EV3:[8,1,1,""],Motor:[3,1,1,""],Sensor:[4,1,1,""]}},objnames:{"0":["mat","module","MATLAB module"],"1":["mat","class","MATLAB class"],"2":["mat","attribute","MATLAB attribute"],"3":["mat","method","MATLAB method"]},objtypes:{"0":"mat:module","1":"mat:class","2":"mat:attribute","3":"mat:method"},terms:{"0016533dbaf5":[],"0x00":[],"0x01":[],"0x02":[],"0x03":[],"0x04":[],"0x05":[],"0x06":[],"0x07":[],"0x08":[],"0x09":[],"0x0a":[],"0x0b":[],"0x0c":[],"0x80":[],"0x81":[],"0x92":[],"0x93":[],"0x94":[],"0x95":[],"0x96":[],"0x97":[],"0x98":[],"0x99":[],"0x9a":[],"0x9b":[],"0x9c":[],"0x9d":[],"0x9e":[],"0x9f":[],"0xa0":[],"0xa1":[],"0xa2":[],"5000hz":[2,8],"5th":[],"abstract":6,"break":[],"byte":[],"case":3,"catch":3,"class":[2,3,4,6,8],"default":4,"function":3,"long":3,"new":[],"return":[2,3,8],"true":[2,3,8],"try":3,"while":[3,6],aachen:6,abl:6,about:[2,3,4,8],acceler:[3,4],accelerationallax:4,access:6,accident:[2,8],act:3,action:3,activ:[],actual:3,adapt:[],add:[],addarrai:[],adddirectcommand:[],addfiles:[],addheaderdirect:[],addheaderdirectrepli:[],addheadersystem:[],addheadersystemrepli:[],addlcsstr:[],addlength:[],address:[],addstr:[],addsystemcommand:[],addvalu:[],advanc:6,affect:3,afraid:[],after:[],again:[],all:[2,3,4,8],allow:4,alreadi:3,also:[2,3,8],alternatingli:3,ambient:4,angl:[],angular:4,ani:3,anoth:3,apply:3,aren:3,around:3,arrai:[],ask:[],automat:[2,3,4,8],avail:4,avoid:[],batteri:[2,8],batterymod:[2,3,8],batterymode:[2,8],batteryvalu:[2,8],been:[2,3,4,8],beep:[2,8],befor:[2,8],begin:[],begin_download:[],begin_getfile:[],begin_upload:[],behav:3,behaviour:[3,6],better:3,between:3,bit:3,blockheader:[],blue:4,bluetooth:[],bluetoothpin:[],bool:[2,3,4,8],both:3,brake:3,brakemod:3,brick:[2,3,4,6,8],brickio:[],buffer:[],bug:[],buggi:3,bump:4,bundl:[],button:[],bytecod:[],bytetobyt:[],c_com:[],c_output:3,call:[2,3,4,8],can:[3,4,6],cannot:[],capabl:[],car:3,central:[2,8],chang:3,charg:[2,8],check:[2,3,8],checkforerror:[],circle:[],clean:[],clear:4,close:[],close_filehandle:[],clr_all:[],clr_changes:[],cmd:[],coast:3,code:4,col:4,color:4,com:[2,8],comgetbricknam:[],comgetbtid:[],comgetmacaddress:[],comm:[2,8],command:[],comment:3,commun:[3,4,6],compress:[],comreadi:[],comsetbricknam:[],comtest:[],confus:[],connect:[2,3,4,8],connectiontyp:[2,8],consist:[3,4],consol:[2,3,4,8],constant:[],constantli:3,construct:[],constructor:[],content:[],continu:3,continue_download:[],continue_getfile:[],continue_list_files:[],continue_upload:[],contribut:[],conveni:[2,8],correctli:3,corrupt:[],corrupt_file:[],count:3,counter:3,cours:3,creat:[2,3,4,8],create_dir:[],createdir:[],current:[2,3,4,8],currentspe:3,data:[],dataset:[],dba:4,debug:[2,3,4,8],decim:[],defin:3,degre:[3,4],delet:[2,8],delete_file:[],deletefil:[],deliber:[],deliv:[2,8],depend:[2,3,4,8],descript:[],design:6,desir:[],destroi:[2,8],destructor:[],detail:[],detect:[],dev:[2,3,4,8],develop:6,devic:3,device_list:[],devicemod:4,devicetyp:[3,4],differ:[2,8],direct:3,direct_command_no_reply:[],direct_command_reply:[],direct_reply:[],direct_reply_error:[],directli:6,directori:[],disconnect:[2,8],displai:[],displaycolor:[],displayhex:[],distcm:4,distin:4,doc:[],document:6,doe:[],doesn:3,don:[3,4],done:3,down:3,download:[],draw:[],drawtest:[],durat:[2,8],each:[2,3,4,8],eas:3,easili:6,effect:[],either:[2,3,8],empti:[],enabl:[2,8],end_of_file:[],endiann:[],enterfwupdate:[],equal:[2,3,8],error:[3,4],establish:[2,8],even:3,everytim:[3,4],exampl:[],excerpt:[],execut:3,exit:[],expect:3,explicitli:[],facilit:4,fals:3,far:3,feedback:[2,3,4,8],file:[],file_exits:[],filedownload:[],files:[],fileupload:[],fillcircle:[],fillrect:[],fillwindow:[],finish:3,firmwar:[2,3,8],first:[2,3,8],five:[],follow:[3,4,6],format:[],forward:3,found:[],four:3,frequenc:[2,8],from:[2,3,4,8],front:[],fun:[2,8],gener:[],generatebytecod:[],germani:6,get:[2,3,6,8],get_brickname:[],get_bumps:[],get_changes:[],get_connection:[],get_format:[],get_id:[],get_lbatt:[],get_minmax:[],get_modename:[],get_name:[],get_network:[],get_symbol:[],get_typemode:[],get_vbatt:[],gggggggg:[],given:[2,3,8],glanc:[2,8],global:[],goe:3,greater:3,green:4,gv0:[],gyro:4,halt:[],handl:[],handle_not_ready:[],happen:3,have:[2,8],header:[],heavi:3,hertz:[2,8],hex:[],high:[2,3,4,6,8],highest:3,hold:3,how:3,howev:[],htacceleromet:4,htcolor:4,htcompass:4,html:[],hyperlink:[],hysic:4,illegal_connection:[],illegal_filename:[],illegal_path:[],imag:6,immedi:[2,3,8],index:[],indic:3,individu:[3,4],infinit:3,inform:[],infrare:4,init_run:[],input:3,input_device:[],inputdeviceclral:[],inputdeviceclrchang:[],inputdevicegetbump:[],inputdevicegetchang:[],inputdevicegetconnect:[],inputdevicegetformat:[],inputdevicegetminmax:[],inputdevicegetmodenam:[],inputdevicegetnam:[],inputdevicegettypemod:[],inputdevicelist:[],inputdevicesettypemod:[],inputdevicesymbol:[],inputpars:[2,3,4,8],inputread:[],inputreadi:[],inputreadsi:[],inputtest:[],instal:6,installat:[],instanc:[3,4],instead:[2,3,4,8],instruct:6,interfac:[2,8],intern:3,internalreset:3,interpret:3,intuit:6,inverserect:[],iotyp:[],isconnect:[2,8],iscorrupt:[],isrun:3,iter:3,itself:3,keep:3,kind:3,kit:[],know:[],lab:6,largemotor:4,last:3,later:3,layer:[2,3,4,6,8],lc0:[],lc1:[],lc2:[],lc4:[],lcs:[],lead:3,led:[],left:3,length:[],less:3,level:[2,3,4,6,8],licens:[],like:3,limit:3,limitmod:3,limitvalu:[2,3,8],line:[],link:[],list:[],list_files:[],list_open_handles:[],listen:4,listfil:[],littl:[],llllll:[],llllllgg:[],load:3,local:[],longtobyt:[],look:6,loop:3,low:[2,6,8],lower:3,lv0:[],mac:[],mai:3,mailbox:[],mailboxwrit:[],mainli:4,make:3,manual:[],master:3,max:[],max_command_globals:[],max_command_locals:[],mean:3,mediummotor:4,meet:6,messag:3,method:[2,3,8],millisecond:[2,3,8],min:[],mind:3,minstorm:[],mmi:[],mode:[2,3,4,8],modul:[],more:[],mostli:[3,6],motor:[],motora:[2,3,8],motorb:[2,3,8],motorc:[2,8],motord:[2,8],move:3,msg:[],multipl:[2,3,4,8],name:3,necessari:[],need:[3,4],neg:3,newpag:[],no_handles_available:[],no_permission:[],none:4,nos:[],note:[2,3,4,8],now:[3,4],number:[],numer:[2,3,4,8],nxt:6,nxtcolor:4,nxtlight:4,nxtsound:4,nxttemperatur:4,nxttouch:4,nxtultrason:4,object:[2,3,4,8],occur:[],off:[2,3,4,8],old:3,onc:[2,3,4,8],once:4,onli:3,only:[2,3,4,8],opcod:[2,3,8],opcom_ready:[],opcom_test:[],opcomget:[],opcomget_get_brickname:[],opcomget_id:[],opcomget_network:[],opcomset:[],opcomset_set_brickname:[],opinput_device_clr_all:[],opinput_device_clr_changes:[],opinput_device_get_bumps:[],opinput_device_get_changes:[],opinput_device_get_connection:[],opinput_device_get_format:[],opinput_device_get_minmax:[],opinput_device_get_modename:[],opinput_device_get_name:[],opinput_device_get_symbol:[],opinput_device_get_typemode:[],opinput_device_list:[],opinput_device_set_typemode:[],opinput_read:[],opinput_readsi:[],opinput_ready:[],opinput_test:[],opjr:[],opmailbox_write:[],opnop:[],opobject_end:[],opoutput_clr_count:[],opoutput_get_count:[],opoutput_polarity:[],opoutput_power:[],opoutput_read:[],opoutput_ready:[],opoutput_reset:[],opoutput_set_type:[],opoutput_speed:[],opoutput_start:[],opoutput_step_power:[],opoutput_step_speed:[],opoutput_step_sync:[],opoutput_stop:[],opoutput_test:[],opoutput_time_power:[],opoutput_time_speed:[],opoutput_time_sync:[],opposit:3,opsound:[],opsound_break:[],opsound_play:[],opsound_ready:[],opsound_repeat:[],opsound_test:[],opsound_tone:[],optimer:[],optimer_read:[],optimer_ready:[],optimer_wait:[],optional:[2,8],opui_draw:[],opui_draw_circle:[],opui_draw_clean:[],opui_draw_fillcircle:[],opui_draw_fillrect:[],opui_draw_fillwindow:[],opui_draw_inverserect:[],opui_draw_line:[],opui_draw_pixel:[],opui_draw_rect:[],opui_draw_restore:[],opui_draw_select_font:[],opui_draw_store:[],opui_draw_text:[],opui_draw_topline:[],opui_draw_update:[],opui_draw_value:[],opui_flush:[],opui_read:[],opui_read_get_lbatt:[],opui_read_get_vbatt:[],opui_write:[],opui_write_init_run:[],opui_write_led:[],opui_write_put_string:[],other:[3,4],otherwis:3,output:[2,8],outputclrcount:[],outputgetcount:[],outputpolar:[],outputpow:[],outputread:[],outputreadi:3,outputreset:[],outputspe:[],outputstart:[],outputsteppow:[],outputstepspe:[],outputstepsync:[],outputstop:[],outputstopal:[],outputtest:3,outputtimepow:[],outputtimespe:[],outputtimesync:[],over:[],packag:[],packet:[2,3,8],page:[],paramet:[2,3,4,8],part:6,pass:[3,4],path:[2,8],paus:[2,8],pdf:[],percent:[2,3,8],percentag:[2,3,8],physic:[2,3,4,8],pin:[],pixel:[],plai:[2,8],play:[],playback:[],playthreeton:[],playton:[2,8],plot:[],plotsensor:[],point:3,polar:[],poll:3,port:[2,3,4,8],posit:3,possibl:[3,4],power:[2,3,8],press:[],pretti:3,previous:3,print:[2,8],probabl:3,program:3,programheader:[],properti:[2,3,4,8],prox:4,pull:3,push:4,put_string:[],rais:3,ramp:[],rate:4,ratio:3,raw:4,reach:3,read:[2,3,4,6,8],readi:[],readm:[],readmailbox:[],ready:[],realli:[],reason:3,receiv:[2,3,8],recogn:[],rect:[],red:4,refer:[],reflect:4,regul:3,releas:3,remot:4,repeat:[],repli:3,repres:[3,4],request:3,requir:[],reset:[2,3,4,8],resetposit:3,resettachocount:3,respect:3,respons:3,restart:[],restore:[],result:3,rfcomm0:[2,3,4,8],rfcomm1:[2,8],rfcomm2:[2,8],right:[3,4],rmsg:[],robot:[3,6],rotat:[],run:3,rwth:6,same:[2,3,8],search:[],second:[2,3,8],secur:3,see:[2,3,8],seed:[],seek:4,seem:[2,8],select_font:[],send:[2,3,6,8],sensor1:[2,4,8],sensor2:[2,8],sensor3:[2,8],sensor4:[2,8],sensor:[],sent:[2,8],serial:[2,8],serport:[2,3,4,8],set:[2,3,4,6,8],set_brickname:[],set_typemode:[],setbrak:3,setbundleid:[],setbundleseedid:[],setpow:[],setproperti:[2,3,4,8],setup:[2,8],sever:6,should:3,show:[],simplifi:6,sinc:[],size:[],size_error:[],slave:3,slow:3,slower:3,slowli:3,smoothli:3,smoothstart:3,smoothstop:3,some:3,sometim:3,somewhat:3,soon:[],sooner:3,sound:[],soundplayton:[],soundreadi:[],soundstopton:[],soundtest:[],sourc:[2,3,4,8],speaker:[],special:[],specifi:4,speed:3,speedregul:3,spin:3,start:[2,3,6,8],state:3,statu:[2,3,8],still:3,stop:[2,3,8],stopallmotor:[2,8],stopton:[2,8],store:[],straight:3,string:[2,8],student:6,stuff:[2,3,8],subcallheader:[],subcod:[],sublay:[3,4],success:[],suppos:3,symbol:[],sync:3,syncedstart:3,syncedstop:3,synchron:3,syncmotor:3,system:[],system_command_no_reply:[],system_command_reply:[],system_reply:[],system_reply_error:[],tacho:3,tachocount:3,tacholimit:3,tachomet:[],take:[3,6],test:[2,3,8],text:[],than:3,them:[2,3,4,8],thi:[2,3,4,6,8],thoroughli:[2,8],three:[],threetonebytecod:[],through:[],thrown:[],tight:[],time:3,timeout:3,tone:[2,8],toneplai:[2,8],too:3,topline:[],touch:4,transfer:[],tricki:3,trust:[],turn:[2,3,4,8],turn_ratio:[],turnratio:3,two:3,type:[2,3,4,8],uireadlbatt:[],uireadvbatt:[],ultrason:4,und:3,undefin:4,unexpect:3,unit:[],unknown:4,unknown_error:[],unknown_handle:[],until:3,updat:[],update:[],upload:[],usb:[],use:3,user:[2,8],valid:[],valu:[2,3,4,6,8],value:[],varargin:[2,3,4,8],variabl:[],variou:6,via:[2,3,4,6,8],view:[2,8],virtual:[2,8],visibl:[],vmthreadheader:[],voltag:[2,3,8],volum:[2,8],wai:6,wait:[],waitfor:[2,3,8],want:6,wast:3,weird:3,wfaddr:[],wfport:[],wfsn:[],what:[2,3,4,8],whatev:3,when:[2,3,8],whether:[],which:[3,4],white:4,wide:[],wifi:[],without:3,wordtobyt:[],work:[2,3,4,8],workaround:3,would:3,wrap:[2,8],writable:[2,3,4,8],write:[],writemailbox:[],wrong:[2,8],yet:[2,8],you:[3,4,6],your:6,zero:[]},titles:["CommandLayer","CommunicationLayer","EV3","Motor","Sensor","Examples","MATLAB Toolbox for controlling Lego Mindstorms EV3","General","EV3"],titleterms:{bluetooth:1,command:0,commandlay:0,communicationinterfac:0,communicationlay:1,content:6,contribut:7,control:6,ev3:[2,6,8],exampl:5,gener:7,indice:[],inform:[],installat:7,lego:6,licens:7,matlab:6,mindstorm:6,motor:3,sensor:4,tabl:[],toolbox:6,usb:1}}) \ No newline at end of file diff --git a/docs/_build/html/source.html b/docs/_build/html/source.html index f093d5eaf1bbcf2d8c58ad814bc7d976edb81784..2e5acbc979fbd5a766fc31941b7b374fd45f5847 100644 --- a/docs/_build/html/source.html +++ b/docs/_build/html/source.html @@ -74,6 +74,10 @@ <li class="toctree-l1"><a class="reference internal" href="Motor.html">Motor</a></li> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="CommandLayer.html">CommandLayer</a></li> +<li class="toctree-l1"><a class="reference internal" href="CommunicationLayer.html">CommunicationLayer</a></li> +</ul> </ul> </li> diff --git a/docs/index.rst b/docs/index.rst index 4ebb311f2fe3915e3d5b5dba277214e1933c6419..f790a41dd18ca65e4ca9c630800801abb68b8658 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,18 +9,20 @@ MATLAB Toolbox for controlling Lego Mindstorms EV3 This MATLAB toolbox was designed to abstract and simplify controlling Lego Mindstorms EV3 robots. Via Bluetooth or USB you can read sensor values or control -your robots' motors in an intuitive way. On a low level (the ##hyperlink## Communication -layer) you are able to send various commands directly to the brick, while on a high level, +your robots' motors in an intuitive way. On a low level (the :doc:`Communication +layer <CommunicationLayer>`) you are able to send various commands directly to the brick, while on a high level, several classes abstract this behaviour for you. If you want to easily access your EV3 robot, these are the classes you will mostly use. -Take a look at the ##link to readme## for installation instructions. +To get started, take a look at the :doc:`installation instructions <readme>` and :doc:`examples <examples>`. This toolbox is being developed at the RWTH Aachen, Germany, as part of the students' lab -##hyperlink## 'MATLAB meets Mindstorms'. It is the follow-up of the widely used ##hyperlink## MATLAB NXT Toolbox. +'MATLAB meets Mindstorms'. It is the follow-up of the `MATLAB NXT Toolbox`_. ##image## +.. _MATLAB NXT Toolbox: http://www.mindstorms.rwth-aachen.de/trac/ + Contents ======== @@ -46,5 +48,6 @@ Advanced .. toctree:: :maxdepth: 2 - + CommandLayer.rst + CommunicationLayer.rst diff --git a/docs/process.py b/docs/process.py index 14e26754d2e9fa83bc9a4f855dcfd45226c613e1..7704a4582f74a583fb34b0ce802101f9991c0a8b 100644 --- a/docs/process.py +++ b/docs/process.py @@ -24,7 +24,7 @@ def preprocess(): with open(abs_path, 'w') as ftemp: content = f.readlines() if content[0] == '%TEMP-FILE FOR BUILDING DOCUMENTATION\n': - raise RuntimeError('Found already preprocessed file.') + raise RuntimeError('Found already preprocessed file: ' + file_name) try: for i, line in enumerate(content): # Worst runtime ever @@ -91,13 +91,19 @@ def postprocess_html_files(): with open(current_file, 'r') as f_old: with open(abs_path, 'w') as f_new: content = f_old.readlines() - # print('opened ' + current_file) for i, line in enumerate(content): + # Replace ` with ' + # This is necessary to make code examples copy-pastable. During the + # creation of the html-files, ' has been replaced by ` for some reason. :( if('‘' in line or '’' in line): - f_new.write(line.replace('‘', '\'').replace('’', '\'')) - else: - f_new.write(line) - print('Postprocessed file ' + current_file) + line = line.replace('‘', '\'').replace('’', '\'') + + # Delete module name from class documentation + ugly_module_string = '<code class="descclassname">source.</code>' + if(ugly_module_string in line): + line = line.replace(ugly_module_string, '') + + f_new.write(line) close(fh) remove(current_file) move(abs_path, current_file)