Commit e04449e2 authored by Maximilian Schnabel's avatar Maximilian Schnabel
Browse files

reformatted code examples, additional information on sensor outputs

parent 727177d2
# 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: 42809051028c0ea2e31137f7f9be60d4
config: 8f8c486ade9823f2fde5c6c26744a01e
tags: 645f666f9bcd5a90fca523b33c5a78b7
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CommandLayer &#8212; 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" />
<link rel="stylesheet" href="_static/bootswatch-3.3.6/readable/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: 'v1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<script type="text/javascript" src="_static/language_data.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 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'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head>
<body role="document">
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
......@@ -107,7 +93,7 @@
<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/CommandLayer.txt"
<a href="_sources/CommandLayer.rst.txt"
rel="nofollow">Source</a>
</div></li>
......@@ -129,7 +115,7 @@
<div class="container">
<div class="row">
<div class="col-md-12 content">
<div class="body col-md-12 content" role="main">
<span class="target" id="module-source"></span><div class="section" id="commandlayer">
<h1>CommandLayer<a class="headerlink" href="#commandlayer" title="Permalink to this headline"></a></h1>
......@@ -154,7 +140,7 @@
</p>
<p>
&copy; Copyright 2017, RWTH Aachen.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.<br/>
</p>
</div>
</footer>
......
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CommunicationLayer &#8212; 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" />
<link rel="stylesheet" href="_static/bootswatch-3.3.6/readable/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: 'v1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<script type="text/javascript" src="_static/language_data.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 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'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
</head>
<body role="document">
</head><body>
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
<div class="container">
......@@ -107,7 +93,7 @@
<li class="hidden-sm">
<div id="sourcelink">
<a href="_sources/CommunicationLayer.txt"
<a href="_sources/CommunicationLayer.rst.txt"
rel="nofollow">Source</a>
</div></li>
......@@ -129,7 +115,7 @@
<div class="container">
<div class="row">
<div class="col-md-12 content">
<div class="body col-md-12 content" role="main">
<span class="target" id="module-source"></span><div class="section" id="communicationlayer">
<h1>CommunicationLayer<a class="headerlink" href="#communicationlayer" title="Permalink to this headline"></a></h1>
......@@ -154,7 +140,7 @@
</p>
<p>
&copy; Copyright 2017, RWTH Aachen.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.<br/>
</p>
</div>
</footer>
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
.. automodule:: source
.. |br| raw:: html
<br />
============
CommandLayer
============
Command
=======
CommunicationInterface
======================
.. automodule:: source
.. |br| raw:: html
<br />
==================
CommunicationLayer
==================
USB
===
Bluetooth
=========
.. automodule:: source
.. |br| raw:: html
<br />
EV3
===
.. autoclass:: EV3
:members: connect, disconnect, stopAllMotors, beep, playTone, stopTone, tonePlayed, setProperties
.. automodule:: source
.. |br| raw:: html
<br />
Motor
=====
.. autoclass:: Motor
:members: start, stop, syncedStart, syncedStop, waitFor, internalReset, resetTachoCount, setBrake, setProperties
.. automodule:: source
.. |br| raw:: html
<br />
Sensor
======
.. autoclass:: Sensor
:members: reset, setProperties
.. automodule:: source
.. |br| raw:: html
<br />
btBrickIO
=========
.. autoclass:: btBrickIO
:members: open, close, read, write, setProperties
========
Examples
========
.. code-block:: matlab
% This example expects a motor at port A and a (random) sensor at port 1
b = EV3();
b.connect('usb');
ma = b.motorA;
ma.setProperties('power', 50, 'limitValue', 720);
ma.start();
% fun
ma.waitFor();
disp(b.sensor1.value);
b.beep();
b.delete();
.. automodule:: source
.. |br| raw:: html
<br />
hidapi
======
.. autoclass:: hidapi
:members: open, close, read, read_timeout, write, getHIDInfoString, setNonBlocking, init, exit, error, enumerate, getManufacturersString, getProductString, getSerialNumberString
.. source documentation master file, created by
sphinx-quickstart on Fri Nov 25 16:05:22 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==================================================
MATLAB Toolbox for controlling Lego Mindstorms EV3
==================================================
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`_.
.. _our repository: https://git.rwth-aachen.de/mindstorms/ev3-toolbox-matlab/blob/master/readme.md
Contents
========
High-Level documentation
.. toctree::
:maxdepth: 2
EV3
Motor
Sensor
Low-Level documentation
.. toctree::
:maxdepth: 3
hid
usbBrickIO
btBrickIO
=======
General
=======
Installation
============
Contribution
============
Licenses
========
.. automodule:: source
.. |br| raw:: html
<br />
EV3
===
.. autoclass:: EV3
:members: connect, disconnect, stopAllMotors, beep, playTone, stopTone, tonePlayed, setProperties
.. automodule:: source
.. |br| raw:: html
<br />
usbBrickIO
==========
.. autoclass:: usbBrickIO
:members: open, close, read, write, setProperties
......@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
......@@ -81,10 +81,26 @@ div.sphinxsidebar input {
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
......@@ -122,6 +138,8 @@ ul.keywordmatches li.goodmatch a {
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
......@@ -149,9 +167,14 @@ table.indextable td {
vertical-align: top;
}
table.indextable dl, table.indextable dd {
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
......@@ -183,8 +206,20 @@ div.genindex-jumpbox {
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
......@@ -217,10 +252,6 @@ div.body td {
text-align: left;
}
.field-list ul {
padding-left: 1em;
}
.first {
margin-top: 0 !important;
}
......@@ -322,6 +353,11 @@ table.docutils {
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
......@@ -337,10 +373,6 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}
table.field-list td, table.field-list th {
border: 0 !important;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
......@@ -377,6 +409,34 @@ div.figure p.caption span.caption-number {
div.figure p.caption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist td {
vertical-align: top;
}
/* -- other body styles ----------------------------------------------------- */
......@@ -418,24 +478,19 @@ dd {
margin-left: 30px;
}
dt:target, .highlighted {
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.optional {
font-size: 1.3em;
}
......@@ -592,6 +647,16 @@ span.eqno {
float: right;
}
span.eqno a.headerlink {
position: relative;
left: 0px;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment