Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
ev3-toolbox-matlab
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Container registry
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Code review analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
mindstorms
ev3-toolbox-matlab
Commits
ed36b333
Commit
ed36b333
authored
7 years ago
by
Linus Atorf
Browse files
Options
Downloads
Patches
Plain Diff
Update readme.md with license, dependency and quoting info
parent
64acc0d6
Branches
Branches containing commit
Tags
v1.0
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+38
-7
38 additions, 7 deletions
README.md
with
38 additions
and
7 deletions
readme
.md
→
README
.md
+
38
−
7
View file @
ed36b333
#
Lego
Mindstorms EV3
MATLAB
Toolbox
#
RWTH -
Mindstorms EV3 Toolbox
for MATLAB
Hello, fellow LEGO constructors and MATLAB programmers, welcome to the RWTH -
Mindstorms EV3 Toolbox for MATLAB!
This toolbox was designed to simplify controlling LEGO MINDSTORMS EV3
robots live using MATLAB. Via Bluetooth or USB you can easily read sensor values
or control your robots’ motors. You can choose to either work on a high level,
with a virtual twin of your EV3, or follow the EV3's firmware specification
by sending commands directly.
This toolbox is being developed at the RWTH Aachen, Germany, and it is the
follow-up of the
[
RWTH MATLAB NXT Toolbox
](
http://www.mindstorms.rwth-aachen.de/
)
.
This toolbox is being developed at RWTH Aachen University, Germany. It is the
successor of the
[
RWTH - MATLAB NXT Toolbox
](
http://www.mindstorms.rwth-aachen.de/
)
. Amongst other applications,
it is used in the yearly lab exercise
[
"MATLAB meets LEGO Mindstorms"
](
https://mindstorms.lfb.rwth-aachen.de
)
by more than 400 students in the first year of their Eletrical Engineering curriculum at RWTH Aachen University
To get started, take a look at the installation instructions and examples below.
## License
This software is distributed under the Lesser GNU Plublic License v2.1 (LGPL 2.1).
To get started, take a look at the installation instructions and examples.
This software is based on the
[
QUT EV3 MATLAB Toolkit
](
https://wiki.qut.edu.au/display/cyphy/QUT+EV3+MATLAB+toolkit
)
by Peter Corke et al. of Queensland University. Source:
<https://github.com/petercorke/robotics-toolbox-matlab/tree/master/interfaces/EV3>
The QUT EV3 MATLAB Toolkit is part of the Robotics Toolbox for MATLAB, see:
P. Corke, "Robotics, Vision
\&
Control: Fundamental Algorithms in Matlab", Springer, 2011, ISBN 978-3-642-20143
This software uses the HIDAPI library by Alan Ott, Signal 11 Software, see
<https://github.com/signal11/hidapi>
## How to quote
If you want to quote this software, you can use the following bibtex snippet:
```
bibtex
@Misc
{
rwthmindstormsev3toolbox
,
author
=
{Atorf, L. and Sondermann, B. and Stadtmann, T. and Rossmann, J.}
,
title
=
{RWTH - Mindstorms EV3 Toolbox}
,
year
=
{2018}
,
version
=
{1.0}
,
organization
=
{Institute for Man-Machine Interaction, RWTH Aachen University}
,
url
=
{https://git.rwth-aachen.de/mindstorms/ev3-toolbox-matlab}
}
```
## Prerequisites
...
...
@@ -64,9 +96,8 @@ You can find more information on the toolbox functions/classes either by using
editor (the
*.functionname*
is optional), or in the PDF/HTML documentation
inside the subfolder
*docs*
.
## Contribution
##
#
Building the documentation
## Building the documentation
The documentation is built using
[
Sphinx
](
http://www.sphinx-doc.org/en/stable/
)
and several
extensions:
[
matlabdomain
](
https://pypi.python.org/pypi/sphinxcontrib-matlabdomain
)
,
[
Napoleon
](
https://pypi.python.org/pypi/sphinxcontrib-napoleon
)
and
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment