diff --git a/docs/__pycache__/process.cpython-34.pyc b/docs/__pycache__/process.cpython-34.pyc new file mode 100644 index 0000000000000000000000000000000000000000..64ba10fe86362119ab3a4e3b6db72b12217361e7 Binary files /dev/null and b/docs/__pycache__/process.cpython-34.pyc differ diff --git a/docs/_build/doctrees/CommunicationLayer.doctree b/docs/_build/doctrees/CommunicationLayer.doctree index 762c24eb0ec2c4441a9b2de7e44a9edf928c029e..355337ddbe6b72d7f19aeb95ee24a9458023eef4 100644 Binary files a/docs/_build/doctrees/CommunicationLayer.doctree and b/docs/_build/doctrees/CommunicationLayer.doctree differ diff --git a/docs/_build/doctrees/EV3.doctree b/docs/_build/doctrees/EV3.doctree index 69672639e54c704cb352a341c01f93d071c57ab3..f268aaa0ab05c97937dd1550fd354decce454983 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 99bd358f2448805b5bbb924e554bf55b2d155f4f..002d4ff59880173f8926d242e29804f34c07f018 100644 Binary files a/docs/_build/doctrees/Motor.doctree and b/docs/_build/doctrees/Motor.doctree differ diff --git a/docs/_build/doctrees/Sensor.doctree b/docs/_build/doctrees/Sensor.doctree index 8a6258e693fd2bad507f0b2ef1b8fdb510e9a97b..c15f329fef75f7b84f3e201fec31e5c7777ed2c9 100644 Binary files a/docs/_build/doctrees/Sensor.doctree and b/docs/_build/doctrees/Sensor.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 3f618fbea3f0133ae475d354ebf6f336ea4c78e2..d0e3f355e446c8d3a8357f6b613a283c3415490b 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/hid.doctree b/docs/_build/doctrees/hid.doctree index a836cbb5790318295ad88da50ea6ea89f8570986..c5e55fe4c904ef0c2081a52aab250a2f1519df1a 100644 Binary files a/docs/_build/doctrees/hid.doctree and b/docs/_build/doctrees/hid.doctree differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree index 71c3da6d49bc8b22ff1d549cbeb05bb425aa5b02..19bbb9eaf0de3d7adee983c3abb8afa5a8938a92 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 064a22e02b19f19c629d5631abcd64dc98202c24..10fd5a846a2c6469d73d1e9444d353551adab5fa 100644 Binary files a/docs/_build/doctrees/readme.doctree and b/docs/_build/doctrees/readme.doctree differ diff --git a/docs/_build/doctrees/source.doctree b/docs/_build/doctrees/source.doctree index aa44ad855404e46fa33a50b124492c8361231c39..a3349dabe5a1b10078cbc28a7f0a0b93973136df 100644 Binary files a/docs/_build/doctrees/source.doctree and b/docs/_build/doctrees/source.doctree differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo index ba95512a49cf9e20b3eb5a7cae4f2b1ab92c2926..a8f899b5d98c61fad6edf9f82630d8a2ccc5e335 100644 --- a/docs/_build/html/.buildinfo +++ b/docs/_build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 647b9b9f8e20873130f8a12e22a915d1 +config: 42809051028c0ea2e31137f7f9be60d4 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/CommandLayer.html b/docs/_build/html/CommandLayer.html index b955febd72e324f0af4ed08999a2a6168f6a68b8..cfa7980cae94034d8e268489073dbbd255aa84f1 100644 --- a/docs/_build/html/CommandLayer.html +++ b/docs/_build/html/CommandLayer.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>CommandLayer — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>CommandLayer — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.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'> @@ -50,7 +50,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -66,10 +66,6 @@ <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> @@ -157,7 +153,7 @@ </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/CommunicationLayer.html b/docs/_build/html/CommunicationLayer.html index 72af7372394b377e3420219dbaac9c6ec0cad119..470f3488002c41efa2c40a849dedeab4f7de7fb2 100644 --- a/docs/_build/html/CommunicationLayer.html +++ b/docs/_build/html/CommunicationLayer.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>CommunicationLayer — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>CommunicationLayer — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.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'> @@ -50,7 +50,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -66,10 +66,6 @@ <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> @@ -157,7 +153,7 @@ </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/EV3.html b/docs/_build/html/EV3.html index 4e94f69ee86b8fa46f2317fc91d1d601b9dce1d6..a189e2ef587a4ee1c74779535e946ac204408b39 100644 --- a/docs/_build/html/EV3.html +++ b/docs/_build/html/EV3.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>EV3 — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>EV3 — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,9 +30,9 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <link rel="next" title="Motor" href="Motor.html" /> - <link rel="prev" title="Examples" href="examples.html" /> + <link rel="prev" title="MATLAB Toolbox for controlling Lego Mindstorms EV3" href="index.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'> @@ -52,7 +52,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,11 +67,7 @@ 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 class="current"> + aria-labelledby="dLabelGlobalToc"><ul class="current"> <li class="toctree-l1 current"><a class="current reference internal" href="#">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> @@ -103,7 +99,7 @@ <li> - <a href="examples.html" title="Previous Chapter: Examples"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Examples</span> + <a href="index.html" title="Previous Chapter: MATLAB Toolbox for controlling Lego Mindstorms EV3"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« MATLAB Toolbo...</span> </a> </li> <li> @@ -151,7 +147,7 @@ <dd><ul class="first last simple"> <li><a class="reference internal" href="#source.EV3.connect" title="source.EV3.connect"><code class="xref mat mat-meth docutils literal"><span class="pre">connect()</span></code></a></li> <li><a class="reference internal" href="#source.EV3.disconnect" title="source.EV3.disconnect"><code class="xref mat mat-meth docutils literal"><span class="pre">disconnect()</span></code></a></li> -<li><a class="reference internal" href="#source.EV3.stopAllMotors" title="source.EV3.stopAllMotors"><code class="xref mat mat-meth docutils literal"><span class="pre">stopAllMotors()</span></code></a></li> +<li><code class="xref mat mat-meth docutils literal"><span class="pre">stopAllMotors()</span></code></li> <li><a class="reference internal" href="#source.EV3.beep" title="source.EV3.beep"><code class="xref mat mat-meth docutils literal"><span class="pre">beep()</span></code></a></li> <li><a class="reference internal" href="#source.EV3.playTone" title="source.EV3.playTone"><code class="xref mat mat-meth docutils literal"><span class="pre">playTone()</span></code></a></li> <li><a class="reference internal" href="#source.EV3.stopTone" title="source.EV3.stopTone"><code class="xref mat mat-meth docutils literal"><span class="pre">stopTone()</span></code></a></li> @@ -371,12 +367,6 @@ b.setProperties('debug', 'on', 'batteryMode', 'Voltage'); % <br /> <p>See also EV3.DEBUG, EV3.BATTERYMODE / <a class="reference internal" href="#source.EV3.debug" title="source.EV3.debug"><code class="xref mat mat-attr docutils literal"><span class="pre">debug</span></code></a>, <a class="reference internal" href="#source.EV3.batteryMode" title="source.EV3.batteryMode"><code class="xref mat mat-attr docutils literal"><span class="pre">batteryMode</span></code></a></p> </dd></dl> -<dl class="method"> -<dt id="source.EV3.stopAllMotors"> -<code class="descname">stopAllMotors</code><span class="sig-paren">(</span><em>ev3</em><span class="sig-paren">)</span><a class="headerlink" href="#source.EV3.stopAllMotors" title="Permalink to this definition">¶</a></dt> -<dd><p>Sends a stop-command to all motor-ports.</p> -</dd></dl> - <dl class="method"> <dt id="source.EV3.stopTone"> <code class="descname">stopTone</code><span class="sig-paren">(</span><em>ev3</em><span class="sig-paren">)</span><a class="headerlink" href="#source.EV3.stopTone" title="Permalink to this definition">¶</a></dt> @@ -428,7 +418,7 @@ b.tonePlayed(); % -> Outputs 1 to console. <br /></dd> </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/Motor.html b/docs/_build/html/Motor.html index ca7b2994609aeb46a61e498ebfbc6195f5b1314a..dbad6f263b3f2c7a86ce3238e0832c65faafc4f8 100644 --- a/docs/_build/html/Motor.html +++ b/docs/_build/html/Motor.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Motor — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>Motor — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <link rel="next" title="Sensor" href="Sensor.html" /> <link rel="prev" title="EV3" href="EV3.html" /> <meta charset='utf-8'> @@ -52,7 +52,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,11 +67,7 @@ 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 class="current"> + aria-labelledby="dLabelGlobalToc"><ul class="current"> <li class="toctree-l1"><a class="reference internal" href="EV3.html">EV3</a></li> <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> @@ -463,7 +459,7 @@ connected as speed correctly returns 0 if it's not)</li> </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/Sensor.html b/docs/_build/html/Sensor.html index 0b371c9ee333d4683cfd1a4ec1a50e3bddebc58b..937f91b8fe6e7297531e145e50fe1b7e9a19a3e6 100644 --- a/docs/_build/html/Sensor.html +++ b/docs/_build/html/Sensor.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Sensor — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>Sensor — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <link rel="next" title="hidapi" href="hid.html" /> <link rel="prev" title="Motor" href="Motor.html" /> <meta charset='utf-8'> @@ -52,7 +52,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,11 +67,7 @@ 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 class="current"> + aria-labelledby="dLabelGlobalToc"><ul class="current"> <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 current"><a class="current reference internal" href="#">Sensor</a></li> @@ -360,16 +356,8 @@ command has been called. <em>[WRITABLE]</em></p> <code class="descname">reset</code><span class="sig-paren">(</span><em>sensor</em><span class="sig-paren">)</span><a class="headerlink" href="#source.Sensor.reset" title="Permalink to this definition">¶</a></dt> <dd><p>Resets sensor value.</p> <p class="rubric">Notes</p> -<ul> -<li><p class="first">This clears ALL the sensors right now, no other Op-Code available... :(</p> -<blockquote> -<div><dl class="docutils"> -<dt>warning(['Current version of reset resets ALL devices, that is, ',...</dt> -<dd><p class="first last">'all motor tacho counts and all other sensor counters!']);</p> -</dd> -</dl> -</div></blockquote> -</li> +<ul class="simple"> +<li>Has not been thoroughly tested but seems to work as expected</li> </ul> </dd></dl> @@ -413,7 +401,7 @@ b.sensor1.setProperties('debug', 'on', 'mode', DeviceMode.Color.Ambient); % <br </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt index 157a890c15b3b897ca5e3259d9f5fbe22c3fe0fe..9ee56c01ac71e7761e2ef9b53c971f77a9372926 100644 --- a/docs/_build/html/_sources/index.txt +++ b/docs/_build/html/_sources/index.txt @@ -4,50 +4,32 @@ contain the root `toctree` directive. ================================================== -MATLAB Toolbox for controlling Lego Mindstorms EV3 +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 :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. +Hi there! This is the documentation for the "Lego Mindstorms EV3" MATLAB Toolbox, +developed by RWTH Aachen. For an introduction about this toolbox, installation +guides and examples, take a look at `our repository`_. -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 -'MATLAB meets Mindstorms'. It is the follow-up of the `MATLAB NXT Toolbox`_. - - -.. _MATLAB NXT Toolbox: http://www.mindstorms.rwth-aachen.de/trac/ +.. _our repository: https://git.rwth-aachen.de/mindstorms/ev3-toolbox-matlab/blob/master/readme.md Contents ======== -Setting up the toolbox +High-Level documentation .. toctree:: :maxdepth: 2 - readme - examples - -Toolbox documentation - -.. toctree:: - :maxdepth: 2 - EV3 Motor Sensor -Advanced +Low-Level documentation .. toctree:: :maxdepth: 3 - + hid usbBrickIO btBrickIO - diff --git a/docs/_build/html/btBrickIO.html b/docs/_build/html/btBrickIO.html index 9ac6d3b9f9506fc264345c97c32d72d3bedc9fb3..95bd5beed7fbece07a9635c50de01f0b39c37ce7 100644 --- a/docs/_build/html/btBrickIO.html +++ b/docs/_build/html/btBrickIO.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>btBrickIO — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>btBrickIO — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <link rel="prev" title="usbBrickIO" href="usbBrickIO.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> @@ -51,7 +51,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,10 +67,6 @@ <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> @@ -281,7 +277,7 @@ BTBRICKIO.CHANNEL, BTBRICKIO.TIMEOUT</p> </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/examples.html b/docs/_build/html/examples.html index 96fe6575db57fee9ba3982487e39e1304ccf4e8a..9254b0d6dda739f8b36b731d8f183cc2adaf2ec5 100644 --- a/docs/_build/html/examples.html +++ b/docs/_build/html/examples.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Examples — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>Examples — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,9 +30,7 @@ <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="EV3" href="EV3.html" /> - <link rel="prev" title="General" href="readme.html" /> + <link rel="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.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'> @@ -52,7 +50,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,11 +65,7 @@ href="index.html">Site <b class="caret"></b></a> <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</a></li> -<li class="toctree-l1 current"><a class="current reference internal" href="#">Examples</a></li> -</ul> -<ul> + aria-labelledby="dLabelGlobalToc"><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> @@ -102,14 +96,6 @@ - <li> - <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="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> @@ -170,7 +156,7 @@ </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html index 823964d32ed6f43943cf41957c512931dade0dbf..a868ed34dffeba5f4ab547fbefc3fb2565611d69 100644 --- a/docs/_build/html/genindex.html +++ b/docs/_build/html/genindex.html @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Index — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>Index — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -16,7 +16,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -31,7 +31,7 @@ <script type="text/javascript" src="_static/bootstrap-sphinx.js"></script> <link rel="index" title="Index" href="#" /> <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.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'> @@ -51,7 +51,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,10 +67,6 @@ <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> @@ -589,10 +585,6 @@ </dt> - <dt><a href="EV3.html#source.EV3.stopAllMotors">stopAllMotors() (source.EV3 method)</a>, <a href="source.html#source.EV3.stopAllMotors">[1]</a> - </dt> - - <dt><a href="EV3.html#source.EV3.stopTone">stopTone() (source.EV3 method)</a>, <a href="source.html#source.EV3.stopTone">[1]</a> </dt> @@ -712,7 +704,7 @@ </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/hid.html b/docs/_build/html/hid.html index deffa114aab5da46eb95089f36e78019a22f7b89..9b1866a66beca190d56e05d9db2b9187b4a40d39 100644 --- a/docs/_build/html/hid.html +++ b/docs/_build/html/hid.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>hidapi — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>hidapi — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <link rel="next" title="usbBrickIO" href="usbBrickIO.html" /> <link rel="prev" title="Sensor" href="Sensor.html" /> <meta charset='utf-8'> @@ -52,7 +52,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -68,10 +68,6 @@ <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> @@ -456,7 +452,7 @@ reported number of bytes written.</li> </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 405118001f2b56e232cdd231bc4f4fcfcc6ad12d..deee34728f91dad5957755d30902e7f05813ce7b 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>MATLAB Toolbox for controlling Lego Mindstorms EV3 — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>MATLAB Toolbox for controlling Lego Mindstorms EV3 — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,8 +30,8 @@ <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="#" /> - <link rel="next" title="General" href="readme.html" /> + <link rel="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="#" /> + <link rel="next" title="EV3" href="EV3.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'> @@ -51,7 +51,7 @@ </button> <a class="navbar-brand" href="#"> Mindstorms EV3 Toolbox</a> - <span class="navbar-text navbar-version pull-left"><b>v0.4</b></span> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,10 +67,6 @@ <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> @@ -107,7 +103,7 @@ <li> - <a href="readme.html" title="Next Chapter: General"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">General »</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> @@ -143,30 +139,12 @@ <div class="section" id="matlab-toolbox-for-controlling-lego-mindstorms-ev3"> <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 <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>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 -‘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>Hi there! This is the documentation for the “Lego Mindstorms EV3” MATLAB Toolbox, +developed by RWTH Aachen. For an introduction about this toolbox, installation +guides and examples, take a look at <a class="reference external" href="https://git.rwth-aachen.de/mindstorms/ev3-toolbox-matlab/blob/master/readme.md">our repository</a>.</p> <div class="section" id="contents"> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2> -<p>Setting up the toolbox</p> -<div class="toctree-wrapper compound"> -<ul> -<li class="toctree-l1"><a class="reference internal" href="readme.html">General</a><ul> -<li class="toctree-l2"><a class="reference internal" href="readme.html#installation">Installation</a></li> -<li class="toctree-l2"><a class="reference internal" href="readme.html#contribution">Contribution</a></li> -<li class="toctree-l2"><a class="reference internal" href="readme.html#licenses">Licenses</a></li> -</ul> -</li> -<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> -</ul> -</div> -<p>Toolbox documentation</p> +<p>High-Level documentation</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="EV3.html">EV3</a></li> @@ -174,7 +152,7 @@ these are the classes you will mostly use.</p> <li class="toctree-l1"><a class="reference internal" href="Sensor.html">Sensor</a></li> </ul> </div> -<p>Advanced</p> +<p>Low-Level documentation</p> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="hid.html">hidapi</a></li> @@ -197,7 +175,7 @@ these are the classes you will mostly use.</p> </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/mat-modindex.html b/docs/_build/html/mat-modindex.html index d739141b2137025ab7ef6339693a550b9b040ac9..53f2f5806caa59bee280c86d64261d207298ed59 100644 --- a/docs/_build/html/mat-modindex.html +++ b/docs/_build/html/mat-modindex.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>MATLAB Module Index — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>MATLAB Module Index — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> @@ -57,7 +57,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -73,10 +73,6 @@ <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> @@ -161,7 +157,7 @@ </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv index 2e46e2abe484e5cc009c63b29e6cbbb90c1a4d8c..2761ae6aaad5db7c68b55918bb27c7051d1fe7ad 100644 Binary files a/docs/_build/html/objects.inv and b/docs/_build/html/objects.inv differ diff --git a/docs/_build/html/readme.html b/docs/_build/html/readme.html index d1bcc12991bfd1b1d9de908d9a6c60cff3887251..b6b3795d8879125824391be57e026844390674f2 100644 --- a/docs/_build/html/readme.html +++ b/docs/_build/html/readme.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>General — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>General — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,9 +30,7 @@ <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="Examples" href="examples.html" /> - <link rel="prev" title="MATLAB Toolbox for controlling Lego Mindstorms EV3" href="index.html" /> + <link rel="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.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'> @@ -52,7 +50,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -67,11 +65,7 @@ href="index.html">Site <b class="caret"></b></a> <ul class="dropdown-menu globaltoc" role="menu" - aria-labelledby="dLabelGlobalToc"><ul class="current"> -<li class="toctree-l1 current"><a class="current reference internal" href="#">General</a></li> -<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> -</ul> -<ul> + aria-labelledby="dLabelGlobalToc"><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> @@ -107,14 +101,6 @@ - <li> - <a href="index.html" title="Previous Chapter: MATLAB Toolbox for controlling Lego Mindstorms EV3"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« MATLAB Toolbo...</span> - </a> - </li> - <li> - <a href="examples.html" title="Next Chapter: Examples"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Examples »</span> - </a> - </li> @@ -171,7 +157,7 @@ </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html index f6c7e9d2014fc221bd5f2c37349eb0640623cee3..1adddd4bca3d3676dba91ad0a143c8b3085ae7d2 100644 --- a/docs/_build/html/search.html +++ b/docs/_build/html/search.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Search — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>Search — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -31,7 +31,7 @@ <script type="text/javascript" src="_static/bootstrap-sphinx.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="#" /> - <link rel="top" title="Mindstorms EV3 Toolbox v0.4-rc.10 documentation" href="index.html" /> + <link rel="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <script type="text/javascript"> jQuery(function() { Search.loadIndex("searchindex.js"); }); </script> @@ -58,7 +58,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -74,10 +74,6 @@ <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> @@ -166,7 +162,7 @@ </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index f9b18dd24b3d2b92511df50bcddd9f098e0e0aad..f7576ea229c474e5df54d5e6a2efa68342e6765b 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:49,filenames:["CommandLayer","CommunicationLayer","EV3","Motor","Sensor","btBrickIO","examples","hid","index","readme","source","usbBrickIO"],objects:{"":{source:[11,0,1,""]},"source.EV3":{batteryMode:[10,2,1,""],batteryValue:[10,2,1,""],beep:[10,3,1,""],connect:[10,3,1,""],debug:[10,2,1,""],disconnect:[10,3,1,""],isConnected:[10,2,1,""],motorA:[10,2,1,""],motorB:[10,2,1,""],motorC:[10,2,1,""],motorD:[10,2,1,""],playTone:[10,3,1,""],sensor1:[10,2,1,""],sensor2:[10,2,1,""],sensor3:[10,2,1,""],sensor4:[10,2,1,""],setProperties:[10,3,1,""],stopAllMotors:[10,3,1,""],stopTone:[10,3,1,""],tonePlayed:[10,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.btBrickIO":{backend:[5,2,1,""],channel:[5,2,1,""],close:[5,3,1,""],debug:[5,2,1,""],deviceName:[5,2,1,""],open:[5,3,1,""],read:[5,3,1,""],serialPort:[5,2,1,""],setProperties:[5,3,1,""],timeOut:[5,2,1,""],write:[5,3,1,""]},"source.hidapi":{close:[7,3,1,""],enumerate:[7,3,1,""],error:[7,3,1,""],exit:[7,3,1,""],getHIDInfoString:[7,3,1,""],getManufacturersString:[7,3,1,""],getProductString:[7,3,1,""],getSerialNumberString:[7,3,1,""],handle:[7,2,1,""],init:[7,3,1,""],nReadBuffer:[7,2,1,""],nWriteBuffer:[7,2,1,""],open:[7,3,1,""],productID:[7,2,1,""],read:[7,3,1,""],read_timeout:[7,3,1,""],setNonBlocking:[7,3,1,""],sheader:[7,2,1,""],slib:[7,2,1,""],vendorID:[7,2,1,""],write:[7,3,1,""]},"source.usbBrickIO":{close:[11,3,1,""],debug:[11,2,1,""],nReadBuffer:[11,2,1,""],nWriteBuffer:[11,2,1,""],open:[11,3,1,""],productID:[11,2,1,""],read:[11,3,1,""],setProperties:[11,3,1,""],timeOut:[11,2,1,""],vendorID:[11,2,1,""],write:[11,3,1,""]},source:{EV3:[10,1,1,""],Motor:[3,1,1,""],Sensor:[4,1,1,""],btBrickIO:[5,1,1,""],hidapi:[7,1,1,""],usbBrickIO:[11,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:{"0x0005":11,"0x694":11,"2nd":[2,3,4,10],"5000hz":[2,10],"abstract":8,"byte":[7,11],"case":[3,11],"catch":[2,3,10],"char":7,"class":[2,3,4,5,7,8,10,11],"default":[4,5,7,11],"final":7,"function":[3,7],"long":3,"null":7,"return":[2,3,5,7,10,11],"throw":7,"true":[2,3,5,10,11],"try":[3,5,11],"while":8,aachen:8,abl:8,abort:[2,10],about:[2,3,4,7,10],acceler:[3,4],accelerationallax:4,access:8,accident:[2,10],act:3,action:3,actual:[3,7,11],addit:7,advanc:8,affect:3,after:[3,5,7,11],afterward:3,again:3,all:[2,3,4,7,10,11],allow:4,alreadi:7,also:[2,3,4,5,7,10,11],alternatingli:[],alwai:[7,11],ambient:4,angular:4,ani:[3,11],announc:[2,3,4,10],anoth:3,append:7,apply:3,aren:3,argument:[2,3,4,10],around:3,arrai:[5,11],automat:[2,3,4,5,7,10],avail:[4,7],backend:5,base:5,batteri:[2,10],batterymod:[2,3,10],batterymode:[2,10],batteryvalu:[2,10],been:[2,3,4,5,10],beep:[2,6,10],befor:5,behav:3,behaviour:8,besid:11,better:3,between:[3,5,7,11],bigger:[7,11],bit:3,block:7,blue:4,bool:[2,3,4,5,10,11],both:3,brake:3,brakemod:3,brakemode:3,brick:[2,3,4,5,8,10,11],brickio:[5,11],brickobject:[2,3,4,10],buffer:[7,11],buggi:[],building:[],bump:4,c_output:3,call:[2,3,4,5,7,10,11],can:[3,4,5,8],car:3,cast:7,central:[2,10],chang:3,channel:5,charg:[2,10],check:[3,7],chosen:5,clear:4,close:[5,7,11],coast:3,code:4,col:4,color:4,com:[2,10],comm:[],comment:3,commerror:7,commhandl:[5,11],commun:[3,4,7,8],compil:7,connect:[2,3,4,5,6,7,10,11],connectiontyp:[2,10],consist:[3,4],consol:[2,3,4,5,10,11],constantli:3,constructor:11,contain:[2,3,4,10],continu:3,contribut:[],control:[],conveni:[2,10],cord:[2,10],correctli:3,correspond:7,could:[5,7,11],count:[3,4],counter:[3,4],cours:3,creat:[2,3,4,7,10],current:[2,3,4,10],currentspe:3,data:[5,7,11],dba:4,debug:[2,3,4,5,10,11],decim:7,defin:3,degre:[3,4],delet:[2,6,7,10],deliv:[2,10],depend:[2,3,4,5,7,10],design:8,destroi:[2,10],dev:[2,3,4,5,10],develop:[7,8],devic:[3,4,5,7,11],devicemod:4,devicenam:5,devicename:5,devicetyp:[3,4],differ:[2,7,10],direct:3,directli:[7,8],disabl:7,disconnect:[2,10],disp:[2,6,10],distcm:4,distin:4,dll:7,document:8,documentation:[],doe:[2,3,7,10,11],doesn:[],don:[3,4],done:3,down:3,durat:[2,10],dure:7,dylib:7,each:[2,3,4,5,10,11],eas:3,easili:8,either:[2,3,10],enabl:[2,7,10,11],enumer:7,equal:[2,3,10],error:[2,3,4,5,7,10,11],establish:[2,10],even:3,eventu:11,everytim:[3,4],exampl:[],execut:3,exit:7,expect:[2,6,10],explicitli:7,extens:7,facilit:4,fail:[2,10],fals:[3,5,11],far:3,fclose:5,feedback:[2,3,4,10],file:7,finish:3,firmwar:[2,3,10],first:[2,3,10],flag:7,follow:[2,3,4,5,8,10,11],fopen:5,format:[5,11],forward:3,four:3,fread:5,frequenc:[2,10],from:[2,3,4,5,7,10,11],front:7,fun:[2,6,10],fwrite:5,gener:[],germani:8,get:[2,3,7,8,10],gethidinfostr:7,getmanufacturersstr:7,getmanufacturersstring:7,getproductstr:7,getproductstring:7,getserialnumberstr:7,getserialnumberstring:7,given:[2,3,4,7,10],glanc:[2,10],goe:3,greater:3,green:4,gyro:4,handl:7,happen:3,have:[2,3,7,10],header:7,heavi:3,henc:5,here:3,hertz:[2,10],hid:[7,11],hid_device_infoptr:7,hid_open:7,hidapi:[],hidhandl:7,high:[2,3,4,8,10],highest:3,hold:3,host:[5,7],how:3,htacceleromet:4,htcolor:4,htcompass:4,http:7,hysic:4,imag:[],immedi:[2,3,10],implement:[5,11],indic:3,individu:[3,4],infinit:3,info:7,inform:[5,7],infrare:4,init:7,input:[2,3,4,10],inputpars:[2,3,4,5,10,11],instal:[7,8],installat:[],instanc:[3,4,7],instantan:[2,10],instead:[2,3,4,10],instruct:8,instrument:5,instrumentcontrol:5,int32:7,interfac:[2,5,7,10,11],intern:3,internalreset:3,interpret:3,intuit:8,invalid:7,invalidhandl:7,isconnect:[2,10],isconnected:[2,10],isrun:3,iter:[],itself:7,keep:3,kind:3,know:7,lab:8,largemotor:4,last:3,later:[],layer:[3,4,8],lead:[],left:3,length:7,less:3,level:[2,3,4,8,10],librari:[7,11],licens:[],like:3,limit:3,limitmod:3,limitvalu:[2,3,6,10],linux:[5,7],list:[2,3,4,5,7,10,11],listen:4,load:3,look:8,loop:3,low:[2,8,10],lower:3,mac:[5,7],made:5,mai:[2,3,4,10],mainli:4,make:3,manufactur:7,mark:[2,3,4,10],master:3,matlab:[],maximum:11,mean:3,mediummotor:4,meet:8,messag:3,meth:[],method:[2,3,4,5,7,10,11],millisecond:[2,3,7,10,11],mind:3,mismatch:7,mode:[2,3,4,10],modul:5,mostli:[3,8],motor:[],motora:[2,3,4,6,10],motorb:[2,3,10],motorc:[2,10],motord:[2,10],move:3,multipl:[2,3,4,5,10,11],must:7,myev3:5,name:[2,3,4,5,7,10],nearli:11,necessari:[2,10],need:[2,3,4,5,7,10,11],neg:3,next:3,non:7,nonblock:7,none:4,note:[2,3,4,5,7,10,11],noth:[2,10],now:[2,4,10],nreadbuff:[7,11],nreadbuffer:11,number:7,numer:[2,3,4,5,7,10,11],nwritebuff:[7,11],nwritebuffer:11,nxt:8,nxtcolor:4,nxtlight:4,nxtsound:4,nxttemperatur:4,nxttouch:4,nxtultrason:4,object:[2,3,4,5,7,10],occur:[5,7,11],off:[2,3,4,10],old:[],onc:[2,3,4,5,10,11],once:4,onli:[],only:[2,3,4,5,10],opcod:3,open:[5,7,11],opposit:3,option:[2,3,4,5,10,11],optional:[2,3,4,10],order:[2,10],oss:7,other:[3,4],otherwis:3,output:[2,10,11],outputreadi:3,outputtest:[],packet:[2,3,5,7,10,11],pair:5,paramet:[2,3,4,5,7,10,11],part:8,pass:[3,4],path:[2,5,10],paus:[2,10],percent:[2,3,10],percentag:[2,3,10],physic:[2,3,4,10],plai:[2,10],playton:[2,10],point:3,pointer:7,poll:3,port:[2,3,4,5,6,10],posit:3,possibl:[3,4,7],potenti:5,power:[2,3,4,6,10],preced:[2,3,4,10],pretti:3,previous:3,print:[2,7,10],probabl:3,produc:7,product:[7,11],productid:[7,11],program:3,properti:[2,3,4,5,10,11],propertyname1:[5,11],propertyname2:[5,11],propertyvalue1:[5,11],propertyvalue2:[5,11],prox:4,pull:[2,3,10],push:4,rais:3,random:[2,6,10],rate:4,ratio:3,raw:4,reach:3,read:[2,3,4,5,7,8,10,11],read_timeout:7,reason:3,receiv:[2,3,10],red:4,reflect:4,regul:3,regular:3,releas:3,remot:4,repli:3,report:7,reportid:7,repres:[3,4],request:3,reset:[2,3,4,10],resetposit:3,resettachocount:3,resiz:7,respect:3,respons:3,result:3,rfcomm0:[2,3,4,5,10],rfcomm1:[2,10],rfcomm2:[2,10],right:[3,4],robot:[3,8],run:3,rwth:8,same:3,second:[2,5,10],secur:3,see:[2,3,4,5,7,10,11],seek:4,seem:[2,10],send:[2,3,8,10],sensor1:[2,4,6,10],sensor2:[2,10],sensor3:[2,10],sensor4:[2,10],sensor:[],sent:[2,10],serial:[2,5,7,10],serialport:5,serport:[2,3,4,5,10],set:[2,3,4,5,7,8,10,11],setbrak:3,setnonblock:7,setproperti:[2,3,4,5,6,10,11],setup:[2,10],sever:8,share:7,sheader:7,should:[3,7,11],shown:5,signal11:7,simplifi:8,size:[7,11],slave:3,slib:7,slow:3,slower:3,slowli:3,small:[2,10],smoothli:3,smoothstart:3,smoothstop:3,some:[3,7],sometim:[],somewhat:3,sooner:[],sourc:[2,3,4,5,7,10,11],specifi:[3,4],speed:3,speedregul:3,spin:3,start:[2,3,6,8,10],state:3,statu:[2,3,10],still:3,stop:[2,3,10],stopallmotor:[2,10],stopton:[2,10],straight:3,string:[2,3,4,5,7,10],struct:7,student:8,stuff:[2,3,10],sublay:[3,4],success:7,suppos:3,sure:5,sync:3,syncedstart:3,syncedstop:3,synchron:3,syncmotor:3,syntax:[2,3,4,5,10,11],system:[5,7],tacho:[3,4],tachocount:3,tacholimit:3,take:[3,8],temp:[],test:[2,3,5,10],than:[3,7,11],them:[2,3,4,10],thi:[2,3,4,5,6,7,8,10],think:7,thoroughli:[2,10],through:[5,11],time:3,timeout:[3,5,7,11],tone:[2,10],toneplai:[2,10],too:3,toolbox:[],touch:4,tricki:3,turn:[2,3,4,10],turnratio:3,two:3,type:[2,3,4,7,10],uint16:7,uint8:[5,7,11],ultrason:4,und:3,undefin:4,unexpect:[],unexpectedli:7,unknown:4,until:3,usage:5,usbbrickio:[],use:[3,11],user:[2,10],using:7,valid:[5,7,11],valu:[2,3,4,6,7,8,10],varargin:[2,3,4,5,10,11],variou:8,vendor:[7,11],vendorid:[7,11],version:4,via:[2,3,4,5,8,10,11],view:[2,10],virtual:[2,10],voltag:[2,3,10],volum:[2,10],wai:8,waitfor:[2,3,6,10],want:8,warn:4,wast:3,weird:3,what:[2,3,4,10],whatev:3,when:[2,3,4,5,7,10,11],which:[2,3,4,5,7,10,11],white:4,window:[5,7],without:[3,7],wmsg:[5,7,11],work:[2,3,4,10,11],workaround:3,would:[2,3,4,10],wrap:[],writable:[2,3,4,10],write:[5,7,11],written:[5,7,11],wrong:[2,10],www:7,xcode:7,yet:[2,10],you:[3,4,7,8,11],your:8},titles:["CommandLayer","CommunicationLayer","EV3","Motor","Sensor","btBrickIO","Examples","hidapi","MATLAB Toolbox for controlling Lego Mindstorms EV3","General","EV3","usbBrickIO"],titleterms:{bluetooth:1,btbrickio:5,command:0,commandlay:0,communicationinterfac:0,communicationlay:1,content:8,contribut:9,control:8,ev3:[2,8,10],exampl:6,gener:9,hidapi:7,installat:9,lego:8,licens:9,matlab:8,mindstorm:8,motor:3,sensor:4,toolbox:8,usb:1,usbbrickio:11}}) \ No newline at end of file +Search.setIndex({envversion:49,filenames:["CommandLayer","CommunicationLayer","EV3","Motor","Sensor","btBrickIO","examples","hid","index","readme","source","usbBrickIO"],objects:{"":{source:[11,0,1,""]},"source.EV3":{batteryMode:[10,2,1,""],batteryValue:[10,2,1,""],beep:[10,3,1,""],connect:[10,3,1,""],debug:[10,2,1,""],disconnect:[10,3,1,""],isConnected:[10,2,1,""],motorA:[10,2,1,""],motorB:[10,2,1,""],motorC:[10,2,1,""],motorD:[10,2,1,""],playTone:[10,3,1,""],sensor1:[10,2,1,""],sensor2:[10,2,1,""],sensor3:[10,2,1,""],sensor4:[10,2,1,""],setProperties:[10,3,1,""],stopTone:[10,3,1,""],tonePlayed:[10,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.btBrickIO":{backend:[5,2,1,""],channel:[5,2,1,""],close:[5,3,1,""],debug:[5,2,1,""],deviceName:[5,2,1,""],open:[5,3,1,""],read:[5,3,1,""],serialPort:[5,2,1,""],setProperties:[5,3,1,""],timeOut:[5,2,1,""],write:[5,3,1,""]},"source.hidapi":{close:[7,3,1,""],enumerate:[7,3,1,""],error:[7,3,1,""],exit:[7,3,1,""],getHIDInfoString:[7,3,1,""],getManufacturersString:[7,3,1,""],getProductString:[7,3,1,""],getSerialNumberString:[7,3,1,""],handle:[7,2,1,""],init:[7,3,1,""],nReadBuffer:[7,2,1,""],nWriteBuffer:[7,2,1,""],open:[7,3,1,""],productID:[7,2,1,""],read:[7,3,1,""],read_timeout:[7,3,1,""],setNonBlocking:[7,3,1,""],sheader:[7,2,1,""],slib:[7,2,1,""],vendorID:[7,2,1,""],write:[7,3,1,""]},"source.usbBrickIO":{close:[11,3,1,""],debug:[11,2,1,""],nReadBuffer:[11,2,1,""],nWriteBuffer:[11,2,1,""],open:[11,3,1,""],productID:[11,2,1,""],read:[11,3,1,""],setProperties:[11,3,1,""],timeOut:[11,2,1,""],vendorID:[11,2,1,""],write:[11,3,1,""]},source:{EV3:[10,1,1,""],Motor:[3,1,1,""],Sensor:[4,1,1,""],btBrickIO:[5,1,1,""],hidapi:[7,1,1,""],usbBrickIO:[11,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:{"0x0005":11,"0x694":11,"2nd":[2,3,4,10],"5000hz":[2,10],"abstract":[],"byte":[7,11],"case":[3,11],"catch":[2,3,10],"char":7,"class":[2,3,4,5,7,10,11],"default":[4,5,7,11],"final":7,"function":[3,7],"long":3,"null":7,"return":[2,3,5,7,10,11],"throw":7,"true":[2,3,5,10,11],"try":[3,5,11],"while":[],aachen:8,abl:[],abort:[2,10],about:[2,3,4,7,8,10],acceler:[3,4],accelerationallax:4,access:[],accident:[2,10],act:3,action:3,actual:[3,7,11],addit:7,advanc:[],affect:3,after:[3,5,7,11],afterward:3,again:3,all:[3,4,7,11],allow:4,alreadi:7,also:[2,3,4,5,7,10,11],alternatingli:[],alwai:[7,11],ambient:4,angular:4,ani:[3,11],announc:[2,3,4,10],anoth:3,append:7,apply:3,aren:3,argument:[2,3,4,10],around:3,arrai:[5,11],automat:[2,3,4,5,7,10],avail:7,backend:5,base:5,batteri:[2,10],batterymod:[2,3,10],batterymode:[2,10],batteryvalu:[2,10],been:[2,3,4,5,10],beep:[2,6,10],befor:5,behav:3,behaviour:[],besid:11,better:3,between:[3,5,7,11],bigger:[7,11],bit:3,block:7,blue:4,bool:[2,3,4,5,10,11],both:3,brake:3,brakemod:3,brakemode:3,brick:[2,3,4,5,10,11],brickio:[5,11],brickobject:[2,3,4,10],buffer:[7,11],buggi:[],building:[],bump:4,c_output:3,call:[2,3,4,5,7,10,11],can:[3,4,5],car:3,cast:7,central:[2,10],chang:3,channel:5,charg:[2,10],check:[3,7],chosen:5,clear:[],close:[5,7,11],coast:3,code:[],col:4,color:4,com:[2,10],comm:[],comment:3,commerror:7,commhandl:[5,11],commun:[3,4,7],compil:7,connect:[2,3,4,5,6,7,10,11],connectiontyp:[2,10],consist:[3,4],consol:[2,3,4,5,10,11],constantli:3,constructor:11,contain:[2,3,4,10],continu:3,contribut:[],control:[],conveni:[2,10],cord:[2,10],correctli:3,correspond:7,could:[5,7,11],count:3,counter:3,cours:3,creat:[2,3,4,7,10],current:[2,3,4,10],currentspe:3,data:[5,7,11],dba:4,debug:[2,3,4,5,10,11],decim:7,defin:3,degre:[3,4],delet:[2,6,7,10],deliv:[2,10],depend:[2,3,4,5,7,10],design:[],destroi:[2,10],dev:[2,3,4,5,10],develop:[7,8],devic:[3,5,7,11],devicemod:4,devicenam:5,devicename:5,devicetyp:[3,4],differ:[2,7,10],direct:3,directli:7,disabl:7,disconnect:[2,10],disp:[2,6,10],distcm:4,distin:4,dll:7,document:8,documentation:[],doe:[2,3,7,10,11],doesn:[],don:[3,4],done:3,down:3,durat:[2,10],dure:7,dylib:7,each:[2,3,4,5,10,11],eas:3,easili:[],either:[2,3,10],enabl:[2,7,10,11],enumer:7,equal:[2,3,10],error:[2,3,4,5,7,10,11],establish:[2,10],even:3,eventu:11,everytim:[3,4],exampl:[],execut:3,exit:7,expect:[2,4,6,10],explicitli:7,extens:7,facilit:4,fail:[2,10],fals:[3,5,11],far:3,fclose:5,feedback:[2,3,4,10],file:7,finish:3,firmwar:[2,3,10],first:[2,3,10],flag:7,follow:[2,3,4,5,10,11],fopen:5,format:[5,11],forward:3,four:3,fread:5,frequenc:[2,10],from:[2,3,4,5,7,10,11],front:7,fun:[2,6,10],fwrite:5,gener:[],germani:[],get:[2,3,7,10],gethidinfostr:7,getmanufacturersstr:7,getmanufacturersstring:7,getproductstr:7,getproductstring:7,getserialnumberstr:7,getserialnumberstring:7,given:[2,3,4,7,10],glanc:[2,10],goe:3,greater:3,green:4,guid:8,gyro:4,handl:7,happen:3,have:[2,3,7,10],header:7,heavi:3,henc:5,here:3,hertz:[2,10],hid:[7,11],hid_device_infoptr:7,hid_open:7,hidapi:[],hidhandl:7,high:[2,3,4,8,10],highest:3,hold:3,host:[5,7],how:3,htacceleromet:4,htcolor:4,htcompass:4,http:7,hysic:4,imag:[],immedi:[2,3,10],implement:[5,11],indic:3,individu:[3,4],infinit:3,info:7,inform:[5,7],infrare:4,init:7,input:[2,3,4,10],inputpars:[2,3,4,5,10,11],instal:[7,8],installat:[],instanc:[3,4,7],instantan:[2,10],instead:[2,3,4,10],instruct:[],instrument:5,instrumentcontrol:5,int32:7,interfac:[2,5,7,10,11],intern:3,internalreset:3,interpret:3,introduct:8,intuit:[],invalid:7,invalidhandl:7,isconnect:[2,10],isconnected:[2,10],isrun:3,iter:[],itself:7,keep:3,kind:3,know:7,lab:[],largemotor:4,last:3,later:[],layer:[3,4],lead:[],left:3,length:7,less:3,level:[2,3,4,8,10],librari:[7,11],licens:[],like:3,limit:3,limitmod:3,limitvalu:[2,3,6,10],linux:[5,7],list:[2,3,4,5,7,10,11],listen:4,load:3,look:8,loop:3,low:[2,8,10],lower:3,mac:[5,7],made:5,mai:[2,3,4,10],mainli:4,make:3,manufactur:7,mark:[2,3,4,10],master:3,matlab:[],maximum:11,mean:3,mediummotor:4,meet:[],messag:3,meth:[],method:[2,3,4,5,7,10,11],millisecond:[2,3,7,10,11],mind:3,mismatch:7,mode:[2,3,4,10],modul:5,mostli:3,motor:[],motora:[2,3,4,6,10],motorb:[2,3,10],motorc:[2,10],motord:[2,10],move:3,multipl:[2,3,4,5,10,11],must:7,myev3:5,name:[2,3,4,5,7,10],nearli:11,necessari:[2,10],need:[2,3,4,5,7,10,11],neg:3,next:3,non:7,nonblock:7,none:4,note:[2,3,4,5,7,10,11],noth:[2,10],now:[2,10],nreadbuff:[7,11],nreadbuffer:11,number:7,numer:[2,3,4,5,7,10,11],nwritebuff:[7,11],nwritebuffer:11,nxt:[],nxtcolor:4,nxtlight:4,nxtsound:4,nxttemperatur:4,nxttouch:4,nxtultrason:4,object:[2,3,4,5,7,10],occur:[5,7,11],off:[2,3,4,10],old:[],onc:[2,3,4,5,10,11],once:4,onli:[],only:[2,3,4,5,10],opcod:3,open:[5,7,11],opposit:3,option:[2,3,4,5,10,11],optional:[2,3,4,10],order:[2,10],oss:7,other:3,otherwis:3,our:8,output:[2,10,11],outputreadi:3,outputtest:[],packet:[2,3,5,7,10,11],pair:5,paramet:[2,3,4,5,7,10,11],part:[],pass:[3,4],path:[2,5,10],paus:[2,10],percent:[2,3,10],percentag:[2,3,10],physic:[2,3,4,10],plai:[2,10],playton:[2,10],point:3,pointer:7,poll:3,port:[2,3,4,5,6,10],posit:3,possibl:[3,4,7],potenti:5,power:[2,3,4,6,10],preced:[2,3,4,10],pretti:3,previous:3,print:[2,7,10],probabl:3,produc:7,product:[7,11],productid:[7,11],program:3,properti:[2,3,4,5,10,11],propertyname1:[5,11],propertyname2:[5,11],propertyvalue1:[5,11],propertyvalue2:[5,11],prox:4,pull:[2,3,10],push:4,rais:3,random:[2,6,10],rate:4,ratio:3,raw:4,reach:3,read:[2,3,4,5,7,10,11],read_timeout:7,reason:3,receiv:[2,3,10],red:4,reflect:4,regul:3,regular:3,releas:3,remot:4,repli:3,report:7,reportid:7,repositori:8,repres:[3,4],request:3,reset:[2,3,4,10],resetposit:3,resettachocount:3,resiz:7,respect:3,respons:3,result:3,rfcomm0:[2,3,4,5,10],rfcomm1:[2,10],rfcomm2:[2,10],right:3,robot:3,run:3,rwth:8,same:3,second:[2,5,10],secur:3,see:[2,3,4,5,7,10,11],seek:4,seem:[2,4,10],send:[2,3,10],sensor1:[2,4,6,10],sensor2:[2,10],sensor3:[2,10],sensor4:[2,10],sensor:[],sent:[2,10],serial:[2,5,7,10],serialport:5,serport:[2,3,4,5,10],set:[2,3,4,5,7,10,11],setbrak:3,setnonblock:7,setproperti:[2,3,4,5,6,10,11],setup:[2,10],sever:[],share:7,sheader:7,should:[3,7,11],shown:5,signal11:7,simplifi:[],size:[7,11],slave:3,slib:7,slow:3,slower:3,slowli:3,small:[2,10],smoothli:3,smoothstart:3,smoothstop:3,some:[3,7],sometim:[],somewhat:3,sooner:[],sourc:[2,3,4,5,7,10,11],specifi:[3,4],speed:3,speedregul:3,spin:3,start:[2,3,6,10],state:3,statu:[2,3,10],still:3,stop:[2,3,10],stopallmotor:[2,10],stopton:[2,10],straight:3,string:[2,3,4,5,7,10],struct:7,student:[],stuff:[2,3,10],sublay:[3,4],success:7,suppos:3,sure:5,sync:3,syncedstart:3,syncedstop:3,synchron:3,syncmotor:3,syntax:[2,3,4,5,10,11],system:[5,7],tacho:3,tachocount:3,tacholimit:3,take:[3,8],temp:[],test:[2,3,4,5,10],than:[3,7,11],them:[2,3,4,10],thi:[2,3,4,5,6,7,8,10],think:7,thoroughli:[2,4,10],through:[5,11],time:3,timeout:[3,5,7,11],tone:[2,10],toneplai:[2,10],too:3,toolbox:[],touch:4,tricki:3,turn:[2,3,4,10],turnratio:3,two:3,type:[2,3,4,7,10],uint16:7,uint8:[5,7,11],ultrason:4,und:3,undefin:4,unexpect:[],unexpectedli:7,unknown:4,until:3,usage:5,usbbrickio:[],use:[3,11],user:[2,10],using:7,valid:[5,7,11],valu:[2,3,4,6,7,10],varargin:[2,3,4,5,10,11],variou:[],vendor:[7,11],vendorid:[7,11],version:[],via:[2,3,4,5,10,11],view:[2,10],virtual:[2,10],voltag:[2,3,10],volum:[2,10],wai:[],waitfor:[2,3,6,10],want:[],warn:[],wast:3,weird:3,what:[2,3,4,10],whatev:3,when:[2,3,4,5,7,10,11],which:[2,3,4,5,7,10,11],white:4,window:[5,7],without:[3,7],wmsg:[5,7,11],work:[2,3,4,10,11],workaround:3,would:[2,3,4,10],wrap:[],writable:[2,3,4,10],write:[5,7,11],written:[5,7,11],wrong:[2,10],www:7,xcode:7,yet:[2,10],you:[3,4,7,11],your:[]},titles:["CommandLayer","CommunicationLayer","EV3","Motor","Sensor","btBrickIO","Examples","hidapi","MATLAB Toolbox for controlling Lego Mindstorms EV3","General","EV3","usbBrickIO"],titleterms:{bluetooth:1,btbrickio:5,command:0,commandlay:0,communicationinterfac:0,communicationlay:1,content:8,contribut:9,control:8,ev3:[2,8,10],exampl:6,gener:9,hidapi:7,installat:9,lego:8,licens:9,matlab:8,mindstorm:8,motor:3,sensor:4,toolbox:8,usb:1,usbbrickio:11}}) \ No newline at end of file diff --git a/docs/_build/html/source.html b/docs/_build/html/source.html index 903ea3ea5d72a8e806be6fb86eee18ed839f027f..9e6a5daafacf07d6192add5e0ea9911e57885f44 100644 --- a/docs/_build/html/source.html +++ b/docs/_build/html/source.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>EV3 — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>EV3 — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.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'> @@ -50,7 +50,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -66,10 +66,6 @@ <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> @@ -141,7 +137,7 @@ <dd><ul class="first last simple"> <li><a class="reference internal" href="#source.EV3.connect" title="source.EV3.connect"><code class="xref mat mat-meth docutils literal"><span class="pre">connect()</span></code></a></li> <li><a class="reference internal" href="#source.EV3.disconnect" title="source.EV3.disconnect"><code class="xref mat mat-meth docutils literal"><span class="pre">disconnect()</span></code></a></li> -<li><a class="reference internal" href="#source.EV3.stopAllMotors" title="source.EV3.stopAllMotors"><code class="xref mat mat-meth docutils literal"><span class="pre">stopAllMotors()</span></code></a></li> +<li><code class="xref mat mat-meth docutils literal"><span class="pre">stopAllMotors()</span></code></li> <li><a class="reference internal" href="#source.EV3.beep" title="source.EV3.beep"><code class="xref mat mat-meth docutils literal"><span class="pre">beep()</span></code></a></li> <li><a class="reference internal" href="#source.EV3.playTone" title="source.EV3.playTone"><code class="xref mat mat-meth docutils literal"><span class="pre">playTone()</span></code></a></li> <li><a class="reference internal" href="#source.EV3.stopTone" title="source.EV3.stopTone"><code class="xref mat mat-meth docutils literal"><span class="pre">stopTone()</span></code></a></li> @@ -361,12 +357,6 @@ b.setProperties(‘debug’, ‘on’, ‘batteryMode’ <p>See also EV3.DEBUG, EV3.BATTERYMODE / <a class="reference internal" href="#source.EV3.debug" title="source.EV3.debug"><code class="xref mat mat-attr docutils literal"><span class="pre">debug</span></code></a>, <a class="reference internal" href="#source.EV3.batteryMode" title="source.EV3.batteryMode"><code class="xref mat mat-attr docutils literal"><span class="pre">batteryMode</span></code></a></p> </dd></dl> -<dl class="method"> -<dt id="source.EV3.stopAllMotors"> -<code class="descname">stopAllMotors</code><span class="sig-paren">(</span><em>ev3</em><span class="sig-paren">)</span><a class="headerlink" href="#source.EV3.stopAllMotors" title="Permalink to this definition">¶</a></dt> -<dd><p>Sends a stop-command to all motor-ports.</p> -</dd></dl> - <dl class="method"> <dt id="source.EV3.stopTone"> <code class="descname">stopTone</code><span class="sig-paren">(</span><em>ev3</em><span class="sig-paren">)</span><a class="headerlink" href="#source.EV3.stopTone" title="Permalink to this definition">¶</a></dt> @@ -418,7 +408,7 @@ b.tonePlayed(); % -> Outputs 1 to console. <br /></dd> </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/html/usbBrickIO.html b/docs/_build/html/usbBrickIO.html index c539f81b082f9eab9f2803b1becabf8ae97ec64f..159476a1b46c199b3e98763cdd96b50317ba5667 100644 --- a/docs/_build/html/usbBrickIO.html +++ b/docs/_build/html/usbBrickIO.html @@ -5,7 +5,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>usbBrickIO — Mindstorms EV3 Toolbox v0.4-rc.10 documentation</title> + <title>usbBrickIO — Mindstorms EV3 Toolbox v1.0 documentation</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -15,7 +15,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: 'v0.4-rc.10', + VERSION: 'v1.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -30,7 +30,7 @@ <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="top" title="Mindstorms EV3 Toolbox v1.0 documentation" href="index.html" /> <link rel="next" title="btBrickIO" href="btBrickIO.html" /> <link rel="prev" title="hidapi" href="hid.html" /> <meta charset='utf-8'> @@ -52,7 +52,7 @@ </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> + <span class="navbar-text navbar-version pull-left"><b>v1.0</b></span> </div> <div class="collapse navbar-collapse nav-collapse"> @@ -68,10 +68,6 @@ <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> @@ -268,7 +264,7 @@ USBBRICKIO.NREADBUFFER, USBBRICKIO.NWRITEBUFFER, USBBRICKIO.TIMEOUT</p> </p> <p> - © Copyright 2016, LfB - RWTH Aachen.<br/> + © Copyright 2017, RWTH Aachen.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/> </p> </div> diff --git a/docs/_build/latex/MindstormsEV3Toolbox.aux b/docs/_build/latex/MindstormsEV3Toolbox.aux index 124d167f89a0aad8d11c6379b2416be7fb48f41b..a0c16aa6b05344ad100cde5917ecc535f9ab607b 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.aux +++ b/docs/_build/latex/MindstormsEV3Toolbox.aux @@ -25,176 +25,163 @@ \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} \@writefile{loliteral-block}{\addvspace {10\p@ }} -\newlabel{index:matlab-nxt-toolbox}{{1}{3}{Contents}{chapter.1}{}} +\newlabel{index:our-repository}{{1}{3}{Contents}{chapter.1}{}} \newlabel{index:contents}{{1}{3}{Contents}{chapter.1}{}} \newlabel{index:matlab-toolbox-for-controlling-lego-mindstorms-ev3}{{1}{3}{Contents}{chapter.1}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.1}General}{3}{section.1.1}} -\newlabel{readme::doc}{{1.1}{3}{General}{section.1.1}{}} -\newlabel{readme:general}{{1.1}{3}{General}{section.1.1}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {1.1.1}Installation}{3}{subsection.1.1.1}} -\newlabel{readme:installation}{{1.1.1}{3}{Installation}{subsection.1.1.1}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {1.1.2}Contribution}{3}{subsection.1.1.2}} -\newlabel{readme:contribution}{{1.1.2}{3}{Contribution}{subsection.1.1.2}{}} -\@writefile{toc}{\contentsline {subsection}{\numberline {1.1.3}Licenses}{3}{subsection.1.1.3}} -\newlabel{readme:licenses}{{1.1.3}{3}{Licenses}{subsection.1.1.3}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.2}Examples}{3}{section.1.2}} -\newlabel{examples::doc}{{1.2}{3}{Examples}{section.1.2}{}} -\newlabel{examples:examples}{{1.2}{3}{Examples}{section.1.2}{}} -\newlabel{EV3:module-source}{{1.2}{3}{Examples}{section*.3}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.3}EV3}{3}{section.1.3}} -\newlabel{EV3:ev3}{{1.3}{3}{EV3}{section.1.3}{}} -\newlabel{EV3::doc}{{1.3}{3}{EV3}{section.1.3}{}} -\newlabel{EV3:source.EV3}{{1.3}{3}{EV3}{section*.4}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{4}{paragraph*.5}} -\newlabel{EV3:source.EV3.motorA}{{1.3}{4}{Notes}{section*.6}{}} -\newlabel{EV3:source.EV3.motorB}{{1.3}{4}{Notes}{section*.7}{}} -\newlabel{EV3:source.EV3.motorC}{{1.3}{4}{Notes}{section*.8}{}} -\newlabel{EV3:source.EV3.motorD}{{1.3}{4}{Notes}{section*.9}{}} -\newlabel{EV3:source.EV3.sensor1}{{1.3}{4}{Notes}{section*.10}{}} -\newlabel{EV3:source.EV3.sensor2}{{1.3}{4}{Notes}{section*.11}{}} -\newlabel{EV3:source.EV3.sensor3}{{1.3}{4}{Notes}{section*.12}{}} -\newlabel{EV3:source.EV3.sensor4}{{1.3}{4}{Notes}{section*.13}{}} -\newlabel{EV3:source.EV3.debug}{{1.3}{4}{Notes}{section*.14}{}} -\newlabel{EV3:source.EV3.batteryMode}{{1.3}{4}{Notes}{section*.15}{}} -\newlabel{EV3:source.EV3.batteryValue}{{1.3}{4}{Notes}{section*.16}{}} -\newlabel{EV3:source.EV3.isConnected}{{1.3}{5}{Notes}{section*.17}{}} -\@writefile{toc}{\contentsline {paragraph}{Example}{5}{paragraph*.18}} -\newlabel{EV3:source.EV3.beep}{{1.3}{5}{Example}{section*.19}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{5}{paragraph*.20}} -\@writefile{toc}{\contentsline {paragraph}{Example}{5}{paragraph*.21}} -\newlabel{EV3:source.EV3.connect}{{1.3}{5}{Example}{section*.22}{}} +\newlabel{EV3:module-source}{{1}{3}{Contents}{section*.3}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.1}EV3}{3}{section.1.1}} +\newlabel{EV3:ev3}{{1.1}{3}{EV3}{section.1.1}{}} +\newlabel{EV3::doc}{{1.1}{3}{EV3}{section.1.1}{}} +\newlabel{EV3:source.EV3}{{1.1}{3}{EV3}{section*.4}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{3}{paragraph*.5}} +\newlabel{EV3:source.EV3.motorA}{{1.1}{3}{Notes}{section*.6}{}} +\newlabel{EV3:source.EV3.motorB}{{1.1}{3}{Notes}{section*.7}{}} +\newlabel{EV3:source.EV3.motorC}{{1.1}{3}{Notes}{section*.8}{}} +\newlabel{EV3:source.EV3.motorD}{{1.1}{4}{Notes}{section*.9}{}} +\newlabel{EV3:source.EV3.sensor1}{{1.1}{4}{Notes}{section*.10}{}} +\newlabel{EV3:source.EV3.sensor2}{{1.1}{4}{Notes}{section*.11}{}} +\newlabel{EV3:source.EV3.sensor3}{{1.1}{4}{Notes}{section*.12}{}} +\newlabel{EV3:source.EV3.sensor4}{{1.1}{4}{Notes}{section*.13}{}} +\newlabel{EV3:source.EV3.debug}{{1.1}{4}{Notes}{section*.14}{}} +\newlabel{EV3:source.EV3.batteryMode}{{1.1}{4}{Notes}{section*.15}{}} +\newlabel{EV3:source.EV3.batteryValue}{{1.1}{4}{Notes}{section*.16}{}} +\newlabel{EV3:source.EV3.isConnected}{{1.1}{4}{Notes}{section*.17}{}} +\@writefile{toc}{\contentsline {paragraph}{Example}{4}{paragraph*.18}} +\newlabel{EV3:source.EV3.beep}{{1.1}{4}{Example}{section*.19}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{4}{paragraph*.20}} +\@writefile{toc}{\contentsline {paragraph}{Example}{4}{paragraph*.21}} +\newlabel{EV3:source.EV3.connect}{{1.1}{4}{Example}{section*.22}{}} \@writefile{toc}{\contentsline {paragraph}{Example}{5}{paragraph*.23}} -\newlabel{EV3:source.EV3.disconnect}{{1.3}{5}{Example}{section*.24}{}} +\newlabel{EV3:source.EV3.disconnect}{{1.1}{5}{Example}{section*.24}{}} \@writefile{toc}{\contentsline {paragraph}{Notes}{5}{paragraph*.25}} -\@writefile{toc}{\contentsline {paragraph}{Example}{6}{paragraph*.26}} -\newlabel{EV3:source.EV3.playTone}{{1.3}{6}{Example}{section*.27}{}} -\@writefile{toc}{\contentsline {paragraph}{Example}{6}{paragraph*.28}} -\newlabel{EV3:source.EV3.setProperties}{{1.3}{6}{Example}{section*.29}{}} +\@writefile{toc}{\contentsline {paragraph}{Example}{5}{paragraph*.26}} +\newlabel{EV3:source.EV3.playTone}{{1.1}{5}{Example}{section*.27}{}} +\@writefile{toc}{\contentsline {paragraph}{Example}{5}{paragraph*.28}} +\newlabel{EV3:source.EV3.setProperties}{{1.1}{5}{Example}{section*.29}{}} \@writefile{toc}{\contentsline {paragraph}{Example}{6}{paragraph*.30}} -\newlabel{EV3:source.EV3.stopAllMotors}{{1.3}{6}{Example}{section*.31}{}} -\newlabel{EV3:source.EV3.stopTone}{{1.3}{6}{Example}{section*.32}{}} -\@writefile{toc}{\contentsline {paragraph}{Example}{6}{paragraph*.33}} -\newlabel{EV3:source.EV3.tonePlayed}{{1.3}{6}{Example}{section*.34}{}} -\newlabel{Motor:module-source}{{1.3}{7}{EV3}{section*.35}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.4}Motor}{7}{section.1.4}} -\newlabel{Motor::doc}{{1.4}{7}{Motor}{section.1.4}{}} -\newlabel{Motor:motor}{{1.4}{7}{Motor}{section.1.4}{}} -\newlabel{Motor:source.Motor}{{1.4}{7}{Motor}{section*.36}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{7}{paragraph*.37}} -\newlabel{Motor:source.Motor.power}{{1.4}{7}{Notes}{section*.38}{}} -\newlabel{Motor:source.Motor.speedRegulation}{{1.4}{7}{Notes}{section*.39}{}} -\newlabel{Motor:source.Motor.smoothStart}{{1.4}{7}{Notes}{section*.40}{}} -\newlabel{Motor:source.Motor.smoothStop}{{1.4}{8}{Notes}{section*.41}{}} -\newlabel{Motor:source.Motor.limitValue}{{1.4}{8}{Notes}{section*.42}{}} -\newlabel{Motor:source.Motor.limitMode}{{1.4}{8}{Notes}{section*.43}{}} -\newlabel{Motor:source.Motor.brakeMode}{{1.4}{8}{Notes}{section*.44}{}} -\newlabel{Motor:source.Motor.debug}{{1.4}{8}{Notes}{section*.45}{}} -\newlabel{Motor:source.Motor.isRunning}{{1.4}{8}{Notes}{section*.46}{}} -\newlabel{Motor:source.Motor.tachoCount}{{1.4}{8}{Notes}{section*.47}{}} -\newlabel{Motor:source.Motor.currentSpeed}{{1.4}{8}{Notes}{section*.48}{}} -\newlabel{Motor:source.Motor.type}{{1.4}{8}{Notes}{section*.49}{}} -\newlabel{Motor:source.Motor.internalReset}{{1.4}{8}{Notes}{section*.50}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{8}{paragraph*.51}} -\newlabel{Motor:source.Motor.resetTachoCount}{{1.4}{8}{Notes}{section*.52}{}} -\newlabel{Motor:source.Motor.setBrake}{{1.4}{9}{Notes}{section*.53}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{9}{paragraph*.54}} -\newlabel{Motor:source.Motor.setProperties}{{1.4}{9}{Notes}{section*.55}{}} -\@writefile{toc}{\contentsline {paragraph}{Example}{9}{paragraph*.56}} -\newlabel{Motor:source.Motor.start}{{1.4}{9}{Notes}{section*.57}{}} -\newlabel{Motor:source.Motor.stop}{{1.4}{9}{Notes}{section*.58}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{9}{paragraph*.59}} -\newlabel{Motor:source.Motor.syncedStart}{{1.4}{9}{Notes}{section*.60}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{10}{paragraph*.61}} -\@writefile{toc}{\contentsline {paragraph}{Example}{10}{paragraph*.62}} -\newlabel{Motor:source.Motor.syncedStop}{{1.4}{10}{Notes}{section*.63}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{10}{paragraph*.64}} -\newlabel{Motor:source.Motor.waitFor}{{1.4}{10}{Notes}{section*.65}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{10}{paragraph*.66}} -\newlabel{Sensor:module-source}{{1.4}{11}{Motor}{section*.67}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.5}Sensor}{11}{section.1.5}} -\newlabel{Sensor:sensor}{{1.5}{11}{Sensor}{section.1.5}{}} -\newlabel{Sensor::doc}{{1.5}{11}{Sensor}{section.1.5}{}} -\newlabel{Sensor:source.Sensor}{{1.5}{11}{Sensor}{section*.68}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{11}{paragraph*.69}} -\newlabel{Sensor:source.Sensor.mode}{{1.5}{11}{Notes}{section*.70}{}} -\newlabel{Sensor:source.Sensor.debug}{{1.5}{13}{Notes}{section*.71}{}} -\newlabel{Sensor:source.Sensor.value}{{1.5}{13}{Notes}{section*.72}{}} -\newlabel{Sensor:source.Sensor.type}{{1.5}{13}{Notes}{section*.73}{}} -\newlabel{Sensor:source.Sensor.reset}{{1.5}{13}{Notes}{section*.74}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{14}{paragraph*.75}} -\newlabel{Sensor:source.Sensor.setProperties}{{1.5}{14}{Notes}{section*.76}{}} -\@writefile{toc}{\contentsline {paragraph}{Example}{14}{paragraph*.77}} -\newlabel{hid:module-source}{{1.5}{14}{Sensor}{section*.78}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.6}hidapi}{14}{section.1.6}} -\newlabel{hid:hidapi}{{1.6}{14}{hidapi}{section.1.6}{}} -\newlabel{hid::doc}{{1.6}{14}{hidapi}{section.1.6}{}} -\newlabel{hid:source.hidapi}{{1.6}{14}{hidapi}{section*.79}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{15}{paragraph*.80}} -\newlabel{hid:source.hidapi.handle}{{1.6}{15}{Notes}{section*.81}{}} -\newlabel{hid:source.hidapi.vendorID}{{1.6}{15}{Notes}{section*.82}{}} -\newlabel{hid:source.hidapi.productID}{{1.6}{15}{Notes}{section*.83}{}} -\newlabel{hid:source.hidapi.nReadBuffer}{{1.6}{15}{Notes}{section*.84}{}} -\newlabel{hid:source.hidapi.nWriteBuffer}{{1.6}{15}{Notes}{section*.85}{}} -\newlabel{hid:source.hidapi.slib}{{1.6}{15}{Notes}{section*.86}{}} -\newlabel{hid:source.hidapi.sheader}{{1.6}{15}{Notes}{section*.87}{}} -\@writefile{toc}{\contentsline {paragraph}{Example}{15}{paragraph*.88}} -\newlabel{hid:source.hidapi.close}{{1.6}{15}{Example}{section*.89}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{15}{paragraph*.90}} -\newlabel{hid:source.hidapi.enumerate}{{1.6}{15}{Example}{section*.91}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{16}{paragraph*.92}} -\newlabel{hid:source.hidapi.error}{{1.6}{16}{Example}{section*.93}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{16}{paragraph*.94}} -\newlabel{hid:source.hidapi.exit}{{1.6}{16}{Example}{section*.95}{}} -\newlabel{hid:source.hidapi.getHIDInfoString}{{1.6}{16}{Example}{section*.96}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{16}{paragraph*.97}} -\newlabel{hid:source.hidapi.getManufacturersString}{{1.6}{16}{Example}{section*.98}{}} -\newlabel{hid:source.hidapi.getProductString}{{1.6}{16}{Example}{section*.99}{}} -\newlabel{hid:source.hidapi.getSerialNumberString}{{1.6}{16}{Example}{section*.100}{}} -\newlabel{hid:source.hidapi.init}{{1.6}{16}{Example}{section*.101}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{17}{paragraph*.102}} -\newlabel{hid:source.hidapi.open}{{1.6}{17}{Example}{section*.103}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{17}{paragraph*.104}} -\newlabel{hid:source.hidapi.read}{{1.6}{17}{Example}{section*.105}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{17}{paragraph*.106}} -\newlabel{hid:source.hidapi.read_timeout}{{1.6}{17}{Example}{section*.107}{}} -\newlabel{hid:source.hidapi.setNonBlocking}{{1.6}{17}{Example}{section*.108}{}} -\newlabel{hid:source.hidapi.write}{{1.6}{17}{Example}{section*.109}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{18}{paragraph*.110}} -\newlabel{usbBrickIO:module-source}{{1.6}{18}{hidapi}{section*.111}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.7}usbBrickIO}{18}{section.1.7}} -\newlabel{usbBrickIO:usbbrickio}{{1.7}{18}{usbBrickIO}{section.1.7}{}} -\newlabel{usbBrickIO::doc}{{1.7}{18}{usbBrickIO}{section.1.7}{}} -\newlabel{usbBrickIO:source.usbBrickIO}{{1.7}{18}{usbBrickIO}{section*.112}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{18}{paragraph*.113}} -\newlabel{usbBrickIO:source.usbBrickIO.debug}{{1.7}{18}{Notes}{section*.114}{}} -\newlabel{usbBrickIO:source.usbBrickIO.vendorID}{{1.7}{18}{Notes}{section*.115}{}} -\newlabel{usbBrickIO:source.usbBrickIO.productID}{{1.7}{18}{Notes}{section*.116}{}} -\newlabel{usbBrickIO:source.usbBrickIO.nReadBuffer}{{1.7}{18}{Notes}{section*.117}{}} -\newlabel{usbBrickIO:source.usbBrickIO.nWriteBuffer}{{1.7}{18}{Notes}{section*.118}{}} -\newlabel{usbBrickIO:source.usbBrickIO.timeOut}{{1.7}{18}{Notes}{section*.119}{}} -\@writefile{toc}{\contentsline {paragraph}{Examples}{19}{paragraph*.120}} -\newlabel{usbBrickIO:source.usbBrickIO.close}{{1.7}{19}{Examples}{section*.121}{}} -\newlabel{usbBrickIO:source.usbBrickIO.open}{{1.7}{19}{Examples}{section*.122}{}} -\newlabel{usbBrickIO:source.usbBrickIO.read}{{1.7}{19}{Examples}{section*.123}{}} -\newlabel{usbBrickIO:source.usbBrickIO.setProperties}{{1.7}{19}{Examples}{section*.124}{}} -\newlabel{usbBrickIO:source.usbBrickIO.write}{{1.7}{19}{Examples}{section*.125}{}} -\newlabel{btBrickIO:module-source}{{1.7}{19}{usbBrickIO}{section*.126}{}} -\@writefile{toc}{\contentsline {section}{\numberline {1.8}btBrickIO}{19}{section.1.8}} -\newlabel{btBrickIO:btbrickio}{{1.8}{19}{btBrickIO}{section.1.8}{}} -\newlabel{btBrickIO::doc}{{1.8}{19}{btBrickIO}{section.1.8}{}} -\newlabel{btBrickIO:source.btBrickIO}{{1.8}{19}{btBrickIO}{section*.127}{}} -\@writefile{toc}{\contentsline {paragraph}{Notes}{19}{paragraph*.128}} -\newlabel{btBrickIO:source.btBrickIO.debug}{{1.8}{20}{Notes}{section*.129}{}} -\newlabel{btBrickIO:source.btBrickIO.serialPort}{{1.8}{20}{Notes}{section*.130}{}} -\newlabel{btBrickIO:source.btBrickIO.deviceName}{{1.8}{20}{Notes}{section*.131}{}} -\newlabel{btBrickIO:source.btBrickIO.channel}{{1.8}{20}{Notes}{section*.132}{}} -\newlabel{btBrickIO:source.btBrickIO.timeOut}{{1.8}{20}{Notes}{section*.133}{}} -\newlabel{btBrickIO:source.btBrickIO.backend}{{1.8}{20}{Notes}{section*.134}{}} -\@writefile{toc}{\contentsline {paragraph}{Examples}{20}{paragraph*.135}} -\newlabel{btBrickIO:source.btBrickIO.close}{{1.8}{20}{Examples}{section*.136}{}} -\newlabel{btBrickIO:source.btBrickIO.open}{{1.8}{20}{Examples}{section*.137}{}} -\newlabel{btBrickIO:source.btBrickIO.read}{{1.8}{20}{Examples}{section*.138}{}} -\newlabel{btBrickIO:source.btBrickIO.setProperties}{{1.8}{20}{Examples}{section*.139}{}} -\newlabel{btBrickIO:source.btBrickIO.write}{{1.8}{20}{Examples}{section*.140}{}} -\@writefile{toc}{\contentsline {chapter}{MATLAB Module Index}{21}{section*.141}} -\@writefile{toc}{\contentsline {chapter}{Index}{23}{section*.142}} +\newlabel{EV3:source.EV3.stopTone}{{1.1}{6}{Example}{section*.31}{}} +\@writefile{toc}{\contentsline {paragraph}{Example}{6}{paragraph*.32}} +\newlabel{EV3:source.EV3.tonePlayed}{{1.1}{6}{Example}{section*.33}{}} +\newlabel{Motor:module-source}{{1.1}{6}{EV3}{section*.34}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.2}Motor}{6}{section.1.2}} +\newlabel{Motor::doc}{{1.2}{6}{Motor}{section.1.2}{}} +\newlabel{Motor:motor}{{1.2}{6}{Motor}{section.1.2}{}} +\newlabel{Motor:source.Motor}{{1.2}{6}{Motor}{section*.35}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{7}{paragraph*.36}} +\newlabel{Motor:source.Motor.power}{{1.2}{7}{Notes}{section*.37}{}} +\newlabel{Motor:source.Motor.speedRegulation}{{1.2}{7}{Notes}{section*.38}{}} +\newlabel{Motor:source.Motor.smoothStart}{{1.2}{7}{Notes}{section*.39}{}} +\newlabel{Motor:source.Motor.smoothStop}{{1.2}{7}{Notes}{section*.40}{}} +\newlabel{Motor:source.Motor.limitValue}{{1.2}{7}{Notes}{section*.41}{}} +\newlabel{Motor:source.Motor.limitMode}{{1.2}{7}{Notes}{section*.42}{}} +\newlabel{Motor:source.Motor.brakeMode}{{1.2}{7}{Notes}{section*.43}{}} +\newlabel{Motor:source.Motor.debug}{{1.2}{7}{Notes}{section*.44}{}} +\newlabel{Motor:source.Motor.isRunning}{{1.2}{7}{Notes}{section*.45}{}} +\newlabel{Motor:source.Motor.tachoCount}{{1.2}{7}{Notes}{section*.46}{}} +\newlabel{Motor:source.Motor.currentSpeed}{{1.2}{7}{Notes}{section*.47}{}} +\newlabel{Motor:source.Motor.type}{{1.2}{7}{Notes}{section*.48}{}} +\newlabel{Motor:source.Motor.internalReset}{{1.2}{8}{Notes}{section*.49}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{8}{paragraph*.50}} +\newlabel{Motor:source.Motor.resetTachoCount}{{1.2}{8}{Notes}{section*.51}{}} +\newlabel{Motor:source.Motor.setBrake}{{1.2}{8}{Notes}{section*.52}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{8}{paragraph*.53}} +\newlabel{Motor:source.Motor.setProperties}{{1.2}{8}{Notes}{section*.54}{}} +\@writefile{toc}{\contentsline {paragraph}{Example}{9}{paragraph*.55}} +\newlabel{Motor:source.Motor.start}{{1.2}{9}{Notes}{section*.56}{}} +\newlabel{Motor:source.Motor.stop}{{1.2}{9}{Notes}{section*.57}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{9}{paragraph*.58}} +\newlabel{Motor:source.Motor.syncedStart}{{1.2}{9}{Notes}{section*.59}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{9}{paragraph*.60}} +\@writefile{toc}{\contentsline {paragraph}{Example}{9}{paragraph*.61}} +\newlabel{Motor:source.Motor.syncedStop}{{1.2}{9}{Notes}{section*.62}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{10}{paragraph*.63}} +\newlabel{Motor:source.Motor.waitFor}{{1.2}{10}{Notes}{section*.64}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{10}{paragraph*.65}} +\newlabel{Sensor:module-source}{{1.2}{10}{Motor}{section*.66}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.3}Sensor}{10}{section.1.3}} +\newlabel{Sensor:sensor}{{1.3}{10}{Sensor}{section.1.3}{}} +\newlabel{Sensor::doc}{{1.3}{10}{Sensor}{section.1.3}{}} +\newlabel{Sensor:source.Sensor}{{1.3}{10}{Sensor}{section*.67}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{10}{paragraph*.68}} +\newlabel{Sensor:source.Sensor.mode}{{1.3}{10}{Notes}{section*.69}{}} +\newlabel{Sensor:source.Sensor.debug}{{1.3}{12}{Notes}{section*.70}{}} +\newlabel{Sensor:source.Sensor.value}{{1.3}{12}{Notes}{section*.71}{}} +\newlabel{Sensor:source.Sensor.type}{{1.3}{12}{Notes}{section*.72}{}} +\newlabel{Sensor:source.Sensor.reset}{{1.3}{13}{Notes}{section*.73}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{13}{paragraph*.74}} +\newlabel{Sensor:source.Sensor.setProperties}{{1.3}{13}{Notes}{section*.75}{}} +\@writefile{toc}{\contentsline {paragraph}{Example}{13}{paragraph*.76}} +\newlabel{hid:module-source}{{1.3}{13}{Sensor}{section*.77}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.4}hidapi}{13}{section.1.4}} +\newlabel{hid:hidapi}{{1.4}{13}{hidapi}{section.1.4}{}} +\newlabel{hid::doc}{{1.4}{13}{hidapi}{section.1.4}{}} +\newlabel{hid:source.hidapi}{{1.4}{13}{hidapi}{section*.78}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{14}{paragraph*.79}} +\newlabel{hid:source.hidapi.handle}{{1.4}{14}{Notes}{section*.80}{}} +\newlabel{hid:source.hidapi.vendorID}{{1.4}{14}{Notes}{section*.81}{}} +\newlabel{hid:source.hidapi.productID}{{1.4}{14}{Notes}{section*.82}{}} +\newlabel{hid:source.hidapi.nReadBuffer}{{1.4}{14}{Notes}{section*.83}{}} +\newlabel{hid:source.hidapi.nWriteBuffer}{{1.4}{14}{Notes}{section*.84}{}} +\newlabel{hid:source.hidapi.slib}{{1.4}{14}{Notes}{section*.85}{}} +\newlabel{hid:source.hidapi.sheader}{{1.4}{14}{Notes}{section*.86}{}} +\@writefile{toc}{\contentsline {paragraph}{Example}{14}{paragraph*.87}} +\newlabel{hid:source.hidapi.close}{{1.4}{14}{Example}{section*.88}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{15}{paragraph*.89}} +\newlabel{hid:source.hidapi.enumerate}{{1.4}{15}{Example}{section*.90}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{15}{paragraph*.91}} +\newlabel{hid:source.hidapi.error}{{1.4}{15}{Example}{section*.92}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{15}{paragraph*.93}} +\newlabel{hid:source.hidapi.exit}{{1.4}{15}{Example}{section*.94}{}} +\newlabel{hid:source.hidapi.getHIDInfoString}{{1.4}{15}{Example}{section*.95}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{15}{paragraph*.96}} +\newlabel{hid:source.hidapi.getManufacturersString}{{1.4}{16}{Example}{section*.97}{}} +\newlabel{hid:source.hidapi.getProductString}{{1.4}{16}{Example}{section*.98}{}} +\newlabel{hid:source.hidapi.getSerialNumberString}{{1.4}{16}{Example}{section*.99}{}} +\newlabel{hid:source.hidapi.init}{{1.4}{16}{Example}{section*.100}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{16}{paragraph*.101}} +\newlabel{hid:source.hidapi.open}{{1.4}{16}{Example}{section*.102}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{16}{paragraph*.103}} +\newlabel{hid:source.hidapi.read}{{1.4}{16}{Example}{section*.104}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{16}{paragraph*.105}} +\newlabel{hid:source.hidapi.read_timeout}{{1.4}{16}{Example}{section*.106}{}} +\newlabel{hid:source.hidapi.setNonBlocking}{{1.4}{17}{Example}{section*.107}{}} +\newlabel{hid:source.hidapi.write}{{1.4}{17}{Example}{section*.108}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{17}{paragraph*.109}} +\newlabel{usbBrickIO:module-source}{{1.4}{17}{hidapi}{section*.110}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.5}usbBrickIO}{17}{section.1.5}} +\newlabel{usbBrickIO:usbbrickio}{{1.5}{17}{usbBrickIO}{section.1.5}{}} +\newlabel{usbBrickIO::doc}{{1.5}{17}{usbBrickIO}{section.1.5}{}} +\newlabel{usbBrickIO:source.usbBrickIO}{{1.5}{17}{usbBrickIO}{section*.111}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{17}{paragraph*.112}} +\newlabel{usbBrickIO:source.usbBrickIO.debug}{{1.5}{18}{Notes}{section*.113}{}} +\newlabel{usbBrickIO:source.usbBrickIO.vendorID}{{1.5}{18}{Notes}{section*.114}{}} +\newlabel{usbBrickIO:source.usbBrickIO.productID}{{1.5}{18}{Notes}{section*.115}{}} +\newlabel{usbBrickIO:source.usbBrickIO.nReadBuffer}{{1.5}{18}{Notes}{section*.116}{}} +\newlabel{usbBrickIO:source.usbBrickIO.nWriteBuffer}{{1.5}{18}{Notes}{section*.117}{}} +\newlabel{usbBrickIO:source.usbBrickIO.timeOut}{{1.5}{18}{Notes}{section*.118}{}} +\@writefile{toc}{\contentsline {paragraph}{Examples}{18}{paragraph*.119}} +\newlabel{usbBrickIO:source.usbBrickIO.close}{{1.5}{18}{Examples}{section*.120}{}} +\newlabel{usbBrickIO:source.usbBrickIO.open}{{1.5}{18}{Examples}{section*.121}{}} +\newlabel{usbBrickIO:source.usbBrickIO.read}{{1.5}{18}{Examples}{section*.122}{}} +\newlabel{usbBrickIO:source.usbBrickIO.setProperties}{{1.5}{18}{Examples}{section*.123}{}} +\newlabel{usbBrickIO:source.usbBrickIO.write}{{1.5}{18}{Examples}{section*.124}{}} +\newlabel{btBrickIO:module-source}{{1.5}{18}{usbBrickIO}{section*.125}{}} +\@writefile{toc}{\contentsline {section}{\numberline {1.6}btBrickIO}{18}{section.1.6}} +\newlabel{btBrickIO:btbrickio}{{1.6}{18}{btBrickIO}{section.1.6}{}} +\newlabel{btBrickIO::doc}{{1.6}{18}{btBrickIO}{section.1.6}{}} +\newlabel{btBrickIO:source.btBrickIO}{{1.6}{18}{btBrickIO}{section*.126}{}} +\@writefile{toc}{\contentsline {paragraph}{Notes}{19}{paragraph*.127}} +\newlabel{btBrickIO:source.btBrickIO.debug}{{1.6}{19}{Notes}{section*.128}{}} +\newlabel{btBrickIO:source.btBrickIO.serialPort}{{1.6}{19}{Notes}{section*.129}{}} +\newlabel{btBrickIO:source.btBrickIO.deviceName}{{1.6}{19}{Notes}{section*.130}{}} +\newlabel{btBrickIO:source.btBrickIO.channel}{{1.6}{19}{Notes}{section*.131}{}} +\newlabel{btBrickIO:source.btBrickIO.timeOut}{{1.6}{19}{Notes}{section*.132}{}} +\newlabel{btBrickIO:source.btBrickIO.backend}{{1.6}{19}{Notes}{section*.133}{}} +\@writefile{toc}{\contentsline {paragraph}{Examples}{19}{paragraph*.134}} +\newlabel{btBrickIO:source.btBrickIO.close}{{1.6}{19}{Examples}{section*.135}{}} +\newlabel{btBrickIO:source.btBrickIO.open}{{1.6}{19}{Examples}{section*.136}{}} +\newlabel{btBrickIO:source.btBrickIO.read}{{1.6}{19}{Examples}{section*.137}{}} +\newlabel{btBrickIO:source.btBrickIO.setProperties}{{1.6}{19}{Examples}{section*.138}{}} +\newlabel{btBrickIO:source.btBrickIO.write}{{1.6}{20}{Examples}{section*.139}{}} +\@writefile{toc}{\contentsline {chapter}{MATLAB Module Index}{21}{section*.140}} +\@writefile{toc}{\contentsline {chapter}{Index}{23}{section*.141}} diff --git a/docs/_build/latex/MindstormsEV3Toolbox.idx b/docs/_build/latex/MindstormsEV3Toolbox.idx index 46189e27a3291d81ce7fc08aa66c40c484a21d3c..745e18b4d43d3681b6ad13aceb5030142ae75d7a 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.idx +++ b/docs/_build/latex/MindstormsEV3Toolbox.idx @@ -1,8 +1,8 @@ \indexentry{source (module)|hyperpage}{3} \indexentry{EV3 (class in source)|hyperpage}{3} -\indexentry{motorA (source.EV3 attribute)|hyperpage}{4} -\indexentry{motorB (source.EV3 attribute)|hyperpage}{4} -\indexentry{motorC (source.EV3 attribute)|hyperpage}{4} +\indexentry{motorA (source.EV3 attribute)|hyperpage}{3} +\indexentry{motorB (source.EV3 attribute)|hyperpage}{3} +\indexentry{motorC (source.EV3 attribute)|hyperpage}{3} \indexentry{motorD (source.EV3 attribute)|hyperpage}{4} \indexentry{sensor1 (source.EV3 attribute)|hyperpage}{4} \indexentry{sensor2 (source.EV3 attribute)|hyperpage}{4} @@ -11,92 +11,91 @@ \indexentry{debug (source.EV3 attribute)|hyperpage}{4} \indexentry{batteryMode (source.EV3 attribute)|hyperpage}{4} \indexentry{batteryValue (source.EV3 attribute)|hyperpage}{4} -\indexentry{isConnected (source.EV3 attribute)|hyperpage}{5} -\indexentry{beep() (source.EV3 method)|hyperpage}{5} -\indexentry{connect() (source.EV3 method)|hyperpage}{5} +\indexentry{isConnected (source.EV3 attribute)|hyperpage}{4} +\indexentry{beep() (source.EV3 method)|hyperpage}{4} +\indexentry{connect() (source.EV3 method)|hyperpage}{4} \indexentry{disconnect() (source.EV3 method)|hyperpage}{5} -\indexentry{playTone() (source.EV3 method)|hyperpage}{6} -\indexentry{setProperties() (source.EV3 method)|hyperpage}{6} -\indexentry{stopAllMotors() (source.EV3 method)|hyperpage}{6} +\indexentry{playTone() (source.EV3 method)|hyperpage}{5} +\indexentry{setProperties() (source.EV3 method)|hyperpage}{5} \indexentry{stopTone() (source.EV3 method)|hyperpage}{6} \indexentry{tonePlayed() (source.EV3 method)|hyperpage}{6} -\indexentry{source (module)|hyperpage}{7} -\indexentry{Motor (class in source)|hyperpage}{7} +\indexentry{source (module)|hyperpage}{6} +\indexentry{Motor (class in source)|hyperpage}{6} \indexentry{power (source.Motor attribute)|hyperpage}{7} \indexentry{speedRegulation (source.Motor attribute)|hyperpage}{7} \indexentry{smoothStart (source.Motor attribute)|hyperpage}{7} -\indexentry{smoothStop (source.Motor attribute)|hyperpage}{8} -\indexentry{limitValue (source.Motor attribute)|hyperpage}{8} -\indexentry{limitMode (source.Motor attribute)|hyperpage}{8} -\indexentry{brakeMode (source.Motor attribute)|hyperpage}{8} -\indexentry{debug (source.Motor attribute)|hyperpage}{8} -\indexentry{isRunning (source.Motor attribute)|hyperpage}{8} -\indexentry{tachoCount (source.Motor attribute)|hyperpage}{8} -\indexentry{currentSpeed (source.Motor attribute)|hyperpage}{8} -\indexentry{type (source.Motor attribute)|hyperpage}{8} +\indexentry{smoothStop (source.Motor attribute)|hyperpage}{7} +\indexentry{limitValue (source.Motor attribute)|hyperpage}{7} +\indexentry{limitMode (source.Motor attribute)|hyperpage}{7} +\indexentry{brakeMode (source.Motor attribute)|hyperpage}{7} +\indexentry{debug (source.Motor attribute)|hyperpage}{7} +\indexentry{isRunning (source.Motor attribute)|hyperpage}{7} +\indexentry{tachoCount (source.Motor attribute)|hyperpage}{7} +\indexentry{currentSpeed (source.Motor attribute)|hyperpage}{7} +\indexentry{type (source.Motor attribute)|hyperpage}{7} \indexentry{internalReset() (source.Motor method)|hyperpage}{8} \indexentry{resetTachoCount() (source.Motor method)|hyperpage}{8} -\indexentry{setBrake() (source.Motor method)|hyperpage}{9} -\indexentry{setProperties() (source.Motor method)|hyperpage}{9} +\indexentry{setBrake() (source.Motor method)|hyperpage}{8} +\indexentry{setProperties() (source.Motor method)|hyperpage}{8} \indexentry{start() (source.Motor method)|hyperpage}{9} \indexentry{stop() (source.Motor method)|hyperpage}{9} \indexentry{syncedStart() (source.Motor method)|hyperpage}{9} -\indexentry{syncedStop() (source.Motor method)|hyperpage}{10} +\indexentry{syncedStop() (source.Motor method)|hyperpage}{9} \indexentry{waitFor() (source.Motor method)|hyperpage}{10} -\indexentry{source (module)|hyperpage}{11} -\indexentry{Sensor (class in source)|hyperpage}{11} -\indexentry{mode (source.Sensor attribute)|hyperpage}{11} -\indexentry{debug (source.Sensor attribute)|hyperpage}{13} -\indexentry{value (source.Sensor attribute)|hyperpage}{13} -\indexentry{type (source.Sensor attribute)|hyperpage}{13} +\indexentry{source (module)|hyperpage}{10} +\indexentry{Sensor (class in source)|hyperpage}{10} +\indexentry{mode (source.Sensor attribute)|hyperpage}{10} +\indexentry{debug (source.Sensor attribute)|hyperpage}{12} +\indexentry{value (source.Sensor attribute)|hyperpage}{12} +\indexentry{type (source.Sensor attribute)|hyperpage}{12} \indexentry{reset() (source.Sensor method)|hyperpage}{13} -\indexentry{setProperties() (source.Sensor method)|hyperpage}{14} -\indexentry{source (module)|hyperpage}{14} -\indexentry{hidapi (class in source)|hyperpage}{14} -\indexentry{handle (source.hidapi attribute)|hyperpage}{15} -\indexentry{vendorID (source.hidapi attribute)|hyperpage}{15} -\indexentry{productID (source.hidapi attribute)|hyperpage}{15} -\indexentry{nReadBuffer (source.hidapi attribute)|hyperpage}{15} -\indexentry{nWriteBuffer (source.hidapi attribute)|hyperpage}{15} -\indexentry{slib (source.hidapi attribute)|hyperpage}{15} -\indexentry{sheader (source.hidapi attribute)|hyperpage}{15} -\indexentry{close() (source.hidapi method)|hyperpage}{15} +\indexentry{setProperties() (source.Sensor method)|hyperpage}{13} +\indexentry{source (module)|hyperpage}{13} +\indexentry{hidapi (class in source)|hyperpage}{13} +\indexentry{handle (source.hidapi attribute)|hyperpage}{14} +\indexentry{vendorID (source.hidapi attribute)|hyperpage}{14} +\indexentry{productID (source.hidapi attribute)|hyperpage}{14} +\indexentry{nReadBuffer (source.hidapi attribute)|hyperpage}{14} +\indexentry{nWriteBuffer (source.hidapi attribute)|hyperpage}{14} +\indexentry{slib (source.hidapi attribute)|hyperpage}{14} +\indexentry{sheader (source.hidapi attribute)|hyperpage}{14} +\indexentry{close() (source.hidapi method)|hyperpage}{14} \indexentry{enumerate() (source.hidapi method)|hyperpage}{15} -\indexentry{error() (source.hidapi method)|hyperpage}{16} -\indexentry{exit() (source.hidapi method)|hyperpage}{16} -\indexentry{getHIDInfoString() (source.hidapi method)|hyperpage}{16} +\indexentry{error() (source.hidapi method)|hyperpage}{15} +\indexentry{exit() (source.hidapi method)|hyperpage}{15} +\indexentry{getHIDInfoString() (source.hidapi method)|hyperpage}{15} \indexentry{getManufacturersString() (source.hidapi method)|hyperpage}{16} \indexentry{getProductString() (source.hidapi method)|hyperpage}{16} \indexentry{getSerialNumberString() (source.hidapi method)|hyperpage}{16} \indexentry{init() (source.hidapi method)|hyperpage}{16} -\indexentry{open() (source.hidapi method)|hyperpage}{17} -\indexentry{read() (source.hidapi method)|hyperpage}{17} -\indexentry{read\_timeout() (source.hidapi method)|hyperpage}{17} +\indexentry{open() (source.hidapi method)|hyperpage}{16} +\indexentry{read() (source.hidapi method)|hyperpage}{16} +\indexentry{read\_timeout() (source.hidapi method)|hyperpage}{16} \indexentry{setNonBlocking() (source.hidapi method)|hyperpage}{17} \indexentry{write() (source.hidapi method)|hyperpage}{17} -\indexentry{source (module)|hyperpage}{18} -\indexentry{usbBrickIO (class in source)|hyperpage}{18} +\indexentry{source (module)|hyperpage}{17} +\indexentry{usbBrickIO (class in source)|hyperpage}{17} \indexentry{debug (source.usbBrickIO attribute)|hyperpage}{18} \indexentry{vendorID (source.usbBrickIO attribute)|hyperpage}{18} \indexentry{productID (source.usbBrickIO attribute)|hyperpage}{18} \indexentry{nReadBuffer (source.usbBrickIO attribute)|hyperpage}{18} \indexentry{nWriteBuffer (source.usbBrickIO attribute)|hyperpage}{18} \indexentry{timeOut (source.usbBrickIO attribute)|hyperpage}{18} -\indexentry{close() (source.usbBrickIO method)|hyperpage}{19} -\indexentry{open() (source.usbBrickIO method)|hyperpage}{19} -\indexentry{read() (source.usbBrickIO method)|hyperpage}{19} -\indexentry{setProperties() (source.usbBrickIO method)|hyperpage}{19} -\indexentry{write() (source.usbBrickIO method)|hyperpage}{19} -\indexentry{source (module)|hyperpage}{19} -\indexentry{btBrickIO (class in source)|hyperpage}{19} -\indexentry{debug (source.btBrickIO attribute)|hyperpage}{20} -\indexentry{serialPort (source.btBrickIO attribute)|hyperpage}{20} -\indexentry{deviceName (source.btBrickIO attribute)|hyperpage}{20} -\indexentry{channel (source.btBrickIO attribute)|hyperpage}{20} -\indexentry{timeOut (source.btBrickIO attribute)|hyperpage}{20} -\indexentry{backend (source.btBrickIO attribute)|hyperpage}{20} -\indexentry{close() (source.btBrickIO method)|hyperpage}{20} -\indexentry{open() (source.btBrickIO method)|hyperpage}{20} -\indexentry{read() (source.btBrickIO method)|hyperpage}{20} -\indexentry{setProperties() (source.btBrickIO method)|hyperpage}{20} +\indexentry{close() (source.usbBrickIO method)|hyperpage}{18} +\indexentry{open() (source.usbBrickIO method)|hyperpage}{18} +\indexentry{read() (source.usbBrickIO method)|hyperpage}{18} +\indexentry{setProperties() (source.usbBrickIO method)|hyperpage}{18} +\indexentry{write() (source.usbBrickIO method)|hyperpage}{18} +\indexentry{source (module)|hyperpage}{18} +\indexentry{btBrickIO (class in source)|hyperpage}{18} +\indexentry{debug (source.btBrickIO attribute)|hyperpage}{19} +\indexentry{serialPort (source.btBrickIO attribute)|hyperpage}{19} +\indexentry{deviceName (source.btBrickIO attribute)|hyperpage}{19} +\indexentry{channel (source.btBrickIO attribute)|hyperpage}{19} +\indexentry{timeOut (source.btBrickIO attribute)|hyperpage}{19} +\indexentry{backend (source.btBrickIO attribute)|hyperpage}{19} +\indexentry{close() (source.btBrickIO method)|hyperpage}{19} +\indexentry{open() (source.btBrickIO method)|hyperpage}{19} +\indexentry{read() (source.btBrickIO method)|hyperpage}{19} +\indexentry{setProperties() (source.btBrickIO method)|hyperpage}{19} \indexentry{write() (source.btBrickIO method)|hyperpage}{20} diff --git a/docs/_build/latex/MindstormsEV3Toolbox.ilg b/docs/_build/latex/MindstormsEV3Toolbox.ilg index 3d55ef3f7de820a3aa8987d6ca06bedd5757b916..60f413b091ff0bf7a9aeb2be5b65009b8d773fba 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.ilg +++ b/docs/_build/latex/MindstormsEV3Toolbox.ilg @@ -1,7 +1,7 @@ This is makeindex, version 2.15 [TeX Live 2013] (kpathsea + Thai support). Scanning style file ./python.ist......done (6 attributes redefined, 0 ignored). -Scanning input file MindstormsEV3Toolbox.idx....done (102 entries accepted, 0 rejected). +Scanning input file MindstormsEV3Toolbox.idx....done (101 entries accepted, 0 rejected). Sorting entries....done (719 comparisons). -Generating output file MindstormsEV3Toolbox.ind....done (155 lines written, 0 warnings). +Generating output file MindstormsEV3Toolbox.ind....done (154 lines written, 0 warnings). Output written in MindstormsEV3Toolbox.ind. Transcript written in MindstormsEV3Toolbox.ilg. diff --git a/docs/_build/latex/MindstormsEV3Toolbox.ind b/docs/_build/latex/MindstormsEV3Toolbox.ind index 732da01635bc5c7524973c8bf3cf45b84c247b03..b53cd6c775f17167217b499b2a98aa5a9039f20f 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.ind +++ b/docs/_build/latex/MindstormsEV3Toolbox.ind @@ -2,147 +2,146 @@ \def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}} \bigletter B - \item backend (source.btBrickIO attribute), \hyperpage{20} + \item backend (source.btBrickIO attribute), \hyperpage{19} \item batteryMode (source.EV3 attribute), \hyperpage{4} \item batteryValue (source.EV3 attribute), \hyperpage{4} - \item beep() (source.EV3 method), \hyperpage{5} - \item brakeMode (source.Motor attribute), \hyperpage{8} - \item btBrickIO (class in source), \hyperpage{19} + \item beep() (source.EV3 method), \hyperpage{4} + \item brakeMode (source.Motor attribute), \hyperpage{7} + \item btBrickIO (class in source), \hyperpage{18} \indexspace \bigletter C - \item channel (source.btBrickIO attribute), \hyperpage{20} - \item close() (source.btBrickIO method), \hyperpage{20} - \item close() (source.hidapi method), \hyperpage{15} - \item close() (source.usbBrickIO method), \hyperpage{19} - \item connect() (source.EV3 method), \hyperpage{5} - \item currentSpeed (source.Motor attribute), \hyperpage{8} + \item channel (source.btBrickIO attribute), \hyperpage{19} + \item close() (source.btBrickIO method), \hyperpage{19} + \item close() (source.hidapi method), \hyperpage{14} + \item close() (source.usbBrickIO method), \hyperpage{18} + \item connect() (source.EV3 method), \hyperpage{4} + \item currentSpeed (source.Motor attribute), \hyperpage{7} \indexspace \bigletter D - \item debug (source.btBrickIO attribute), \hyperpage{20} + \item debug (source.btBrickIO attribute), \hyperpage{19} \item debug (source.EV3 attribute), \hyperpage{4} - \item debug (source.Motor attribute), \hyperpage{8} - \item debug (source.Sensor attribute), \hyperpage{13} + \item debug (source.Motor attribute), \hyperpage{7} + \item debug (source.Sensor attribute), \hyperpage{12} \item debug (source.usbBrickIO attribute), \hyperpage{18} - \item deviceName (source.btBrickIO attribute), \hyperpage{20} + \item deviceName (source.btBrickIO attribute), \hyperpage{19} \item disconnect() (source.EV3 method), \hyperpage{5} \indexspace \bigletter E \item enumerate() (source.hidapi method), \hyperpage{15} - \item error() (source.hidapi method), \hyperpage{16} + \item error() (source.hidapi method), \hyperpage{15} \item EV3 (class in source), \hyperpage{3} - \item exit() (source.hidapi method), \hyperpage{16} + \item exit() (source.hidapi method), \hyperpage{15} \indexspace \bigletter G - \item getHIDInfoString() (source.hidapi method), \hyperpage{16} + \item getHIDInfoString() (source.hidapi method), \hyperpage{15} \item getManufacturersString() (source.hidapi method), \hyperpage{16} \item getProductString() (source.hidapi method), \hyperpage{16} \item getSerialNumberString() (source.hidapi method), \hyperpage{16} \indexspace \bigletter H - \item handle (source.hidapi attribute), \hyperpage{15} - \item hidapi (class in source), \hyperpage{14} + \item handle (source.hidapi attribute), \hyperpage{14} + \item hidapi (class in source), \hyperpage{13} \indexspace \bigletter I \item init() (source.hidapi method), \hyperpage{16} \item internalReset() (source.Motor method), \hyperpage{8} - \item isConnected (source.EV3 attribute), \hyperpage{5} - \item isRunning (source.Motor attribute), \hyperpage{8} + \item isConnected (source.EV3 attribute), \hyperpage{4} + \item isRunning (source.Motor attribute), \hyperpage{7} \indexspace \bigletter L - \item limitMode (source.Motor attribute), \hyperpage{8} - \item limitValue (source.Motor attribute), \hyperpage{8} + \item limitMode (source.Motor attribute), \hyperpage{7} + \item limitValue (source.Motor attribute), \hyperpage{7} \indexspace \bigletter M - \item mode (source.Sensor attribute), \hyperpage{11} - \item Motor (class in source), \hyperpage{7} - \item motorA (source.EV3 attribute), \hyperpage{4} - \item motorB (source.EV3 attribute), \hyperpage{4} - \item motorC (source.EV3 attribute), \hyperpage{4} + \item mode (source.Sensor attribute), \hyperpage{10} + \item Motor (class in source), \hyperpage{6} + \item motorA (source.EV3 attribute), \hyperpage{3} + \item motorB (source.EV3 attribute), \hyperpage{3} + \item motorC (source.EV3 attribute), \hyperpage{3} \item motorD (source.EV3 attribute), \hyperpage{4} \indexspace \bigletter N - \item nReadBuffer (source.hidapi attribute), \hyperpage{15} + \item nReadBuffer (source.hidapi attribute), \hyperpage{14} \item nReadBuffer (source.usbBrickIO attribute), \hyperpage{18} - \item nWriteBuffer (source.hidapi attribute), \hyperpage{15} + \item nWriteBuffer (source.hidapi attribute), \hyperpage{14} \item nWriteBuffer (source.usbBrickIO attribute), \hyperpage{18} \indexspace \bigletter O - \item open() (source.btBrickIO method), \hyperpage{20} - \item open() (source.hidapi method), \hyperpage{17} - \item open() (source.usbBrickIO method), \hyperpage{19} + \item open() (source.btBrickIO method), \hyperpage{19} + \item open() (source.hidapi method), \hyperpage{16} + \item open() (source.usbBrickIO method), \hyperpage{18} \indexspace \bigletter P - \item playTone() (source.EV3 method), \hyperpage{6} + \item playTone() (source.EV3 method), \hyperpage{5} \item power (source.Motor attribute), \hyperpage{7} - \item productID (source.hidapi attribute), \hyperpage{15} + \item productID (source.hidapi attribute), \hyperpage{14} \item productID (source.usbBrickIO attribute), \hyperpage{18} \indexspace \bigletter R - \item read() (source.btBrickIO method), \hyperpage{20} - \item read() (source.hidapi method), \hyperpage{17} - \item read() (source.usbBrickIO method), \hyperpage{19} - \item read\_timeout() (source.hidapi method), \hyperpage{17} + \item read() (source.btBrickIO method), \hyperpage{19} + \item read() (source.hidapi method), \hyperpage{16} + \item read() (source.usbBrickIO method), \hyperpage{18} + \item read\_timeout() (source.hidapi method), \hyperpage{16} \item reset() (source.Sensor method), \hyperpage{13} \item resetTachoCount() (source.Motor method), \hyperpage{8} \indexspace \bigletter S - \item Sensor (class in source), \hyperpage{11} + \item Sensor (class in source), \hyperpage{10} \item sensor1 (source.EV3 attribute), \hyperpage{4} \item sensor2 (source.EV3 attribute), \hyperpage{4} \item sensor3 (source.EV3 attribute), \hyperpage{4} \item sensor4 (source.EV3 attribute), \hyperpage{4} - \item serialPort (source.btBrickIO attribute), \hyperpage{20} - \item setBrake() (source.Motor method), \hyperpage{9} + \item serialPort (source.btBrickIO attribute), \hyperpage{19} + \item setBrake() (source.Motor method), \hyperpage{8} \item setNonBlocking() (source.hidapi method), \hyperpage{17} - \item setProperties() (source.btBrickIO method), \hyperpage{20} - \item setProperties() (source.EV3 method), \hyperpage{6} - \item setProperties() (source.Motor method), \hyperpage{9} - \item setProperties() (source.Sensor method), \hyperpage{14} - \item setProperties() (source.usbBrickIO method), \hyperpage{19} - \item sheader (source.hidapi attribute), \hyperpage{15} - \item slib (source.hidapi attribute), \hyperpage{15} + \item setProperties() (source.btBrickIO method), \hyperpage{19} + \item setProperties() (source.EV3 method), \hyperpage{5} + \item setProperties() (source.Motor method), \hyperpage{8} + \item setProperties() (source.Sensor method), \hyperpage{13} + \item setProperties() (source.usbBrickIO method), \hyperpage{18} + \item sheader (source.hidapi attribute), \hyperpage{14} + \item slib (source.hidapi attribute), \hyperpage{14} \item smoothStart (source.Motor attribute), \hyperpage{7} - \item smoothStop (source.Motor attribute), \hyperpage{8} - \item source (module), \hyperpage{3}, \hyperpage{7}, \hyperpage{11}, \hyperpage{14}, - \hyperpage{18, 19} + \item smoothStop (source.Motor attribute), \hyperpage{7} + \item source (module), \hyperpage{3}, \hyperpage{6}, \hyperpage{10}, \hyperpage{13}, + \hyperpage{17, 18} \item speedRegulation (source.Motor attribute), \hyperpage{7} \item start() (source.Motor method), \hyperpage{9} \item stop() (source.Motor method), \hyperpage{9} - \item stopAllMotors() (source.EV3 method), \hyperpage{6} \item stopTone() (source.EV3 method), \hyperpage{6} \item syncedStart() (source.Motor method), \hyperpage{9} - \item syncedStop() (source.Motor method), \hyperpage{10} + \item syncedStop() (source.Motor method), \hyperpage{9} \indexspace \bigletter T - \item tachoCount (source.Motor attribute), \hyperpage{8} - \item timeOut (source.btBrickIO attribute), \hyperpage{20} + \item tachoCount (source.Motor attribute), \hyperpage{7} + \item timeOut (source.btBrickIO attribute), \hyperpage{19} \item timeOut (source.usbBrickIO attribute), \hyperpage{18} \item tonePlayed() (source.EV3 method), \hyperpage{6} - \item type (source.Motor attribute), \hyperpage{8} - \item type (source.Sensor attribute), \hyperpage{13} + \item type (source.Motor attribute), \hyperpage{7} + \item type (source.Sensor attribute), \hyperpage{12} \indexspace \bigletter U - \item usbBrickIO (class in source), \hyperpage{18} + \item usbBrickIO (class in source), \hyperpage{17} \indexspace \bigletter V - \item value (source.Sensor attribute), \hyperpage{13} - \item vendorID (source.hidapi attribute), \hyperpage{15} + \item value (source.Sensor attribute), \hyperpage{12} + \item vendorID (source.hidapi attribute), \hyperpage{14} \item vendorID (source.usbBrickIO attribute), \hyperpage{18} \indexspace @@ -150,6 +149,6 @@ \item waitFor() (source.Motor method), \hyperpage{10} \item write() (source.btBrickIO method), \hyperpage{20} \item write() (source.hidapi method), \hyperpage{17} - \item write() (source.usbBrickIO method), \hyperpage{19} + \item write() (source.usbBrickIO method), \hyperpage{18} \end{theindex} diff --git a/docs/_build/latex/MindstormsEV3Toolbox.log b/docs/_build/latex/MindstormsEV3Toolbox.log index 4bdbd61de2f9679e5aa817ab19c0894fbc92907d..0071761bcf09fd733c10e23dee7fec894af4fc52 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.log +++ b/docs/_build/latex/MindstormsEV3Toolbox.log @@ -1,4 +1,4 @@ -This is pdfTeX, Version 3.1415926-2.5-1.40.14 (TeX Live 2013/Debian) (format=pdflatex 2016.11.23) 30 JUN 2017 16:17 +This is pdfTeX, Version 3.1415926-2.5-1.40.14 (TeX Live 2013/Debian) (format=pdflatex 2016.11.23) 15 AUG 2017 19:10 entering extended mode restricted \write18 enabled. %&-line parsing enabled. @@ -1000,60 +1000,47 @@ LaTeX Font Info: Font shape `T1/ptm/bx/n' in size <10> not available ] Chapter 1. LaTeX Font Info: Font shape `T1/phv/bx/n' in size <14.4> not available -(Font) Font shape `T1/phv/b/n' tried instead on input line 160. +(Font) Font shape `T1/phv/b/n' tried instead on input line 152. LaTeX Font Info: Font shape `T1/ptm/bx/n' in size <14.4> not available -(Font) Font shape `T1/ptm/b/n' tried instead on input line 160. +(Font) Font shape `T1/ptm/b/n' tried instead on input line 152. LaTeX Font Info: Font shape `T1/ptm/bx/n' in size <24.88> not available -(Font) Font shape `T1/ptm/b/n' tried instead on input line 160. -LaTeX Font Info: Try loading font information for T1+pcr on input line 179. +(Font) Font shape `T1/ptm/b/n' tried instead on input line 152. +LaTeX Font Info: Try loading font information for T1+pcr on input line 1. (/usr/share/texlive/texmf-dist/tex/latex/psnfss/t1pcr.fd File: t1pcr.fd 2001/06/04 font definitions for T1/pcr. ) -LaTeX Font Info: Font shape `T1/pcr/m/it' in size <9> not available -(Font) Font shape `T1/pcr/m/sl' tried instead on input line 180. -LaTeX Font Info: Try loading font information for TS1+pcr on input line 182. - - -(/usr/share/texlive/texmf-dist/tex/latex/psnfss/ts1pcr.fd -File: ts1pcr.fd 2001/06/04 font definitions for TS1/pcr. -) LaTeX Font Info: Font shape `T1/pcr/bx/n' in size <10> not available (Font) Font shape `T1/pcr/b/n' tried instead on input line 1. LaTeX Font Info: Font shape `T1/ptm/bx/it' in size <10> not available -(Font) Font shape `T1/ptm/b/it' tried instead on input line 201. -LaTeX Font Info: Try loading font information for TS1+ptm on input line 202. +(Font) Font shape `T1/ptm/b/it' tried instead on input line 162. +LaTeX Font Info: Try loading font information for TS1+ptm on input line 163. (/usr/share/texlive/texmf-dist/tex/latex/psnfss/ts1ptm.fd File: ts1ptm.fd 2001/06/04 font definitions for TS1/ptm. -) [3] +) LaTeX Font Info: Font shape `T1/pcr/m/it' in size <10> not available (Font) Font shape `T1/pcr/m/sl' tried instead on input line 1. - [4] -Underfull \hbox (badness 10000) in paragraph at lines 398--400 + [3] [4] +Underfull \hbox (badness 10000) in paragraph at lines 359--361 []\T1/pcr/b/n/10 serPort \T1/ptm/m/n/10 (\T1/pcr/m/sl/10 string in {'/dev/rfcom m1', '/dev/rfcomm2', ...}\T1/ptm/m/n/10 ) -- [] -[5] -Underfull \hbox (badness 10000) in paragraph at lines 484--485 + +Underfull \hbox (badness 10000) in paragraph at lines 445--446 []\T1/pcr/b/n/10 batteryMode \T1/ptm/m/n/10 (\T1/pcr/m/sl/10 string in {'Voltag e'/'Percentage'}\T1/ptm/m/n/10 ) -- see [] -[6] [7] [8] [9] [10] [11] [12] [13] -Underfull \hbox (badness 10000) in paragraph at lines 1313--1315 -[]\T1/ptm/m/n/10 `all mo-tor tacho - [] - -[14] [15] -Underfull \hbox (badness 10000) in paragraph at lines 1603--1605 +[5] [6] [7] [8] [9] [10] [11] [12] [13] [14] +Underfull \hbox (badness 10000) in paragraph at lines 1549--1551 []\T1/ptm/m/n/10 See also HI-DAPI.GETMANUFACTURERSSTRING, HI-DAPI.GETPRODUCTSTR ING, HI- [] -[16] [17] [18] [19] -Underfull \hbox (badness 5504) in paragraph at lines 2078--2080 +[15] [16] [17] [18] [19] +Underfull \hbox (badness 5504) in paragraph at lines 2024--2026 []\T1/ptm/m/n/10 See also BT-BRICKIO.DEBUG, BT-BRICKIO.SERIALPORT, BT-BRICKIO.D EVICENAME, BT- [] @@ -1070,23 +1057,23 @@ EVICENAME, BT- ] [24 ]) -Package atveryend Info: Empty hook `BeforeClearDocument' on input line 2110. -Package atveryend Info: Empty hook `AfterLastShipout' on input line 2110. +Package atveryend Info: Empty hook `BeforeClearDocument' on input line 2056. +Package atveryend Info: Empty hook `AfterLastShipout' on input line 2056. (./MindstormsEV3Toolbox.aux) -Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 2110. -Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 2110. +Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 2056. +Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 2056. Package rerunfilecheck Info: File `MindstormsEV3Toolbox.out' has not changed. -(rerunfilecheck) Checksum: CA85C18231C8BE65A74CF3036572891B;1005. -Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 2110. +(rerunfilecheck) Checksum: 9719E66C3E78A64D7D70223B0833B074;820. +Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 2056. ) Here is how much of TeX's memory you used: - 13596 strings out of 493304 - 186205 string characters out of 6139870 - 277350 words of memory out of 5000000 - 16554 multiletter control sequences out of 15000+600000 - 62190 words of font info for 80 fonts, out of 8000000 for 9000 + 13536 strings out of 493304 + 185311 string characters out of 6139870 + 273034 words of memory out of 5000000 + 16512 multiletter control sequences out of 15000+600000 + 53871 words of font info for 71 fonts, out of 8000000 for 9000 958 hyphenation exceptions out of 8191 36i,12n,45p,527b,671s stack positions out of 5000i,500n,10000p,200000b,80000s {/usr/share/texlive/texmf-dist/fonts/enc/dvips/base/8r.enc}</usr/share/texliv @@ -1099,10 +1086,10 @@ texlive/texmf-dist/fonts/type1/urw/times/utmb8a.pfb></usr/share/texlive/texmf-d ist/fonts/type1/urw/times/utmbi8a.pfb></usr/share/texlive/texmf-dist/fonts/type 1/urw/times/utmr8a.pfb></usr/share/texlive/texmf-dist/fonts/type1/urw/times/utm ri8a.pfb> -Output written on MindstormsEV3Toolbox.pdf (28 pages, 178554 bytes). +Output written on MindstormsEV3Toolbox.pdf (28 pages, 172860 bytes). PDF statistics: - 584 PDF objects out of 1000 (max. 8388607) - 533 compressed objects within 6 object streams - 186 named destinations out of 1000 (max. 500000) - 109 words of extra memory for PDF output out of 10000 (max. 10000000) + 565 PDF objects out of 1000 (max. 8388607) + 514 compressed objects within 6 object streams + 180 named destinations out of 1000 (max. 500000) + 93 words of extra memory for PDF output out of 10000 (max. 10000000) diff --git a/docs/_build/latex/MindstormsEV3Toolbox.out b/docs/_build/latex/MindstormsEV3Toolbox.out index 2a21406590ebad8fc4a7e706f91a278aed799cf3..22711f503c315e66f6cf13d69f069b33c3e64502 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.out +++ b/docs/_build/latex/MindstormsEV3Toolbox.out @@ -1,11 +1,9 @@ \BOOKMARK [0][-]{chapter.1}{\376\377\000C\000o\000n\000t\000e\000n\000t\000s}{}% 1 -\BOOKMARK [1][-]{section.1.1}{\376\377\000G\000e\000n\000e\000r\000a\000l}{chapter.1}% 2 -\BOOKMARK [1][-]{section.1.2}{\376\377\000E\000x\000a\000m\000p\000l\000e\000s}{chapter.1}% 3 -\BOOKMARK [1][-]{section.1.3}{\376\377\000E\000V\0003}{chapter.1}% 4 -\BOOKMARK [1][-]{section.1.4}{\376\377\000M\000o\000t\000o\000r}{chapter.1}% 5 -\BOOKMARK [1][-]{section.1.5}{\376\377\000S\000e\000n\000s\000o\000r}{chapter.1}% 6 -\BOOKMARK [1][-]{section.1.6}{\376\377\000h\000i\000d\000a\000p\000i}{chapter.1}% 7 -\BOOKMARK [1][-]{section.1.7}{\376\377\000u\000s\000b\000B\000r\000i\000c\000k\000I\000O}{chapter.1}% 8 -\BOOKMARK [1][-]{section.1.8}{\376\377\000b\000t\000B\000r\000i\000c\000k\000I\000O}{chapter.1}% 9 -\BOOKMARK [0][-]{section*.141}{\376\377\000M\000A\000T\000L\000A\000B\000\040\000M\000o\000d\000u\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 10 -\BOOKMARK [0][-]{section*.142}{\376\377\000I\000n\000d\000e\000x}{}% 11 +\BOOKMARK [1][-]{section.1.1}{\376\377\000E\000V\0003}{chapter.1}% 2 +\BOOKMARK [1][-]{section.1.2}{\376\377\000M\000o\000t\000o\000r}{chapter.1}% 3 +\BOOKMARK [1][-]{section.1.3}{\376\377\000S\000e\000n\000s\000o\000r}{chapter.1}% 4 +\BOOKMARK [1][-]{section.1.4}{\376\377\000h\000i\000d\000a\000p\000i}{chapter.1}% 5 +\BOOKMARK [1][-]{section.1.5}{\376\377\000u\000s\000b\000B\000r\000i\000c\000k\000I\000O}{chapter.1}% 6 +\BOOKMARK [1][-]{section.1.6}{\376\377\000b\000t\000B\000r\000i\000c\000k\000I\000O}{chapter.1}% 7 +\BOOKMARK [0][-]{section*.140}{\376\377\000M\000A\000T\000L\000A\000B\000\040\000M\000o\000d\000u\000l\000e\000\040\000I\000n\000d\000e\000x}{}% 8 +\BOOKMARK [0][-]{section*.141}{\376\377\000I\000n\000d\000e\000x}{}% 9 diff --git a/docs/_build/latex/MindstormsEV3Toolbox.pdf b/docs/_build/latex/MindstormsEV3Toolbox.pdf index 956a691f8dc5ddbb8dad5c445cb9030a7dc5bb93..64c49bfd6bd2fad0db48d27192caf8c1c3a17138 100644 Binary files a/docs/_build/latex/MindstormsEV3Toolbox.pdf and b/docs/_build/latex/MindstormsEV3Toolbox.pdf differ diff --git a/docs/_build/latex/MindstormsEV3Toolbox.tex b/docs/_build/latex/MindstormsEV3Toolbox.tex index 1292b6735f88a3c6320aa0d6cae7dbdf71ab34ce..6cf917ea3ef6ba93136fdcfdcaba0ff04acd98e2 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.tex +++ b/docs/_build/latex/MindstormsEV3Toolbox.tex @@ -32,8 +32,8 @@ \title{Mindstorms EV3 Toolbox Documentation} -\date{Jun 30, 2017} -\release{v0.4-rc.10} +\date{Aug 15, 2017} +\release{v1.0} \author{LfB - RWTH Aachen} \newcommand{\sphinxlogo}{} \renewcommand{\releasename}{Release} @@ -144,53 +144,14 @@ \phantomsection\label{index::doc} -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 \DUrole{xref,doc}{Communication -layer}) 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. - -To get started, take a look at the {\hyperref[readme::doc]{\sphinxcrossref{\DUrole{doc}{installation instructions}}}} and {\hyperref[examples::doc]{\sphinxcrossref{\DUrole{doc}{examples}}}}. - -This toolbox is being developed at the RWTH Aachen, Germany, as part of the students' lab -`MATLAB meets Mindstorms'. It is the follow-up of the \href{http://www.mindstorms.rwth-aachen.de/trac/}{MATLAB NXT Toolbox}. +Hi there! This is the documentation for the ``Lego Mindstorms EV3'' MATLAB Toolbox, +developed by RWTH Aachen. For an introduction about this toolbox, installation +guides and examples, take a look at \href{https://git.rwth-aachen.de/mindstorms/ev3-toolbox-matlab/blob/master/readme.md}{our repository}. \chapter{Contents} -\label{index:matlab-nxt-toolbox}\label{index:contents}\label{index:matlab-toolbox-for-controlling-lego-mindstorms-ev3} -Setting up the toolbox - - -\section{General} -\label{readme::doc}\label{readme:general} - -\subsection{Installation} -\label{readme:installation} - -\subsection{Contribution} -\label{readme:contribution} - -\subsection{Licenses} -\label{readme:licenses} - -\section{Examples} -\label{examples::doc}\label{examples:examples} -\begin{Verbatim}[commandchars=\\\{\}] -\PYG{c}{\PYGZpc{} This example expects a motor at port A and a (random) sensor at port 1} -\PYG{n}{b} \PYG{p}{=} \PYG{n}{EV3}\PYG{p}{(}\PYG{p}{)}\PYG{p}{;} -\PYG{n}{b}\PYG{p}{.}\PYG{n}{connect}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{usb\PYGZsq{}}\PYG{p}{)}\PYG{p}{;} -\PYG{n}{ma} \PYG{p}{=} \PYG{n}{b}\PYG{p}{.}\PYG{n}{motorA}\PYG{p}{;} -\PYG{n}{ma}\PYG{p}{.}\PYG{n}{setProperties}\PYG{p}{(}\PYG{l+s}{\PYGZsq{}}\PYG{l+s}{power\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{50}\PYG{p}{,} \PYG{l+s}{\PYGZsq{}}\PYG{l+s}{limitValue\PYGZsq{}}\PYG{p}{,} \PYG{l+m+mi}{720}\PYG{p}{)}\PYG{p}{;} -\PYG{n}{ma}\PYG{p}{.}\PYG{n}{start}\PYG{p}{(}\PYG{p}{)}\PYG{p}{;} -\PYG{c}{\PYGZpc{} fun} -\PYG{n}{ma}\PYG{p}{.}\PYG{n}{waitFor}\PYG{p}{(}\PYG{p}{)}\PYG{p}{;} -\PYG{n+nb}{disp}\PYG{p}{(}\PYG{n}{b}\PYG{p}{.}\PYG{n}{sensor1}\PYG{p}{.}\PYG{n}{value}\PYG{p}{)}\PYG{p}{;} -\PYG{n}{b}\PYG{p}{.}\PYG{n}{beep}\PYG{p}{(}\PYG{p}{)}\PYG{p}{;} -\PYG{n}{b}\PYG{p}{.}\PYG{n}{delete}\PYG{p}{(}\PYG{p}{)}\PYG{p}{;} -\end{Verbatim} - -Toolbox documentation +\label{index:our-repository}\label{index:contents}\label{index:matlab-toolbox-for-controlling-lego-mindstorms-ev3} +High-Level documentation \phantomsection\label{EV3:module-source}\index{source (module)} \section{EV3} @@ -497,14 +458,6 @@ See also EV3.DEBUG, EV3.BATTERYMODE / \sphinxcode{debug}, \sphinxcode{batteryMod \end{fulllineitems} -\index{stopAllMotors() (source.EV3 method)} - -\begin{fulllineitems} -\phantomsection\label{EV3:source.EV3.stopAllMotors}\pysiglinewithargsret{\sphinxbfcode{stopAllMotors}}{\emph{ev3}}{} -Sends a stop-command to all motor-ports. - -\end{fulllineitems} - \index{stopTone() (source.EV3 method)} \begin{fulllineitems} @@ -1307,14 +1260,7 @@ Resets sensor value. \paragraph{Notes} \begin{itemize} \item {} -This clears ALL the sensors right now, no other Op-Code available... :( -\begin{quote} -\begin{description} -\item[{warning({[}'Current version of reset resets ALL devices, that is, `,...}] \leavevmode -`all motor tacho counts and all other sensor counters!'{]}); - -\end{description} -\end{quote} +Has not been thoroughly tested but seems to work as expected \end{itemize} @@ -1350,7 +1296,7 @@ b.sensor1.setProperties(`debug', `on', `mode', DeviceMode.Color.Ambient); \% \end{fulllineitems} -Advanced +Low-Level documentation \phantomsection\label{hid:module-source}\index{source (module)} \section{hidapi} diff --git a/docs/_build/latex/MindstormsEV3Toolbox.toc b/docs/_build/latex/MindstormsEV3Toolbox.toc index 0023c130001e9813a4304a5d94fe8819e24cbe7c..78021444cdb9307a52fb1e68f90805238a95dad6 100644 --- a/docs/_build/latex/MindstormsEV3Toolbox.toc +++ b/docs/_build/latex/MindstormsEV3Toolbox.toc @@ -1,51 +1,46 @@ \select@language {english} \contentsline {chapter}{\numberline {1}Contents}{3}{chapter.1} -\contentsline {section}{\numberline {1.1}General}{3}{section.1.1} -\contentsline {subsection}{\numberline {1.1.1}Installation}{3}{subsection.1.1.1} -\contentsline {subsection}{\numberline {1.1.2}Contribution}{3}{subsection.1.1.2} -\contentsline {subsection}{\numberline {1.1.3}Licenses}{3}{subsection.1.1.3} -\contentsline {section}{\numberline {1.2}Examples}{3}{section.1.2} -\contentsline {section}{\numberline {1.3}EV3}{3}{section.1.3} -\contentsline {paragraph}{Notes}{4}{paragraph*.5} -\contentsline {paragraph}{Example}{5}{paragraph*.18} -\contentsline {paragraph}{Notes}{5}{paragraph*.20} -\contentsline {paragraph}{Example}{5}{paragraph*.21} +\contentsline {section}{\numberline {1.1}EV3}{3}{section.1.1} +\contentsline {paragraph}{Notes}{3}{paragraph*.5} +\contentsline {paragraph}{Example}{4}{paragraph*.18} +\contentsline {paragraph}{Notes}{4}{paragraph*.20} +\contentsline {paragraph}{Example}{4}{paragraph*.21} \contentsline {paragraph}{Example}{5}{paragraph*.23} \contentsline {paragraph}{Notes}{5}{paragraph*.25} -\contentsline {paragraph}{Example}{6}{paragraph*.26} -\contentsline {paragraph}{Example}{6}{paragraph*.28} +\contentsline {paragraph}{Example}{5}{paragraph*.26} +\contentsline {paragraph}{Example}{5}{paragraph*.28} \contentsline {paragraph}{Example}{6}{paragraph*.30} -\contentsline {paragraph}{Example}{6}{paragraph*.33} -\contentsline {section}{\numberline {1.4}Motor}{7}{section.1.4} -\contentsline {paragraph}{Notes}{7}{paragraph*.37} -\contentsline {paragraph}{Notes}{8}{paragraph*.51} -\contentsline {paragraph}{Notes}{9}{paragraph*.54} -\contentsline {paragraph}{Example}{9}{paragraph*.56} -\contentsline {paragraph}{Notes}{9}{paragraph*.59} -\contentsline {paragraph}{Notes}{10}{paragraph*.61} -\contentsline {paragraph}{Example}{10}{paragraph*.62} -\contentsline {paragraph}{Notes}{10}{paragraph*.64} -\contentsline {paragraph}{Notes}{10}{paragraph*.66} -\contentsline {section}{\numberline {1.5}Sensor}{11}{section.1.5} -\contentsline {paragraph}{Notes}{11}{paragraph*.69} -\contentsline {paragraph}{Notes}{14}{paragraph*.75} -\contentsline {paragraph}{Example}{14}{paragraph*.77} -\contentsline {section}{\numberline {1.6}hidapi}{14}{section.1.6} -\contentsline {paragraph}{Notes}{15}{paragraph*.80} -\contentsline {paragraph}{Example}{15}{paragraph*.88} -\contentsline {paragraph}{Notes}{15}{paragraph*.90} -\contentsline {paragraph}{Notes}{16}{paragraph*.92} -\contentsline {paragraph}{Notes}{16}{paragraph*.94} -\contentsline {paragraph}{Notes}{16}{paragraph*.97} -\contentsline {paragraph}{Notes}{17}{paragraph*.102} -\contentsline {paragraph}{Notes}{17}{paragraph*.104} -\contentsline {paragraph}{Notes}{17}{paragraph*.106} -\contentsline {paragraph}{Notes}{18}{paragraph*.110} -\contentsline {section}{\numberline {1.7}usbBrickIO}{18}{section.1.7} -\contentsline {paragraph}{Notes}{18}{paragraph*.113} -\contentsline {paragraph}{Examples}{19}{paragraph*.120} -\contentsline {section}{\numberline {1.8}btBrickIO}{19}{section.1.8} -\contentsline {paragraph}{Notes}{19}{paragraph*.128} -\contentsline {paragraph}{Examples}{20}{paragraph*.135} -\contentsline {chapter}{MATLAB Module Index}{21}{section*.141} -\contentsline {chapter}{Index}{23}{section*.142} +\contentsline {paragraph}{Example}{6}{paragraph*.32} +\contentsline {section}{\numberline {1.2}Motor}{6}{section.1.2} +\contentsline {paragraph}{Notes}{7}{paragraph*.36} +\contentsline {paragraph}{Notes}{8}{paragraph*.50} +\contentsline {paragraph}{Notes}{8}{paragraph*.53} +\contentsline {paragraph}{Example}{9}{paragraph*.55} +\contentsline {paragraph}{Notes}{9}{paragraph*.58} +\contentsline {paragraph}{Notes}{9}{paragraph*.60} +\contentsline {paragraph}{Example}{9}{paragraph*.61} +\contentsline {paragraph}{Notes}{10}{paragraph*.63} +\contentsline {paragraph}{Notes}{10}{paragraph*.65} +\contentsline {section}{\numberline {1.3}Sensor}{10}{section.1.3} +\contentsline {paragraph}{Notes}{10}{paragraph*.68} +\contentsline {paragraph}{Notes}{13}{paragraph*.74} +\contentsline {paragraph}{Example}{13}{paragraph*.76} +\contentsline {section}{\numberline {1.4}hidapi}{13}{section.1.4} +\contentsline {paragraph}{Notes}{14}{paragraph*.79} +\contentsline {paragraph}{Example}{14}{paragraph*.87} +\contentsline {paragraph}{Notes}{15}{paragraph*.89} +\contentsline {paragraph}{Notes}{15}{paragraph*.91} +\contentsline {paragraph}{Notes}{15}{paragraph*.93} +\contentsline {paragraph}{Notes}{15}{paragraph*.96} +\contentsline {paragraph}{Notes}{16}{paragraph*.101} +\contentsline {paragraph}{Notes}{16}{paragraph*.103} +\contentsline {paragraph}{Notes}{16}{paragraph*.105} +\contentsline {paragraph}{Notes}{17}{paragraph*.109} +\contentsline {section}{\numberline {1.5}usbBrickIO}{17}{section.1.5} +\contentsline {paragraph}{Notes}{17}{paragraph*.112} +\contentsline {paragraph}{Examples}{18}{paragraph*.119} +\contentsline {section}{\numberline {1.6}btBrickIO}{18}{section.1.6} +\contentsline {paragraph}{Notes}{19}{paragraph*.127} +\contentsline {paragraph}{Examples}{19}{paragraph*.134} +\contentsline {chapter}{MATLAB Module Index}{21}{section*.140} +\contentsline {chapter}{Index}{23}{section*.141} diff --git a/docs/conf.py b/docs/conf.py index 1685a350b23b229ac2ff2b83029a20959cec59bb..f0141b9e502441b4cb9f5bb6a9c72486487de689 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -81,17 +81,17 @@ master_doc = 'index' # General information about the project. project = u'Mindstorms EV3 Toolbox' -copyright = u'2016, LfB - RWTH Aachen' -author = u'LfB - RWTH Aachen' +copyright = u'2017, RWTH Aachen' +author = u'RWTH Aachen' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'v0.4' +version = u'v1.0' # The full version, including alpha/beta/rc tags. -release = u'v0.4-rc.10' +release = u'v1.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -157,7 +157,7 @@ html_theme = 'bootstrap' # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = {'navbar_fixed_top': True, +html_theme_options = {'navbar_fixed_top': True, 'bootswatch_theme': "readable"} # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 157a890c15b3b897ca5e3259d9f5fbe22c3fe0fe..9ee56c01ac71e7761e2ef9b53c971f77a9372926 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,50 +4,32 @@ contain the root `toctree` directive. ================================================== -MATLAB Toolbox for controlling Lego Mindstorms EV3 +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 :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. +Hi there! This is the documentation for the "Lego Mindstorms EV3" MATLAB Toolbox, +developed by RWTH Aachen. For an introduction about this toolbox, installation +guides and examples, take a look at `our repository`_. -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 -'MATLAB meets Mindstorms'. It is the follow-up of the `MATLAB NXT Toolbox`_. - - -.. _MATLAB NXT Toolbox: http://www.mindstorms.rwth-aachen.de/trac/ +.. _our repository: https://git.rwth-aachen.de/mindstorms/ev3-toolbox-matlab/blob/master/readme.md Contents ======== -Setting up the toolbox +High-Level documentation .. toctree:: :maxdepth: 2 - readme - examples - -Toolbox documentation - -.. toctree:: - :maxdepth: 2 - EV3 Motor Sensor -Advanced +Low-Level documentation .. toctree:: :maxdepth: 3 - + hid usbBrickIO btBrickIO -