Skip to content
Snippets Groups Projects
Commit 839e8d0a authored by Tim Stadtmann's avatar Tim Stadtmann
Browse files

Update readme.md

parent fc8a3643
No related branches found
No related tags found
No related merge requests found
# "Lego Mindstorms EV3" MATLAB Toolbox # Lego Mindstorms EV3 MATLAB Toolbox
Hello, fellow LEGO constructors and MATLAB programmers, welcome to the RWTH - Mindstorms Hello, fellow LEGO constructors and MATLAB programmers, welcome to the RWTH -
EV3 Toolbox for MATLAB! Mindstorms EV3 Toolbox for MATLAB!
This toolbox was designed to abstract and simplify controlling LEGO MINDSTORMS EV3 This toolbox was designed to simplify controlling LEGO MINDSTORMS EV3
robots using MATLAB. Via Bluetooth or USB you can read sensor values or control robots live using MATLAB. Via Bluetooth or USB you can easily read sensor values
your robots’ motors in an intuitive way. You can choose whether to strictly or control your robots’ motors. You can choose to either work on a high level,
follow the EV3's firmware specification by sending commands directly, or operate working a virtual twin of your EV3, or follow the EV3's firmware specification
on a higher level, using a complete virtualized EV3, including Motor and Sensor by sending commands directly.
classes.
This toolbox is being developed at the RWTH Aachen, Germany, and it is the follow-up This toolbox is being developed at the RWTH Aachen, Germany, and it is the
of the [RWTH MATLAB NXT Toolbox](http://www.mindstorms.rwth-aachen.de/). follow-up of the
[RWTH MATLAB NXT Toolbox](http://www.mindstorms.rwth-aachen.de/).
To get started, take a look at the installation instructions and examples. To get started, take a look at the installation instructions and examples.
## Prerequisites ## ## Prerequisites
If you use Windows, you will need to have the Instrument Control Toolbox installed If you use Windows, you will need to have the Instrument Control Toolbox
for USB to work properly. installed for USB to work properly.
This toolbox has been developed and tested on MATLAB 2014a/2016a, on Windows 7/10 This toolbox has been developed and tested on MATLAB 2014a/2016a, on Windows
and Ubuntu 14.04/16.04. If you encounter problems using other configurations, feel free to 7/10 and Ubuntu 14.04/16.04. If you encounter problems using other
contact us. configurations, feel free to contact us.
The EV3's firmware version needs to be updated to 1.09, bugs and unsuspected behaviour The EV3's firmware version needs to be updated to 1.09, bugs and unsuspected
has been encountered when using older versions. behaviour have been encountered when we use older versions.
## Installation ## ## Installation
In most cases, you will only need to download the toolbox and add it's path to your In most cases, you will only need to download the toolbox and add its path to
MATLAB search path. ('Set path' -> 'Add with subfolders') your MATLAB search path. ('Set path' -> 'Add with subfolders')
You can skip the next part and proceed to the first example to test if everything works
fine.
If you use a Linux system and connecting via Bluetooth does not work, If you use a Linux system and connecting via Bluetooth does not work,
you can try to manually install the *HIDAPI*, an API for communication with you can try to manually install the *HIDAPI*, an API for communication with
HID devices, which this toolbox uses for Bluetooth connection on Linux - a prebuilt HID devices, which this toolbox uses for Bluetooth connection on Linux - a
version is delivered with the toolbox. HIDAPI can be installed using the prebuilt version is delivered with the toolbox. HIDAPI can be installed using the
[official repositories of your distribution](https://packages.ubuntu.com/de/source/trusty/hidapi/) [official repositories of your distribution](https://packages.ubuntu.com/de/source/trusty/hidapi/)
or [built](https://github.com/signal11/hidapi/) or [built](https://github.com/signal11/hidapi/) on your own.
on your own.
## Examples ## ## Examples
Before you can try out the following example, you will need to have your EV3 Before you can try out the following example, you will need to have your EV3
connected to your PC via Bluetooth or USB. If you use a Linux system and want connected to your PC via Bluetooth or USB. If you use a Linux system and want
to try out Bluetooth, we suggest you use the 'btconnect'-script you find to try out Bluetooth, we suggest you use the 'btconnect'-script you find
in 'Tools'. It is a command line script which should facilitate pairing with the in 'Tools'. It is a commandline script which aims to make pairing with the
brick. The syntax is 'btconnect *brickName*' (you can read the brick more easy. The syntax is 'btconnect *brickName*' (you can read the
name your EV3 at the top of its display - it should be *EV3* by default). name of your EV3 at the top of its display - it should be *EV3* by default).
``` ```
% This example expects a motor at port A and a (random) sensor at port 1 % This example expects a motor at port A and a (random) sensor at port 1
...@@ -63,13 +59,13 @@ disp(b.sensor1.value); ...@@ -63,13 +59,13 @@ disp(b.sensor1.value);
b.beep(); b.beep();
b.disconnect(); b.disconnect();
``` ```
You can find more info on the toolbox functions/classes either by using *help functionname/classname* You can find more information on the toolbox functions/classes either by using
and *doc functionname/classname*, or in the generated PDF/HTML documentation (in *docs*). *help functionname/classname* and *doc functionname/classname* in your MATLAB
editor, or in the PDF/HTML documentation inside the subfolder *docs*.
## Contribution ## ## Contribution
TODO
### Building the documentation ### ### Building the documentation
The documentation is built using [Sphinx](http://www.sphinx-doc.org/en/stable/) and several The documentation is built using [Sphinx](http://www.sphinx-doc.org/en/stable/) and several
extensions: [matlabdomain](https://pypi.python.org/pypi/sphinxcontrib-matlabdomain), extensions: [matlabdomain](https://pypi.python.org/pypi/sphinxcontrib-matlabdomain),
[Napoleon](https://pypi.python.org/pypi/sphinxcontrib-napoleon) and [Napoleon](https://pypi.python.org/pypi/sphinxcontrib-napoleon) and
... ...
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment